strcalc.h 5.77 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * 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.
 *
 * 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.
 */

20
21
22
23
24
25
26
27
28
29
30
31
32
/*
 * 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
 */

/**
 * @file strcalc.h
33
 *
34
35
36
37
 * 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.
38
 *
39
 */
40
41
42
43

#ifndef _STRCALC_H_
#define _STRCALC_H_

44
45
#include "irmode.h"

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
#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
 */

65
#define SC_DEFAULT_PRECISION 64
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

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
83
  SC_F
84
85
};

86
87
88
/**
 * Possible operations on integer values.
 */
89
typedef enum {
Michael Beck's avatar
Michael Beck committed
90
  SC_ADD = 0,   /**< Addition */
Florian Liekweg's avatar
Florian Liekweg committed
91
92
93
94
95
96
97
98
99
100
101
102
103
  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 */
104
} sc_op_t;
105

106
/**
Michael Beck's avatar
Michael Beck committed
107
 * The output mode for integer values.
108
109
 */
enum base_t {
Florian Liekweg's avatar
Florian Liekweg committed
110
111
112
113
114
  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 */
115
116
};

117
/*
118
 * definitions and macros
119
 */
120
121
#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))
Michael Beck's avatar
Michael Beck committed
122
#define sc_neg(a, c)    sc_calc((a), NULL, SC_NEG, (c))
123
#define sc_and(a, b, c) sc_calc((a), (b), SC_AND, (c))
Michael Beck's avatar
Michael Beck committed
124
#define sc_or(a, b, c)  sc_calc((a), (b), SC_OR, (c))
125
#define sc_xor(a, b, c) sc_calc((a), (b), SC_XOR, (c))
Michael Beck's avatar
Michael Beck committed
126
#define sc_not(a, c)    sc_calc((a), NULL, SC_NOT, (c))
127
128
129
#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))
Michael Beck's avatar
Michael Beck committed
130
131
#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))
132
#define sc_shrs(a, b, c, d, e) sc_bitcalc((a), (b), (c), (d), SC_SHRS, (e))
Michael Beck's avatar
Michael Beck committed
133
#define sc_rot(a, b, c, d, e)  sc_bitcalc((a), (b), (c), (d), SC_ROT, (e))
134

135
/*
136
 * function declarations
137
 */
138
const void *sc_get_buffer(void);
Michael Beck's avatar
Michael Beck committed
139
int sc_get_buffer_length(void);
140

Michael Beck's avatar
BugFix:    
Michael Beck committed
141
142
void sign_extend(char *calc_buffer, ir_mode *mode);

143
144
145
146
/** 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 */
147
void sc_val_from_long(long l, void *buffer);
148
149

/** create a value form an unsigned long */
150
void sc_val_from_ulong(unsigned long l, void *buffer);
151
152

/** converts a value to a long */
Michael Beck's avatar
Michael Beck committed
153
long sc_val_to_long(const void *val);
154
155
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);
156

157
158
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);
159
160
int  sc_comp(const void *val1, const void *val2);

Matthias Heil's avatar
Matthias Heil committed
161
162
int sc_get_highest_set_bit(const void *value);
int sc_get_lowest_set_bit(const void *value);
163
164
165
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
166
unsigned char sc_sub_bits(const void *value, int len, unsigned byte_ofs);
167

168
169
170
/**
 * Converts a tarval into a string.
 *
171
172
173
174
 * @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
175
 */
176
const char *sc_print(const void *val1, unsigned bits, enum base_t base, int signed_mode);
177

Michael Beck's avatar
Michael Beck committed
178
/** Initialize the strcalc module.
179
180
181
182
183
184
 * 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
185
void init_strcalc(int precision_in_bytes);
186
void finish_strcalc(void);
187
int sc_get_precision(void);
Matthias Heil's avatar
Matthias Heil committed
188

189
#endif /* _STRCALC_H_ */