- is_tarval() added
[libfirm] / ir / tv / tv_t.h
1 /*
2  * Copyright (C) 1995-2008 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    Representation of and static computations on target machine
23  *           values -- private header.
24  * @date     2003
25  * @author   Mathias Heil
26  * @version  $Id$
27  */
28 #ifndef FIRM_TV_TV_T_H
29 #define FIRM_TV_TV_T_H
30
31 #include "firm_config.h"
32 #include "firm_common.h"
33
34 #include <assert.h>
35 #include "irmode.h"
36 #include "tv.h"
37
38 /** Debugging aid for the firmEvaluator: Marks for reserved tarvals values. */
39 enum reserved_id {
40   resid_tarval_bad       = 1,  /**< tarval_bad marker. */
41   resid_tarval_undefined = 2,  /**< tarval_undefined marker. */
42   resid_tarval_b_false   = 3,  /**< tarval_b_false marker. */
43   resid_tarval_b_true    = 4   /**< tarval_b_true marker. */
44 };
45
46 /**
47  * Initialization of the tarval module.
48  *
49  * Call before init_mode().
50  *
51  * @param null_value  The reference mode NULL value, typical 0l
52  */
53 void init_tarval_1(long null_value);
54
55 /**
56  * Initialization of the tarval module.
57  *
58  * Call after init_mode().
59  */
60 void init_tarval_2(void);
61
62 /**
63  * Free all memory occupied by the tarval module.
64  */
65 void finish_tarval(void);
66
67 /**
68  * This struct represents the afore mentioned tarvals.
69  *
70  * A tarval struct consists of an internal representation of the
71  * value and some additional fields further describing the value.
72  *
73  * ATTRIBUTES:
74  *   - ir_mode *mode     The mode of the stored value
75  *   - void *value       The internal representation
76  *
77  * @sa
78  *   irmode.h for predefined modes
79  */
80 struct tarval {
81   firm_kind kind;         /**< must be k_tarval */
82   ir_mode   *mode;        /**< the mode of the stored value */
83   const void *value;      /**< the value stored in an internal way... */
84   unsigned int length;    /**< the length of the stored value */
85 };
86
87 /* inline functions */
88 /*
89  * Access routines for tarval fields ========================================
90  */
91 static INLINE ir_mode *
92 _get_tarval_mode(const tarval *tv) {
93   assert(tv);
94   return tv->mode;
95 }
96
97 static INLINE tarval *
98 _get_tarval_bad(void) {
99   return tarval_bad;
100 }
101
102 static INLINE tarval *
103 _get_tarval_undefined(void) {
104   return tarval_undefined;
105 }
106
107 static INLINE tarval *
108 _get_tarval_b_false(void) {
109   return tarval_b_false;
110 }
111
112 static INLINE tarval *
113 _get_tarval_b_true(void) {
114   return tarval_b_true;
115 }
116
117 static INLINE int
118 _is_tarval(const void *thing) {
119         return get_kind(thing) == k_tarval;
120 }
121
122 #define get_tarval_mode(tv)     _get_tarval_mode(tv)
123 #define get_tarval_bad()        _get_tarval_bad()
124 #define get_tarval_undefined()  _get_tarval_undefined()
125 #define get_tarval_b_false()    _get_tarval_b_false()
126 #define get_tarval_b_true()     _get_tarval_b_true()
127 #define get_tarval_P_void()     _get_tarval_P_void()
128 #define is_tarval(thing)        _is_tarval(thing)
129
130 #endif /* FIRM_TV_TV_T_H */