use tv_t.h instead of tv.h
[libfirm] / ir / ir / irmode.h
index a022be8..5d49921 100644 (file)
@@ -46,9 +46,8 @@
  * ATTRIBUTES:
  *  -  modecode code:           An unambigous int (enum) for the mode
  *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
- *  -  mode_sort sort:          sort of mode specifying possible usage kategories
+ *  -  mode_sort sort:          sort of mode specifying possible usage categories
  *  -  int    size:             size of the mode in Bits.
- *  -  int    align:            byte alignment
  *  -  unsigned sign:1:         signedness of this mode
  *  -  ... more to come
  *  -  modulo_shift             specifies for modes of kind irms_int_number
@@ -140,7 +139,6 @@ typedef enum {
  * @param name         the name of the mode to be created
  * @param sort         the mode_sort of the mode to be created
  * @param bit_size     number of bits this mode allocate
- * @param bit_align    the alignment for an entity of this mode in bits
  * @param sign         non-zero if this is a signed mode
  * @param arithmetic    arithmetic operations possible with a mode
  * @param modulo_shift  Is ignored for modes other than integer.
@@ -148,41 +146,40 @@ typedef enum {
  * This function constructs a new mode given by the parameters.
  * If the parameters match an already defined mode, this mode is returned
  * (including the default modes).
- * If the mode is newly allocated, a new unique mode_code is choosen.
+ * If the mode is newly allocated, a new unique mode_code is chosen.
  * Also, special value tarvals will be calculated such as null,
- * min, max and can be retrieved using the get_mode_* fuctions
+ * min, max and can be retrieved using the get_mode_* functions
  *
  * @return
  *     The new mode or NULL on error.
  *
  * @note
  *     It is allowed to construct the default modes. So, a call
- *     new_ir_mode("Is", irms_int_number, 32, 4, 1, irma_twos_complement, 32) will return mode_Is.
+ *     new_ir_mode("Is", irms_int_number, 32, 1, irma_twos_complement, 32) will return mode_Is.
  */
-ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int bit_align, int sign, mode_arithmetic arithmetic, unsigned int modulo_shift);
+ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int sign, mode_arithmetic arithmetic, unsigned int modulo_shift);
 
 /**
  * Creates a new vector mode.
  *
- * @param name         the name of the mode to be created
- * @param sort         the mode_sort of the mode to be created
- * @param bit_size     number of bits for one element of this mode
+ * @param name               the name of the mode to be created
+ * @param sort               the mode_sort of the mode to be created
+ * @param bit_size         number of bits for one element of this mode
  * @param num_of_elem   number of elements in this vector mode
- * @param bit_align    the alignment for an entity of this mode in bits
- * @param sign         non-zero if this is a signed mode
+ * @param sign               non-zero if this is a signed mode
  * @param arithmetic    arithmetic operations possible with a mode
  * @param modulo_shift  Is ignored for modes other than integer.
  *
  * This function constructs a new vector mode given by the parameters.
  * If the parameters match an already defined mode, this mode is returned.
- * If the mode is newly allocated, a new unique mode_code is choosen.
+ * If the mode is newly allocated, a new unique mode_code is chosen.
  * Also, special value tarvals will be calculated such as null,
- * min, max and can be retrieved using the get_mode_* fuctions
+ * min, max and can be retrieved using the get_mode_* functions
  *
  * @return
  *     The new mode or NULL on error.
  */
-ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int bit_align, int sign,
+ir_mode *new_ir_vector_mode(const char *name, mode_sort sort, int bit_size, unsigned num_of_elem, int sign,
                     mode_arithmetic arithmetic, unsigned int modulo_shift );
 
 /**
@@ -198,16 +195,16 @@ int is_mode(void *thing);
 /* ********** Access methods to read mode information *********** */
 
 /** Returns the classification of the mode */
-modecode get_mode_modecode(const ir_mode *mode);
+modecode    get_mode_modecode(const ir_mode *mode);
 
 /** Returns the ident* of the mode */
-ident *get_mode_ident(const ir_mode *mode);
+ident      *get_mode_ident(const ir_mode *mode);
 
 /** Returns the null-terminated name of this mode. */
 const char *get_mode_name(const ir_mode *mode);
 
 /** Returns a coarse classification of the mode. */
-mode_sort get_mode_sort(const ir_mode *mode);
+mode_sort   get_mode_sort(const ir_mode *mode);
 
 /** Returns the size of values of the mode in bits. */
 int get_mode_size_bits(const ir_mode *mode);
@@ -216,13 +213,6 @@ int get_mode_size_bits(const ir_mode *mode);
  *  If the size is not dividable by 8 returns -1. */
 int get_mode_size_bytes(const ir_mode *mode);
 
-/** Returns the alignment of values of the mode in bits. */
-int get_mode_align_bits(const ir_mode *mode);
-
-/** Returns the alignment of values of the mode in bytes.
- *  If the alignment is not dividable by 8 returns -1. */
-int get_mode_align_bytes(const ir_mode *mode);
-
 /** Returns the signess of a mode.
  *
  * Returns the signess of a mode: 1 if mode is signed. */
