rename type entity into ir_entity
[libfirm] / ir / tr / type.h
index ebf815e..916006c 100644 (file)
@@ -5,7 +5,7 @@
  * Author:      Goetz Lindenmaier
  * Modified by: Michael Beck
  * Created:
- * Copyright:   (c) 2001-2003 Universität Karlsruhe
+ * Copyright:   (c) 2001-2006 Universität Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  * CVS-ID:      $Id$
  */
@@ -156,7 +156,7 @@ typedef enum {
                                       method.
                                       For types:  entities of this type are allocated and accessed from
                                       external code.  Default for types.  */
-} visibility;
+} ir_visibility;
 
 /** The visibility of a type.
  *
@@ -196,8 +196,8 @@ typedef enum {
  * Entities of types are never visibility_external_allocated (right?).
  * Else returns visibility_local.
  */
-visibility get_type_visibility (const ir_type *tp);
-void       set_type_visibility (ir_type *tp, visibility v);
+ir_visibility get_type_visibility(const ir_type *tp);
+void          set_type_visibility(ir_type *tp, ir_visibility v);
 
 
 
@@ -206,13 +206,14 @@ typedef enum {
   layout_undefined,    /**< The layout of this type is not defined.
                             Address computation to access fields is not
                             possible, fields must be accessed by Sel
-                            nodes.  This is the default value except for
+                            nodes.  Enumeration constants might be undefined.
+                            This is the default value except for
                             pointer, primitive and method types. */
   layout_fixed         /**< The layout is fixed, all component/member entities
                             have an offset assigned.  Size of the type is known.
                             Arrays can be accessed by explicit address
-                            computation. Default for pointer, primitive and method
-                            types.  */
+                            computation.  Enumeration constants must be defined.
+                            Default for pointer, primitive and method types. */
 } type_state;
 
 /** Returns a human readable string for the enum entry. */
@@ -329,7 +330,7 @@ void          inc_master_type_visited(void);
  * @return
  *     true if the thing is a type, else false
  */
-int is_type  (const void *thing);
+int is_type(const void *thing);
 
 /**
  *   Checks whether two types are structurally equal.
@@ -404,7 +405,7 @@ int equal_type(ir_type *typ1, ir_type *typ2);
  *      @return smaller than the points_to type of lt.
  *
  */
-int smaller_type (ir_type *st, ir_type *lt);
+int smaller_type(ir_type *st, ir_type *lt);
 
 /**
  *  @page class_type    Representation of a class type
@@ -470,37 +471,37 @@ ir_type *new_d_type_class (ident *name, dbg_info *db);
 /* --- manipulate private fields of class type  --- */
 
 /** Adds the entity as member of the class.  */
-void    add_class_member   (ir_type *clss, entity *member);
+void add_class_member   (ir_type *clss, ir_entity *member);
 
 /** Returns the number of members of this class. */
-int     get_class_n_members (const ir_type *clss);
+int get_class_n_members (const ir_type *clss);
 
 /** Returns the member at position pos, 0 <= pos < n_member */
-entity *get_class_member   (const ir_type *clss, int pos);
+ir_entity *get_class_member   (const ir_type *clss, int pos);
 
 /** Returns index of mem in clss, -1 if not contained. */
-int     get_class_member_index(const ir_type *clss, entity *mem);
+int get_class_member_index(const ir_type *clss, ir_entity *mem);
 
 /** Finds the member with name 'name'. If several members with the same
  *  name returns one of them.  Returns NULL if no member found. */
-entity *get_class_member_by_name(ir_type *clss, ident *name);
+ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
 
 /** Overwrites the member at position pos, 0 <= pos < n_member with
  *  the passed entity. */
-void    set_class_member   (ir_type *clss, entity *member, int pos);
+void set_class_member   (ir_type *clss, ir_entity *member, int pos);
 
 /** Replaces complete member list in class type by the list passed.
  *
  *  Copies the list passed. This function is necessary to reduce the number of members.
  *  members is an array of entities, num the size of this array.  Sets all
  *  owners of the members passed to clss. */
-void    set_class_members  (ir_type *clss, entity *members[], int arity);
+void set_class_members  (ir_type *clss, ir_entity *members[], int arity);
 
 /** Finds member in the list of members and removes it.
  *
  *  Shrinks the member list, so iterate from the end!!!
  *  Does not deallocate the entity.  */
