typo removed

[libfirm] / ir / ir / irmode.h

diff --git a/ir/ir/irmode.h b/ir/ir/irmode.h
index cef56c7..f133a62 100644 (file)
--- a/ir/ir/irmode.h
+++ b/ir/ir/irmode.h
@@ -1,7 +1,14 @@
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
- * All rights reserved.
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/irmode.h
+ * Purpose:     Data modes of operations.
+ * Author:      Martin Trapp, Christian Schaefer
+ * Modified by: Goetz Lindenmaier, Mathias Heil
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1998-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  */
-/* $Id$ */
 
 /**
  * @file irmode.h
@@ -18,6 +25,7 @@
  *    UKA tech report 1999-44 for more information about modes.
  *
  */
+
 #ifndef _IRMODE_H_
 #define _IRMODE_H_
 
@@ -43,6 +51,8 @@
  *  -  int    align:            byte alignment
  *  -  unsigned sign:1:         signedness of this mode
  *  -  ... more to come
+ *  -  modulo_shift             specifies for modes of kind irms_int_number
+ *                              whether shift applies modulo to value of bits to shift
  *
  * SEE ALSO:
  *    The tech report 1999-44 describing FIRM and predefined modes
@@ -85,8 +95,8 @@ typedef enum { /* irm is short for `ir mode' */
 typedef enum {
   /* Predefined sorts of modes */
   irms_auxiliary,         /**< Only for Firm use. Not extensible. (irm_T) */
-  irms_control_flow,       /**< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
-  irms_memory,             /**< Marks the memory mode.  Not extensible. (irm_M) */
+  irms_control_flow,      /**< Marks all control flow modes. Not extensible. (irm_BB, irm_X) */
+  irms_memory,            /**< Marks the memory mode.  Not extensible. (irm_M) */
   irms_internal_boolean,  /**< Internal boolean representation.
                               Storing to memory impossible, convert first. (irm_b) */
                             /** user-extensible sorts of modes **/
@@ -133,6 +143,7 @@ typedef enum {
  * @param align                the byte 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.
  *
  * This function constructs a new mode given by the parameters.
  * If the parameters match an already defined mode, this mode is returned
@@ -146,9 +157,9 @@ typedef enum {
  *
  * @note
  *     It is allowed to construct the default modes. So, a call
- *     new_ir_mode("Is", irms_int_number, 32, 4, 1) will return mode_Is.
+ *     new_ir_mode("Is", irms_int_number, 32, 4, 1, 32) will return mode_Is.
  */
-ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int align, int sign, mode_arithmetic arithmetic);
+ir_mode *new_ir_mode(const char *name, mode_sort sort, int bit_size, int align, int sign, mode_arithmetic arithmetic, unsigned int modulo_shift);
 
 /**
  *   Checks whether a pointer points to a mode.
@@ -190,6 +201,13 @@ 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
+ *  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);
+
+
 /** Returns the stored intermediate information. */
 void* get_mode_link(const ir_mode *mode);