Typo fixed.
[libfirm] / ir / ir / irmode.h
index 6ea0aad..cef56c7 100644 (file)
@@ -247,11 +247,7 @@ tarval *get_mode_infinite(ir_mode *mode);
  */
 tarval *get_mode_NAN(ir_mode *mode);
 
-/* -- Auxiliary modes necessary for the Firm representation -- */
-extern ir_mode *mode_T;  /**< tuple (none) */
-extern ir_mode *mode_X;  /**< execution */
 extern ir_mode *mode_M;         /**< memory */
-extern ir_mode *mode_BB; /**< block */
 
 /* -- A set of predifined, numerical modes according to Techreport 1999-44 -- */
 extern ir_mode *mode_F;         /**< signed float(32) */
@@ -266,17 +262,26 @@ 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_b;  /**< internal boolean */
 extern ir_mode *mode_C;  /**< 8 bit char */
 extern ir_mode *mode_U;  /**< 16 bit unicode char */
+
 extern ir_mode *mode_P;  /**< pointer */
+extern ir_mode *mode_P_mach; /**< A pointer mode that is set by the client of libfirm.  This mode
+                              represents the pointer size of the target machine. Is initialized
+                              to mode_P. */
+
+/* -- Auxiliary modes necessary for the Firm representation -- */
+extern ir_mode *mode_b;  /**< internal boolean */
+
+extern ir_mode *mode_X;  /**< execution */
+extern ir_mode *mode_BB; /**< block */
 
+extern ir_mode *mode_T;  /**< tuple (none) */
 extern ir_mode *mode_ANY;/**< undefined mode */
 extern ir_mode *mode_BAD;/**< bad mode */
 
 /*@{*/
 /** 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);
@@ -293,14 +298,24 @@ 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);
+ir_mode *get_modeM(void);
+ir_mode *get_modeT(void);
 ir_mode *get_modeANY(void);
 ir_mode *get_modeBAD(void);
 
+/** Returns the machine specific pointer mode. */
+ir_mode *get_modeP_mach(void);
+
 /**
-   Functions to check, whether a modecode is signed, float, int, num, data,
-   datab or dataM.
+ * Sets the machine specific pointer mode.
+ * If not set, the predefined mode mode_P will be used.
+ */
+void set_modeP_mach(ir_mode *p);
+
+/**
+   Functions to check, whether a modecode is signed, float, int, character,
+   reference, num, numP, data, datab or dataM.
 
    For more exact definitions read the corresponding pages
    in the firm documentation or the following enumeration
@@ -311,25 +326,26 @@ ir_mode *get_modeBAD(void);
    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 "character" is defined as:
+   character  = {irm_C, irm_U}
+
+   The set of "reference" is defined as:
+   reference  = {irm_P}
+
    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}
+   num   = {float || int}
+
+   The set of "numP" is defined as:
+   numP  =  {float || int || reference}
 
    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}
+   data  =  {num || character || reference}
 
    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 }
+   datab =  {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}
+   dataM =  {data || irm_M}
 */
 /*@}*/
 /* Test for a certain class of modes. */
@@ -339,6 +355,7 @@ int mode_is_int (const ir_mode *mode);
 int mode_is_character (const ir_mode *mode);
 int mode_is_reference (const ir_mode *mode);
 int mode_is_num (const ir_mode *mode);
+int mode_is_numP (const ir_mode *mode);
 int mode_is_data (const ir_mode *mode);
 int mode_is_datab (const ir_mode *mode);
 int mode_is_dataM (const ir_mode *mode);