-void    remove_class_member(ir_type *clss, entity *member);
+void remove_class_member(ir_type *clss, ir_entity *member);
 
 
 /** Adds subtype as subtype to clss.
@@ -582,7 +583,7 @@ void    remove_class_supertype(ir_type *clss, ir_type *supertype);
 #define remove_class_base_type(clss, basetype)     remove_class_supertype(clss, basetype)
 
 /** This enumeration flags the peculiarity of entities and types. */
-typedef enum peculiarity {
+typedef enum {
   peculiarity_description,     /**< Represents only a description.  The entity/type is never
                             allocated, no code/data exists for this entity/type.
                         @@@ eventually rename to descriptive (adjective as the others!)*/
@@ -596,21 +597,21 @@ typedef enum peculiarity {
   peculiarity_existent         /**< The entity/type (can) exist.
                     @@@ eventually rename to 'real' i.e., 'echt'
                         This serves better as opposition to description _and_ inherited.*/
-} peculiarity;
+} ir_peculiarity;
 
 /** Returns a human readable string for a peculiarity. */
-const char *get_peculiarity_name(peculiarity p);
+const char *get_peculiarity_name(ir_peculiarity p);
 
 /** Returns the peculiarity of the class. */
-peculiarity get_class_peculiarity (const ir_type *clss);
+ir_peculiarity get_class_peculiarity (const ir_type *clss);
 /** Sets the peculiarity of the class. */
-void        set_class_peculiarity (ir_type *clss, peculiarity pec);
+void           set_class_peculiarity (ir_type *clss, ir_peculiarity pec);
 
 /** Returns the type info entity of a class. */
-entity *get_class_type_info(const ir_type *clss);
+ir_entity *get_class_type_info(const ir_type *clss);
 
 /** Set a type info entity for the class. */
-void set_class_type_info(ir_type *clss, entity *ent);
+void set_class_type_info(ir_type *clss, ir_entity *ent);
 
 /** Returns the size of the virtual function table. */
 unsigned get_class_vtable_size(const ir_type *clss);
@@ -668,26 +669,26 @@ ir_type *new_d_type_struct (ident *name, dbg_info* db);
 /* --- manipulate private fields of struct --- */
 
 /** Adds the entity as member of the struct.  */
-void    add_struct_member   (ir_type *strct, entity *member);
+void add_struct_member   (ir_type *strct, ir_entity *member);
 
 /** Returns the number of members of this struct. */
-int     get_struct_n_members (const ir_type *strct);
+int get_struct_n_members (const ir_type *strct);
 
 /** Returns the member at position pos, 0 <= pos < n_member */
-entity *get_struct_member   (const ir_type *strct, int pos);
+ir_entity *get_struct_member   (const ir_type *strct, int pos);
 
 /** Returns index of member in strct, -1 if not contained. */
-int     get_struct_member_index(const ir_type *strct, entity *member);
+int get_struct_member_index(const ir_type *strct, ir_entity *member);
 
 /** Overwrites the member at position pos, 0 <= pos < n_member with
    the passed entity. */
-void    set_struct_member   (ir_type *strct, int pos, entity *member);
+void set_struct_member   (ir_type *strct, int pos, ir_entity *member);
 
 /** Finds member in the list of members and removes it. */
-void    remove_struct_member (ir_type *strct, entity *member);
+void remove_struct_member (ir_type *strct, ir_entity *member);
 
 /** Returns true if a type is a struct type. */
-int     is_Struct_type(const ir_type *strct);
+int is_Struct_type(const ir_type *strct);
 
 /**
  * @page method_type    Representation of a method type
@@ -764,12 +765,20 @@ ir_type *get_method_param_type(ir_type *method, int pos);
 void  set_method_param_type(ir_type *method, int pos, ir_type *tp);
 /** Returns an entity that represents the copied value argument.  Only necessary
    for compounds passed by value. This information is constructed only on demand. */
-entity *get_method_value_param_ent(ir_type *method, int pos);
+ir_entity *get_method_value_param_ent(ir_type *method, int pos);
 /**
  * Returns a type that represents the copied value arguments if one
  * was allocated, else NULL.
  */
 ir_type *get_method_value_param_type(const ir_type *method);
+/** Returns an ident representing the parameters name. Returns NULL if not set.
+    For debug support only. */
+ident *get_method_param_ident(ir_type *method, int pos);
+/** Returns a string representing the parameters name. Returns NULL if not set.
+    For debug support only. */
+const char *get_method_param_name(ir_type *method, int pos);
+/** Sets an ident representing the parameters name. For debug support only. */
+void set_method_param_ident(ir_type *method, int pos, ident *id);
 
 /** Returns the number of results of a method type. */
 int   get_method_n_ress   (const ir_type *method);
@@ -781,7 +790,7 @@ ir_type *get_method_res_type(ir_type *method, int pos);
 void  set_method_res_type(ir_type *method, int pos, ir_type *tp);
 /** Returns an entity that represents the copied value result.  Only necessary
    for compounds passed by value. This information is constructed only on demand. */
-entity *get_method_value_res_ent(ir_type *method, int pos);
+ir_entity *get_method_value_res_ent(ir_type *method, int pos);
 
 /**
  * Returns a type that represents the copied value results.
@@ -848,6 +857,7 @@ typedef enum {
                                          GCC: __attribute__((malloc)). */
   mtp_property_intrinsic = 0x00000040, /**< This method is intrinsic. It is expected that
                                          a lowering phase will remove all calls to it. */
+  mtp_property_runtime   = 0x00000080, /**< This method represents a runtime routine. */
   mtp_property_inherited = (1<<31)     /**< Internal. Used only in irg's, means property is
                                          inherited from type. */
 } mtp_additional_property;
