syntactic changes for jni generator / crecoder
[libfirm] / ir / tr / entity.h
index 4f91854..e6c2cd2 100644 (file)
@@ -50,6 +50,7 @@
 
 # include "ident.h"
 # include "type.h"
+# include "dbginfo.h"
 
 /*******************************************************************/
 /** general                                                       **/
@@ -62,9 +63,9 @@ void init_entity (void);
 /** ENTITY                                                        **/
 /*******************************************************************/
 
+/* to resolve recursion between entity.h and irgraph.h */
 #ifndef _IR_GRAPH_TYPEDEF_
 #define _IR_GRAPH_TYPEDEF_
-/* to resolve recursion between entity.h and irgraph.h */
 typedef struct ir_graph ir_graph;
 #endif
 
@@ -103,6 +104,7 @@ typedef struct ir_graph ir_graph;
  *              In that case there nowhere exists code for this entity and this entity
  *              is never dynamically used in the code.
  *              Values: description, existent.  Default: existent.
+ *   visited   visited flag.  Master flag is type_visited.
  *
  *  These fields can only be accessed via access functions.
  *
@@ -111,19 +113,21 @@ typedef struct ir_graph ir_graph;
  * SOURCE
  */
 
+/* to resolve recursion between entity.h and type.h */
 #ifndef _ENTITY_TYPEDEF_
 #define _ENTITY_TYPEDEF_
-/* to resolve recursion between entity.h and type.h */
 typedef struct entity entity;
 #endif
 
+
 /* Creates a new entity.
    Automatically inserts the entity as a member of owner.
    Entity is automatic_allocated and uninitialize except if the type
    is type_method, then it is static_allocated and constant.  The constant
    value is a pointer to the method.
    Visibility is local, offset -1, and it is not volatile. */
-entity     *new_entity (type *owner, ident *name, type *type);
+entity     *new_entity (type *owner, ident *name, type *tp);
+entity     *new_d_entity (type *owner, ident *name, type *tp, dbg_info *db);
 /* Copies the entity if the new_owner is different from the
    owner of the old entity.  Else returns the old entity.
    Automatically inserts the new entity as a member of owner. */
@@ -133,10 +137,14 @@ entity     *copy_entity_own (entity *old, type *new_owner);
    Automatically inserts the new entity as a member of owner.
    The mangled name ld_name is set to NULL. */
 entity     *copy_entity_name (entity *old, ident *new_name);
+/* Frees the entity.  The owner will still contain the pointer to this
+   entity, as well as all other references! */
+void        free_entity (entity *ent);
 
 /** manipulate fields of entity **/
 const char *get_entity_name     (entity *ent);
 ident      *get_entity_ident    (entity *ent);
+
 /* returns the mangled name of the entity.  If the mangled name is
    set it returns the existing name.  Else it generates a name
    with mangle_entity() and remembers this new name internally. */
@@ -144,26 +152,26 @@ ident      *get_entity_ld_ident (entity *ent);
 void        set_entity_ld_ident (entity *ent, ident *ld_ident);
 const char *get_entity_ld_name (entity *end);
 
-/*
-char       *get_entity_ld_name  (entity *ent);
-void        set_entity_ld_name  (entity *ent, char *ld_name);
-*/
-
 type       *get_entity_owner (entity *ent);
-/* Sets the owner field in entity to owner. */
+/* Sets the owner field in entity to owner.  Don't forget to add
+   ent to owner!! */
 void        set_entity_owner (entity *ent, type *owner);
 INLINE void assert_legal_owner_of_ent(type *owner);
 
 type     *get_entity_type (entity *ent);
-void      set_entity_type (entity *ent, type *type);
+void      set_entity_type (entity *ent, type *tp);
 
 typedef enum {
-  automatic_allocated,/* The entity is allocated during runtime, implicitly
-                        as component of a compound type.   This is the default. */
-  dynamic_allocated,  /* The entity is allocated during runtime, explicitly
-                        by an Alloc node. */
-  static_allocated    /* The entity is allocated statically.  We can use a
-                         SymConst(?) as address of the entity. */
+  automatic_allocated, /* The entity is allocated during runtime, implicitly
+                         as component of a compound type.   This is the default. */
+  parameter_allocated, /* The entity is a parameter.  It is also automatic allocated.
+                         We distinguish the allocation of paramters from the allocation
+                         of local variables as their placement depends on the calling
+                         conventions. */
+  dynamic_allocated,   /* The entity is allocated during runtime, explicitly
+                         by an Alloc node. */
+  static_allocated     /* The entity is allocated statically.  We can use a
+                          SymConst(?) as address of the entity. */
 } ent_allocation;
 
 ent_allocation get_entity_allocation (entity *ent);
