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 /* 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) \
  99   TYPE_LANG_FLAG_1 (REC_OR_UNION_CHECK (NODE))
 100
 101 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
 102    front-end.  */
 103 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
 104
 105 /* Nonzero for composite types if this is a by-reference type.  */
 106 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
 107
 108 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
 109    type for an object whose type includes its template in addition to
 110    its value (only true for RECORD_TYPE).  */
 111 #define TYPE_CONTAINS_TEMPLATE_P(NODE) \
 112   TYPE_LANG_FLAG_3 (REC_OR_UNION_CHECK (NODE))
 113
 114 /* For INTEGER_TYPE, nonzero if this really represents a VAX
 115    floating-point type.  */
 116 #define TYPE_VAX_FLOATING_POINT_P(NODE)  \
 117   TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE))
 118
 119 /* True if NODE is a thin pointer.  */
 120 #define TYPE_THIN_POINTER_P(NODE)                       \
 121   (POINTER_TYPE_P (NODE)                                \
 122    && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE       \
 123    && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE)))
 124
 125 /* True if TYPE is either a fat or thin pointer to an unconstrained
 126    array.  */
 127 #define TYPE_FAT_OR_THIN_POINTER_P(NODE) \
 128   (TYPE_FAT_POINTER_P (NODE) || TYPE_THIN_POINTER_P (NODE))
 129
 130 /* For INTEGER_TYPEs, nonzero if the type has a biased representation.  */
 131 #define TYPE_BIASED_REPRESENTATION_P(NODE) \
 132   TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE))
 133
 134 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran.  */
 135 #define TYPE_CONVENTION_FORTRAN_P(NODE) \
 136   TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE))
 137
 138 /* For FUNCTION_TYPEs, nonzero if the function returns by reference.  */
 139 #define TYPE_RETURNS_BY_REF_P(NODE) \
 140   TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE))
 141
 142 /* For VOID_TYPE, ENUMERAL_TYPE, UNION_TYPE, and RECORD_TYPE, nonzero if this
 143    is a dummy type, made to correspond to a private or incomplete type.  */
 144 #define TYPE_DUMMY_P(NODE) TYPE_LANG_FLAG_4 (NODE)
 145
 146 /* True if TYPE is such a dummy type.  */
 147 #define TYPE_IS_DUMMY_P(NODE) \
 148   ((TREE_CODE (NODE) == VOID_TYPE || TREE_CODE (NODE) == RECORD_TYPE    \
 149     || TREE_CODE (NODE) == UNION_TYPE || TREE_CODE (NODE) == ENUMERAL_TYPE) \
 150    && TYPE_DUMMY_P (NODE))
 151
 152 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present.  */
 153 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
 154   TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
 155
 156 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
 157    padding or alignment.  */
 158 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
 159
 160 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada
 161    subprogram contains no parameters passed by copy in/copy out then this
 162    field is 0. Otherwise it points to a list of nodes used to specify the
 163    return values of the out (or in out) parameters that qualify to be passed
 164    by copy in copy out.  It is a CONSTRUCTOR.  For a full description of the
 165    cico parameter passing mechanism refer to the routine gnat_to_gnu_entity. */
 166 #define TYPE_CI_CO_LIST(NODE)   \
 167   (&TYPE_LANG_SPECIFIC (FUNCTION_TYPE_CHECK (NODE))->t.generic)
 168 #define SET_TYPE_CI_CO_LIST(NODE, X)   \
 169   (TYPE_LANG_SPECIFIC (FUNCTION_TYPE_CHECK (NODE)) = (struct lang_type *)(X))
 170
 171 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
 172    modulus. */
 173 #define TYPE_MODULUS(NODE)  \
 174   (&TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))->t.generic)
 175 #define SET_TYPE_MODULUS(NODE, X)  \
 176   (TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE)) = (struct lang_type *)(X))
 177
 178 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, points to
 179    the type corresponding to the Ada index type.  */
 180 #define TYPE_INDEX_TYPE(NODE)   \
 181   (&TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))->t.generic)
 182 #define SET_TYPE_INDEX_TYPE(NODE, X)    \
 183   (TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE)) = (struct lang_type *) (X))
 184
 185 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, stores the
 186    Digits_Value.  */
 187 #define TYPE_DIGITS_VALUE(NODE) \
 188   (&TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))->t.generic)
 189 #define SET_TYPE_DIGITS_VALUE(NODE, X)  \
 190   (TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE)) = (struct lang_type *) (X))
 191
 192 /* For INTEGER_TYPE, stores the RM_Size of the type.  */
 193 #define TYPE_RM_SIZE_INT(NODE)  (INTEGER_TYPE_CHECK (NODE)->type.values)
 194
 195 /* Likewise for ENUMERAL_TYPE.  */
 196 #define TYPE_RM_SIZE_ENUM(NODE) \
 197   (&TYPE_LANG_SPECIFIC (ENUMERAL_TYPE_CHECK (NODE))->t.generic)
 198 #define SET_TYPE_RM_SIZE_ENUM(NODE, X)  \
 199   (TYPE_LANG_SPECIFIC (ENUMERAL_TYPE_CHECK (NODE)) = (struct lang_type *)(X))
 200
 201 #define TYPE_RM_SIZE(NODE)                                      \
 202   (TREE_CODE (NODE) == ENUMERAL_TYPE ? TYPE_RM_SIZE_ENUM (NODE) \
 203    : TREE_CODE (NODE) == INTEGER_TYPE ? TYPE_RM_SIZE_INT (NODE) \
 204    : 0)
 205
 206 /* For a RECORD_TYPE that is a fat pointer, point to the type for the
 207    unconstrained object.  Likewise for a RECORD_TYPE that is pointed
 208    to by a thin pointer.  */
 209 #define TYPE_UNCONSTRAINED_ARRAY(NODE)  \
 210   (&TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))->t.generic)
 211 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X)  \
 212   (TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE)) = (struct lang_type *)(X))
 213
 214 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada
 215    size of the object.  This differs from the GCC size in that it does not
 216    include any rounding up to the alignment of the type.  */
 217 #define TYPE_ADA_SIZE(NODE)     (&TYPE_LANG_SPECIFIC (NODE)->t.generic)
 218 #define SET_TYPE_ADA_SIZE(NODE, X) \
 219   (TYPE_LANG_SPECIFIC (NODE) = (struct lang_type *)(X))
 220
 221 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
 222    the index type that should be used when the actual bounds are required for
 223    a template.  This is used in the case of packed arrays.  */
 224 #define TYPE_ACTUAL_BOUNDS(NODE)   (&TYPE_LANG_SPECIFIC (NODE)->t.generic)
 225 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \
 226   (TYPE_LANG_SPECIFIC (NODE) = (struct lang_type *)(X))
 227
 228 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both
 229    the template and object.
 230
 231    ??? We also put this on an ENUMERAL_TYPE that's dummy.  Technically,
 232    this is a conflict on the minval field, but there doesn't seem to be
 233    simple fix, so we'll live with this kludge for now.  */
 234 #define TYPE_OBJECT_RECORD_TYPE(NODE) \
 235   (TREE_CHECK2 ((NODE), UNCONSTRAINED_ARRAY_TYPE, ENUMERAL_TYPE)->type.minval)
 236
 237 /* Nonzero in a FUNCTION_DECL that represents a stubbed function
 238    discriminant.  */
 239 #define DECL_STUBBED_P(NODE) DECL_LANG_FLAG_0 (FUNCTION_DECL_CHECK (NODE))
 240
 241 /* Nonzero if this decl is always used by reference; i.e., an INDIRECT_REF
 242    is needed to access the object.  */
 243 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (NODE)
 244
 245 /* Nonzero if this decl is a PARM_DECL for an Ada array being passed to a
 246    foreign convention subprogram.  */
 247 #define DECL_BY_COMPONENT_PTR_P(NODE) DECL_LANG_FLAG_2 (PARM_DECL_CHECK (NODE))
 248
 249 /* Nonzero in a FIELD_DECL that is a dummy built for some internal reason.  */
 250 #define DECL_INTERNAL_P(NODE) DECL_LANG_FLAG_3 (FIELD_DECL_CHECK (NODE))
 251
 252 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure.  */
 253 #define DECL_ELABORATION_PROC_P(NODE) \
 254   DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
 255
 256 /* Nonzero if this is a decl for a pointer that points to something which
 257    is readonly.  Used mostly for fat pointers.  */
 258 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
 259
 260 /* Nonzero in a FIELD_DECL if there was a record rep clause.  */
 261 #define DECL_HAS_REP_P(NODE) DECL_LANG_FLAG_5 (FIELD_DECL_CHECK (NODE))
 262
 263 /* Nonzero in a PARM_DECL if we are to pass by descriptor.  */
 264 #define DECL_BY_DESCRIPTOR_P(NODE) DECL_LANG_FLAG_5 (PARM_DECL_CHECK (NODE))
 265
 266 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
 267    memory.  Used when a scalar constant is aliased or has its
 268    address taken.  */
 269 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
 270   (&DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))->t.generic)
 271 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \
 272   (DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE)) = (struct lang_decl *)(X))
 273
 274 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
 275    source of the decl.  */
 276 #define DECL_ORIGINAL_FIELD(NODE) \
 277   (&DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))->t.generic)
 278 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \
 279   (DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE)) = (struct lang_decl *)(X))
 280
 281 /* In a FIELD_DECL corresponding to a discriminant, contains the
 282    discriminant number.  */
 283 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
 284
 285 /* This is the loop id for a GNAT_LOOP_ID node.  */
 286 #define TREE_LOOP_ID(NODE) \
 287   ((union lang_tree_node *) GNAT_LOOP_ID_CHECK (NODE))->loop_id.loop_id
 288
 289 /* Define fields and macros for statements.
 290
 291    Start by defining which tree codes are used for statements.  */
 292 #define IS_STMT(NODE)           (TREE_CODE_CLASS (TREE_CODE (NODE)) == 's')
 293
 294 /* We store the Sloc in statement nodes.  */
 295 #define TREE_SLOC(NODE)         TREE_COMPLEXITY (STMT_CHECK (NODE))
 296
 297 #define EXPR_STMT_EXPR(NODE)    TREE_OPERAND_CHECK_CODE (NODE, EXPR_STMT, 0)
 298 #define BLOCK_STMT_LIST(NODE)   TREE_OPERAND_CHECK_CODE (NODE, BLOCK_STMT, 0)
 299 #define IF_STMT_COND(NODE)      TREE_OPERAND_CHECK_CODE (NODE, IF_STMT, 0)
 300 #define IF_STMT_TRUE(NODE)      TREE_OPERAND_CHECK_CODE (NODE, IF_STMT, 1)
 301 #define IF_STMT_ELSEIF(NODE)    TREE_OPERAND_CHECK_CODE (NODE, IF_STMT, 2)
 302 #define IF_STMT_ELSE(NODE)      TREE_OPERAND_CHECK_CODE (NODE, IF_STMT, 3)
 303 #define GOTO_STMT_LABEL(NODE)   TREE_OPERAND_CHECK_CODE (NODE, GOTO_STMT, 0)
 304 #define LABEL_STMT_LABEL(NODE)  TREE_OPERAND_CHECK_CODE (NODE, LABEL_STMT, 0)
 305 #define RETURN_STMT_EXPR(NODE)  TREE_OPERAND_CHECK_CODE (NODE, RETURN_STMT, 0)
 306 #define ASM_STMT_TEMPLATE(NODE) TREE_OPERAND_CHECK_CODE (NODE, ASM_STMT, 0)
 307 #define ASM_STMT_OUTPUT(NODE)   TREE_OPERAND_CHECK_CODE (NODE, ASM_STMT, 1)
 308 #define ASM_STMT_ORIG_OUT(NODE) TREE_OPERAND_CHECK_CODE (NODE, ASM_STMT, 2)
 309 #define ASM_STMT_INPUT(NODE)    TREE_OPERAND_CHECK_CODE (NODE, ASM_STMT, 3)
 310 #define ASM_STMT_CLOBBER(NODE)  TREE_OPERAND_CHECK_CODE (NODE, ASM_STMT, 4)