gcc/ada/gcc-interface/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-2009, 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 /* The resulting tree type.  */
  27 union GTY((desc ("0"),
  28            chain_next ("(union lang_tree_node *)TREE_CHAIN (&%h.generic)")))
  29   lang_tree_node
  30 {
  31   union tree_node GTY((tag ("0"),
  32                        desc ("tree_node_structure (&%h)"))) generic;
  33 };
  34
  35 /* Ada uses the lang_decl and lang_type fields to hold a tree.  */
  36 struct GTY(()) lang_type { tree t; };
  37 struct GTY(()) lang_decl { tree t; };
  38
  39 /* Macros to get and set the tree in TYPE_LANG_SPECIFIC.  */
  40 #define GET_TYPE_LANG_SPECIFIC(NODE) \
  41   (TYPE_LANG_SPECIFIC (NODE) ? TYPE_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  42
  43 #define SET_TYPE_LANG_SPECIFIC(NODE, X) \
  44   (TYPE_LANG_SPECIFIC (NODE)            \
  45    = (TYPE_LANG_SPECIFIC (NODE)         \
  46       ? TYPE_LANG_SPECIFIC (NODE) : GGC_NEW (struct lang_type)))->t = (X)
  47
  48 /* Macros to get and set the tree in DECL_LANG_SPECIFIC.  */
  49 #define GET_DECL_LANG_SPECIFIC(NODE) \
  50   (DECL_LANG_SPECIFIC (NODE) ? DECL_LANG_SPECIFIC (NODE)->t : NULL_TREE)
  51
  52 #define SET_DECL_LANG_SPECIFIC(NODE, X) \
  53   (DECL_LANG_SPECIFIC (NODE)            \
  54    = (DECL_LANG_SPECIFIC (NODE)         \
  55       ? DECL_LANG_SPECIFIC (NODE) : GGC_NEW (struct lang_decl)))->t = (X)
  56
  57
  58 /* Flags added to 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) \
  63   TYPE_LANG_FLAG_0 (RECORD_OR_UNION_CHECK (NODE))
  64
  65 #define TYPE_FAT_POINTER_P(NODE) \
  66   (TREE_CODE (NODE) == RECORD_TYPE && TYPE_IS_FAT_POINTER_P (NODE))
  67
  68 /* For integral types and array types, nonzero if this is a packed array type
  69    used for bit-packed types.  Such types should not be extended to a larger
  70    size or validated against a specified size.  */
  71 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) TYPE_LANG_FLAG_0 (NODE)
  72
  73 #define TYPE_IS_PACKED_ARRAY_TYPE_P(NODE) \
  74   ((TREE_CODE (NODE) == INTEGER_TYPE || TREE_CODE (NODE) == ARRAY_TYPE) \
  75    && TYPE_PACKED_ARRAY_TYPE_P (NODE))
  76
  77 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that
  78    is not equal to two to the power of its mode's size.  */
  79 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE))
  80
  81 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of
  82    an Ada array other than the first.  */
  83 #define TYPE_MULTI_ARRAY_P(NODE) TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE))
  84
  85 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an
  86    unconstrained array or record.  */
  87 #define TYPE_RETURNS_UNCONSTRAINED_P(NODE) \
  88   TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE))
  89
  90 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes
  91    a justified modular type (will only be true for RECORD_TYPE).  */
  92 #define TYPE_JUSTIFIED_MODULAR_P(NODE) \
  93   TYPE_LANG_FLAG_1 (RECORD_OR_UNION_CHECK (NODE))
  94
  95 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
  96    front-end.  */
  97 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
  98
  99 /* Nonzero for composite types if this is a by-reference type.  */
 100 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
 101
 102 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
 103    type for an object whose type includes its template in addition to
 104    its value (only true for RECORD_TYPE).  */
 105 #define TYPE_CONTAINS_TEMPLATE_P(NODE) \
 106   TYPE_LANG_FLAG_3 (RECORD_OR_UNION_CHECK (NODE))
 107
 108 /* For INTEGER_TYPE, nonzero if this really represents a VAX
 109    floating-point type.  */
 110 #define TYPE_VAX_FLOATING_POINT_P(NODE) \
 111   TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE))
 112
 113 /* True if NODE is a thin pointer.  */
 114 #define TYPE_THIN_POINTER_P(NODE)                       \
 115   (POINTER_TYPE_P (NODE)                                \
 116    && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE       \
 117    && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE)))
 118
 119 /* True if TYPE is either a fat or thin pointer to an unconstrained
 120    array.  */
 121 #define TYPE_FAT_OR_THIN_POINTER_P(NODE) \
 122   (TYPE_FAT_POINTER_P (NODE) || TYPE_THIN_POINTER_P (NODE))
 123
 124 /* For INTEGER_TYPEs, nonzero if the type has a biased representation.  */
 125 #define TYPE_BIASED_REPRESENTATION_P(NODE) \
 126   TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE))
 127
 128 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran.  */
 129 #define TYPE_CONVENTION_FORTRAN_P(NODE) \
 130   TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE))
 131
 132 /* For FUNCTION_TYPEs, nonzero if the function returns by reference.  */
 133 #define TYPE_RETURNS_BY_REF_P(NODE) \
 134   TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE))
 135
 136 /* For VOID_TYPE, ENUMERAL_TYPE, UNION_TYPE, and RECORD_TYPE, nonzero if this
 137    is a dummy type, made to correspond to a private or incomplete type.  */
 138 #define TYPE_DUMMY_P(NODE) TYPE_LANG_FLAG_4 (NODE)
 139
 140 /* True if TYPE is such a dummy type.  */
 141 #define TYPE_IS_DUMMY_P(NODE) \
 142   ((TREE_CODE (NODE) == VOID_TYPE || TREE_CODE (NODE) == RECORD_TYPE    \
 143     || TREE_CODE (NODE) == UNION_TYPE || TREE_CODE (NODE) == ENUMERAL_TYPE) \
 144    && TYPE_DUMMY_P (NODE))
 145
 146 /* For FUNCTION_TYPEs, nonzero if function returns by being passed a pointer
 147    to a place to store its result.  */
 148 #define TYPE_RETURNS_BY_TARGET_PTR_P(NODE) \
 149   TYPE_LANG_FLAG_5 (FUNCTION_TYPE_CHECK (NODE))
 150
 151 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present.  */
 152 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
 153   TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
 154
 155 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
 156    padding or alignment.  */
 157 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
 158
 159 /* True if TYPE can alias any other types.  */
 160 #define TYPE_UNIVERSAL_ALIASING_P(NODE) TYPE_LANG_FLAG_6 (NODE)
 161
 162 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada subprogram
 163    contains no parameters passed by copy in/copy out then this field is zero.
 164    Otherwise it points to a list of nodes used to specify the return values
 165    of the out (or in out) parameters that qualify to be passed by copy in/
 166    copy out. For a full description of the copy in/copy out parameter passing
 167    mechanism refer to the routine gnat_to_gnu_entity. */
 168 #define TYPE_CI_CO_LIST(NODE) TYPE_LANG_SLOT_1 (FUNCTION_TYPE_CHECK (NODE))
 169
 170 /* For integral types, this is the RM size of the type.  */
 171 #define TYPE_RM_SIZE(NODE) \
 172   TYPE_LANG_SLOT_1 (TREE_CHECK3 (NODE, ENUMERAL_TYPE, BOOLEAN_TYPE, INTEGER_TYPE))
 173
 174 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both
 175    the template and object.
 176
 177    ??? We also put this on an ENUMERAL_TYPE that's dummy.  Technically,
 178    this is a conflict on the minval field, but there doesn't seem to be
 179    simple fix, so we'll live with this kludge for now.  */
 180 #define TYPE_OBJECT_RECORD_TYPE(NODE) \
 181   (TREE_CHECK2 ((NODE), UNCONSTRAINED_ARRAY_TYPE, ENUMERAL_TYPE)->type.minval)
 182
 183 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
 184    modulus. */
 185 #define TYPE_MODULUS(NODE) GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 186 #define SET_TYPE_MODULUS(NODE, X) \
 187   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 188
 189 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, this is the
 190    Digits_Value.  */
 191 #define TYPE_DIGITS_VALUE(NODE) \
 192   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 193 #define SET_TYPE_DIGITS_VALUE(NODE, X) \
 194   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 195
 196 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, this is
 197    the type corresponding to the Ada index type.  */
 198 #define TYPE_INDEX_TYPE(NODE) \
 199   GET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 200 #define SET_TYPE_INDEX_TYPE(NODE, X) \
 201   SET_TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE), X)
 202
 203 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
 204    the index type that should be used when the actual bounds are required for
 205    a template.  This is used in the case of packed arrays.  */
 206 #define TYPE_ACTUAL_BOUNDS(NODE) \
 207   GET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE))
 208 #define SET_TYPE_ACTUAL_BOUNDS(NODE, X) \
 209   SET_TYPE_LANG_SPECIFIC (TREE_CHECK2 (NODE, INTEGER_TYPE, ARRAY_TYPE), X)
 210
 211 /* For a RECORD_TYPE that is a fat pointer, point to the type for the
 212    unconstrained object.  Likewise for a RECORD_TYPE that is pointed
 213    to by a thin pointer.  */
 214 #define TYPE_UNCONSTRAINED_ARRAY(NODE) \
 215   GET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))
 216 #define SET_TYPE_UNCONSTRAINED_ARRAY(NODE, X) \
 217   SET_TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE), X)
 218
 219 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada
 220    size of the object.  This differs from the GCC size in that it does not
 221    include any rounding up to the alignment of the type.  */
 222 #define TYPE_ADA_SIZE(NODE) \
 223   GET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE))
 224 #define SET_TYPE_ADA_SIZE(NODE, X) \
 225   SET_TYPE_LANG_SPECIFIC (RECORD_OR_UNION_CHECK (NODE), X)
 226
 227
 228 /* Flags added to decl nodes.  */
 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 in a VAR_DECL if it is guaranteed to be constant after having
 235    been elaborated and TREE_READONLY is not set on it.  */
 236 #define DECL_READONLY_ONCE_ELAB(NODE) DECL_LANG_FLAG_0 (VAR_DECL_CHECK (NODE))
 237
 238 /* Nonzero if this decl is always used by reference; i.e., an INDIRECT_REF
 239    is needed to access the object.  */
 240 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (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 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_3 (PARM_DECL_CHECK (NODE))
 248
 249 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure.  */
 250 #define DECL_ELABORATION_PROC_P(NODE) \
 251   DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
 252
 253 /* Nonzero if this is a decl for a pointer that points to something which
 254    is readonly.  Used mostly for fat pointers.  */
 255 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
 256
 257 /* Nonzero in a PARM_DECL if we are to pass by descriptor.  */
 258 #define DECL_BY_DESCRIPTOR_P(NODE) DECL_LANG_FLAG_5 (PARM_DECL_CHECK (NODE))
 259
 260 /* Nonzero in a VAR_DECL if it is a pointer renaming a global object.  */
 261 #define DECL_RENAMING_GLOBAL_P(NODE) DECL_LANG_FLAG_5 (VAR_DECL_CHECK (NODE))
 262
 263 /* In a FIELD_DECL corresponding to a discriminant, contains the
 264    discriminant number.  */
 265 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
 266
 267 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
 268    memory.  Used when a scalar constant is aliased or has its
 269    address taken.  */
 270 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
 271   GET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))
 272 #define SET_DECL_CONST_CORRESPONDING_VAR(NODE, X) \
 273   SET_DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE), X)
 274
 275 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
 276    source of the decl.  */
 277 #define DECL_ORIGINAL_FIELD(NODE) \
 278   GET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))
 279 #define SET_DECL_ORIGINAL_FIELD(NODE, X) \
 280   SET_DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE), X)
 281
 282 /* In a VAR_DECL, points to the object being renamed if the VAR_DECL is a
 283    renaming pointer, otherwise 0.  Note that this object is guaranteed to
 284    be protected against multiple evaluations.  */
 285 #define DECL_RENAMED_OBJECT(NODE) \
 286   GET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE))
 287 #define SET_DECL_RENAMED_OBJECT(NODE, X) \
 288   SET_DECL_LANG_SPECIFIC (VAR_DECL_CHECK (NODE), X)
 289
 290 /* In a TYPE_DECL, points to the parallel type if any, otherwise 0.  */
 291 #define DECL_PARALLEL_TYPE(NODE) \
 292   GET_DECL_LANG_SPECIFIC (TYPE_DECL_CHECK (NODE))
 293 #define SET_DECL_PARALLEL_TYPE(NODE, X) \
 294   SET_DECL_LANG_SPECIFIC (TYPE_DECL_CHECK (NODE), X)
 295
 296 /* In a FUNCTION_DECL, points to the stub associated with the function
 297    if any, otherwise 0.  */
 298 #define DECL_FUNCTION_STUB(NODE) \
 299   GET_DECL_LANG_SPECIFIC (FUNCTION_DECL_CHECK (NODE))
 300 #define SET_DECL_FUNCTION_STUB(NODE, X) \
 301   SET_DECL_LANG_SPECIFIC (FUNCTION_DECL_CHECK (NODE), X)
 302
 303 /* In a PARM_DECL, points to the alternate TREE_TYPE.  */
 304 #define DECL_PARM_ALT_TYPE(NODE) \
 305   GET_DECL_LANG_SPECIFIC (PARM_DECL_CHECK (NODE))
 306 #define SET_DECL_PARM_ALT_TYPE(NODE, X) \
 307   SET_DECL_LANG_SPECIFIC (PARM_DECL_CHECK (NODE), X)
 308
 309
 310 /* Fields and macros for statements.  */
 311 #define IS_ADA_STMT(NODE) \
 312   (STATEMENT_CLASS_P (NODE) && TREE_CODE (NODE) >= STMT_STMT)
 313
 314 #define STMT_STMT_STMT(NODE)     TREE_OPERAND_CHECK_CODE (NODE, STMT_STMT, 0)
 315 #define LOOP_STMT_TOP_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 0)
 316 #define LOOP_STMT_BOT_COND(NODE) TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 1)
 317 #define LOOP_STMT_UPDATE(NODE)   TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 2)
 318 #define LOOP_STMT_BODY(NODE)     TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 3)
 319 #define LOOP_STMT_LABEL(NODE)    TREE_OPERAND_CHECK_CODE (NODE, LOOP_STMT, 4)
 320 #define EXIT_STMT_COND(NODE)     TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 0)
 321 #define EXIT_STMT_LABEL(NODE)    TREE_OPERAND_CHECK_CODE (NODE, EXIT_STMT, 1)