verify: Clarify assertion message.
[libfirm] / ir / ir / irmode_t.h
index 10dbe56..e268ae4 100644 (file)
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
 
-/* $Id$ */
+/**
+ * @file
+ * @brief   Data modes of operations -- private header.
+ * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Mathias Heil,
+ *          Michael Beck
+ */
+#ifndef FIRM_IR_IRMODE_T_H
+#define FIRM_IR_IRMODE_T_H
 
-# ifndef _IRMODE_T_H_
-# define _IRMODE_T_H_
+#include <assert.h>
+#include "irtypes.h"
+#include "irmode.h"
 
-# include "irmode.h"
+#define get_modeP_code()               get_modeP_code_()
+#define get_modeP_data()               get_modeP_data_()
+#define get_mode_ident(mode)           get_mode_ident_(mode)
+#define get_mode_sort(mode)            get_mode_sort_(mode)
+#define get_mode_size_bits(mode)       get_mode_size_bits_(mode)
+#define get_mode_size_bytes(mode)      get_mode_size_bytes_(mode)
+#define get_mode_sign(mode)            get_mode_sign_(mode)
+#define get_mode_arithmetic(mode)      get_mode_arithmetic_(mode)
+#define get_mode_modulo_shift(mode)    get_mode_modulo_shift_(mode)
+#define get_mode_link(mode)            get_mode_link_(mode)
+#define set_mode_link(mode, l)         set_mode_link_(mode, l)
+#define mode_is_signed(mode)           mode_is_signed_(mode)
+#define mode_is_float(mode)            mode_is_float_(mode)
+#define mode_is_int(mode)              mode_is_int_(mode)
+#define mode_is_reference(mode)        mode_is_reference_(mode)
+#define mode_is_num(mode)              mode_is_num_(mode)
+#define mode_is_data(mode)             mode_is_data_(mode)
+#define mode_is_datab(mode)            mode_is_datab_(mode)
+#define mode_is_dataM(mode)            mode_is_dataM_(mode)
+#define get_type_for_mode(mode)        get_type_for_mode_(mode)
+#define get_mode_mantissa_size(mode)   get_mode_mantissa_size_(mode)
+#define get_mode_exponent_size(mode)   get_mode_exponent_size_(mode)
 
-struct ir_mode {
-  modecode code;
-  ident *name;            /* Name of this mode */
-  int    size;            /* size of the mode in Bytes. */
-  int    ld_align;        /* ld means log2 */
-  tarval *min;            /* largest value to be represented by this mode */
-  tarval *max;            /* smallest value to be represented by this mode */
-  tarval *null;           /* Representation of zero in this mode */
-  unsigned fsigned:1;     /* signedness of this mode */
-  unsigned ffloat:1;      /* true if this is a float */
-};
+static inline ir_mode *get_modeP_code_(void) { return mode_P_code; }
 
+static inline ir_mode *get_modeP_data_(void) { return mode_P_data; }
 
-void init_mode (void);
+static inline ident *get_mode_ident_(const ir_mode *mode) { return mode->name; }
+
+static inline ir_mode_sort get_mode_sort_(const ir_mode *mode) { return mode->sort; }
+
+static inline unsigned get_mode_size_bits_(const ir_mode *mode) { return mode->size; }
+
+static inline unsigned get_mode_size_bytes_(const ir_mode *mode)
+{
+       unsigned size = get_mode_size_bits_(mode);
+       if ((size & 7) != 0) return (unsigned) -1;
+       return size >> 3;
+}
+
+static inline int get_mode_sign_(const ir_mode *mode) { return mode->sign; }
+
+static inline ir_mode_arithmetic get_mode_arithmetic_(const ir_mode *mode) { return mode->arithmetic; }
+
+static inline unsigned int get_mode_modulo_shift_(const ir_mode *mode) { return mode->modulo_shift; }
+
+static inline void *get_mode_link_(const ir_mode *mode) { return mode->link; }
+
+static inline void set_mode_link_(ir_mode *mode, void *l) { mode->link = l; }
+
+/* Functions to check, whether a mode is signed, float, int, num, data,
+   datab or dataM. For more exact definitions read the corresponding pages
+   in the firm documentation or the following enumeration
+
+   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_U || 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}
+*/
+
+static inline int mode_is_signed_(const ir_mode *mode)
+{
+       return mode->sign;
+}
+
+static inline int mode_is_float_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) == irms_float_number);
+}
+
+static inline int mode_is_int_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) == irms_int_number);
+}
+
+static inline int mode_is_reference_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) == irms_reference);
+}
+
+static inline int mode_is_num_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) & irmsh_is_num);
+}
+
+static inline int mode_is_data_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) & irmsh_is_data);
+}
+
+static inline int mode_is_datab_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) & irmsh_is_datab);
+}
+
+static inline int mode_is_dataM_(const ir_mode *mode)
+{
+       return (get_mode_sort(mode) & irmsh_is_dataM);
+}
+
+static inline ir_type *get_type_for_mode_(const ir_mode *mode)
+{
+       return mode->type;
+}
+
+static inline unsigned get_mode_mantissa_size_(const ir_mode *mode)
+{
+       return mode->float_desc.mantissa_size;
+}
+
+static inline unsigned get_mode_exponent_size_(const ir_mode *mode)
+{
+       return mode->float_desc.exponent_size;
+}
+
+/** mode module initialization, call once before use of any other function **/
+void init_mode(void);
+
+/** mode module finalization. frees all memory.  */
+void finish_mode(void);
 
 #endif