shouldn't be here anymore
[libfirm] / include / libfirm / typerep.h
index 930228d..6c01a9d 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -454,6 +454,55 @@ ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
 ir_node *get_atomic_ent_value(ir_entity *ent);
 void set_atomic_ent_value(ir_entity *ent, ir_node *val);
 
+/** the kind (type) of an initializer */
+typedef enum ir_initializer_kind_t {
+       /* initializer containing an ir_node from the const-code irg */
+       IR_INITIALIZER_CONST,
+       /* initializer containing a tarval */
+       IR_INITIALIZER_TARVAL,
+       /* initializes type with default values (usually 0) */
+       IR_INITIALIZER_NULL,
+       /* list of initializers used to initializer a compound or array type */
+       IR_INITIALIZER_COMPOUND
+} ir_initializer_kind_t;
+
+/** returns kind of an initializer */
+ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
+
+/**
+ * returns the null initializer (there's only one instance of it in a program )
+ */
+ir_initializer_t *get_initializer_null(void);
+
+/**
+ * creates an initializer containing a reference to a node on the const-code
+ * irg.
+ */
+ir_initializer_t *create_initializer_const(ir_node *value);
+
+/** creates an initializer containing a single tarval value */
+ir_initializer_t *create_initializer_tarval(tarval *tv);
+
+/** return value contained in a const initializer */
+ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
+
+/** return value contained in a tarval initializer */
+tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
+
+/** creates a compound initializer which holds @p n_entries entries */
+ir_initializer_t *create_initializer_compound(unsigned n_entries);
+
+/** returns the number of entries in a compound initializer */
+unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer);
+
+/** sets entry with index @p index to the initializer @p value */
+void set_initializer_compound_value(ir_initializer_t *initializer,
+                                    unsigned index, ir_initializer_t *value);
+
+/** returns the value with index @p index of a compound initializer */
+ir_initializer_t *get_initializer_compound_value(
+               const ir_initializer_t *initializer, unsigned index);
+
 /** Creates a new compound graph path of given length. */
 compound_graph_path *new_compound_graph_path(ir_type *tp, int length);
 
@@ -515,6 +564,10 @@ ir_entity *get_compound_ent_value_member(ir_entity *ent, int pos);
 /** Sets the path at pos 0 */
 void set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos);
 
+void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
+
+ir_initializer_t *get_entity_initializer(const ir_entity *entity);
+
 /** Initializes the entity ent which must be of a one dimensional
    array type with the values given in the values array.
    The array must have a lower and an upper bound.  Keeps the
@@ -531,7 +584,7 @@ void set_array_entity_values(ir_entity *ent, tarval **values, int num_vals);
  * @param ent Any entity of compound type with at least pos initialization values.
  * @param pos The position of the value for which the offset is requested.
  */
-int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
+unsigned get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
 
 /** Return the overall offset of value at position pos in bytes.
  *
@@ -541,7 +594,7 @@ int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
  * @param ent Any entity of compound type with at least pos initialization values.
  * @param pos The position of the value for which the offset is requested.
  */
-int get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
+unsigned get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
 
 /* --- Fields of entities with a class type as owner --- */
 /* Overwrites is a field that specifies that an access to the overwritten
@@ -692,22 +745,6 @@ typedef enum acc_bits {
 #define IS_WRITTEN(a)  ((a) & ptr_access_write)
 #define IS_STORED(a)   ((a) & ptr_access_store)
 
-/**
- * Supported image sections.
- * Currently only methods can be placed in different sections.
- */
-typedef enum {
-       section_text,           /**< The code segment. This is the default for methods. */
-       section_constructors    /**< The constructor section. */
-} ir_img_section;
-
-/** Returns the section of a method. */
-ir_img_section get_method_img_section(const ir_entity *method);
-
-/** Sets the section of a method. */
-void set_method_img_section(ir_entity *method, ir_img_section section);
-
-
 /**
  * @page tyop  type operations
  *  This module specifies the kinds of types available in firm.
@@ -1331,32 +1368,21 @@ ir_mode *get_type_mode(const ir_type *tp);
  */
 void set_type_mode(ir_type *tp, ir_mode* m);
 
-/** Returns the size of a type in bytes, returns -1 if the size is NOT
- *  a byte size, i.e. not dividable by 8. */
-int get_type_size_bytes(const ir_type *tp);
-
-/** Returns the size of a type in bits. */
-int get_type_size_bits(const ir_type *tp);
+/** Returns the size of a type in bytes. */
+unsigned get_type_size_bytes(const ir_type *tp);
 
 /** Sets the size of a type in bytes.
  *
  * For primitive, enumeration, pointer and method types the size
  * is always fixed. This call is legal but has no effect.
  */
