Formatting for firmjni
[libfirm] / ir / ir / irmode.h
index c9162b3..3615d86 100644 (file)
 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Christian Schaefer
-**
-irmode.h Modes for ir operators.
-
-This module specifies the modes that type the firm nodes.  See
-UKA tech report 1999-44 for more information about modes.
+* All rights reserved.
+*/
 
+/**
+ * @file irmode.h
+ *
+ * Modes for ir operators.
+ *
+ * @author Christian Schaefer
+ *
+ * This module specifies the modes that type the firm nodes.  See
+ * UKA tech report 1999-14 for more information about modes.
+ *
+ * @todo
+ * This file is at the level of the original fiasco.  It needs to be ported
+ * to the version of the tech report!!! This will be done with the
+ * reimplementation of the tarval module.
+ */
 
-@@@ This file is at the level of the original fiasco.  It needs to be ported
-to the version of the tech report!!! This will be done with the reimplementation
-of the tarval module.
-*/
+/* $Id$ */
 
 # ifndef _IRMODE_H_
 # define _IRMODE_H_
 
 #include "ident.h"
+#include <stdbool.h>
 
 # define target_bits 8
 
 # define NUM_MODES 20
 
+#ifndef _TARVAL_TYPEDEF_
+#define _TARVAL_TYPEDEF_
+typedef struct tarval tarval;
+#endif
+
+/**
+ * according to tech report 1999-14:
+ */
 typedef enum { /* irm is short for `ir mode' */
-  irm_T,                        /* former irm_N */
-  irm_f, irm_d, /* irm_e, */
-  irm_c, irm_C, irm_h, irm_H, irm_i, irm_I, irm_l, irm_L,
-  irm_B, irm_b,
-  irm_p,
-  irm_s, irm_S,
-  irm_X, irm_M, irm_R, irm_Z,
-  irm_max
-  /*  according to tech report 1999-44:
-  irm_BB, irm_X,                 // basic block, execution
-  irm_F, irm_D, irm_E,           // float, double, extended
-  irm_B, irm_Bu, irm_H, irm_Hu, irm_I, irm_Iu, irm_L, irm_Lu,
-                                 // byte, short, int, long
-  irm_C,                         // character
-  irm_P,                         // pointer
-  irm_b,                         // internal boolean
-  irm_M,                         // memory
-  irm_T,                         // tuple
-  irm_max */
+  irm_BB,                       /**< basic block */
+  irm_X,                        /**< execution */
+  irm_F,                        /**< float(32) */
+  irm_D,                        /**< double(64) */
+  irm_E,                        /**< extended(80) */
+  irm_Bs,                       /**< signed byte(8) */
+  irm_Bu,                       /**< unsigned byte(8) */
+  irm_Hs,                       /**< signed short(16) */
+  irm_Hu,                       /**< unsigned short(16) */
+  irm_Is,                       /**< signed int(32) */
+  irm_Iu,                       /**< unsigned int(32) */
+  irm_Ls,                       /**< signed long(64) */
+  irm_Lu,                       /**< unsigned long(64) */
+  irm_C,                        /**< character */
+  irm_P,                        /**< pointer */
+  irm_b,                        /**< internal boolean */
+  irm_M,                        /**< memory */
+  irm_T,                        /**< tuple */
+  irm_U,                        /**< unicode character */
+  irm_max                       /**< maximum value for modecode */
 } modecode;
 
