some fixes for xml dumper / still buggy.

[libfirm] / ir / tv / strcalc.h

diff --git a/ir/tv/strcalc.h b/ir/tv/strcalc.h
index 0309861..ffb81ac 100644 (file)
--- a/ir/tv/strcalc.h
+++ b/ir/tv/strcalc.h
@@ -18,12 +18,35 @@
 #ifndef _STRCALC_H_
 #define _STRCALC_H_
 
-#define BIGGEST_INTEGER_SIZE_IN_BYTES 8
-#define SCDEBUG
+#ifdef STRCALC_DEBUG_ALL             /* switch on all debug options */
+#  ifndef STRCALC_DEBUG
+#    define STRCALC_DEBUG            /* switch on debug output */
+#  endif
+#  ifndef STRCALC_DEBUG_PRINTCOMP    /* print arguments and result of each computation */
+#    define STRCALC_DEBUG_PRINTCOMP
+#  endif
+#  ifndef STRCALC_DEBUG_FULLPRINT
+#    define STRCALC_DEBUG_FULLPRINT  /* print full length of values (e.g. 128 bit instead of 64 bit using default init) */
+#  endif
+#  ifndef STRCALC_DEBUG_GROUPPRINT
+#    define STRCALC_DEBUG_GROUPPRINT /* print spaces after each 8 bits */
+#  endif
+#endif
+
+#ifdef STRCALC_DEBUG
+  /* shortcut output for debugging */
+#  define sc_print_hex(a) sc_print((a), 0, SC_HEX)
+#  define sc_print_dec(a) sc_print((a), 0, SC_DEC)
+#  define sc_print_oct(a) sc_print((a), 0, SC_OCT)
+#  define sc_print_bin(a) sc_print((a), 0, SC_BIN)
+#endif
+
+/*
+ * constants, typedefs, enums
+ */
+
+#define DEFAULT_PRECISION_IN_BYTES 8
 
-/*****************************************************************************
- * typedefs, enums and structs
- *****************************************************************************/
 enum {
   SC_0 = 0,
   SC_1,
@@ -40,36 +63,43 @@ enum {
   SC_C,
   SC_D,
   SC_E,
-  SC_F,
+  SC_F
 };
 
+/**
+ * Possible operations on integer values.
+ */
 enum {
-  SC_ADD = 0,
-  SC_SUB,
-  SC_NEG,
-  SC_MUL,
-  SC_DIV,
-  SC_MOD,
-  SC_SHL,
-  SC_SHR,
-  SC_SHRS,
-  SC_ROT,
-  SC_AND,
-  SC_OR,
-  SC_NOT,
-  SC_XOR,
+  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 */
 };
 
-enum {
-  SC_HEX,
-  SC_DEC,
-  SC_OKT,
-  SC_BIN,
+/**
+ * The output mode for ntger 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 */
 };
 
-/*****************************************************************************
+/*
  * definitions and macros
- *****************************************************************************/
+ */
 #define sc_add(a, b) sc_calc((a), (b), SC_ADD)
 #define sc_sub(a, b) sc_calc((a), (b), SC_SUB)
 #define sc_neg(a) sc_calc((a), NULL, SC_NEG)
@@ -85,13 +115,9 @@ enum {
 #define sc_shrs(a, b, c, d) sc_bitcalc((a), (b), (c), (d), SC_SHRS)
 #define sc_rot(a, b, c, d) sc_bitcalc((a), (b), (c), (d), SC_ROT)
 
-#define sc_print_hex(a) sc_print((a), SC_HEX)
-#define sc_print_dec(a) sc_print((a), SC_DEC)
-#define sc_print_okt(a) sc_print((a), SC_OKT)
-#define sc_print_bin(a) sc_print((a), SC_BIN)
-/*****************************************************************************
+/*
  * function declarations
- *****************************************************************************/
+ */
 const void *sc_get_buffer(void);
 const int sc_get_buffer_length(void);
 
@@ -102,9 +128,26 @@ void sc_min_from_bits(unsigned int num_bits, unsigned int sign);
 void sc_max_from_bits(unsigned int num_bits, unsigned int sign);
 
 void sc_calc(const void *val1, const void *val2, unsigned op);
-void sc_bitcalc(const void *val1, const void *val2, unsigned radius, unsigned sign, unsigned op);
+void sc_bitcalc(const void *val1, const void *val2, int radius, int sign, unsigned op);
 int  sc_comp(const void *val1, const void *val2);
 
-char* sc_print(const void *val1, unsigned base);
+int sc_get_highest_set_bit(const void *value);
+int sc_get_lowest_set_bit(const void *value);
+int sc_is_zero(const void *value);
+int sc_is_negative(const void *value);
+int sc_had_carry(void);
+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
+ */
+const char *sc_print(const void *val1, unsigned bits, enum base_t base);
+
+void init_strcalc(int precision_in_bytes);
+int get_precision(void);
 
 #endif /* _STRCALC_H_ */