nsz Git - libfirm/blob - ir/tv/strcalc.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    Provides basic mathematical operations on values represented as strings.
  23  * @date     2003
  24  * @author   Mathias Heil
  25  * @version  $Id$
  26  * @summary
  27  *
  28  * The module uses a string to represent values, and provides operations
  29  * to perform calculations with these values.
  30  * Results are stored in an internal buffer, so you have to make a copy
  31  * of them if you need to store the result.
  32  *
  33  */
  34 #ifndef FIRM_TV_STRCALC_H
  35 #define FIRM_TV_STRCALC_H
  36
  37 #include "irmode.h"
  38
  39 #ifdef STRCALC_DEBUG_ALL             /* switch on all debug options */
  40 #  ifndef STRCALC_DEBUG
  41 #    define STRCALC_DEBUG            /* switch on debug output */
  42 #  endif
  43 #  ifndef STRCALC_DEBUG_PRINTCOMP    /* print arguments and result of each computation */
  44 #    define STRCALC_DEBUG_PRINTCOMP
  45 #  endif
  46 #  ifndef STRCALC_DEBUG_FULLPRINT
  47 #    define STRCALC_DEBUG_FULLPRINT  /* print full length of values (e.g. 128 bit instead of 64 bit using default init) */
  48 #  endif
  49 #  ifndef STRCALC_DEBUG_GROUPPRINT
  50 #    define STRCALC_DEBUG_GROUPPRINT /* print spaces after each 8 bits */
  51 #  endif
  52 #endif
  53
  54 /*
  55  * constants, typedefs, enums
  56  */
  57
  58 #define SC_DEFAULT_PRECISION 64
  59
  60 enum {
  61   SC_0 = 0,
  62   SC_1,
  63   SC_2,
  64   SC_3,
  65   SC_4,
  66   SC_5,
  67   SC_6,
  68   SC_7,
  69   SC_8,
  70   SC_9,
  71   SC_A,
  72   SC_B,
  73   SC_C,
  74   SC_D,
  75   SC_E,
  76   SC_F
  77 };
  78
  79 /**
  80  * Possible operations on integer values.
  81  */
  82 typedef enum {
  83   SC_ADD = 0,   /**< Addition */
  84   SC_SUB,       /**< Subtraction */
  85   SC_NEG,       /**< Unary Minus */
  86   SC_MUL,       /**< Multiplication */
  87   SC_DIV,       /**< Integer Division (with rounding toward zero ?) */
  88   SC_MOD,       /**< Devision Remainder */
  89   SC_SHL,       /**< Left Shift */
  90   SC_SHR,       /**< Logical (unsigned) Right Shift */
  91   SC_SHRS,      /**< Arithmetic (signed) Right Shift */
  92   SC_ROT,       /**< Rotation (both directions) */
  93   SC_AND,       /**< Bitwise And */
  94   SC_OR,        /**< Bitwise Or */
  95   SC_NOT,       /**< Bitwise Not */
  96   SC_XOR        /**< Bitwise Exclusive Or */
  97 } sc_op_t;
  98
  99 /**
 100  * The output mode for integer values.
 101  */
 102 enum base_t {
 103   SC_hex,   /**< hexadecimal output with small letters */
 104   SC_HEX,   /**< hexadecimal output with BIG letters */
 105   SC_DEC,   /**< decimal output */
 106   SC_OCT,   /**< octal output */
 107   SC_BIN    /**< binary output */
 108 };
 109
 110 /*
 111  * definitions and macros
 112  */
 113 #define sc_add(a, b, c) sc_calc((a), (b), SC_ADD, (c))
 114 #define sc_sub(a, b, c) sc_calc((a), (b), SC_SUB, (c))
 115 #define sc_neg(a, c)    sc_calc((a), NULL, SC_NEG, (c))
 116 #define sc_and(a, b, c) sc_calc((a), (b), SC_AND, (c))
 117 #define sc_or(a, b, c)  sc_calc((a), (b), SC_OR, (c))
 118 #define sc_xor(a, b, c) sc_calc((a), (b), SC_XOR, (c))
 119 #define sc_not(a, c)    sc_calc((a), NULL, SC_NOT, (c))
 120 #define sc_mul(a, b, c) sc_calc((a), (b), SC_MUL, (c))
 121 #define sc_div(a, b, c) sc_calc((a), (b), SC_DIV, (c))
 122 #define sc_mod(a, b, c) sc_calc((a), (b), SC_MOD, (c))
 123 #define sc_shl(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_SHL, (e))
 124 #define sc_shr(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_SHR, (e))
 125 #define sc_shrs(a, b, c, d, e) sc_bitcalc((a), (b), (c), (d), SC_SHRS, (e))
 126 #define sc_rot(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_ROT, (e))
 127
 128 /*
 129  * function declarations
 130  */
 131 const void *sc_get_buffer(void);
 132 int sc_get_buffer_length(void);
 133
 134 void sign_extend(char *calc_buffer, ir_mode *mode);
 135
 136 /** create an value form a string representation */
 137 void sc_val_from_str(const char *str, unsigned int len, void *buffer, ir_mode *mode);
 138
 139 /** create a value from a long */
 140 void sc_val_from_long(long l, void *buffer);
 141
 142 /** create a value form an unsigned long */
 143 void sc_val_from_ulong(unsigned long l, void *buffer);
 144
 145 /** converts a value to a long */
 146 long sc_val_to_long(const void *val);
 147 void sc_min_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
 148 void sc_max_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
 149
 150 void sc_calc(const void *val1, const void *val2, unsigned op, void *buffer);
 151 void sc_bitcalc(const void *val1, const void *val2, int radius, int sign, unsigned op, void *buffer);
 152 int  sc_comp(const void *val1, const void *val2);
 153
 154 int sc_get_highest_set_bit(const void *value);
 155 int sc_get_lowest_set_bit(const void *value);
 156 int sc_is_zero(const void *value);
 157 int sc_is_negative(const void *value);
 158 int sc_had_carry(void);
 159 unsigned char sc_sub_bits(const void *value, int len, unsigned byte_ofs);
 160
 161 /**
 162  * Converts a tarval into a string.
 163  *
 164  * @param val1        the value pointer
 165  * @param bits        number of valid bits in this value
 166  * @param base        output base
 167  * @param signed_mode print it signed (only decimal mode supported
 168  */
 169 const char *sc_print(const void *val1, unsigned bits, enum base_t base, int signed_mode);
 170
 171 /** Initialize the strcalc module.
 172  * Sets up internal data structures and constants
 173  * After the first call subsequent calls have no effect
 174  *
 175  * @param precision_in_bytes Specifies internal precision to be used
 176  *   for calculations. The reason for being multiples of 8 eludes me
 177  */
 178 void init_strcalc(int precision_in_bytes);
 179 void finish_strcalc(void);
 180 int sc_get_precision(void);
 181
 182 #endif /* FIRM_TV_STRCALC_H */