@@ -231,29 +221,33 @@ int get_mode_sign(const ir_mode *mode);
 /** Returns the arithmetic of a mode */
 int get_mode_arithmetic(const ir_mode *mode);
 
-/** Attribute modulo shift specifies for modes of kind irms_int_number
+/** Get the modulo shift attribute.
+ *
+ *  Attribute modulo shift specifies for modes of kind irms_int_number
  *  whether shift applies modulo to value of bits to shift.  Zero for
  *  modes that are not integer.
  */
 unsigned int get_mode_modulo_shift(const ir_mode *mode);
 
-/** Attribute vector_elem specifies the number of vector elements of
+/** Return the number of vector elements.
+ *
+ *  Attribute vector_elem specifies the number of vector elements of
  *  a vector mode. For non-vector modes it returns 1 for data and 0
  *  for all other modes
  */
-unsigned int get_mode_vector_elems(const ir_mode *mode);
+unsigned int get_mode_n_vector_elems(const ir_mode *mode);
 
 /** Returns the stored intermediate information. */
-voidget_mode_link(const ir_mode *mode);
+void *get_mode_link(const ir_mode *mode);
 
 /** Stores new intermediate information. */
-void set_mode_link(ir_mode *mode, void *l);
+void  set_mode_link(ir_mode *mode, void *l);
 
 /**
  * Returns the smallest representable value of a given mode.
  *
  * For modes of the sort float_number this is the most negative value
- * bigger than -infinit.
+ * bigger than -infinite.
  */
 tarval *get_mode_min(ir_mode *mode);
 
@@ -261,7 +255,7 @@ tarval *get_mode_min(ir_mode *mode);
  * Returns the biggest representable value o f a given mode.
  *
  * For modes of the sort float_number this is the largest value lower
- * than infinit.
+ * than infinite.
  */
 tarval *get_mode_max(ir_mode *mode);
 
@@ -270,7 +264,7 @@ tarval *get_mode_max(ir_mode *mode);
  *
  * Zero is the additive neutral element and as such
  * is defined only for modes allowing addition, i.e.
- * floats and ints, and references (NULL-Pointer)
+ * op_pin_state_floats and ints, and references (NULL-Pointer)
  * else returns tarval_bad.
  */
 tarval *get_mode_null(ir_mode *mode);
@@ -280,7 +274,7 @@ tarval *get_mode_null(ir_mode *mode);
  *
  * One, being the multiplicative neutral element,
  * is defined only for modes allowing multiplication,
- * i.e. ints and floats.
+ * i.e. ints and op_pin_state_floats.
  */
 tarval *get_mode_one(ir_mode *mode);
 
@@ -302,14 +296,14 @@ tarval *get_mode_NAN(ir_mode *mode);
 
 extern ir_mode *mode_M;         /**< memory */
 
-/* -- A set of predifined, numerical modes according to Techreport 1999-44 -- */
+/* -- A set of predefined, numerical modes according to Techreport 1999-44 -- */
 extern ir_mode *mode_F;         /**< signed float(32) */
 extern ir_mode *mode_D;  /**< signed double(64) */
 extern ir_mode *mode_E;  /**< signed extended(80) */
 extern ir_mode *mode_Bs; /**< signed byte (former char) */
 extern ir_mode *mode_Bu; /**< unsigned byte (former char) */
 extern ir_mode *mode_Hs; /**< signed short integer */
-extern ir_mode *mode_Hu; /**< unsigened short integer */
+extern ir_mode *mode_Hu; /**< unsigned short integer */
 extern ir_mode *mode_Is; /**< signed integer */
 extern ir_mode *mode_Iu; /**< unsigned integer */
 extern ir_mode *mode_Ls; /**< signed long integer */
@@ -421,10 +415,33 @@ int mode_is_int_vector (const ir_mode *mode);
    according to firm definiton */
 int smaller_mode(const ir_mode *sm, const ir_mode *lm);
 
-/** mode module initialization, call once before use of any other function **/
-void init_mode(void);
+/**
+ * Returns a matching unsigned mode for a given integer signed mode.
+ * Returns NULL if no matching mode exists.
+ */
+ir_mode *find_unsigned_mode(const ir_mode *mode);
+
+/**
+ * Returns a matching signed mode for a given integer unsigned mode.
+ * Returns NULL if no matching mode exists.
+ */
+ir_mode *find_signed_mode(const ir_mode *mode);
+
+/**
+ * Returns an integer mode with 2*n bits for a given integer mode with n bits.
+ * Returns NULL if no matching mode exists.
+ */
+ir_mode *find_double_bits_int_mode(const ir_mode *mode);
 
-/** mode module finalization. frees all memory.  */
-void finish_mode(void);
+/**
+ * Returns non-zero if the given mode honors signed zero's, i.e.,
+ * a +0 and a -0 exists and handled differently.
+ */
+int mode_honor_signed_zeros(const ir_mode *mode);
+
+/**
+ * Returns non-zero if the given mode might overflow on unary Minus.
+ */
+int mode_overflow_on_unary_Minus(const ir_mode *mode);
 
 #endif /* _IRMODE_H_ */