nsz Git - libfirm/blob - ir/tr/entity.h

   1 /*
   2 **  Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
   3 **  All rights reserved.
   4 **
   5 **  Authors: Martin Trapp, Christian Schaefer,
   6 **           Goetz Lindenmaier
   7 **
   8 **  entity.h:  entities represent all program known objects.
   9 **
  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.
  16 **
  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
  20 **  member.
  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.
  26 **
  27 **  In detail the datastructure entity has the following fields:
  28 **
  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
  43 **                  an assertion.
  44 */
  45
  46 # ifndef _ENTITY_H_
  47 # define _ENTITY_H_
  48
  49 # include "ident.h"
  50 # include "type.h"
  51
  52 /*******************************************************************/
  53 /** general                                                       **/
  54 /*******************************************************************/
  55
  56 /* initalize entity module */
  57 void init_entity (void);
  58
  59 /*******************************************************************/
  60 /** ENTITY                                                        **/
  61 /*******************************************************************/
  62
  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;
  67 #endif
  68
  69 #ifndef _ENTITY_TYPEDEF_
  70 #define _ENTITY_TYPEDEF_
  71 /* to resolve recursion between entity.h and type.h */
  72 typedef struct entity entity;
  73 #endif
  74
  75 /* Creates a new entity.
  76    Automatically inserts the entity as a member of owner. */
  77 entity     *new_entity (type *owner, ident *name, type *type);
  78 /* Copies the entity if the new_owner is different from the
  79    owner of the old entity.  Else returns the old entity.
  80    Automatically inserts the new entity as a member of owner. */
  81 entity     *copy_entity_own (entity *old, type *new_owner);
  82 /* Copies the entity if the new_name is different from the
  83    name of the old entity.  Else returns the old entity.
  84    Automatically inserts the new entity as a member of owner.
  85    The mangled name ld_name is set to NULL. */
  86 entity     *copy_entity_name (entity *old, ident *new_name);
  87 /* manipulate fields of entity */
  88 const char *get_entity_name     (entity *ent);
  89 ident      *get_entity_ident    (entity *ent);
  90 /* returns the mangled name of the entity.  If the mangled name is
  91    set it returns the existing name.  Else it generates a name
  92    with mangle_entity() and remembers this new name internally. */
  93 ident      *get_entity_ld_ident (entity *ent);
  94 void        set_entity_ld_ident (entity *ent, ident *ld_ident);
  95
  96 /*
  97 char     *get_entity_ld_name  (entity *ent);
  98 void      set_entity_ld_name  (entity *ent, char *ld_name);
  99 */
 100
 101 type     *get_entity_owner (entity *ent);
 102 void      set_entity_owner (entity *ent, type *owner);
 103 inline void  assert_legal_owner_of_ent(type *owner);
 104
 105 type     *get_entity_type (entity *ent);
 106 void      set_entity_type (entity *ent, type *type);
 107
 108 typedef enum {
 109   dynamic_allocated,  /* The entity is allocated during runtime, either explicitly
 110                          by an Alloc node or implicitly as component of a compound
 111                          type.  This is the default. */
 112   static_allocated    /* The entity is allocated statically.  We can use a
 113                           SymConst as address of the entity. */
 114 } ent_allocation;
 115
 116 ent_allocation get_entity_allocation (entity *ent);
 117 void           set_entity_allocation (entity *ent, ent_allocation al);
 118
 119 /* This enumeration flags the visibility of entities.  This is necessary
 120    for partial compilation. */
 121 typedef enum {
 122   local,              /* The entity is only visible locally.  This is the default. */
 123   external_visible,   /* The entity is visible to other external program parts, but
 124                          it is defined here.  It may not be optimized away.  The entity must
 125                          be static_allocated. */
 126   external_allocated  /* The entity is defined and allocated externaly.  This compilation
 127                          must not allocate memory for this entity. The entity must
 128                          be static_allocated. */
 129 } ent_visibility;
 130
 131 ent_visibility get_entity_visibility (entity *ent);
 132 void           set_entity_visibility (entity *ent, ent_visibility vis);
 133
 134 int       get_entity_offset (entity *ent);
 135 void      set_entity_offset (entity *ent, int offset);
 136
 137 /* The entity knows the corresponding irg if the entity is a method.
 138    This allows to get from a Call to the called irg. */
 139 ir_graph *get_entity_irg(entity *ent);
 140 void      set_entity_irg(entity *ent, ir_graph *irg);
 141
 142
 143 # endif /* _ENTITY_H_ */