gcc/ada/ada-tree.h

   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-2008, 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 3,  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 along with GCC; see the file COPYING3.  If not see        *
  19  * <http://www.gnu.org/licenses/>.                                          *
  20  *                                                                          *
  21  * GNAT was originally developed  by the GNAT team at  New York University. *
  22  * Extensive contributions were provided by Ada Core Technologies Inc.      *
  23  *                                                                          *
  24  ****************************************************************************/
  25
  26 /* Ada language-specific GC tree codes.  */
  27 #define DEFTREECODE(SYM, NAME, TYPE, LENGTH) SYM,
  28 enum gnat_tree_code {
  29   __DUMMY = LAST_AND_UNUSED_TREE_CODE,
  30 #include "ada-tree.def"
  31   LAST_GNAT_TREE_CODE
  32 };
  33 #undef DEFTREECODE
  34
  35 /* Ada uses the lang_decl and lang_type fields to hold a tree.  */
  36 union lang_tree_node
  37   GTY((desc ("0"),
  38        chain_next ("(union lang_tree_node *)GENERIC_NEXT (&%h.t)")))
  39 {
  40   union tree_node GTY((tag ("0"))) t;
  41 };
  42 struct lang_decl GTY(()) {tree t; };
  43 struct lang_type GTY(()) {tree t; };
  44
  45 /* Define macros to get and set the tree in TYPE_ and DECL_LANG_SPECIFIC.  */
  46 #define GET_TYPE_LANG_SPECIFIC(NODE) \
  47   (TYPE_LANG_SPECIFIC (NODE) ? TYPE_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  48 #define SET_TYPE_LANG_SPECIFIC(NODE, X) \
  49  (TYPE_LANG_SPECIFIC (NODE)                     \
  50   = (TYPE_LANG_SPECIFIC (NODE)                  \
  51      ? TYPE_LANG_SPECIFIC (NODE) : ggc_alloc (sizeof (struct lang_type))))   \
  52  ->t = X;
  53
  54 #define GET_DECL_LANG_SPECIFIC(NODE) \
  55   (DECL_LANG_SPECIFIC (NODE) ? DECL_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  56 #define SET_DECL_LANG_SPECIFIC(NODE, VALUE)     \
  57  (DECL_LANG_SPECIFIC (NODE)                     \
  58   = (DECL_LANG_SPECIFIC (NODE)                  \
  59      ? DECL_LANG_SPECIFIC (NODE) : ggc_alloc (sizeof (struct lang_decl))))   \
  60  ->t = VALUE;
  61
  62 /* Flags added to GCC type nodes.  */
  63
  64 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is a
  65    record being used as a fat pointer (only true for RECORD_TYPE).  */
  66 #define TYPE_IS_FAT_POINTER_P(NODE) \
  67   TYPE_LANG_FLAG_0 (RECORD_OR_UNION_CHECK (NODE))
  68
  69 #define TYPE_FAT_POINTER_P(NODE)  \
  70   (TREE_CODE (NODE) == RECORD_TYPE && TYPE_IS_FAT_POINTER_P (NODE))
  71
  72 /* For integral types and array types, nonzero if this is a packed array type
  73    used for bit-packed types.  Such types should not be extended to a larger
  74    size or validated against a specified size.  */
  75 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) TYPE_LANG_FLAG_0 (NODE)
  76
  77 #define TYPE_IS_PACKED_ARRAY_TYPE_P(NODE) \
  78   ((TREE_CODE (NODE) == INTEGER_TYPE || TREE_CODE (NODE) == ARRAY_TYPE) \
  79    && TYPE_PACKED_ARRAY_TYPE_P (NODE))
  80
  81 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that
  82    is not equal to two to the power of its mode's size.  */
  83 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE))
  84
  85 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of
  86    an Ada array other than the first.  */
  87 #define TYPE_MULTI_ARRAY_P(NODE)  TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE))
  88
  89 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an
  90    unconstrained array or record.  */
  91 #define TYPE_RETURNS_UNCONSTRAINED_P(NODE) \
  92   TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE))
  93
  94 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes
  95    a justified modular type (will only be true for RECORD_TYPE).  */
  96 #define TYPE_JUSTIFIED_MODULAR_P(NODE) \
  97   TYPE_LANG_FLAG_1 (RECORD_OR_UNION_CHECK (NODE))
  98
  99 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
 100    front-end.  */
 101 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
 102
 103 /* Nonzero for composite types if this is a by-reference type.  */
 104 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
 105
 106 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
 107    type for an object whose type includes its template in addition to
 108    its value (only true for RECORD_TYPE).  */
 109 #define TYPE_CONTAINS_TEMPLATE_P(NODE) \
 110   TYPE_LANG_FLAG_3 (RECORD_OR_UNION_CHECK (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 FUNCTION_TYPEs, nonzero if function returns by being passed a pointer
 151    to a place to store its result.  */
 152 #define TYPE_RETURNS_BY_TARGET_PTR_P(NODE) \
 153   TYPE_LANG_FLAG_5 (FUNCTION_TYPE_CHECK (NODE))
 154
 155 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present.  */
 156 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
 157   TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
 158
 159 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
 160    padding or alignment.  */
 161 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
 162
 163 /* True if TYPE can alias any other types.  */
 164 #define TYPE_UNIVERSAL_ALIASING_P(NODE) TYPE_LANG_FLAG_6 (NODE)
 165
 166 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada
 167    subprogram contains no parameters passed by copy in/copy out then this
 168    field is 0. Otherwise it points to a list of nodes used to specify the
 169    return values of the out (or in out) parameters that qualify to be passed
 170    by copy in copy out.  It is a CONSTRUCTOR.  For a full description of the
 171    cico parameter passing mechanism refer to the routine gnat_to_gnu_entity. */
 172 #define TYPE_CI_CO_LIST(NODE)  TYPE_LANG_SLOT_1 (FUNCTION_TYPE_CHECK (NODE))
 173
 174 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
 175    modulus. */
 176 #define TYPE_MODULUS(NODE) GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 177 #define SET_TYPE_MODULUS(NODE, X)  \
 178   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 179
 180 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, points to
 181    the type corresponding to the Ada index type.  */
 182 #define TYPE_INDEX_TYPE(NODE) \
 183   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 184 #define SET_TYPE_INDEX_TYPE(NODE, X) \
 185   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 186
 187 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, stores the
 188    Digits_Value.  */
 189 #define TYPE_DIGITS_VALUE(NODE) \
 190   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 191 #define SET_TYPE_DIGITS_VALUE(NODE, X)  \
 192   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 193
 194 /* For numeric types, stores the RM_Size of the type.  */
 195 #define TYPE_RM_SIZE_NUM(NODE)  TYPE_LANG_SLOT_1 (NUMERICAL_TYPE_CHECK (NODE))
 196
 197 #define TYPE_RM_SIZE(NODE)                                      \
 198   (INTEGRAL_TYPE_P (NODE) || TREE_CODE (NODE) == REAL_TYPE      \
 199    ? TYPE_RM_SIZE_NUM (NODE) : 0)
 200
 201 /* For a RECORD_TYPE that is a fat pointer, point to the type for the
 202    unconstrained object.  Likewise for a RECORD_TYPE that is pointed
 203    to by a thin pointer.  */
 204 #define TYPE_UNCONSTRAINED_ARRAY(NODE)  \
 205   GET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))
 206 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X)  \
 207   SET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE), X)
 208
 209 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada
 210    size of the object.  This differs from the GCC size in that it does not
 211    include any rounding up to the alignment of the type.  */
 212 #define TYPE_ADA_SIZE(NODE)   \
 213   GET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE))
 214 #define SET_TYPE_ADA_SIZE(NODE, X) \
 215   SET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE), X)
 216
 217 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
 218    the index type that should be used when the actual bounds are required for
 219    a template.  This is used in the case of packed arrays.  */
 220 #define TYPE_ACTUAL_BOUNDS(NODE)   \
 221   GET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE))
 222 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \
 223   SET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE), X)
 224
 225 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both
 226    the template and object.
 227
 228    ??? We also put this on an ENUMERAL_TYPE that's dummy.  Technically,
 229    this is a conflict on the minval field, but there doesn't seem to be
 230    simple fix, so we'll live with this kludge for now.  */
 231 #define TYPE_OBJECT_RECORD_TYPE(NODE) \
 232   (TREE_CHECK2 ((NODE), UNCONSTRAINED_ARRAY_TYPE, ENUMERAL_TYPE)->type.minval)
 233
 234 /* Nonzero in a FUNCTION_DECL that represents a stubbed function
 235    discriminant.  */
 236 #define DECL_STUBBED_P(NODE) DECL_LANG_FLAG_0 (FUNCTION_DECL_CHECK (NODE))
 237
 238 /* Nonzero in a VAR_DECL if it is guaranteed to be constant after having
 239    been elaborated and TREE_READONLY is not set on it.  */
 240 #define DECL_READONLY_ONCE_ELAB(NODE) DECL_LANG_FLAG_0 (VAR_DECL_CHECK (NODE))
 241
 242 /* Nonzero if this decl is always used by reference; i.e., an INDIRECT_REF
 243    is needed to access the object.  */
 244 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (NODE)
 245
 246 /* Nonzero in a FIELD_DECL that is a dummy built for some internal reason.  */
 247 #define DECL_INTERNAL_P(NODE) DECL_LANG_FLAG_3 (FIELD_DECL_CHECK (NODE))
 248
 249 /* Nonzero if this decl is a PARM_DECL for an Ada array being passed to a
 250    foreign convention subprogram.  */
 251 #define DECL_BY_COMPONENT_PTR_P(NODE) DECL_LANG_FLAG_3 (PARM_DECL_CHECK (NODE))
 252
 253 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure.  */
 254 #define DECL_ELABORATION_PROC_P(NODE) \
 255   DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
 256
 257 /* Nonzero if this is a decl for a pointer that points to something which
 258    is readonly.  Used mostly for fat pointers.  */
 259 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
 260
 261 /* Nonzero in a FIELD_DECL if there was a record rep clause.  */
 262 #define DECL_HAS_REP_P(NODE) DECL_LANG_FLAG_5 (FIELD_DECL_CHECK (NODE))
 263
 264 /* Nonzero in a PARM_DECL if we are to pass by descriptor.  */
 265 #define DECL_BY_DESCRIPTOR_P(NODE) DECL_LANG_FLAG_5 (PARM_DECL_CHECK (NODE))
 266
 267 /* Nonzero in a VAR_DECL if it is a pointer renaming a global object.  */
 268 #define DECL_RENAMING_GLOBAL_P(NODE) DECL_LANG_FLAG_5 (VAR_DECL_CHECK (NODE))
 269
 270 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
 271    memory.  Used when a scalar constant is aliased or has its
 272    address taken.  */
 273 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
 274   GET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))
 275 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \
 276   SET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE), X)
 277
 278 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
 279    source of the decl.  */
 280 #define DECL_ORIGINAL_FIELD(NODE) \
 281   GET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))
 282 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \
 283   SET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE), X)
 284
 285 /* In a VAR_DECL, points to the object being renamed if the VAR_DECL is a
 286    renaming pointer, otherwise 0.  Note that this object is guaranteed to
 287    be protected against multiple evaluations.  */
 288 #define DECL_RENAMED_OBJECT(NODE) \
 289   GET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE))
 290 #define SET_DECL_RENAMED_OBJECT(NODE, X) \
 291   SET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE), X)
 292
 293 /* In a TYPE_DECL, points to the parallel type if any, otherwise 0.  */
 294 #define DECL_PARALLEL_TYPE(NODE) \
 295   GET_DECL_LANG_SPECIFIC (TYPE_DECL_CHECK (NODE))
 296 #define SET_DECL_PARALLEL_TYPE(NODE, X) \
 297   SET_DECL_LANG_SPECIFIC (TYPE_DECL_CHECK (NODE), X)
 298
 299 /* In a FUNCTION_DECL, points to the stub associated with the function
 300    if any, otherwise 0.  */
 301 #define DECL_FUNCTION_STUB(NODE) \
 302   GET_DECL_LANG_SPECIFIC (FUNCTION_DECL_CHECK (NODE))
 303 #define SET_DECL_FUNCTION_STUB(NODE, X) \
 304   SET_DECL_LANG_SPECIFIC (FUNCTION_DECL_CHECK (NODE), X)
 305
 306 /* In a FIELD_DECL corresponding to a discriminant, contains the
 307    discriminant number.  */
 308 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
 309
 310 /* Define fields and macros for statements.
 311
 312    Start by defining which tree codes are used for statements.  */
 313 #define IS_STMT(NODE)           (STATEMENT_CLASS_P (NODE))
 314 #define IS_ADA_STMT(NODE)       (IS_STMT (NODE)                         \
 315                                  && TREE_CODE (NODE) >= STMT_STMT)
 316
 317 #define STMT_STMT_STMT(NODE)    TREE_OPERAND_CHECK_CODE (NODE, STMT_STMT, 0)
 318 #define LOOP_STMT_TOP_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 0)
 319 #define LOOP_STMT_BOT_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 1)
 320 #define LOOP_STMT_UPDATE(NODE)  TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 2)
 321 #define LOOP_STMT_BODY(NODE)    TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 3)
 322 #define LOOP_STMT_LABEL(NODE)   TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 4)
 323 #define EXIT_STMT_COND(NODE)    TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 0)
 324 #define EXIT_STMT_LABEL(NODE)   TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 1)
 325 #define REGION_STMT_BODY(NODE)  TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 0)
 326 #define REGION_STMT_HANDLE(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 1)
 327 #define REGION_STMT_BLOCK(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 2)
 328 #define HANDLER_STMT_ARG(NODE) TREE_OPERAND_CHECK_CODE (NODE, HANDLER_STMT, 0)
 329 #define HANDLER_STMT_LIST(NODE) TREE_OPERAND_CHECK_CODE (NODE, HANDLER_STMT, 1)
 330 #define HANDLER_STMT_BLOCK(NODE) TREE_OPERAND_CHECK_CODE(NODE, HANDLER_STMT, 2)