@@ -963,19 +973,19 @@ ir_type   *new_d_type_union (ident *name, dbg_info* db);
 int     get_union_n_members      (const ir_type *uni);
 
 /** Adds a new entity to a union type */
-void    add_union_member (ir_type *uni, entity *member);
+void    add_union_member (ir_type *uni, ir_entity *member);
 
 /** Returns the entity at position pos of a union */
-entity *get_union_member (const ir_type *uni, int pos);
+ir_entity *get_union_member (const ir_type *uni, int pos);
 
 /** Returns index of member in uni, -1 if not contained. */
-int     get_union_member_index(const ir_type *uni, entity *member);
+int     get_union_member_index(const ir_type *uni, ir_entity *member);
 
 /** Overwrites a entity at position pos in a union type. */
-void    set_union_member (ir_type *uni, int pos, entity *member);
+void    set_union_member (ir_type *uni, int pos, ir_entity *member);
 
 /** Finds member in the list of members and removes it. */
-void    remove_union_member (ir_type *uni, entity *member);
+void    remove_union_member (ir_type *uni, ir_entity *member);
 
 /** Returns true if a type is a union type. */
 int     is_Union_type          (const ir_type *uni);
@@ -1070,7 +1080,7 @@ void set_array_order (ir_type *array, int dimension, int order);
 /** Returns the order of an array dimension. */
 int  get_array_order (const ir_type *array, int dimension);
 
-/** Find the array dimension that is placed at order ord. */
+/** Find the array dimension that is placed at order order. */
 int find_array_dimension(const ir_type *array, int order);
 
 /** Sets the array element type. */
@@ -1080,10 +1090,10 @@ void  set_array_element_type (ir_type *array, ir_type* tp);
 ir_type *get_array_element_type (ir_type *array);
 
 /** Sets the array element entity. */
-void  set_array_element_entity (ir_type *array, entity *ent);
+void  set_array_element_entity (ir_type *array, ir_entity *ent);
 
 /** Get the array element entity. */
-entity *get_array_element_entity (const ir_type *array);
+ir_entity *get_array_element_entity (const ir_type *array);
 
 /** Returns true if a type is an array type. */
 int    is_Array_type(const ir_type *array);
@@ -1094,40 +1104,55 @@ int    is_Array_type(const ir_type *array);
  * Enumeration types need not necessarily be represented explicitly
  * by Firm types, as the frontend can lower them to integer constants as
  * well.  For debugging purposes or similar tasks this information is useful.
+ * The type state layout_fixed is set, if all enumeration constant have
+ * there tarvals assigned.  Until then
  *
- * - *enum:         The target values representing the constants used to
+ * - *const:        The target values representing the constants used to
  *                  represent individual enumerations.
- * - *enum_nameid:  Idents containing the source program name of the enumeration
- *                  constants
  */
+
+#ifndef _IR_ENUM_CONST_TYPEDEF_
+#define _IR_ENUM_CONST_TYPEDEF_
+typedef struct ir_enum_const ir_enum_const;
+#endif
+
 /** Create a new type enumeration -- set the enumerators independently. */