-void set_type_size_bytes(ir_type *tp, int size);
-
-/** Sets the size of a type in bits.
- *
- * For primitive, enumeration, pointer and method types the size
- * is always fixed. This call is legal but has no effect.
- */
-void set_type_size_bits(ir_type *tp, int size);
+void set_type_size_bytes(ir_type *tp, unsigned size);
 
 /** 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(ir_type *tp);
+unsigned get_type_alignment_bytes(ir_type *tp);
 
 /** Returns the alignment of a type in bits.
  *
@@ -1366,19 +1392,9 @@ int get_type_alignment_bytes(ir_type *tp);
  *  -#.) compound types have the alignment of there biggest member.
  *  -#.) array types have the alignment of there element type.
  *  -#.) method types return 0 here.
- *  -#.) all other types return 8 here (i.e. aligned at byte).
+ *  -#.) all other types return 1 here (i.e. aligned at byte).
  */
-int get_type_alignment_bits(ir_type *tp);
-
-/** Sets the alignment of a type in bytes. */
-void set_type_alignment_bytes(ir_type *tp, int size);
-
-/** Sets the alignment of a type in bits.
- *
- * For method types the alignment is always fixed.
- * This call is legal but has no effect.
- */
-void set_type_alignment_bits(ir_type *tp, int size);
+void set_type_alignment_bytes(ir_type *tp, unsigned align);
 
 /** Returns the visited count of a type. */
 unsigned long get_type_visited(const ir_type *tp);
@@ -1838,7 +1854,17 @@ ir_type *new_type_method(ident *name, int n_param, int n_res);
  * The arrays for the parameter and result types are not initialized by
  * the constructor.
  */
-ir_type *new_d_type_method(ident *name, int n_param, int n_res, dbg_info* db);
+ir_type *new_d_type_method(ident *name, int n_param, int n_res, dbg_info *db);
+
+/** Clone an existing method type.
+ *
+ * @param tp      the method type to clone.
+ * @param prefix  if non-null, will be the prefix for the name of
+ *                the cloned type
+ *
+ * @return the cloned method type.
+ */
+ir_type *clone_type_method(ir_type *tp, ident *prefix);
 
 /* -- manipulate private fields of method. -- */
 
@@ -1934,21 +1960,21 @@ void set_method_additional_property(ir_type *method, mtp_additional_property fla
  * upper 8 encode the calling conventions.
  */
 typedef enum {
-       cc_reg_param        = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
-                                              This flag may be set as default on some architectures. */
-       cc_last_on_top      = 0x02000000, /**< The last non-register parameter is transmitted on top of
-                                              the stack. This is equivalent to the pascal
-                                              calling convention. If this flag is not set, the first
-                                              non-register parameter is used (stdcall or cdecl
-                                              calling convention) */
-       cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
-                                              function calls (stdcall). */
-       cc_this_call        = 0x08000000, /**< The first parameter is a this pointer and is transmitted
-                                              in a special way. */
-       cc_compound_ret     = 0x10000000, /**< the method returns a compound
-                                               type */
-
-       cc_bits             = (0xFF << 24)  /**< the calling convention bits */
+       cc_reg_param           = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
+                                                 This flag may be set as default on some architectures. */
+       cc_last_on_top         = 0x02000000, /**< The last non-register parameter is transmitted on top of
+                                                 the stack. This is equivalent to the pascal
+                                                 calling convention. If this flag is not set, the first
+                                                 non-register parameter is used (stdcall or cdecl
+                                                 calling convention) */
+       cc_callee_clear_stk    = 0x04000000, /**< The callee clears the stack. This forbids variadic
+                                                 function calls (stdcall). */
+       cc_this_call           = 0x08000000, /**< The first parameter is a this pointer and is transmitted
+                                                 in a special way. */
+       cc_compound_ret        = 0x10000000, /**< The method returns a compound type. */
+       cc_frame_on_caller_stk = 0x20000000, /**< The method did not allocate an own stack frame, instead the
+                                                 caller must reserve size on its own stack. */
+       cc_bits                = (0xFF << 24)/**< The calling convention bits. */
 } calling_convention;
 
 /* some often used cases: made as defines because firmjni cannot handle two
@@ -2375,6 +2401,13 @@ int is_lowered_type(const ir_type *tp);
  */
 ir_type *new_type_frame(ident *name);
 
+/**
+ * Makes a clone of a frame type.
+ * Sets entity links from old frame entities to new onces and
+ * vice versa.
+ */
+ir_type *clone_frame_type(ir_type *type);
+
 /**
  * Sets a lowered type for a type. This sets both associations
  * and marks lowered_type as a "lowered" one.
@@ -2399,7 +2432,7 @@ ir_type *get_associated_type(const ir_type *tp);
  *
  * @return the entity representing the area
  */
-ir_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, unsigned alignment, int at_start);
 
 /*-----------------------------------------------------------------*/
 /** Debug aides                                                   **/