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  *                                                                          *
  10  *          Copyright (C) 1992-2001 Free Software Foundation, Inc.          *
  11  *                                                                          *
  12  * GNAT is free software;  you can  redistribute it  and/or modify it under *
  13  * terms of the  GNU General Public License as published  by the Free Soft- *
  14  * ware  Foundation;  either version 2,  or (at your option) any later ver- *
  15  * sion.  GNAT is distributed in the hope that it will be useful, but WITH- *
  16  * OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY *
  17  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License *
  18  * for  more details.  You should have  received  a copy of the GNU General *
  19  * Public License  distributed with GNAT;  see file COPYING.  If not, write *
  20  * to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, *
  21  * MA 02111-1307, USA.                                                      *
  22  *                                                                          *
  23  * GNAT was originally developed  by the GNAT team at  New York University. *
  24  * It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). *
  25  *                                                                          *
  26  ****************************************************************************/
  27
  28 /* Ada language-specific GC tree codes.  */
  29 #define DEFTREECODE(SYM, NAME, TYPE, LENGTH) SYM,
  30 enum gnat_tree_code {
  31   __DUMMY = LAST_AND_UNUSED_TREE_CODE,
  32 #include "ada-tree.def"
  33   LAST_GNAT_TREE_CODE
  34 };
  35 #undef DEFTREECODE
  36
  37 /* Flags added to GCC type nodes.  */
  38
  39 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is a
  40    record being used as a fat pointer (only true for RECORD_TYPE).  */
  41 #define TYPE_IS_FAT_POINTER_P(NODE) TYPE_LANG_FLAG_0 (NODE)
  42
  43 #define TYPE_FAT_POINTER_P(NODE)  \
  44   (TREE_CODE (NODE) == RECORD_TYPE && TYPE_IS_FAT_POINTER_P (NODE))
  45
  46 /* For integral types, nonzero if this is a packed array type.  Such
  47    types should not be extended to a larger size.  */
  48 #define TYPE_PACKED_ARRAY_TYPE_P(NODE) TYPE_LANG_FLAG_0 (NODE)
  49
  50 /* For INTEGER_TYPE, nonzero if this is a modular type with a modulus that
  51    is not equal to two to the power of its mode's size.  */
  52 #define TYPE_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (INTEGER_TYPE_CHECK (NODE))
  53
  54 /* For ARRAY_TYPE, nonzero if this type corresponds to a dimension of
  55    an Ada array other than the first.  */
  56 #define TYPE_MULTI_ARRAY_P(NODE)  TYPE_LANG_FLAG_1 (ARRAY_TYPE_CHECK (NODE))
  57
  58 /* For FUNCTION_TYPE, nonzero if this denotes a function returning an
  59    unconstrained array or record.  */
  60 #define TYPE_RETURNS_UNCONSTRAINED_P(NODE) \
  61   TYPE_LANG_FLAG_1 (FUNCTION_TYPE_CHECK (NODE))
  62
  63 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this denotes
  64    a left-justified modular type (will only be true for RECORD_TYPE).  */
  65 #define TYPE_LEFT_JUSTIFIED_MODULAR_P(NODE) TYPE_LANG_FLAG_1 (NODE)
  66
  67 /* Nonzero in an arithmetic subtype if this is a subtype not known to the
  68    front-end.  */
  69 #define TYPE_EXTRA_SUBTYPE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
  70
  71 /* Nonzero for composite types if this is a by-reference type.  */
  72 #define TYPE_BY_REFERENCE_P(NODE) TYPE_LANG_FLAG_2 (NODE)
  73
  74 /* For RECORD_TYPE, UNION_TYPE, and QUAL_UNION_TYPE, nonzero if this is the
  75    type for an object whose type includes its template in addition to
  76    its value (only true for RECORD_TYPE).  */
  77 #define TYPE_CONTAINS_TEMPLATE_P(NODE) TYPE_LANG_FLAG_3 (NODE)
  78
  79 /* For INTEGER_TYPE, nonzero if this really represents a VAX
  80    floating-point type.  */
  81 #define TYPE_VAX_FLOATING_POINT_P(NODE)  \
  82   TYPE_LANG_FLAG_3 (INTEGER_TYPE_CHECK (NODE))
  83
  84 /* True if NODE is a thin pointer.  */
  85 #define TYPE_THIN_POINTER_P(NODE)                       \
  86   (POINTER_TYPE_P (NODE)                                \
  87    && TREE_CODE (TREE_TYPE (NODE)) == RECORD_TYPE       \
  88    && TYPE_CONTAINS_TEMPLATE_P (TREE_TYPE (NODE)))
  89
  90 /* True if TYPE is either a fat or thin pointer to an unconstrained
  91    array.  */
  92 #define TYPE_FAT_OR_THIN_POINTER_P(NODE) \
  93   (TYPE_FAT_POINTER_P (NODE) || TYPE_THIN_POINTER_P (NODE))
  94
  95 /* For INTEGER_TYPEs, nonzero if the type has a biased representation.  */
  96 #define TYPE_BIASED_REPRESENTATION_P(NODE) \
  97   TYPE_LANG_FLAG_4 (INTEGER_TYPE_CHECK (NODE))
  98
  99 /* For ARRAY_TYPEs, nonzero if the array type has Convention_Fortran.  */
 100 #define TYPE_CONVENTION_FORTRAN_P(NODE) \
 101   TYPE_LANG_FLAG_4 (ARRAY_TYPE_CHECK (NODE))
 102
 103 /* For FUNCTION_TYPEs, nonzero if the function returns by reference.  */
 104 #define TYPE_RETURNS_BY_REF_P(NODE) \
 105   TYPE_LANG_FLAG_4 (FUNCTION_TYPE_CHECK (NODE))
 106
 107 /* For VOID_TYPE, ENUMERAL_TYPE, UNION_TYPE, and RECORD_TYPE, nonzero if this
 108    is a dummy type, made to correspond to a private or incomplete type.  */
 109 #define TYPE_DUMMY_P(NODE) TYPE_LANG_FLAG_4 (NODE)
 110
 111 /* True if TYPE is such a dummy type.  */
 112 #define TYPE_IS_DUMMY_P(NODE) \
 113   ((TREE_CODE (NODE) == VOID_TYPE || TREE_CODE (NODE) == RECORD_TYPE    \
 114     || TREE_CODE (NODE) == UNION_TYPE || TREE_CODE (NODE) == ENUMERAL_TYPE) \
 115    && TYPE_DUMMY_P (NODE))
 116
 117 /* For an INTEGER_TYPE, nonzero if TYPE_ACTUAL_BOUNDS is present.  */
 118 #define TYPE_HAS_ACTUAL_BOUNDS_P(NODE) \
 119   TYPE_LANG_FLAG_5 (INTEGER_TYPE_CHECK (NODE))
 120
 121 /* For a RECORD_TYPE, nonzero if this was made just to supply needed
 122    padding or alignment.  */
 123 #define TYPE_IS_PADDING_P(NODE) TYPE_LANG_FLAG_5 (RECORD_TYPE_CHECK (NODE))
 124
 125 /* This field is only defined for FUNCTION_TYPE nodes. If the Ada
 126    subprogram contains no parameters passed by copy in/copy out then this
 127    field is 0. Otherwise it points to a list of nodes used to specify the
 128    return values of the out (or in out) parameters that qualify to be passed
 129    by copy in copy out.  It is a CONSTRUCTOR.  For a full description of the
 130    cico parameter passing mechanism refer to the routine gnat_to_gnu_entity. */
 131 #define TYPE_CI_CO_LIST(NODE)   \
 132   (tree) TYPE_LANG_SPECIFIC (FUNCTION_TYPE_CHECK (NODE))
 133
 134 /* For an INTEGER_TYPE with TYPE_MODULAR_P, this is the value of the
 135    modulus. */
 136 #define TYPE_MODULUS(NODE)  \
 137   (tree) TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 138
 139 /* For an INTEGER_TYPE that is the TYPE_DOMAIN of some ARRAY_TYPE, points to
 140    the type corresponding to the Ada index type.  */
 141 #define TYPE_INDEX_TYPE(NODE)   \
 142   (tree) TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 143
 144 /* For an INTEGER_TYPE with TYPE_VAX_FLOATING_POINT_P, stores the
 145    Digits_Value.  */
 146 #define TYPE_DIGITS_VALUE(NODE)  \
 147   (long) TYPE_LANG_SPECIFIC (INTEGER_TYPE_CHECK (NODE))
 148
 149 /* For INTEGER_TYPE, stores the RM_Size of the type.  */
 150 #define TYPE_RM_SIZE_INT(NODE)  TYPE_VALUES (INTEGER_TYPE_CHECK (NODE))
 151
 152 /* Likewise for ENUMERAL_TYPE.  */
 153 #define TYPE_RM_SIZE_ENUM(NODE) \
 154   (tree) TYPE_LANG_SPECIFIC (ENUMERAL_TYPE_CHECK (NODE))
 155
 156 #define TYPE_RM_SIZE(NODE)                                      \
 157   (TREE_CODE (NODE) == ENUMERAL_TYPE ? TYPE_RM_SIZE_ENUM (NODE) \
 158    : TREE_CODE (NODE) == INTEGER_TYPE ? TYPE_RM_SIZE_INT (NODE) \
 159    : 0)
 160
 161 /* For a RECORD_TYPE that is a fat pointer, point to the type for the
 162    unconstrained object.  Likewise for a RECORD_TYPE that is pointed
 163    to by a thin pointer.  */
 164 #define TYPE_UNCONSTRAINED_ARRAY(NODE)  \
 165   (tree) TYPE_LANG_SPECIFIC (RECORD_TYPE_CHECK (NODE))
 166
 167 /* For other RECORD_TYPEs and all UNION_TYPEs and QUAL_UNION_TYPEs, the Ada
 168    size of the object.  This differs from the GCC size in that it does not
 169    include any rounding up to the alignment of the type.  */
 170 #define TYPE_ADA_SIZE(NODE)     (tree) TYPE_LANG_SPECIFIC (NODE)
 171
 172 /* For an INTEGER_TYPE with TYPE_HAS_ACTUAL_BOUNDS_P or an ARRAY_TYPE, this is
 173    the index type that should be used when the actual bounds are required for
 174    a template.  This is used in the case of packed arrays.  */
 175 #define TYPE_ACTUAL_BOUNDS(NODE)   (tree) TYPE_LANG_SPECIFIC (NODE)
 176
 177 /* In an UNCONSTRAINED_ARRAY_TYPE, points to the record containing both
 178    the template and object.  */
 179 #define TYPE_OBJECT_RECORD_TYPE(NODE) TYPE_MIN_VALUE (NODE)
 180
 181 /* Nonzero in a FUNCTION_DECL that represents a stubbed function
 182    discriminant.  */
 183 #define DECL_STUBBED_P(NODE) DECL_LANG_FLAG_0 (FUNCTION_DECL_CHECK (NODE))
 184
 185 /* Nonzero if this decl is always used by reference; i.e., an INDIRECT_REF
 186    is needed to access the object.  */
 187 #define DECL_BY_REF_P(NODE) DECL_LANG_FLAG_1 (NODE)
 188
 189 /* Nonzero if this decl is a PARM_DECL for an Ada array being passed to a
 190    foreign convention subprogram.  */
 191 #define DECL_BY_COMPONENT_PTR_P(NODE) DECL_LANG_FLAG_2 (NODE)
 192
 193 /* Nonzero in a FIELD_DECL that is a dummy built for some internal reason.  */
 194 #define DECL_INTERNAL_P(NODE) DECL_LANG_FLAG_3 (FIELD_DECL_CHECK (NODE))
 195
 196 /* Nonzero in a FUNCTION_DECL that corresponds to an elaboration procedure.  */
 197 #define DECL_ELABORATION_PROC_P(NODE) \
 198   DECL_LANG_FLAG_3 (FUNCTION_DECL_CHECK (NODE))
 199
 200 /* Nonzero if this is a decl for a pointer that points to something which
 201    is readonly.  Used mostly for fat pointers.  */
 202 #define DECL_POINTS_TO_READONLY_P(NODE) DECL_LANG_FLAG_4 (NODE)
 203
 204 /* Nonzero in a FIELD_DECL if there was a record rep clause.  */
 205 #define DECL_HAS_REP_P(NODE) DECL_LANG_FLAG_5 (FIELD_DECL_CHECK (NODE))
 206
 207 /* Nonzero in a PARM_DECL if we are to pass by descriptor.  */
 208 #define DECL_BY_DESCRIPTOR_P(NODE) DECL_LANG_FLAG_5 (PARM_DECL_CHECK (NODE))
 209
 210 /* In a CONST_DECL, points to a VAR_DECL that is allocatable to
 211    memory.  Used when a scalar constant is aliased or has its
 212    address taken.  */
 213 #define DECL_CONST_CORRESPONDING_VAR(NODE) \
 214   (tree) DECL_LANG_SPECIFIC (CONST_DECL_CHECK (NODE))
 215
 216 /* In a FIELD_DECL, points to the FIELD_DECL that was the ultimate
 217    source of the decl.  */
 218 #define DECL_ORIGINAL_FIELD(NODE) \
 219   (tree) DECL_LANG_SPECIFIC (FIELD_DECL_CHECK (NODE))
 220
 221 /* In a FIELD_DECL corresponding to a discriminant, contains the
 222    discriminant number.  */
 223 #define DECL_DISCRIMINANT_NUMBER(NODE) DECL_INITIAL (FIELD_DECL_CHECK (NODE))
 224
 225 /* This is a horrible kludge to store the loop_id of a loop into a tree
 226    node.  We need to find some other place to store it!  */
 227 #define TREE_LOOP_ID(NODE) (TREE_CHECK (NODE, GNAT_LOOP_ID)->real_cst.rtl)