BugFix: added forgotten typedef
[libfirm] / ir / tv / strcalc.h
index ed94515..0adf445 100644 (file)
@@ -23,6 +23,8 @@
 #ifndef _STRCALC_H_
 #define _STRCALC_H_
 
+#include "irmode.h"
+
 #ifdef STRCALC_DEBUG_ALL             /* switch on all debug options */
 #  ifndef STRCALC_DEBUG
 #    define STRCALC_DEBUG            /* switch on debug output */
@@ -67,31 +69,31 @@ enum {
  * Possible operations on integer values.
  */
 typedef enum {
-  SC_ADD = 0,          /**< Addition */
-  SC_SUB,              /**< Substraction */
-  SC_NEG,              /**< Unary Minus */
-  SC_MUL,              /**< Multiplication */
-  SC_DIV,              /**< Integer Division (with rounding toward zero ?) */
-  SC_MOD,              /**< Devision Remainder */
-  SC_SHL,              /**< Left Shift */
-  SC_SHR,              /**< Logical (unsigned) Right Shift */
-  SC_SHRS,             /**< Arithmetic (signed) Right Shift */
-  SC_ROT,              /**< Rotation (both directions) */
-  SC_AND,              /**< Bitwise And */
-  SC_OR,               /**< Bitwise Or */
-  SC_NOT,              /**< Bitwise Not */
-  SC_XOR,              /**< Bitwise Exclusive Or */
+  SC_ADD = 0,   /**< Addition */
+  SC_SUB,       /**< Substraction */
+  SC_NEG,       /**< Unary Minus */
+  SC_MUL,       /**< Multiplication */
+  SC_DIV,       /**< Integer Division (with rounding toward zero ?) */
+  SC_MOD,       /**< Devision Remainder */
+  SC_SHL,       /**< Left Shift */
+  SC_SHR,       /**< Logical (unsigned) Right Shift */
+  SC_SHRS,      /**< Arithmetic (signed) Right Shift */
+  SC_ROT,       /**< Rotation (both directions) */
+  SC_AND,       /**< Bitwise And */
+  SC_OR,        /**< Bitwise Or */
+  SC_NOT,       /**< Bitwise Not */
+  SC_XOR        /**< Bitwise Exclusive Or */
 } sc_op_t;
 
 /**
- * The output mode for ntger values.
+ * The output mode for integer values.
  */
 enum base_t {
-  SC_hex,      /**< hexadecimal output with small letters */
-  SC_HEX,      /**< hexadecimal output with BIG letters */
-  SC_DEC,      /**< decimal output */
-  SC_OCT,      /**< octal output */
-  SC_BIN       /**< binary output */
+  SC_hex,   /**< hexadecimal output with small letters */
+  SC_HEX,   /**< hexadecimal output with BIG letters */
+  SC_DEC,   /**< decimal output */
+  SC_OCT,   /**< octal output */
+  SC_BIN    /**< binary output */
 };
 
 /*
@@ -99,28 +101,35 @@ enum base_t {
  */
 #define sc_add(a, b, c) sc_calc((a), (b), SC_ADD, (c))
 #define sc_sub(a, b, c) sc_calc((a), (b), SC_SUB, (c))
-#define sc_neg(a, c) sc_calc((a), NULL, SC_NEG, (c))
+#define sc_neg(a, c)    sc_calc((a), NULL, SC_NEG, (c))
 #define sc_and(a, b, c) sc_calc((a), (b), SC_AND, (c))
-#define sc_or(a, b, c) sc_calc((a), (b), SC_OR, (c))
+#define sc_or(a, b, c)  sc_calc((a), (b), SC_OR, (c))
 #define sc_xor(a, b, c) sc_calc((a), (b), SC_XOR, (c))
-#define sc_not(a, c) sc_calc((a), NULL, SC_NOT, (c))
+#define sc_not(a, c)    sc_calc((a), NULL, SC_NOT, (c))
 #define sc_mul(a, b, c) sc_calc((a), (b), SC_MUL, (c))
 #define sc_div(a, b, c) sc_calc((a), (b), SC_DIV, (c))
 #define sc_mod(a, b, c) sc_calc((a), (b), SC_MOD, (c))
-#define sc_shl(a, b, c, d, e) sc_bitcalc((a), (b), (c), (d), SC_SHL, (e))
-#define sc_shr(a, b, c, d, e) sc_bitcalc((a), (b), (c), (d), SC_SHR, (e))
+#define sc_shl(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_SHL, (e))
+#define sc_shr(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_SHR, (e))
 #define sc_shrs(a, b, c, d, e) sc_bitcalc((a), (b), (c), (d), SC_SHRS, (e))
-#define sc_rot(a, b, c, d, e) sc_bitcalc((a), (b), (c), (d), SC_ROT, (e))
+#define sc_rot(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_ROT, (e))
 
 /*
  * function declarations
  */
 const void *sc_get_buffer(void);
-const int sc_get_buffer_length(void);
+int sc_get_buffer_length(void);
+
+/** create an value form a string representation */
+void sc_val_from_str(const char *str, unsigned int len, void *buffer, ir_mode *mode);
 
-void sc_val_from_str(const char *str, unsigned int len, void *buffer);
+/** create a value from a long */
 void sc_val_from_long(long l, void *buffer);
+
+/** create a value form an unsigned long */
 void sc_val_from_ulong(unsigned long l, void *buffer);
+
+/** converts a value to a long */
 long sc_val_to_long(const void *val);
 void sc_min_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
 void sc_max_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
@@ -139,13 +148,13 @@ unsigned char sc_sub_bits(const void *value, int len, unsigned byte_ofs);
 /**
  * Converts a tarval into a string.
  *
- * @param val1         the value pointer
- * @param bits         number of valid bits in this value
- * @param base         output base
+ * @param val1      the value pointer
+ * @param bits      number of valid bits in this value
+ * @param base      output base
  */
 const char *sc_print(const void *val1, unsigned bits, enum base_t base);
 
-/** Init strcalc module
+/** Initialize the strcalc module.
  * Sets up internal data structures and constants
  * After the first call subsequent calls have no effect
  *