Some access routines for visited flags in entity.h, irnode.h,

[libfirm] / ir / tr / entity.h

diff --git a/ir/tr/entity.h b/ir/tr/entity.h
index 45176fb..7ea0a15 100644 (file)
--- a/ir/tr/entity.h
+++ b/ir/tr/entity.h
@@ -43,6 +43,8 @@
 **                  an assertion.
 */
 
+/* $Id$ */
+
 # ifndef _ENTITY_H_
 # define _ENTITY_H_
 
@@ -72,9 +74,25 @@ typedef struct ir_graph ir_graph;
  *   entity - An abstract data type to represent program entites.
  * NOTE
  *
- *   ... not documented ...
- *
  * ATTRIBUTES
+ *   owner      A compound type this entity is a part of.
+ *   type       The type of this entity.
+ *   name       The string that represents this entity in the source program.
+ *   allocation A flag saying whether the entity is dynamically or statically
+ *              allocated (values: dynamic_allocated,  static_allocated).
+ *              @@@ Does this make sense???
+ *   visibility A flag indicating the visibility of this entity (values: local,
+ *              external_visible,  external_allocated)
+ *   variability A flag indicating the variability of this entity (values:
+ *              uninitialized, initalized, part_constant, constant)
+ *   offset     The offset of the entity within the compound object.  Only set
+ *              if IR in the state "@@@"  Wie nennen wir den??
+ *   overwrites A list of entities overwritten by this entity.  This list is only
+ *              existent if the owner of this entity is a class.  The members in
+ *              this list must be entities of super classes.
+ *   link       A void* to associate some additional inforamtion with the entity.
+ *   irg        If the entity is a method this is the ir graph that represents the
+ *              code of the method.
  *
  *
  *  These fields can only be accessed via access functions.
@@ -113,14 +131,14 @@ ident      *get_entity_ld_ident (entity *ent);
 void        set_entity_ld_ident (entity *ent, ident *ld_ident);
 
 /*
-char     *get_entity_ld_name  (entity *ent);
-void      set_entity_ld_name  (entity *ent, char *ld_name);
+char       *get_entity_ld_name  (entity *ent);
+void        set_entity_ld_name  (entity *ent, char *ld_name);
 */
 
-type     *get_entity_owner (entity *ent);
+type       *get_entity_owner (entity *ent);
 /* Sets the owner field in entity to owner. */
-void      set_entity_owner (entity *ent, type *owner);
-inline void  assert_legal_owner_of_ent(type *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);
@@ -151,25 +169,66 @@ typedef enum {
 ent_visibility get_entity_visibility (entity *ent);
 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
+                      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
+                      given a value for are constant. */
+  constant          /* The entity is constant. */
+} ent_variability;
+
+ent_variability get_entity_variability (entity *ent);
+void            set_entity_variability (entity *ent, ent_variability var);
+
+/* 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);
+
+/* 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);
+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);
+
+/* Only set if layout = fixed. */
 int       get_entity_offset (entity *ent);
 void      set_entity_offset (entity *ent, int offset);
 
 /* 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
-   is mostly useful for method entities. */
+   is mostly useful for method entities.
+   If a Sel node selects an entity that is overwritten by other entities it
+   must return a pointer to the entity of the dynamic type of the pointer
+   that is passed to it.  Lowering of the Sel node must assure this. */
 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);
 /* Do we need a second relation "overwritten"? */
 
+/* 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. */
 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);
+/* Returns true if the type of the entity is a class, structure,
+   array or union type. */
+int is_compound_entity(entity *ent);
+
 
 /*****/