@@ -188,7 +196,7 @@ void           set_entity_visibility (entity *ent, ent_visibility vis);
 /* This enumeration flags the variability of entities. */
 typedef enum {
   uninitialized,    /* The content of the entity is completely unknown. */
-  initialized,       /* After allocation the entity is initalized with the
+  initialized,      /* After allocation the entity is initalized with the
                       value given somewhere in the entity. */
   part_constant,    /* For entities of compound types.  Some members of the entity
                       are constant.  The others are uninitialized.  Those members
@@ -208,10 +216,29 @@ typedef enum {
 ent_volatility get_entity_volatility (entity *ent);
 void           set_entity_volatility (entity *ent, ent_volatility vol);
 
+/* Only set if layout = fixed. */
+int       get_entity_offset (entity *ent);
+void      set_entity_offset (entity *ent, int offset);
+
+/* A link to store intermediate information */
+void*   get_entity_link(entity *ent);
+void    set_entity_link(entity *ent, void *l);
+
+/** Fields of method entities **/
+/* The entity knows the corresponding irg if the entity is a method.
+   This allows to get from a Call to the called irg.
+   Only entities of peculiarity "existent" can have a corresponding irg,
+   else the field is fixed to NULL.  (Get returns NULL, set asserts.) */
+ir_graph *get_entity_irg(entity *ent);
+void      set_entity_irg(entity *ent, ir_graph *irg);
+
 /* For the definition of enumeration peculiarity see type.h */
 peculiarity get_entity_peculiarity (entity *ent);
 void        set_entity_peculiarity (entity *ent, peculiarity pec);
 
+/** Representation of constant values of entites **/
+/* Set current_ir_graph to get_const_code_irg() to generate a constant
+   expression. */
 /* Copies a firm subgraph that complies to the restrictions for
    constant expressions to current_block in current_ir_graph. */
 ir_node *copy_const_value(ir_node *n);
@@ -219,19 +246,15 @@ ir_node *copy_const_value(ir_node *n);
 /* Set has no effect for entities of type method. */
 ir_node *get_atomic_ent_value(entity *ent);
 void     set_atomic_ent_value(entity *ent, ir_node *val);
-/* Copies the value represented by the entity to current_block
-   in current_ir_graph. @@@ oblivious, use copy_const_vallue */
-ir_node *copy_atomic_ent_value(entity *ent);
 
-/* A value of a compound entity is a pair of value and the corresponding
+/* A value of a compound entity is a pair of value and the corresponding
    member of the compound. */
 void     add_compound_ent_value(entity *ent, ir_node *val, entity *member);
-/* oblivious, use copy_const_value @@@ */
-void     copy_and_add_compound_ent_value(entity *ent, ir_node *val, entity *member);
 int      get_compound_ent_n_values(entity *ent);
 ir_node *get_compound_ent_value(entity *ent, int pos);
 entity  *get_compound_ent_value_member(entity *ent, int pos);
 void     set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos);
+void     remove_compound_ent_value(entity *ent, entity *value_ent);
 /* Inits the entity ent witch must be of a one dimensional
    array type with the values given in the values array.
    The array must have a lower and an upper bound.  Keeps the
@@ -239,13 +262,8 @@ void     set_compound_ent_value(entity *ent, ir_node *val, entity *member, int p
    fits into the given array size.  Does not test whether the
    values have the proper mode for the array. */
 void set_array_entity_values(entity *ent, tarval **values, int num_vals);
-/* Copies the value pos of the entity to current_block in current_ir_graph. */
-ir_node *copy_compound_ent_value(entity *ent, int pos);
-
-/* Only set if layout = fixed. */
-int       get_entity_offset (entity *ent);
-void      set_entity_offset (entity *ent, int offset);
 
+/** Fields of entities with a class type as owner **/
 /* Overwrites is a field that specifies that an access to the overwritten
    entity in the supertype must use this entity.  It's a list as with
    multiple inheritance several enitites can be overwritten.  This field
@@ -259,23 +277,12 @@ void    add_entity_overwrites   (entity *ent, entity *overwritten);
 int     get_entity_n_overwrites (entity *ent);
 entity *get_entity_overwrites   (entity *ent, int pos);
 void    set_entity_overwrites   (entity *ent, int pos, entity *overwritten);
+
 void    add_entity_overwrittenby   (entity *ent, entity *overwrites);
 int     get_entity_n_overwrittenby (entity *ent);
 entity *get_entity_overwrittenby   (entity *ent, int pos);
 void    set_entity_overwrittenby   (entity *ent, int pos, entity *overwrites);
 
-/* A link to store intermediate information */
-void*   get_entity_link(entity *ent);
-void    set_entity_link(entity *ent, void *l);
-
-/* The entity knows the corresponding irg if the entity is a method.
-   This allows to get from a Call to the called irg.
-   Only entities of peculiarity "existent" can have a corresponding irg,
-   else the field is fixed to NULL.  (Get returns NULL, set asserts.) */
-ir_graph *get_entity_irg(entity *ent);
-void      set_entity_irg(entity *ent, ir_graph *irg);
-
-
 /* Returns true if the type of the entity is a primitive, pointer
    enumeration or method type. */
 int is_atomic_entity(entity *ent);
@@ -283,6 +290,19 @@ int is_atomic_entity(entity *ent);
    array or union type. */
 int is_compound_entity(entity *ent);
 
+/* Returns true if ent1 and ent2 have are equal except for their owner.
+   Two entities are equal if
+    - they have the same type (the same C-struct)
+    - ...?
+*/
+bool equal_entity(entity *ent1, entity *ent2);
+
+
+unsigned long get_entity_visited(entity *ent);
+void        set_entity_visited(entity *ent, unsigned long num);
+/* Sets visited field in entity to entity_visited. */
+void        mark_entity_visited(entity *ent);
+
 
 /*****/