- /****h* tools/strcalc
+/*
+ * Copyright (C) 1995-2008 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
+ * @version $Id$
+ * @summary
+ *
+ * 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
+# 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
+
+/*
+ * constants, typedefs, enums
+ */
-#define BIGGEST_INTEGER_SIZE_IN_BYTES 8
-#define SCDEBUG
+#define SC_DEFAULT_PRECISION 64
-/*****************************************************************************
- * typedefs, enums and structs
- *****************************************************************************/
enum {
SC_0 = 0,
SC_1,
SC_C,
SC_D,
SC_E,
- SC_F,
+ SC_F
};
-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,
+/**
+ * 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 */
};
-enum {
- SC_HEX,
- SC_DEC,
- SC_OKT,
- SC_BIN,
-};
+/**
+ * buffer = value1 + value2
+ */
+void sc_add(const void *value1, const void *value2, void *buffer);
+
+/**
+ * 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_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);
-/*****************************************************************************
- * 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)
-#define sc_and(a, b) sc_calc((a), (b), SC_AND)
-#define sc_or(a, b) sc_calc((a), (b), SC_OR)
-#define sc_xor(a, b) sc_calc((a), (b), SC_XOR)
-#define sc_not(a) sc_calc((a), NULL, SC_NOT)
-#define sc_mul(a, b) sc_calc((a), (b), SC_MUL)
-#define sc_div(a, b) sc_calc((a), (b), SC_DIV)
-#define sc_mod(a, b) sc_calc((a), (b), SC_MOD)
-#define sc_shl(a, b, c, d) sc_bitcalc((a), (b), (c), (d), SC_SHL)
-#define sc_shr(a, b, c, d) sc_bitcalc((a), (b), (c), (d), SC_SHR)
-#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)
-/*****************************************************************************
+/**
+ * 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 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 sign_extend(void *buffer, ir_mode *mode);
+
+/** create an value form a string representation */
+void sc_val_from_str(const char *str, unsigned int len, void *buffer, ir_mode *mode);
+
+/** 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);
-void sc_val_from_str(const char *str, unsigned int len);
-void sc_val_from_long(long l);
+/** 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 sc_max_from_bits(unsigned int num_bits, unsigned int sign);
+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 sc_bitcalc(const void *val1, const void *val2, unsigned radius, unsigned sign, unsigned op);
+/** 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);
-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);
+
+/**
+ * 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 signed_mode print it signed (only decimal mode supported
+ */
+const char *sc_print(const void *val1, unsigned bits, enum base_t base, int signed_mode);
+
+/** Initialize the strcalc module.
+ * Sets up internal data structures and constants
+ * After the first call subsequent calls have no effect
+ *
+ * @param precision_in_bytes Specifies internal precision to be used
+ * 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);
+
+/** Return the bit at a given position. */
+int sc_get_bit_at(const void *value, unsigned pos);
+
+/* Strange semantics */
+int sc_had_carry(void);
-#endif /* _STRCALC_H_ */
+#endif /* FIRM_TV_STRCALC_H */
projects / libfirm / blobdiff