2 ** Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
3 ** All rights reserved.
5 ** Authors: Martin Trapp, Christian Schaefer,
8 ** entity.h: entities represent all program known objects.
10 ** An entity is the representation of program known objects in Firm.
11 ** The primary concept of entities is to represent members of complex
12 ** types, i.e., fields and methods of classes. As not all programming
13 ** language model all variables and methods as members of some class,
14 ** the concept of entities is extended to cover also local and global
15 ** variables, and arbitrary procedures.
17 ** An entity always specifies the type of the object it represents and
18 ** the type of the object it is a part of, the owner of the entity.
19 ** Originally this is the type of the class of which the entity is a
21 ** The owner of local variables is the procedure they are defined in.
22 ** The owner of global variables and procedures visible in the whole
23 ** program is a universally defined class type "GlobalType". The owner
24 ** of procedures defined in the scope of an other procedure is the
25 ** enclosing procedure.
27 ** In detail the datastructure entity has the following fields:
29 ** ident *name Name of this entity as specified in the source code.
30 ** Only unequivocal in conjuction with scope.
31 ** ident *ld_name Unique name of this entity, i.e., the mangled
32 ** name. E.g., for a class `A' with field `a' this
33 ** is the ident for `A_a'.
34 ** type *type The type of this entity, e.g., a method type, a
35 ** basic type of the language or a class itself.
36 ** type *owner; The class this entity belongs to. In case of local
37 ** variables the method they are defined in.
38 ** int offset; Offset in byte for this entity. Fixed when layout
39 ** of owner is determined.
40 ** ir_graph *irg; If (type == method_type) this is the corresponding irg.
41 ** The ir_graph constructor automatically sets this field.
42 ** If (type !- method_type) access of this field will cause
52 /*******************************************************************/
54 /*******************************************************************/
56 /* initalize entity module */
57 void init_entity (void);
59 /*******************************************************************/
61 /*******************************************************************/
63 #ifndef _IR_GRAPH_TYPEDEF_
64 #define _IR_GRAPH_TYPEDEF_
65 /* to resolve recursion between entity.h and irgraph.h */
66 typedef struct ir_graph ir_graph;
72 * entity - An abstract data type to represent program entites.
75 * ... not documented ...
80 * These fields can only be accessed via access functions.
87 #ifndef _ENTITY_TYPEDEF_
88 #define _ENTITY_TYPEDEF_
89 /* to resolve recursion between entity.h and type.h */
90 typedef struct entity entity;
93 /* Creates a new entity.
94 Automatically inserts the entity as a member of owner. */
95 entity *new_entity (type *owner, ident *name, type *type);
96 /* Copies the entity if the new_owner is different from the
97 owner of the old entity. Else returns the old entity.
98 Automatically inserts the new entity as a member of owner. */
99 entity *copy_entity_own (entity *old, type *new_owner);
100 /* Copies the entity if the new_name is different from the
101 name of the old entity. Else returns the old entity.
102 Automatically inserts the new entity as a member of owner.
103 The mangled name ld_name is set to NULL. */
104 entity *copy_entity_name (entity *old, ident *new_name);
106 /** manipulate fields of entity **/
107 const char *get_entity_name (entity *ent);
108 ident *get_entity_ident (entity *ent);
109 /* returns the mangled name of the entity. If the mangled name is
110 set it returns the existing name. Else it generates a name
111 with mangle_entity() and remembers this new name internally. */
112 ident *get_entity_ld_ident (entity *ent);
113 void set_entity_ld_ident (entity *ent, ident *ld_ident);
116 char *get_entity_ld_name (entity *ent);
117 void set_entity_ld_name (entity *ent, char *ld_name);
120 type *get_entity_owner (entity *ent);
121 /* Sets the owner field in entity to owner. */
122 void set_entity_owner (entity *ent, type *owner);
123 inline void assert_legal_owner_of_ent(type *owner);
125 type *get_entity_type (entity *ent);
126 void set_entity_type (entity *ent, type *type);
129 dynamic_allocated, /* The entity is allocated during runtime, either explicitly
130 by an Alloc node or implicitly as component of a compound
131 type. This is the default. */
132 static_allocated /* The entity is allocated statically. We can use a
133 SymConst as address of the entity. */
136 ent_allocation get_entity_allocation (entity *ent);
137 void set_entity_allocation (entity *ent, ent_allocation al);
139 /* This enumeration flags the visibility of entities. This is necessary
140 for partial compilation. */
142 local, /* The entity is only visible locally. This is the default. */
143 external_visible, /* The entity is visible to other external program parts, but
144 it is defined here. It may not be optimized away. The entity must
145 be static_allocated. */
146 external_allocated /* The entity is defined and allocated externaly. This compilation
147 must not allocate memory for this entity. The entity must
148 be static_allocated. */
151 ent_visibility get_entity_visibility (entity *ent);
152 void set_entity_visibility (entity *ent, ent_visibility vis);
154 int get_entity_offset (entity *ent);
155 void set_entity_offset (entity *ent, int offset);
157 /* Overwrites is a field that specifies that an access to the overwritten
158 entity in the supertype must use this entity. It's a list as with
159 multiple inheritance several enitites can be overwritten. This field
160 is mostly useful for method entities. */
161 void add_entity_overwrites (entity *ent, entity *overwritten);
162 int get_entity_n_overwrites (entity *ent);
163 entity *get_entity_overwrites (entity *ent, int pos);
164 void set_entity_overwrites (entity *ent, int pos, entity *overwritten);
165 /* Do we need a second relation "overwritten"? */
167 /* The entity knows the corresponding irg if the entity is a method.
168 This allows to get from a Call to the called irg. */
169 ir_graph *get_entity_irg(entity *ent);
170 void set_entity_irg(entity *ent, ir_graph *irg);
176 # endif /* _ENTITY_H_ */