tv: Let fc_comp() return an ir_relation instead of magic numbers.
[libfirm] / ir / tv / strcalc.h
index 7a33ef5..8d74b81 100644 (file)
@@ -1,22 +1,39 @@
-  /****h* tools/strcalc
+/*
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
- * NAME
- *   strcalc -- calculations using strings
- *   Provides basic mathematical operations on values represented as strings
+ * This file is part of libFirm.
  *
- * AUTHORS
- *   Matthias Heil
+ * 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.
  *
- * DESCRIPTION
- *    The module uses a string to represent values, and provides operations
- *   to perform calculations with these values.
- *    Results are stored in an internal buffer, so you have to make a copy
- *   of them if you need to store the result.
+ * 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.
+ */
 
-#ifndef _STRCALC_H_
-#define _STRCALC_H_
+/**
+ * @file
+ * @brief    Provides basic mathematical operations on values represented as strings.
+ * @date     2003
+ * @author   Mathias Heil
+ * @brief
+ *
+ * The module uses a string to represent values, and provides operations
+ * to perform calculations with these values.
+ * Results are stored in an internal buffer, so you have to make a copy
+ * of them if you need to store the result.
+ *
+ */
+#ifndef FIRM_TV_STRCALC_H
+#define FIRM_TV_STRCALC_H
+
+#include "irmode.h"
 
 #ifdef STRCALC_DEBUG_ALL             /* switch on all debug options */
 #  ifndef STRCALC_DEBUG
@@ -59,88 +76,176 @@ enum {
 };
 
 /**
- * Possible operations on integer values.
+ * The output mode for 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_op_t;
+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 */
+};
 
 /**
- * The output mode for ntger values.
+ * buffer = value1 + value2
  */
-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 */
-};
+void sc_add(const void *value1, const void *value2, void *buffer);
 
-/*
- * definitions and macros
- */
-#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_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_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_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_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))
+/**
+ * buffer = value1 - value2
+ */
+void sc_sub(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = -value
+ */
+void sc_neg(const void *value, void *buffer);
+
+/**
+ * buffer = value1 & value2
+ */
+void sc_and(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = value1 & ~value2
+ */
+void sc_andnot(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = value1 | value2
+ */
+void sc_or(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = value1 ^ value2
+ */
+void sc_xor(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = ~value
+ */
+void sc_not(const void *value, void *buffer);
+
+/**
+ * buffer = value1 * value2
+ */
+void sc_mul(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = value1 / value2
+ */
+void sc_div(const void *value1, const void *value2, void *buffer);
+
+/**
+ * buffer = value1 % value2
+ */
+void sc_mod(const void *value1, const void *value2, void *buffer);
+
+/**
+ * div_buffer = value1 / value2
+ * mod_buffer = value1 % value2
+ */
+void sc_divmod(const void *value1, const void *value2, void *div_buffer, void *mod_buffer);
+
+/**
+ * buffer = value1 << offset
+ */
+void sc_shlI(const void *val1, long shift_cnt, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 << value2
+ */
+void sc_shl(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 >>u offset
+ */
+void sc_shrI(const void *val1, long shift_cnt, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 >>u value2
+ */
+void sc_shr(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 >>s offset
+ */
+void sc_shrsI(const void *val1, long shift_cnt, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 >>s value2
+ */
+void sc_shrs(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 <<left>> value2
+ */
+void sc_rotl(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = 0
+ */
+void sc_zero(void *buffer);
 
 /*
  * function declarations
  */
 const void *sc_get_buffer(void);
-const int sc_get_buffer_length(void);
+int sc_get_buffer_length(void);
 
-void sc_val_from_str(const char *str, unsigned int len, void *buffer);
+void sign_extend(void *buffer, ir_mode *mode);
+
+/**
+ * create an value form a string representation
+ * @return 1 if ok, 0 in case of parse error
+ */
+int sc_val_from_str(char sign, unsigned base, const char *str,
+                    size_t 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);
 
-void sc_calc(const void *val1, const void *val2, unsigned op, void *buffer);
-void sc_bitcalc(const void *val1, const void *val2, int radius, int sign, unsigned op, void *buffer);
+/** truncates a value to lowest @p num_bits bits */
+void sc_truncate(unsigned num_bits, void *buffer);
+
+/**
+ * Compares val1 and val2
+ */
 int  sc_comp(const void *val1, const void *val2);
 
 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);
+
+/**
+ * Return the bits of a tarval at a given byte-offset.
+ *
+ * @param value     the value
+ * @param len       number of valid bits in the value
+ * @param byte_ofs  the byte offset
+ */
 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
+ * @param signed_mode print it signed (only decimal mode supported
  */
-const char *sc_print(const void *val1, unsigned bits, enum base_t base);
+const char *sc_print(const void *val1, unsigned bits, enum base_t base, int signed_mode);
 
-/** Init strcalc module
+/** Initialize the strcalc module.
  * Sets up internal data structures and constants
  * After the first call subsequent calls have no effect
  *
@@ -148,6 +253,16 @@ const char *sc_print(const void *val1, unsigned bits, enum base_t base);
  *   for calculations. The reason for being multiples of 8 eludes me
  */
 void init_strcalc(int precision_in_bytes);
+void finish_strcalc(void);
 int sc_get_precision(void);
 
-#endif /* _STRCALC_H_ */
+/** Return the bit at a given position. */
+int sc_get_bit_at(const void *value, unsigned pos);
+
+/** Set the bit at the specified position. */
+void sc_set_bit_at(void *value, unsigned pos);
+
+/* Strange semantics */
+int sc_had_carry(void);
+
+#endif /* FIRM_TV_STRCALC_H */