added visibility flag for types.
[libfirm] / ir / tr / type.h
index 1b79612..464944c 100644 (file)
@@ -44,7 +44,6 @@
 # include "irmode.h"
 # include "dbginfo.h"
 
-
 /* to resolve recursion between entity.h and type.h */
 #ifndef _ENTITY_TYPEDEF_
 #define _ENTITY_TYPEDEF_
@@ -56,6 +55,8 @@ typedef struct entity entity;
 typedef struct ir_node ir_node;
 #endif
 
+# include "tr_inheritance.h"
+
 /**
  *  An abstract data type to represent types.
  *
@@ -148,6 +149,73 @@ ident*      get_type_ident(const type *tp);
 void        set_type_ident(type *tp, ident* id);
 const char* get_type_name(const type *tp);
 
+/** This enumeration flags the visibility of entities and types.
+ *
+ * This is necessary for partial compilation.
+ * We rely on the ordering of the flags.
+ */
+typedef enum {
+  visibility_local,              /**< The entity is only visible locally.  This is the default for
+                                     entities.
+                                     The type is only visible locally.  All instances are allocated
+                                     locally, and no pointer to entities of this type are passed
+                                     out of this compilation unit. */
+  visibility_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.
+                                     For types:  entities of this type can be accessed externaly.  No
+                                     instances of this type are allocated externally.  */
+  visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
+                                     must not allocate memory for this entity. The entity must
+                                     be static_allocated.  This can also be an external defined
+                                     method.
+                                     For types:  entities of this type are allocated and accessed from
+                                     external code.  Default for types.  */
+} visibility;
+
+/** The visibility of a type.
+ *
+ *  The visibility of a type indicates, whether entities of this type
+ *  are accessed or allocated in external code.
+ *
+ *  An entity of a type is allocated in external code, if the external
+ *  code declares a variable of this type, or dynamically allocates
+ *  an entity of this type.  If the external code declares a (compound)
+ *  type, that contains entities of this type, the visibility also
+ *  must be external_allocated.
+ *
+ *  The visibility must be higher than that of all entities, if the
+ *  type is a compound.  Here it is questionable, what happens with
+ *  static entities.  If these are accessed external by direct reference,
+ *  (a static call to a method, that is also in the dispatch table)
+ *  it should not affect the visibility of the type.
+ *
+ *
+ * @@@ Do we need a visibility for types?
+ * I change the layout of types radically when doing type splitting.
+ * I need to know, which fields of classes are accessed in the rts,
+ * e.g., [_length.  I may not move [_length to the split part.
+ * The layout though, is a property of the type.
+ *
+ * One could also think of changing the mode of a type ...
+ *
+ * But, we could also output macros to access the fields, e.g.,
+ *  ACCESS_[_length (X)   X->length              // conventional
+ *  ACCESS_[_length (X)   X->_split_ref->length  // with type splitting
+ *
+ * For now I implement this function, that returns the visibility
+ * based on the visibility of the entities of a compound ...
+ *
+ * This function returns visibility_external_visible if one or more
+ * entities of a compound type have visibility_external_visible.
+ * Entities of types are never visibility_external_allocated (right?).
+ * Else returns visibility_local.
+ */
+visibility get_type_visibility (const type *tp);
+void       set_type_visibility (type *tp, visibility v);
+
+
+
 /** The state of the type layout. */
 typedef enum {
   layout_undefined,    /**< The layout of this type is not defined.
@@ -208,17 +276,21 @@ void        set_type_size_bytes(type *tp, int size);
  */
 void        set_type_size_bits(type *tp, int size);
 
-/** Returns the alignment of a type in bytes, returns -1 if the alignment is NOT
- *  a byte size, ie not dividable by 8. Calls get_type_alignment_bits(). */
+/** Returns the alignment of a type in bytes.
+ *
+ *  Returns -1 if the alignment is NOT
+ *  a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
 int         get_type_alignment_bytes(type *tp);
 
-/** Returns the alignment of a type in bits. If the alignment of a type is
- * not set, it is calculated here according to the following rules:
- * 1.) if a type has a mode, the alignment is the mode size.
- * 2.) compound types have the alignment of it's biggest member.
- * 3.) array types have the alignment of its element type.
- * 4.) method types return 0 here.
- * 5.) all other types return 8 here (i.e. aligned at byte).
+/** Returns the alignment of a type in bits.
+ *
+ *  If the alignment of a type is
+ *  not set, it is calculated here according to the following rules:
+ *  1.) if a type has a mode, the alignment is the mode size.
+ *  2.) compound types have the alignment of it's biggest member.
+ *  3.) array types have the alignment of its element type.
+ *  4.) method types return 0 here.
+ *  5.) all other types return 8 here (i.e. aligned at byte).
  */
 int         get_type_alignment_bits(type *tp);
 
@@ -394,28 +466,31 @@ entity *get_class_member   (const type *clss, int pos);
 int     get_class_member_index(type *clss, 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. */
*  name returns one of them.  Returns NULL if no member found. */
 entity *get_class_member_by_name(type *clss, ident *name);
 
 /** Overwrites the member at position pos, 0 <= pos < n_member with
-   the passed entity. */
*  the passed entity. */
 void    set_class_member   (type *clss, 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. */
+ *
+ *  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  (type *clss, 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.  */
+ *
+ *  Shrinks the member list, so iterate from the end!!!
+ *  Does not deallocate the entity.  */
 void    remove_class_member(type *clss, entity *member);
 
 
 /** Adds subtype as subtype to clss.
-   Checks whether clss is a supertype of subtype.  If not
-   adds also clss as supertype to subtype.  */
+ *
+ *  Checks whether clss is a supertype of subtype.  If not
+ *  adds also clss as supertype to subtype.  */
 void    add_class_subtype   (type *clss, type *subtype);
 
 /** Returns the number of subtypes */
@@ -424,9 +499,16 @@ int     get_class_n_subtypes (const type *clss);
 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
 type   *get_class_subtype   (type *clss, int pos);
 
+/** Returns the index to access subclass as subtype of class.
+ *
+ *  If subclass is no direct subtype of class returns -1.
+ */
+int get_class_subtype_index(type *clss, const type *subclass);
+
 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
-   Does not set the corresponding supertype relation for subtype: this might
-   be a different position! */
+ *
+ *  Does not set the corresponding supertype relation for subtype: this might
+ *  be a different position! */
 void    set_class_subtype   (type *clss, type *subtype, int pos);
 
 /** Finds subtype in the list of subtypes and removes it  */
@@ -434,22 +516,27 @@ void    remove_class_subtype(type *clss, type *subtype);
 
 
 /** Adds supertype as supertype to class.
-   Checks whether clss is a subtype of supertype.  If not
-   adds also clss as subtype to supertype.  */
+ *
+ *  Checks whether clss is a subtype of supertype.  If not
+ *  adds also clss as subtype to supertype.  */
 void    add_class_supertype   (type *clss, type *supertype);
 
 /** Returns the number of supertypes */
 int     get_class_n_supertypes (const type *clss);
 
-/** Returns the index of an supertype in a type. */
+/** Returns the index to access superclass as supertype of class.
+ *
+ *  If superclass is no direct supertype of class returns -1.
+ */
 int     get_class_supertype_index(type *clss, type *super_clss);
 
 /** Gets the supertype at position pos,  0 <= pos < n_supertype. */
 type   *get_class_supertype   (type *clss, int pos);
 
-/** Sets the supertype at position pos, 0 <= pos < n_subtype.
-   Does not set the corresponding subtype relation for supertype: this might
-   be a different position! */
+/** Sets the supertype at position pos, 0 <= pos < n_supertype.
+ *
+ *  Does not set the corresponding subtype relation for supertype: this might
+ *  be at a different position! */
 void    set_class_supertype   (type *clss, type *supertype, int pos);
 
 /** Finds supertype in the list of supertypes and removes it */
@@ -486,9 +573,6 @@ int  get_class_dfn (const type *clss);
 /** Returns true if a type is a class type. */
 int is_Class_type(const type *clss);
 
-/** Returns true if low is subclass of high. */
-int is_subclass_of(type *low, type *high);
-
 /**
  *  @page struct_type   Representation of a struct type
  *
@@ -784,13 +868,25 @@ ir_node * get_array_upper_bound     (const type *array, int dimension);
 /** Works only if bound is Const node with tarval that can be converted to long. */
 long      get_array_upper_bound_int (const type *array, int dimension);
 
+/** Sets an array dimension to a specific order. */
 void set_array_order (type *array, int dimension, int order);
+
+/** Returns the order of an array dimension. */
 int  get_array_order (const type *array, int dimension);
 
+/** Find the array dimension that is placed at order ord. */
+int find_array_dimension(const type *array, int order);
+
+/** Sets the array element type. */
 void  set_array_element_type (type *array, type *tp);
+
+/** Gets the array element type. */
 type *get_array_element_type (type *array);
 
+/** Sets the array element entity. */
 void  set_array_element_entity (type *array, entity *ent);
+
+/** Get the array element entity. */
 entity *get_array_element_entity (const type *array);
 
 /** Returns true if a type is an array type. */