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