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

   1 /*10 2002/03/19 13:08:33
   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 */
  28
  29 /* $Id$ */
  30
  31 # ifndef _ENTITY_T_H_
  32 # define _ENTITY_T_H_
  33
  34 # include "entity.h"
  35
  36 struct entity {
  37   firm_kind kind;
  38   ident *name;          /* name of this entity */
  39   ident *ld_name;       /* Unique name of this entity, i.e., the mangled
  40                            name.  E.g., for a class `A' with field `a' this
  41                            is the ident for `A_a'. */
  42   type *type;           /* The type of this entity, e.g., a method type, a
  43                            basic type of the language or a class itself */
  44   type *owner;          /* The class this entity belongs to.  In case of local
  45                            variables the method they are defined in. */
  46   entity **overwrites;  /* A list of entities this entity overwrites.  */
  47   entity **overwrittenby;  /* A list of entities that overwrite this entity.  */
  48   ent_allocation allocation;  /* Distinguishes static and dynamically allocated
  49                                  entities. */
  50   ent_visibility visibility;  /* Specifies visibility to external program
  51                                  fragments */
  52   ent_variability variability;  /* Specifies variability of entities content */
  53   ent_volatility volatility;    /* Specifies volatility of entities content */
  54   ir_node *value;            /* value of atomic entity */
  55   ir_node **values;     /* values of compound entities */
  56   entity **val_ents;    /* entities corresponding to constant values */
  57   int  offset;          /* Offset in byte for this entity.  Fixed when layout
  58                            of owner is determined.  */
  59   void *link;           /* To store some intermediate information */
  60   unsigned long visit;  /* visited counter for walks of the type information */
  61   /* for methods */
  62   enum peculiarity peculiarity;
  63   ir_graph *irg;        /* If (type == method_type) this is the corresponding irg.
  64                            The ir_graph constructor automatically sets this field.
  65                            Yes, it must be here. */
  66   struct dbg_info* dbi;    /* A pointer to information for debug support. */
  67 };
  68
  69
  70 # endif /* _ENTITY_T_H_ */