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-2003 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 ****************************************************************************/ 26 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 33 }; 34 #undef DEFTREECODE 35 36 /* A tree to hold a loop ID. */ 37 struct tree_loop_id GTY(()) 38 { 39 struct tree_common common; 40 struct nesting *loop_id; 41 }; 42 43 /* The language-specific tree. */ 44 union lang_tree_node 45 GTY((desc ("TREE_CODE (&%h.generic) == GNAT_LOOP_ID"), 46 chain_next ("(union lang_tree_node *)TREE_CHAIN (&%h.generic)"))) 47 { 48 union tree_node GTY ((tag ("0"), 49 desc ("tree_node_structure (&%h)"))) 50 generic; 51 struct tree_loop_id GTY ((tag ("1"))) loop_id; 52 }; 53 54 /* Ada uses the lang_decl and lang_type fields to hold more trees. */ 55 struct lang_decl GTY(()) 56 { 57 union lang_tree_node 58 GTY((desc ("TREE_CODE (&%h.generic) == GNAT_LOOP_ID"))) t; 59 }; 60 struct lang_type GTY(()) 61 { 62 union lang_tree_node 63 GTY((desc ("TREE_CODE (&%h.generic) == GNAT_LOOP_ID"))) t; 64 }; 65 66 /* Flags added to GCC type nodes. */ 67 68 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is a 69 record being used as a fat pointer (only true for RECORD_TYPE). */ 70 #define TYPE_IS_FAT_POINTER_P(NODE) TYPE_LANG_FLAG_0 (NODE) 71 72 #define TYPE_FAT_POINTER_P(NODE) \ 73 (TREE_CODE (NODE) == RECORD_TYPE && TYPE_IS_FAT_POINTER_P (NODE)) 74 75 /* For integral types and array types, nonzero if this is a packed array type. 76 Such types should not be extended to a larger size. */ 77 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) TYPE_LANG_FLAG_0 (NODE) 78 79 #define TYPE_IS_PACKED_ARRAY_TYPE_P(NODE) \ 80 ((TREE_CODE (NODE) == INTEGER_TYPE || TREE_CODE (NODE) == ARRAY_TYPE) \ 81 && TYPE_PACKED_ARRAY_TYPE_P (NODE)) 82 83 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that 84 is not equal to two to the power of its mode's size. */ 85 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE)) 86 87 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of 88 an Ada array other than the first. */ 89 #define TYPE_MULTI_ARRAY_P(NODE) TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE)) 90 91 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an 92 unconstrained array or record. */ 93 #define TYPE_RETURNS_UNCONSTRAINED_P(NODE) \ 94 TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE)) 95 96 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes 97 a left-justified modular type (will only be true for RECORD_TYPE). */ 98 #define TYPE_LEFT_JUSTIFIED_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (NODE) 99 100 /* Nonzero in an arithmetic subtype if this is a subtype not known to the 101 front-end. */ 102 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE) 103 104 /* Nonzero for composite types if this is a by-reference type. */ 105 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE) 106 107 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the 108 type for an object whose type includes its template in addition to 109 its value (only true for RECORD_TYPE). */ 110 #define TYPE_CONTAINS_TEMPLATE_P(NODE) TYPE_LANG_FLAG_3 (NODE) 111 112 /* For INTEGER_TYPE, nonzero if this really represents a VAX 113 floating-point type. */ 114 #define TYPE_VAX_FLOATING_POINT_P(NODE) \ 115 TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE)) 116 117 /* True if NODE is a thin pointer. */ 118 #define TYPE_THIN_POINTER_P(NODE) \ 119 (POINTER_TYPE_P (NODE) \ 120 && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE \ 121 && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE))) 122 123 /* True if TYPE is either a fat or thin pointer to an unconstrained 124 array. */ 125 #define TYPE_FAT_OR_THIN_POINTER_P(NODE) \ 126 (TYPE_FAT_POINTER_P (NODE) || TYPE_THIN_POINTER_P (NODE)) 127 128 /* For INTEGER_TYPEs, nonzero if the type has a biased representation. */ 129 #define TYPE_BIASED_REPRESENTATION_P(NODE) \ 130 TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE)) 131 132 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran. */ 133 #define TYPE_CONVENTION_FORTRAN_P(NODE) \ 134 TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE)) 135 136 /* For FUNCTION_TYPEs, nonzero if the function returns by reference. */ 137 #define TYPE_RETURNS_BY_REF_P(NODE) \ 138 TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE)) 139 140 /* For VOID_TYPE, ENUMERAL_TYPE, UNION_TYPE, and RECORD_TYPE, nonzero if this 141 is a dummy type, made to correspond to a private or incomplete type. */ 142 #define TYPE_DUMMY_P(NODE) TYPE_LANG_FLAG_4 (NODE) 143 144 /* True if TYPE is such a dummy type. */ 145 #define TYPE_IS_DUMMY_P(NODE) \ 146 ((TREE_CODE (NODE) == VOID_TYPE || TREE_CODE (NODE) == RECORD_TYPE \ 147 || TREE_CODE (NODE) == UNION_TYPE || TREE_CODE (NODE) == ENUMERAL_TYPE) \ 148 && TYPE_DUMMY_P (NODE)) 149 150 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present. */ 151 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \ 152 TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE)) 153 154 /* For a RECORD_TYPE, nonzero if this was made just to supply needed 155 padding or alignment. */ 156 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE)) 157 158 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada 159 subprogram contains no parameters passed by copy in/copy out then this 160 field is 0. Otherwise it points to a list of nodes used to specify the 161 return values of the out (or in out) parameters that qualify to be passed 162 by copy in copy out. It is a CONSTRUCTOR. For a full description of the 163 cico parameter passing mechanism refer to the routine gnat_to_gnu_entity. */ 164 #define TYPE_CI_CO_LIST(NODE) \ 165 (&TYPE_LANG_SPECIFIC (FUNCTION_TYPE_CHECK (NODE))->t.generic) 166 #define SET_TYPE_CI_CO_LIST(NODE, X) \ 167 (TYPE_LANG_SPECIFIC (FUNCTION_TYPE_CHECK (NODE)) = (struct lang_type *)(X)) 168 169 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the 170 modulus. */ 171 #define TYPE_MODULUS(NODE) \ 172 (&TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))->t.generic) 173 #define SET_TYPE_MODULUS(NODE, X) \ 174 (TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE)) = (struct lang_type *)(X)) 175 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 (&TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))->t.generic) 180 #define SET_TYPE_INDEX_TYPE(NODE, X) \ 181 (TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE)) = (struct lang_type *) (X)) 182 183 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, stores the 184 Digits_Value. */ 185 #define TYPE_DIGITS_VALUE(NODE) \ 186 (&TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))->t.generic) 187 #define SET_TYPE_DIGITS_VALUE(NODE, X) \ 188 (TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE)) = (struct lang_type *) (X)) 189 190 /* For INTEGER_TYPE, stores the RM_Size of the type. */ 191 #define TYPE_RM_SIZE_INT(NODE) TYPE_VALUES (INTEGER_TYPE_CHECK (NODE)) 192 193 /* Likewise for ENUMERAL_TYPE. */ 194 #define TYPE_RM_SIZE_ENUM(NODE) \ 195 (&TYPE_LANG_SPECIFIC (ENUMERAL_TYPE_CHECK (NODE))->t.generic) 196 #define SET_TYPE_RM_SIZE_ENUM(NODE, X) \ 197 (TYPE_LANG_SPECIFIC (ENUMERAL_TYPE_CHECK (NODE)) = (struct lang_type *)(X)) 198 199 #define TYPE_RM_SIZE(NODE) \ 200 (TREE_CODE (NODE) == ENUMERAL_TYPE ? TYPE_RM_SIZE_ENUM (NODE) \ 201 : TREE_CODE (NODE) == INTEGER_TYPE ? TYPE_RM_SIZE_INT (NODE) \ 202 : 0) 203 204 /* For a RECORD_TYPE that is a fat pointer, point to the type for the 205 unconstrained object. Likewise for a RECORD_TYPE that is pointed 206 to by a thin pointer. */ 207 #define TYPE_UNCONSTRAINED_ARRAY(NODE) \ 208 (&TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))->t.generic) 209 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X) \ 210 (TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE)) = (struct lang_type *)(X)) 211 212 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada 213 size of the object. This differs from the GCC size in that it does not 214 include any rounding up to the alignment of the type. */ 215 #define TYPE_ADA_SIZE(NODE) (&TYPE_LANG_SPECIFIC (NODE)->t.generic) 216 #define SET_TYPE_ADA_SIZE(NODE, X) \ 217 (TYPE_LANG_SPECIFIC (NODE) = (struct lang_type *)(X)) 218 219 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is 220 the index type that should be used when the actual bounds are required for 221 a template. This is used in the case of packed arrays. */ 222 #define TYPE_ACTUAL_BOUNDS(NODE) (&TYPE_LANG_SPECIFIC (NODE)->t.generic) 223 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \ 224 (TYPE_LANG_SPECIFIC (NODE) = (struct lang_type *)(X)) 225 226 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both 227 the template and object. */ 228 #define TYPE_OBJECT_RECORD_TYPE(NODE) TYPE_MIN_VALUE (NODE) 229 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)) 233 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) 237 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)) 241 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)) 244 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)) 248 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) 252 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)) 255 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)) 258 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 (&DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))->t.generic) 264 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \ 265 (DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE)) = (struct lang_decl *)(X)) 266 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 (&DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))->t.generic) 271 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \ 272 (DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE)) = (struct lang_decl *)(X)) 273 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)) 277 278 /* This is the loop id for a GNAT_LOOP_ID node. */ 279 #define TREE_LOOP_ID(NODE) \ 280 ((union lang_tree_node *) TREE_CHECK (NODE, GNAT_LOOP_ID))->loop_id.loop_id 281 282 /* Define fields and macros for statements. 283 284 Start by defining which tree codes are used for statements. */ 285 #define IS_STMT(NODE) (TREE_CODE_CLASS (TREE_CODE (NODE)) == 's') 286 287 /* We store the Sloc in statement nodes. */ 288 #define TREE_SLOC(NODE) TREE_COMPLEXITY (STMT_CHECK (NODE)) 289 290 /* There is just one field in an EXPR_STMT: the expression. */ 291 #define EXPR_STMT_EXPR(NODE) TREE_OPERAND_CHECK_CODE (NODE, EXPR_STMT, 0) 292