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-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  ****************************************************************************/
  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 /* Ada uses the lang_decl and lang_type fields to hold a tree.  */
  37 union lang_tree_node GTY((desc ("0"))) {union tree_node GTY((tag ("0"))) t; };
  38 struct lang_decl GTY(()) {tree t; };
  39 struct lang_type GTY(()) {tree t; };
  40
  41 /* Define macros to get and set the tree in TYPE_ and DECL_LANG_SPECIFIC.  */
  42 #define GET_TYPE_LANG_SPECIFIC(NODE) \
  43   (TYPE_LANG_SPECIFIC (NODE) ? TYPE_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  44 #define SET_TYPE_LANG_SPECIFIC(NODE, X) \
  45  (TYPE_LANG_SPECIFIC (NODE)                     \
  46   = (TYPE_LANG_SPECIFIC (NODE)                  \
  47      ? TYPE_LANG_SPECIFIC (NODE) : ggc_alloc (sizeof (struct lang_type))))   \
  48  ->t = X;
  49
  50 #define GET_DECL_LANG_SPECIFIC(NODE) \
  51   (DECL_LANG_SPECIFIC (NODE) ? DECL_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  52 #define SET_DECL_LANG_SPECIFIC(NODE, VALUE)     \
  53  (DECL_LANG_SPECIFIC (NODE)                     \
  54   = (DECL_LANG_SPECIFIC (NODE)                  \
  55      ? DECL_LANG_SPECIFIC (NODE) : ggc_alloc (sizeof (struct lang_decl))))   \
  56  ->t = VALUE;
  57
  58 /* Flags added to GCC type nodes.  */
  59
  60 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is a
  61    record being used as a fat pointer (only true for RECORD_TYPE).  */
  62 #define TYPE_IS_FAT_POINTER_P(NODE) TYPE_LANG_FLAG_0 (NODE)
  63
  64 #define TYPE_FAT_POINTER_P(NODE)  \
  65   (TREE_CODE (NODE) == RECORD_TYPE && TYPE_IS_FAT_POINTER_P (NODE))
  66
  67 /* For integral types and array types, nonzero if this is a packed array type.
  68    Such types should not be extended to a larger size.  */
  69 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) TYPE_LANG_FLAG_0 (NODE)
  70
  71 #define TYPE_IS_PACKED_ARRAY_TYPE_P(NODE) \
  72   ((TREE_CODE (NODE) == INTEGER_TYPE || TREE_CODE (NODE) == ARRAY_TYPE) \
  73    && TYPE_PACKED_ARRAY_TYPE_P (NODE))
  74
  75 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that
  76    is not equal to two to the power of its mode's size.  */
  77 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE))
  78
  79 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of
  80    an Ada array other than the first.  */
  81 #define TYPE_MULTI_ARRAY_P(NODE)  TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE))
  82
  83 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an
  84    unconstrained array or record.  */
  85 #define TYPE_RETURNS_UNCONSTRAINED_P(NODE) \
  86   TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE))
  87
  88 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes
  89    a justified modular type (will only be true for RECORD_TYPE).  */
  90 #define TYPE_JUSTIFIED_MODULAR_P(NODE) \
  91   TYPE_LANG_FLAG_1 (RECORD_OR_UNION_CHECK (NODE))
  92
  93 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
  94    front-end.  */
  95 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
  96
  97 /* Nonzero for composite types if this is a by-reference type.  */
  98 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
  99
 100 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
 101    type for an object whose type includes its template in addition to
 102    its value (only true for RECORD_TYPE).  */
 103 #define TYPE_CONTAINS_TEMPLATE_P(NODE) \
 104   TYPE_LANG_FLAG_3 (RECORD_OR_UNION_CHECK (NODE))
 105
 106 /* For INTEGER_TYPE, nonzero if this really represents a VAX
 107    floating-point type.  */
 108 #define TYPE_VAX_FLOATING_POINT_P(NODE)  \
 109   TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE))
 110
 111 /* True if NODE is a thin pointer.  */
 112 #define TYPE_THIN_POINTER_P(NODE)                       \
 113   (POINTER_TYPE_P (NODE)                                \
 114    && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE       \
 115    && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE)))
 116
 117 /* True if TYPE is either a fat or thin pointer to an unconstrained
 118    array.  */
 119 #define TYPE_FAT_OR_THIN_POINTER_P(NODE) \
 120   (TYPE_FAT_POINTER_P (NODE) || TYPE_THIN_POINTER_P (NODE))
 121
 122 /* For INTEGER_TYPEs, nonzero if the type has a biased representation.  */
 123 #define TYPE_BIASED_REPRESENTATION_P(NODE) \
 124   TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE))
 125
 126 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran.  */
 127 #define TYPE_CONVENTION_FORTRAN_P(NODE) \
 128   TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE))
 129
 130 /* For FUNCTION_TYPEs, nonzero if the function returns by reference.  */
 131 #define TYPE_RETURNS_BY_REF_P(NODE) \
 132   TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE))
 133
 134 /* For FUNCTION_TYPEs, nonzero if function returns by being passed a pointer
 135    to a place to store its result.  */
 136 #define TYPE_RETURNS_BY_TARGET_PTR_P(NODE) \
 137   TYPE_LANG_FLAG_5 (FUNCTION_TYPE_CHECK (NODE))
 138
 139 /* For VOID_TYPE, ENUMERAL_TYPE, UNION_TYPE, and RECORD_TYPE, nonzero if this
 140    is a dummy type, made to correspond to a private or incomplete type.  */
 141 #define TYPE_DUMMY_P(NODE) TYPE_LANG_FLAG_4 (NODE)
 142
 143 /* True if TYPE is such a dummy type.  */
 144 #define TYPE_IS_DUMMY_P(NODE) \
 145   ((TREE_CODE (NODE) == VOID_TYPE || TREE_CODE (NODE) == RECORD_TYPE    \
 146     || TREE_CODE (NODE) == UNION_TYPE || TREE_CODE (NODE) == ENUMERAL_TYPE) \
 147    && TYPE_DUMMY_P (NODE))
 148
 149 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present.  */
 150 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
 151   TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
 152
 153 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
 154    padding or alignment.  */
 155 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
 156
 157 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada
 158    subprogram contains no parameters passed by copy in/copy out then this
 159    field is 0. Otherwise it points to a list of nodes used to specify the
 160    return values of the out (or in out) parameters that qualify to be passed
 161    by copy in copy out.  It is a CONSTRUCTOR.  For a full description of the
 162    cico parameter passing mechanism refer to the routine gnat_to_gnu_entity. */
 163 #define TYPE_CI_CO_LIST(NODE)  TYPE_LANG_SLOT_1 (FUNCTION_TYPE_CHECK (NODE))
 164
 165 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
 166    modulus. */
 167 #define TYPE_MODULUS(NODE) GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 168 #define SET_TYPE_MODULUS(NODE, X)  \
 169   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 170
 171 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, points to
 172    the type corresponding to the Ada index type.  */
 173 #define TYPE_INDEX_TYPE(NODE) \
 174   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 175 #define SET_TYPE_INDEX_TYPE(NODE, X) \
 176   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 177
 178 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, stores the
 179    Digits_Value.  */
 180 #define TYPE_DIGITS_VALUE(NODE) \
 181   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 182 #define SET_TYPE_DIGITS_VALUE(NODE, X)  \
 183   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 184
 185 /* For numeric types, stores the RM_Size of the type.  */
 186 #define TYPE_RM_SIZE_NUM(NODE)  TYPE_LANG_SLOT_1 (NUMERICAL_TYPE_CHECK (NODE))
 187
 188 #define TYPE_RM_SIZE(NODE)                                      \
 189   (INTEGRAL_TYPE_P (NODE) || TREE_CODE (NODE) == REAL_TYPE      \
 190    ? TYPE_RM_SIZE_NUM (NODE) : 0)
 191
 192 /* For a RECORD_TYPE that is a fat pointer, point to the type for the
 193    unconstrained object.  Likewise for a RECORD_TYPE that is pointed
 194    to by a thin pointer.  */
 195 #define TYPE_UNCONSTRAINED_ARRAY(NODE)  \
 196   GET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))
 197 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X)  \
 198   SET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE), X)
 199
 200 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada
 201    size of the object.  This differs from the GCC size in that it does not
 202    include any rounding up to the alignment of the type.  */
 203 #define TYPE_ADA_SIZE(NODE)   \
 204   GET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE))
 205 #define SET_TYPE_ADA_SIZE(NODE, X) \
 206   SET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE), X)
 207
 208 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
 209    the index type that should be used when the actual bounds are required for
 210    a template.  This is used in the case of packed arrays.  */
 211 #define TYPE_ACTUAL_BOUNDS(NODE)   \
 212   GET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE))
 213 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \
 214   SET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE), X)
 215
 216 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both
 217    the template and object.
 218
 219    ??? We also put this on an ENUMERAL_TYPE that's dummy.  Technically,
 220    this is a conflict on the minval field, but there doesn't seem to be
 221    simple fix, so we'll live with this kludge for now.  */
 222 #define TYPE_OBJECT_RECORD_TYPE(NODE) \
 223   (TREE_CHECK2 ((NODE), UNCONSTRAINED_ARRAY_TYPE, ENUMERAL_TYPE)->type.minval)
 224
 225 /* Nonzero in a FUNCTION_DECL that represents a stubbed function
 226    discriminant.  */
 227 #define DECL_STUBBED_P(NODE) DECL_LANG_FLAG_0 (FUNCTION_DECL_CHECK (NODE))
 228
 229 /* Nonzero if this decl is always used by reference; i.e., an INDIRECT_REF
 230    is needed to access the object.  */
 231 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (NODE)
 232
 233 /* Nonzero if this decl is a PARM_DECL for an Ada array being passed to a
 234    foreign convention subprogram.  */
 235 #define DECL_BY_COMPONENT_PTR_P(NODE) DECL_LANG_FLAG_2 (PARM_DECL_CHECK (NODE))
 236
 237 /* Nonzero in a FIELD_DECL that is a dummy built for some internal reason.  */
 238 #define DECL_INTERNAL_P(NODE) DECL_LANG_FLAG_3 (FIELD_DECL_CHECK (NODE))
 239
 240 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure.  */
 241 #define DECL_ELABORATION_PROC_P(NODE) \
 242   DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
 243
 244 /* Nonzero if this is a decl for a pointer that points to something which
 245    is readonly.  Used mostly for fat pointers.  */
 246 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
 247
 248 /* Nonzero in a FIELD_DECL if there was a record rep clause.  */
 249 #define DECL_HAS_REP_P(NODE) DECL_LANG_FLAG_5 (FIELD_DECL_CHECK (NODE))
 250
 251 /* Nonzero in a PARM_DECL if we are to pass by descriptor.  */
 252 #define DECL_BY_DESCRIPTOR_P(NODE) DECL_LANG_FLAG_5 (PARM_DECL_CHECK (NODE))
 253
 254 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
 255    memory.  Used when a scalar constant is aliased or has its
 256    address taken.  */
 257 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
 258   GET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))
 259 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \
 260   SET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE), X)
 261
 262 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
 263    source of the decl.  */
 264 #define DECL_ORIGINAL_FIELD(NODE) \
 265   GET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))
 266 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \
 267   SET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE), X)
 268
 269 /* In a FIELD_DECL corresponding to a discriminant, contains the
 270    discriminant number.  */
 271 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
 272
 273 /* Define fields and macros for statements.
 274
 275    Start by defining which tree codes are used for statements.  */
 276 #define IS_STMT(NODE)           (STATEMENT_CLASS_P (NODE))
 277 #define IS_ADA_STMT(NODE)       (IS_STMT (NODE)                         \
 278                                  && TREE_CODE (NODE) >= STMT_STMT)
 279
 280 #define STMT_STMT_STMT(NODE)    TREE_OPERAND_CHECK_CODE (NODE, STMT_STMT, 0)
 281 #define LOOP_STMT_TOP_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 0)
 282 #define LOOP_STMT_BOT_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 1)
 283 #define LOOP_STMT_UPDATE(NODE)  TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 2)
 284 #define LOOP_STMT_BODY(NODE)    TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 3)
 285 #define LOOP_STMT_LABEL(NODE)   TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 4)
 286 #define EXIT_STMT_COND(NODE)    TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 0)
 287 #define EXIT_STMT_LABEL(NODE)   TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 1)
 288 #define REGION_STMT_BODY(NODE)  TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 0)
 289 #define REGION_STMT_HANDLE(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 1)
 290 #define REGION_STMT_BLOCK(NODE) TREE_OPERAND_CHECK_CODE (NODE, REGION_STMT, 2)
 291 #define HANDLER_STMT_ARG(NODE) TREE_OPERAND_CHECK_CODE (NODE, HANDLER_STMT, 0)
 292 #define HANDLER_STMT_LIST(NODE) TREE_OPERAND_CHECK_CODE (NODE, HANDLER_STMT, 1)
 293 #define HANDLER_STMT_BLOCK(NODE) TREE_OPERAND_CHECK_CODE(NODE, HANDLER_STMT, 2)