2005-01-22 Thomas Koenig <Thomas.Koenig@online.de>
[official-gcc.git] / gcc / ada / ada-tree.h
blobfde996972c91031a9b1816ace2dc3f856dcaee79
1 /****************************************************************************
2 * *
3 * GNAT COMPILER COMPONENTS *
4 * *
5 * A D A - T R E E *
6 * *
7 * C Header File *
8 * *
9 * Copyright (C) 1992-2004 Free Software Foundation, Inc. *
10 * *
11 * GNAT is free software; you can redistribute it and/or modify it under *
12 * terms of the GNU General Public License as published by the Free Soft- *
13 * ware Foundation; either version 2, or (at your option) any later ver- *
14 * sion. GNAT is distributed in the hope that it will be useful, but WITH- *
15 * OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *
16 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License *
17 * for more details. You should have received a copy of the GNU General *
18 * Public License distributed with GNAT; see file COPYING. If not, write *
19 * to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, *
20 * MA 02111-1307, USA. *
21 * *
22 * GNAT was originally developed by the GNAT team at New York University. *
23 * Extensive contributions were provided by Ada Core Technologies Inc. *
24 * *
25 ****************************************************************************/
27 /* Ada language-specific GC tree codes. */
28 #define DEFTREECODE(SYM, NAME, TYPE, LENGTH) SYM,
29 enum gnat_tree_code {
30 __DUMMY = LAST_AND_UNUSED_TREE_CODE,
31 #include "ada-tree.def"
32 LAST_GNAT_TREE_CODE
34 #undef DEFTREECODE
36 /* Ada uses the lang_decl and lang_type fields to hold a tree. */
37 union lang_tree_node
38 GTY((desc ("0"),
39 chain_next ("(union lang_tree_node *)TREE_CHAIN (&%h.t)")))
41 union tree_node GTY((tag ("0"))) t;
43 struct lang_decl GTY(()) {tree t; };
44 struct lang_type GTY(()) {tree t; };
46 /* Define macros to get and set the tree in TYPE_ and DECL_LANG_SPECIFIC. */
47 #define GET_TYPE_LANG_SPECIFIC(NODE) \
48 (TYPE_LANG_SPECIFIC (NODE) ? TYPE_LANG_SPECIFIC (NODE)->t : NULL_TREE)
49 #define SET_TYPE_LANG_SPECIFIC(NODE, X) \
50 (TYPE_LANG_SPECIFIC (NODE) \
51 = (TYPE_LANG_SPECIFIC (NODE) \
52 ? TYPE_LANG_SPECIFIC (NODE) : ggc_alloc (sizeof (struct lang_type)))) \
53 ->t = X;
55 #define GET_DECL_LANG_SPECIFIC(NODE) \
56 (DECL_LANG_SPECIFIC (NODE) ? DECL_LANG_SPECIFIC (NODE)->t : NULL_TREE)
57 #define SET_DECL_LANG_SPECIFIC(NODE, VALUE) \
58 (DECL_LANG_SPECIFIC (NODE) \
59 = (DECL_LANG_SPECIFIC (NODE) \
60 ? DECL_LANG_SPECIFIC (NODE) : ggc_alloc (sizeof (struct lang_decl)))) \
61 ->t = VALUE;
63 /* Flags added to GCC type nodes. */
65 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is a
66 record being used as a fat pointer (only true for RECORD_TYPE). */
67 #define TYPE_IS_FAT_POINTER_P(NODE) TYPE_LANG_FLAG_0 (NODE)
69 #define TYPE_FAT_POINTER_P(NODE) \
70 (TREE_CODE (NODE) == RECORD_TYPE && TYPE_IS_FAT_POINTER_P (NODE))
72 /* For integral types and array types, nonzero if this is a packed array type.
73 Such types should not be extended to a larger size. */
74 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) TYPE_LANG_FLAG_0 (NODE)
76 #define TYPE_IS_PACKED_ARRAY_TYPE_P(NODE) \
77 ((TREE_CODE (NODE) == INTEGER_TYPE || TREE_CODE (NODE) == ARRAY_TYPE) \
78 && TYPE_PACKED_ARRAY_TYPE_P (NODE))
80 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that
81 is not equal to two to the power of its mode's size. */
82 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE))
84 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of
85 an Ada array other than the first. */
86 #define TYPE_MULTI_ARRAY_P(NODE) TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE))
88 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an
89 unconstrained array or record. */
90 #define TYPE_RETURNS_UNCONSTRAINED_P(NODE) \
91 TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE))
93 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes
94 a justified modular type (will only be true for RECORD_TYPE). */
95 #define TYPE_JUSTIFIED_MODULAR_P(NODE) \
96 TYPE_LANG_FLAG_1 (RECORD_OR_UNION_CHECK (NODE))
98 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
99 front-end. */
100 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
102 /* Nonzero for composite types if this is a by-reference type. */
103 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
105 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
106 type for an object whose type includes its template in addition to
107 its value (only true for RECORD_TYPE). */
108 #define TYPE_CONTAINS_TEMPLATE_P(NODE) \
109 TYPE_LANG_FLAG_3 (RECORD_OR_UNION_CHECK (NODE))
111 /* For INTEGER_TYPE, nonzero if this really represents a VAX
112 floating-point type. */
113 #define TYPE_VAX_FLOATING_POINT_P(NODE) \
114 TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE))
116 /* True if NODE is a thin pointer. */
117 #define TYPE_THIN_POINTER_P(NODE) \
118 (POINTER_TYPE_P (NODE) \
119 && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE \
120 && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE)))
122 /* True if TYPE is either a fat or thin pointer to an unconstrained
123 array. */
124 #define TYPE_FAT_OR_THIN_POINTER_P(NODE) \
125 (TYPE_FAT_POINTER_P (NODE) || TYPE_THIN_POINTER_P (NODE))
127 /* For INTEGER_TYPEs, nonzero if the type has a biased representation. */
128 #define TYPE_BIASED_REPRESENTATION_P(NODE) \
129 TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE))
131 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran. */
132 #define TYPE_CONVENTION_FORTRAN_P(NODE) \
133 TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE))
135 /* For FUNCTION_TYPEs, nonzero if the function returns by reference. */
136 #define TYPE_RETURNS_BY_REF_P(NODE) \
137 TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE))
139 /* For FUNCTION_TYPEs, nonzero if function returns by being passed a pointer
140 to a place to store its result. */
141 #define TYPE_RETURNS_BY_TARGET_PTR_P(NODE) \
142 TYPE_LANG_FLAG_5 (FUNCTION_TYPE_CHECK (NODE))
144 /* For VOID_TYPE, ENUMERAL_TYPE, UNION_TYPE, and RECORD_TYPE, nonzero if this
145 is a dummy type, made to correspond to a private or incomplete type. */
146 #define TYPE_DUMMY_P(NODE) TYPE_LANG_FLAG_4 (NODE)
148 /* True if TYPE is such a dummy type. */
149 #define TYPE_IS_DUMMY_P(NODE) \
150 ((TREE_CODE (NODE) == VOID_TYPE || TREE_CODE (NODE) == RECORD_TYPE \
151 || TREE_CODE (NODE) == UNION_TYPE || TREE_CODE (NODE) == ENUMERAL_TYPE) \
152 && TYPE_DUMMY_P (NODE))
154 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present. */
155 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
156 TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
158 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
159 padding or alignment. */
160 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
162 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada
163 subprogram contains no parameters passed by copy in/copy out then this
164 field is 0. Otherwise it points to a list of nodes used to specify the
165 return values of the out (or in out) parameters that qualify to be passed
166 by copy in copy out. It is a CONSTRUCTOR. For a full description of the
167 cico parameter passing mechanism refer to the routine gnat_to_gnu_entity. */
168 #define TYPE_CI_CO_LIST(NODE) TYPE_LANG_SLOT_1 (FUNCTION_TYPE_CHECK (NODE))
170 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
171 modulus. */
172 #define TYPE_MODULUS(NODE) GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
173 #define SET_TYPE_MODULUS(NODE, X) \
174 SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
176 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, points to
177 the type corresponding to the Ada index type. */
178 #define TYPE_INDEX_TYPE(NODE) \
179 GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
180 #define SET_TYPE_INDEX_TYPE(NODE, X) \
181 SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
183 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, stores the
184 Digits_Value. */
185 #define TYPE_DIGITS_VALUE(NODE) \
186 GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
187 #define SET_TYPE_DIGITS_VALUE(NODE, X) \
188 SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
190 /* For numeric types, stores the RM_Size of the type. */
191 #define TYPE_RM_SIZE_NUM(NODE) TYPE_LANG_SLOT_1 (NUMERICAL_TYPE_CHECK (NODE))
193 #define TYPE_RM_SIZE(NODE) \
194 (INTEGRAL_TYPE_P (NODE) || TREE_CODE (NODE) == REAL_TYPE \
195 ? TYPE_RM_SIZE_NUM (NODE) : 0)
197 /* For a RECORD_TYPE that is a fat pointer, point to the type for the
198 unconstrained object. Likewise for a RECORD_TYPE that is pointed
199 to by a thin pointer. */
200 #define TYPE_UNCONSTRAINED_ARRAY(NODE) \
201 GET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))
202 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X) \
203 SET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE), X)
205 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada
206 size of the object. This differs from the GCC size in that it does not
207 include any rounding up to the alignment of the type. */
208 #define TYPE_ADA_SIZE(NODE) \
209 GET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE))
210 #define SET_TYPE_ADA_SIZE(NODE, X) \
211 SET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE), X)
213 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
214 the index type that should be used when the actual bounds are required for
215 a template. This is used in the case of packed arrays. */
216 #define TYPE_ACTUAL_BOUNDS(NODE) \
217 GET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE))
218 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \
219 SET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE), X)
221 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both
222 the template and object.
224 ??? We also put this on an ENUMERAL_TYPE that's dummy. Technically,
225 this is a conflict on the minval field, but there doesn't seem to be
226 simple fix, so we'll live with this kludge for now. */
227 #define TYPE_OBJECT_RECORD_TYPE(NODE) \
228 (TREE_CHECK2 ((NODE), UNCONSTRAINED_ARRAY_TYPE, ENUMERAL_TYPE)->type.minval)
230 /* Nonzero in a FUNCTION_DECL that represents a stubbed function
231 discriminant. */
232 #define DECL_STUBBED_P(NODE) DECL_LANG_FLAG_0 (FUNCTION_DECL_CHECK (NODE))
234 /* Nonzero if this decl is always used by reference; i.e., an INDIRECT_REF
235 is needed to access the object. */
236 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (NODE)
238 /* Nonzero if this decl is a PARM_DECL for an Ada array being passed to a
239 foreign convention subprogram. */
240 #define DECL_BY_COMPONENT_PTR_P(NODE) DECL_LANG_FLAG_2 (PARM_DECL_CHECK (NODE))
242 /* Nonzero in a FIELD_DECL that is a dummy built for some internal reason. */
243 #define DECL_INTERNAL_P(NODE) DECL_LANG_FLAG_3 (FIELD_DECL_CHECK (NODE))
245 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure. */
246 #define DECL_ELABORATION_PROC_P(NODE) \
247 DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
249 /* Nonzero if this is a decl for a pointer that points to something which
250 is readonly. Used mostly for fat pointers. */
251 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
253 /* Nonzero in a FIELD_DECL if there was a record rep clause. */
254 #define DECL_HAS_REP_P(NODE) DECL_LANG_FLAG_5 (FIELD_DECL_CHECK (NODE))
256 /* Nonzero in a PARM_DECL if we are to pass by descriptor. */
257 #define DECL_BY_DESCRIPTOR_P(NODE) DECL_LANG_FLAG_5 (PARM_DECL_CHECK (NODE))
259 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
260 memory. Used when a scalar constant is aliased or has its
261 address taken. */
262 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
263 GET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))
264 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \
265 SET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE), X)
267 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
268 source of the decl. */
269 #define DECL_ORIGINAL_FIELD(NODE) \
270 GET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))
271 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \
272 SET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE), X)
274 /* In a FIELD_DECL corresponding to a discriminant, contains the
275 discriminant number. */
276 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
278 /* Define fields and macros for statements.
280 Start by defining which tree codes are used for statements. */
281 #define IS_STMT(NODE) (STATEMENT_CLASS_P (NODE))
282 #define IS_ADA_STMT(NODE) (IS_STMT (NODE) \
283 && TREE_CODE (NODE) >= STMT_STMT)
285 #define STMT_STMT_STMT(NODE) TREE_OPERAND_CHECK_CODE (NODE, STMT_STMT, 0)
286 #define LOOP_STMT_TOP_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 0)
287 #define LOOP_STMT_BOT_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 1)
288 #define LOOP_STMT_UPDATE(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 2)
289 #define LOOP_STMT_BODY(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 3)
290 #define LOOP_STMT_LABEL(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 4)
291 #define EXIT_STMT_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 0)
292 #define EXIT_STMT_LABEL(NODE) TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 1)
293 #define REGION_STMT_BODY(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 0)
294 #define REGION_STMT_HANDLE(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 1)
295 #define REGION_STMT_BLOCK(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 2)
296 #define HANDLER_STMT_ARG(NODE) TREE_OPERAND_CHECK_CODE (NODE, HANDLER_STMT, 0)
297 #define HANDLER_STMT_LIST(NODE) TREE_OPERAND_CHECK_CODE (NODE, HANDLER_STMT, 1)
298 #define HANDLER_STMT_BLOCK(NODE) TREE_OPERAND_CHECK_CODE(NODE, HANDLER_STMT, 2)