-typedef struct {
-  modecode code;
-  ident *name;            /* Name of this mode */
-  int    size;            /* size of the mode in Bytes. */
-  int    ld_align;        /* ld means log2 */
-  struct tarval *min;     /* largest value to be represented by this mode */
-  struct tarval *max;     /* smallest value to be represented by this mode */
-  struct tarval *null;    /* Representation of zero in this mode */
-  unsigned fsigned:1;     /* signedness of this mode */
-  unsigned ffloat:1;      /* true if this is a float */
-} ir_mode;
-
-extern ir_mode *mode_T; /* tuple (none) */
-extern ir_mode *mode_f; /* signed float */
-extern ir_mode *mode_d; /* signed double */
-/* extern ir_mode *mode_e; * signed extended */
-extern ir_mode *mode_c; /* signed byte (former char) */
-extern ir_mode *mode_C; /* unsigned byte (former char) */
-extern ir_mode *mode_h; /* signed short integer */
-extern ir_mode *mode_H; /* unsigened short integer */
-extern ir_mode *mode_i; /* signed integer */
-extern ir_mode *mode_I; /* unsigned integer */
-extern ir_mode *mode_l; /* signed long integer */
-extern ir_mode *mode_L; /* unsigned long integer */
-extern ir_mode *mode_B; /* bits */             /* oblivious */
-/* extern ir_mode *mode_c;  * char */
-extern ir_mode *mode_p; /* pointer */
-extern ir_mode *mode_b; /* internal boolean */
-extern ir_mode *mode_s;                        /* oblivious  */
-extern ir_mode *mode_S;                        /* oblivious */
-extern ir_mode *mode_X; /* execution */
-extern ir_mode *mode_M; /* memory */
-extern ir_mode *mode_R; /* block */
-extern ir_mode *mode_Z; /* infinit integers */ /* oblivious */
-extern ir_mode *mode_T; /* tuple (none) */
-
-void init_mode (void);
-
-modecode get_modecode_of_mode (ir_mode *mode);
-/* void set_modecode_of_mode (ir_mode *mode, modecode code); */
-ident *get_ident_of_mode (ir_mode *mode);
-ident *get_mode_ident (ir_mode *mode);
-
-/* void set_ident_of_mode (ir_mode *mode, ident *name); */
-int get_size_of_mode (ir_mode *mode);
-/* void set_size_of_mode (ir_mode *mode, int size); */
-int get_ld_align_of_mode (ir_mode *mode);
-/* void set_ld_align_of_mode (ir_mode *mode, int ld_align); */
-struct tarval *get_min_of_mode (ir_mode *mode);
-/* void set_min_of_mode (ir_mode *mode, struct tarval *min); */
-struct tarval *get_max_of_mode (ir_mode *mode);
-/* void set_max_of_mode (ir_mode *mode, struct tarval *max); */
-struct tarval *get_null_of_mode (ir_mode *mode);
-/* void set_null_of_mode (ir_mode *mode, struct tarval *null); */
-unsigned get_fsigned_of_mode (ir_mode *mode);
-/* void set_fsigned_of_mode (ir_mode *mode, unsigned fsigned); */
-unsigned get_ffloat_of_mode (ir_mode *mode);
-/* void set_ffloat_of_mode (ir_mode *mode, unsigned ffloat); */
+typedef struct ir_mode ir_mode;
+
+extern ir_mode *mode_T;  /**< tuple (none) */
+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_Is; /**< signed integer */
+extern ir_mode *mode_Iu; /**< unsigned integer */
+extern ir_mode *mode_Ls; /**< signed long integer */
+extern ir_mode *mode_Lu; /**< unsigned long integer */
+extern ir_mode *mode_C;  /**< char */
+extern ir_mode *mode_U;  /**< unicode char */
+extern ir_mode *mode_P;  /**< pointer */
+extern ir_mode *mode_b;  /**< internal boolean */
+extern ir_mode *mode_X;  /**< execution */
+extern ir_mode *mode_M;         /**< memory */
+extern ir_mode *mode_BB; /**< block */
+
+/*@{*/
+/** Access routines for JNI Interface */
+ir_mode *get_modeT(void);
+ir_mode *get_modeF(void);
+ir_mode *get_modeD(void);
+ir_mode *get_modeE(void);
+ir_mode *get_modeBs(void);
+ir_mode *get_modeBu(void);
+ir_mode *get_modeHs(void);
+ir_mode *get_modeHu(void);
+ir_mode *get_modeIs(void);
+ir_mode *get_modeIu(void);
+ir_mode *get_modeLs(void);
+ir_mode *get_modeLu(void);
+ir_mode *get_modeC(void);
+ir_mode *get_modeU(void);
+ir_mode *get_modeP(void);
+ir_mode *get_modeb(void);
+ir_mode *get_modeX(void);
+ir_mode *get_modeM(void);
+ir_mode *get_modeBB(void);
+/*@}*/
+
+/** An enum for this mode */
+modecode get_mode_modecode (ir_mode *mode);
+/* void  set_mode_modecode (ir_mode *mode, modecode code);  */
+
+/** The ident of this mode */
+ident   *get_mode_ident    (ir_mode *mode);
+/* void  set_mode_ident    (ir_mode *mode, ident *id);    */
+
+/** The name of this mode */
+const char *get_mode_name  (ir_mode *mode);
+/* void  set_mode_name     (ir_mode *mode, char *name);    */
+
+/** The size of values of the mode in bytes. */
+int      get_mode_size     (ir_mode *mode);
+/* void  set_mode_size     (ir_mode *mode, int size);       */
+
+/** The alignment of values of the mode. */
+int      get_mode_ld_align (ir_mode *mode);
+/* void  set_mode_ld_align (ir_mode *mode, int ld_align); */
+
+/** The smallest representable value */
+tarval  *get_mode_min      (ir_mode *mode);
+/* void  set_mode_min      (ir_mode *mode, tarval *min); */
+
+/** The biggest representable value */
+tarval  *get_mode_max      (ir_mode *mode);
+/* void  set_mode_max      (ir_mode *mode, tarval *max); */
 