-ir_type   *new_type_enumeration    (ident *name, int n_enums);
+ir_type   *new_type_enumeration(ident *name, int n_enums);
 
 /** Create a new type enumeration with debug information -- set the enumerators independently. */
-ir_type   *new_d_type_enumeration    (ident *name, int n_enums, dbg_info *db);
+ir_type   *new_d_type_enumeration(ident *name, int n_enums, dbg_info *db);
 
 /* --- manipulate fields of enumeration type. --- */
 
+/** Set an enumeration constant to a enumeration type at a given position. */
+void set_enumeration_const(ir_type *enumeration, int pos, ident *nameid, tarval *con);
+
 /** Returns the number of enumeration values of this enumeration */
-int     get_enumeration_n_enums (const ir_type *enumeration);
+int     get_enumeration_n_enums(const ir_type *enumeration);
+
+/** Returns the enumeration constant at a given position. */
+ir_enum_const *get_enumeration_const(const ir_type *enumeration, int pos);
+
+/** Returns the enumeration type owner of an enumeration constant. */
+ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
 
-/** Sets the enumeration value at a given position. */
-void    set_enumeration_enum    (ir_type *enumeration, int pos, tarval *con);
+/** Sets the enumeration constant value. */
+void    set_enumeration_value(ir_enum_const *enum_cnst, tarval *con);
 
-/** Returns the enumeration value at a given position. */
-tarval *get_enumeration_enum    (const ir_type *enumeration, int pos);
+/** Returns the enumeration constant value. */
+tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
 
-/** Assign an ident to an enumeration value at a given position. */
-void    set_enumeration_nameid  (ir_type *enumeration, int pos, ident *id);
+/** Assign an ident to an enumeration constant. */
+void    set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
 
-/** Returns the assigned ident of an enumeration value at a given position. */
-ident  *get_enumeration_nameid  (const ir_type *enumeration, int pos);
+/** Returns the assigned ident of an enumeration constant. */
+ident  *get_enumeration_nameid(const ir_enum_const *enum_cnst);
 
-/** Returns the assigned name of an enumeration value at a given position. */
-const char *get_enumeration_name(const ir_type *enumeration, int pos);
+/** Returns the assigned name of an enumeration constant. */
+const char *get_enumeration_name(const ir_enum_const *enum_cnst);
 
 /** Returns true if a type is a enumeration type. */
-int     is_Enumeration_type     (const ir_type *enumeration);
+int     is_Enumeration_type(const ir_type *enumeration);
 
 /**
  * @page pointer_type   Representation of a pointer type
@@ -1168,13 +1193,13 @@ ir_type *find_pointer_type_to_type (ir_type *tp);
  * important information they carry is held in the common mode field.
  */
 /** Creates a new primitive type. */
-ir_type *new_type_primitive (ident *name, ir_mode *mode);
+ir_type *new_type_primitive(ident *name, ir_mode *mode);
 
 /** Creates a new primitive type with debug information. */
-ir_type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
+ir_type *new_d_type_primitive(ident *name, ir_mode *mode, dbg_info* db);
 
 /** Returns true if a type is a primitive type. */
-int  is_Primitive_type  (const ir_type *primitive);
+int  is_Primitive_type(const ir_type *primitive);
 
 
 /**
@@ -1256,10 +1281,10 @@ int get_compound_n_members(const ir_type *tp);
  *
  * @see get_compound_n_members() for justification of existence.
  */
-entity *get_compound_member(const ir_type *tp, int pos);
+ir_entity *get_compound_member(const ir_type *tp, int pos);
 
 /** Returns index of member in tp, -1 if not contained. */
-int     get_compound_member_index(const ir_type *tp, entity *member);
+int     get_compound_member_index(const ir_type *tp, ir_entity *member);
 
 /**
  * Checks whether a type is a compound type.
@@ -1316,7 +1341,7 @@ ir_type *get_associated_type(const ir_type *tp);
  *
  * @return the entity representing the area
  */
-entity *frame_alloc_area(ir_type *frame_type, int size, int alignment, int at_start);
+ir_entity *frame_alloc_area(ir_type *frame_type, int size, int alignment, int at_start);
 
 /*-----------------------------------------------------------------*/
 /** Debug aides                                                   **/