** of procedures defined in the scope of an other procedure is the
** enclosing procedure.
**
+** In detail the datastructure entity has the following fields:
+**
+** ident *name Name of this entity as specified in the source code.
+** Only unequivocal in conjuction with scope.
+** ident *ld_name Unique name of this entity, i.e., the mangled
+** name. E.g., for a class `A' with field `a' this
+** is the ident for `A_a'.
+** type *type The type of this entity, e.g., a method type, a
+** basic type of the language or a class itself.
+** type *owner; The class this entity belongs to. In case of local
+** variables the method they are defined in.
+** int offset; Offset in byte for this entity. Fixed when layout
+** of owner is determined.
+** ir_graph *irg; If (type == method_type) this is the corresponding irg.
+** The ir_graph constructor automatically sets this field.
+** If (type !- method_type) access of this field will cause
+** an assertion.
*/
# ifndef _ENTITY_H_
typedef struct entity entity;
#endif
-/* create a new entity */
-entity *new_entity (type *owner, ident *name, type *type);
+/* Creates a new entity.
+ Automatically inserts the entity as a member of owner. */
+entity *new_entity (type *owner, ident *name, type *type);
/* manipulate fields of entity */
-char *get_entity_name (entity *ent);
-ident *get_entity_ident (entity *ent);
-
-ident *get_entity_ld_name (entity *ent);
+const char *get_entity_name (entity *ent);
+ident *get_entity_ident (entity *ent);
+/* returns the mangled name of the entity */
+ident *get_entity_ld_name (entity *ent);
/*
char *get_entity_ld_name (entity *ent);
type *get_entity_type (entity *ent);
void set_entity_type (entity *ent, type *type);
+typedef enum {
+ dynamic_allocated, /* The entity is allocated during runtime, either explicitly
+ by an Alloc node or implicitly as component of a compound
+ type. This is the default. */
+ 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);
+void set_entity_allocation (entity *ent, ent_allocation al);
+
+/* This enumeration flags the visibility of entities. This is necessary
+ for partial compilation. */
+typedef enum {
+ local, /* The entity is only visible locally. This is the default. */
+ external_visible, /* The entity is visible to other external program parts, but
+ it is defined here. It may not be optimized away. The entity must
+ be static_allocated. */
+ external_allocated /* The entity is defined and allocated externaly. This compilation
+ must not allocate memory for this entity. The entity must
+ be static_allocated. */
+} ent_visibility;
+
+ent_visibility get_entity_visibility (entity *ent);
+void set_entity_visibility (entity *ent, ent_visibility vis);
+
+int get_entity_offset (entity *ent);
+void set_entity_offset (entity *ent, int offset);
+
/* 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);