strcalc.h 4.81 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/*
 * Project:     libFIRM
 * File name:   ir/tv/strcalc.h
 * Purpose:     Provides basic mathematical operations on values represented as strings.
 * Author:      Mathias Heil
 * Modified by:
 * Created:
 * CVS-ID:      $Id$
 * Copyright:   (c) 2003 Universitt Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
 */

/**
 * @file strcalc.h
15
 *
16
17
18
19
 * 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.
20
 *
21
 */
22
23
24
25

#ifndef _STRCALC_H_
#define _STRCALC_H_

26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#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
 */

45
#define SC_DEFAULT_PRECISION 64
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

enum {
  SC_0 = 0,
  SC_1,
  SC_2,
  SC_3,
  SC_4,
  SC_5,
  SC_6,
  SC_7,
  SC_8,
  SC_9,
  SC_A,
  SC_B,
  SC_C,
  SC_D,
  SC_E,
Till Riedel's avatar
Till Riedel committed
63
  SC_F
64
65
};

66
67
68
/**
 * Possible operations on integer values.
 */
69
typedef enum {
Florian Liekweg's avatar
Florian Liekweg committed
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  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 */
84
} sc_op_t;
85

86
87
88
89
/**
 * The output mode for ntger values.
 */
enum base_t {
Florian Liekweg's avatar
Florian Liekweg committed
90
91
92
93
94
  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 */
95
96
};

97
/*
98
 * definitions and macros
99
 */
100
101
102
103
104
105
106
107
108
109
110
111
112
113
#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))
114

115
/*
116
 * function declarations
117
 */
118
119
120
const void *sc_get_buffer(void);
const int sc_get_buffer_length(void);

121
122
123
void sc_val_from_str(const char *str, unsigned int len, void *buffer);
void sc_val_from_long(long l, void *buffer);
void sc_val_from_ulong(unsigned long l, void *buffer);
Michael Beck's avatar
Michael Beck committed
124
long sc_val_to_long(const void *val);
125
126
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);
127

128
129
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);
130
131
int  sc_comp(const void *val1, const void *val2);

Matthias Heil's avatar
Matthias Heil committed
132
133
int sc_get_highest_set_bit(const void *value);
int sc_get_lowest_set_bit(const void *value);
134
135
136
int sc_is_zero(const void *value);
int sc_is_negative(const void *value);
int sc_had_carry(void);
Matthias Heil's avatar
Matthias Heil committed
137
unsigned char sc_sub_bits(const void *value, int len, unsigned byte_ofs);
138

139
140
141
/**
 * Converts a tarval into a string.
 *
Florian Liekweg's avatar
Florian Liekweg committed
142
143
144
 * @param val1      the value pointer
 * @param bits      number of valid bits in this value
 * @param base      output base
145
146
 */
const char *sc_print(const void *val1, unsigned bits, enum base_t base);
147

148
149
150
151
152
153
154
/** Init 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
 */
Matthias Heil's avatar
Matthias Heil committed
155
void init_strcalc(int precision_in_bytes);
156
void finish_strcalc(void);
157
int sc_get_precision(void);
Matthias Heil's avatar
Matthias Heil committed
158

159
#endif /* _STRCALC_H_ */