+/** The value Zero represented in this mode */
+tarval  *get_mode_null     (ir_mode *mode);
+/* void  set_mode_null     (ir_mode *mode, tarval *null); */
+
+/** Returns 1 if mode is signed, else 0. */
+unsigned get_mode_fsigned  (ir_mode *mode);
+/* void  set_mode_fsigned  (ir_mode *mode, unsigned fsigned); */
+
+/** Returns 1 if mode is float, else 0. */
+unsigned get_mode_ffloat   (ir_mode *mode);
+/* void  set_mode_ffloat   (ir_mode *mode, unsigned ffloat); */
+
+/*@{*/
+/**
+   Functions to check, whether a modecode is signed, float, int, num, data,
+   datab or dataM.
+
+   For more exact definitions read the corresponding pages
+   in the firm documentation or the followingenumeration
+
+   The set of "float" is defined as:
+   float = {irm_F, irm_D, irm_E}
+
+   The set of "int" is defined as:
+   int   = {irm_Bs, irm_Bu, irm_Hs, irm_Hu, irm_Is, irm_Iu, irm_Ls, irm_Lu}
+
+   The set of "num" is defined as:
+   num   = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
+            irm_Is, irm_Iu, irm_Ls, irm_Lu}
+            = {float || int}
+
+   The set of "data" is defined as:
+   data  = {irm_F, irm_D, irm_E irm_Bs, irm_Bu, irm_Hs, irm_Hu,
+            irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P}
+            = {num || irm_C || irm_P}
+
+   The set of "datab" is defined as:
+   datab = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
+            irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_b}
+            = {data || irm_b }
+
+   The set of "dataM" is defined as:
+   dataM = {irm_F, irm_D, irm_E, irm_Bs, irm_Bu, irm_Hs, irm_Hu,
+            irm_Is, irm_Iu, irm_Ls, irm_Lu, irm_C, irm_U, irm_P, irm_M}
+            = {data || irm_M}
+*/
+
+/* Test for a certain class of modes. */
 int mode_is_signed (ir_mode *mode);
 int mode_is_float (ir_mode *mode);
 int mode_is_int (ir_mode *mode);
-# define is_chilCHIL(m) ((m) <= irm_L && (m) >= irm_c) /* old */
 int mode_is_num (ir_mode *mode);
 int mode_is_data (ir_mode *mode);
 int mode_is_datab (ir_mode *mode);
 int mode_is_dataM (ir_mode *mode);
+/*@}*/
+
+/** Returns true if sm can be converted to lm without loss
+   according to firm definiton */
+bool smaller_mode(ir_mode *sm, ir_mode *lm);
 
 # endif /* _IRMODE_H_ */