gcc/ada/types.h

   1 /****************************************************************************
   2  *                                                                          *
   3  *                         GNAT COMPILER COMPONENTS                         *
   4  *                                                                          *
   5  *                                T Y P E S                                 *
   6  *                                                                          *
   7  *                              C Header File                               *
   8  *                                                                          *
   9  *          Copyright (C) 1992-2005, 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,  51  Franklin  Street,  Fifth  Floor, *
  20  * Boston, MA 02110-1301, 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 /* This is the C file that corresponds to the Ada package spec Types. It was
  28    created manually from the files types.ads and types.adb.
  29
  30    This package contains host independent type definitions which are used
  31    throughout the compiler modules. The comments in the C version are brief
  32    reminders of the purpose of each declaration.  For complete documentation,
  33    see the Ada version of these definitions.  */
  34
  35 /* Boolean Types:  */
  36
  37 /* Boolean type (cannot use enum, because of bit field restriction on some
  38    compilers).  */
  39 typedef unsigned char Boolean;
  40 #define False 0
  41 #define True  1
  42
  43 /* General Use Integer Types */
  44
  45 /* Signed 32/bit integer */
  46 typedef int Int;
  47
  48 /* Signed 16 bit integer */
  49 typedef short Short;
  50
  51 /* Non/negative Int values */
  52 typedef Int Nat;
  53
  54 /* Positive Int values */
  55 typedef Int Pos;
  56
  57 /* 8/bit unsigned integer */
  58 typedef char Byte;
  59
  60 /* 8/Bit Character and String Types:  */
  61
  62 /* 8/bit character type */
  63 typedef char Char;
  64
  65 /* Graphic characters, as defined in ARM */
  66 typedef Char Graphic_Character;
  67
  68 /* Line terminator characters (LF, VT, FF, CR) */
  69 typedef Char Line_Terminator;
  70
  71 /* Characters with the upper bit set */
  72 typedef Char Upper_Half_Character;
  73
  74 /* String type built on Char (note that zero is an OK index) */
  75 typedef Char *Str;
  76
  77 /* Pointer to string of Chars */
  78 typedef Char *Str_Ptr;
  79
  80 /* Types for the fat pointer used for strings and the template it
  81    points to.  */
  82 typedef struct {int Low_Bound, High_Bound; } String_Template;
  83 typedef struct {const char *Array; String_Template *Bounds; }
  84         __attribute ((aligned (sizeof (char *) * 2))) Fat_Pointer;
  85
  86 /* Types for Node/Entity Kinds:  */
  87
  88 /* The reason that these are defined here in the C version, rather than in the
  89    corresponding packages is that the requirement for putting bodies of
  90    inlined stuff IN the C header changes the dependencies.  Both sinfo.h
  91    and einfo.h now reference routines defined in tree.h.
  92
  93    Note: these types would more naturally be defined as unsigned  char, but
  94    once again, the annoying restriction on bit fields for some compilers
  95    bites us!  */
  96
  97 typedef unsigned int Node_Kind;
  98 typedef unsigned int Entity_Kind;
  99
 100 /* Types used for Text Buffer Handling:  */
 101
 102 /* Type used for subscripts in text buffer.  */
 103 typedef Int Text_Ptr;
 104
 105 /* Text buffer used to hold source file or library information file.  */
 106 typedef Char *Text_Buffer;
 107
 108 /* Pointer to text buffer.  */
 109 typedef Char *Text_Buffer_Ptr;
 110
 111 /* Types used for Source Input Handling:  */
 112
 113 /* Line number type, used for storing all line numbers.  */
 114 typedef Int Line_Number_Type;
 115
 116 /* Column number type, used for storing all column numbers.  */
 117 typedef Int Column_Number_Type;
 118
 119 /* Type used to store text of a source file.  */
 120 typedef Text_Buffer Source_Buffer;
 121
 122 /* Pointer to source buffer. */
 123 typedef Text_Buffer_Ptr Source_Buffer_Ptr;
 124
 125 /* Type used for source location.  */
 126 typedef Text_Ptr Source_Ptr;
 127
 128 /* Value used to indicate no source position set.  */
 129 #define No_Location -1
 130
 131 /* Used for Sloc in all nodes in the representation of package Standard.  */
 132 #define Standard_Location -2
 133
 134 /* Type used for union of all possible ID values covering all ranges */
 135 typedef int Union_Id;
 136
 137 /* Range definitions for Tree Data:  */
 138
 139 #define List_Low_Bound          -100000000
 140 #define List_High_Bound         0
 141
 142 #define Node_Low_Bound          0
 143 #define Node_High_Bound         99999999
 144
 145 #define Elist_Low_Bound         100000000
 146 #define Elist_High_Bound        199999999
 147
 148 #define Elmt_Low_Bound          200000000
 149 #define Elmt_High_Bound         299999999
 150
 151 #define Names_Low_Bound         300000000
 152 #define Names_High_Bound        399999999
 153
 154 #define Strings_Low_Bound       400000000
 155 #define Strings_High_Bound      499999999
 156
 157 #define Ureal_Low_Bound         500000000
 158 #define Ureal_High_Bound        599999999
 159
 160 #define Uint_Low_Bound          600000000
 161 #define Uint_Table_Start        2000000000
 162 #define Uint_High_Bound         2099999999
 163
 164 SUBTYPE (List_Range,      Int, List_Low_Bound,    List_High_Bound)
 165 SUBTYPE (Node_Range,      Int, Node_Low_Bound,    Node_High_Bound)
 166 SUBTYPE (Elist_Range,     Int, Elist_Low_Bound,   Elist_High_Bound)
 167 SUBTYPE (Elmt_Range,      Int, Elmt_Low_Bound,    Elmt_High_Bound)
 168 SUBTYPE (Names_Range,     Int, Names_Low_Bound,   Names_High_Bound)
 169 SUBTYPE (Strings_Range,   Int, Strings_Low_Bound, Strings_High_Bound)
 170 SUBTYPE (Uint_Range,      Int, Uint_Low_Bound,    Uint_High_Bound)
 171 SUBTYPE (Ureal_Range,     Int, Ureal_Low_Bound,   Ureal_High_Bound)
 172
 173 /* Types for Names_Table Package:  */
 174
 175 typedef Int Name_Id;
 176
 177 /* Name_Id value for no name present.  */
 178 #define No_Name Names_Low_Bound
 179
 180 /* Name_Id value for bad name.  */
 181 #define Error_Name (Names_Low_Bound + 1)
 182
 183 /* First subscript of names table. */
 184 #define First_Name_Id (Names_Low_Bound + 2)
 185
 186 /* Types for Tree Package:  */
 187
 188 /* Subscript of nodes table entry.  */
 189 typedef Int Node_Id;
 190
 191 /* Used in semantics for Node_Id value referencing an entity.  */
 192 typedef Node_Id Entity_Id;
 193
 194 /* Null node.  */
 195 #define Empty 0
 196
 197 /* Error node.  */
 198 #define Error 1
 199
 200 /* Subscript of first allocated node.  */
 201 #define First_Node_Id Empty
 202
 203 /* Subscript of entry in lists table.  */
 204 typedef Int List_Id;
 205
 206 /* Indicates absence of a list.  */
 207 #define No_List 0
 208
 209 /* Error list. */
 210 #define Error_List List_Low_Bound
 211
 212 /* Subscript of first allocated list header.  */
 213 #define First_List_Id Error_List
 214
 215 /* Element list Id, subscript value of entry in lists table.  */
 216 typedef Int Elist_Id;
 217
 218 /* Used to indicate absence of an element list.  */
 219 #define No_Elist Elist_Low_Bound
 220
 221 /* Subscript of first allocated elist header */
 222 #define First_Elist_Id (No_Elist + 1)
 223
 224 /* Element Id, subscript value of entry in elements table.  */
 225 typedef Int Elmt_Id;
 226
 227 /* Used to indicate absence of a list element.  */
 228 #define No_Elmt Elmt_Low_Bound
 229
 230 /* Subscript of first allocated element */
 231 #define First_Elmt_Id (No_Elmt + 1)
 232
 233 /* Types for String_Table Package:  */
 234
 235 /* Subscript of strings table entry.  */
 236 typedef Int String_Id;
 237
 238 /* Used to indicate missing string Id.  */
 239 #define No_String Strings_Low_Bound
 240
 241 /* Subscript of first entry in strings table.  */
 242 #define First_String_Id (No_String + 1)
 243
 244 /* Types for Uint_Support Package:  */
 245
 246 /* Type used for representation of universal integers.  */
 247 typedef Int Uint;
 248
 249 /* Used to indicate missing Uint value.  */
 250 #define No_Uint Uint_Low_Bound
 251
 252 /* Base value used to represent Uint values.  */
 253 #define Base 32768
 254
 255 /* Minimum and maximum integers directly representable as Uint values */
 256 #define Min_Direct (-(Base - 1))
 257 #define Max_Direct ((Base - 1) * (Base - 1))
 258
 259 #define Uint_Direct_Bias  (Uint_Low_Bound + Base)
 260 #define Uint_Direct_First (Uint_Direct_Bias + Min_Direct)
 261 #define Uint_Direct_Last  (Uint_Direct_Bias + Max_Direct)
 262
 263 /* Define range of direct biased values */
 264 SUBTYPE (Uint_Direct, Uint, Uint_Direct_First, Uint_Direct_Last)
 265
 266 /* Constants in Uint format.  */
 267 #define Uint_0  (Uint_Direct_Bias + 0)
 268 #define Uint_1  (Uint_Direct_Bias + 1)
 269 #define Uint_2  (Uint_Direct_Bias + 2)
 270 #define Uint_10 (Uint_Direct_Bias + 10)
 271 #define Uint_16 (Uint_Direct_Bias + 16)
 272
 273 /* Types for Ureal_Support Package:  */
 274
 275 /* Type used for representation of universal reals.  */
 276 typedef Int Ureal;
 277
 278 /* Used to indicate missing Uint value.  */
 279 #define No_Ureal Ureal_Low_Bound
 280
 281 /* Subscript of first entry in Ureal table.  */
 282 #define Ureal_First_Entry (No_Ureal + 1)
 283
 284 /* Character Code Type:  */
 285
 286 /* Character code value, intended to be 32 bits.  */
 287 typedef unsigned Char_Code;
 288
 289 /* Types Used for Library Management:  */
 290
 291 /* Unit number.  */
 292 typedef Int Unit_Number_Type;
 293
 294 /* Unit number value for main unit.  */
 295 #define Main_Unit 0
 296
 297 /* Type used for lines table.  */
 298 typedef Source_Ptr *Lines_Table_Type;
 299
 300 /* Type used for pointer to lines table.  */
 301 typedef Source_Ptr *Lines_Table_Ptr;
 302
 303 /* Length of time stamp value.  */
 304 #define Time_Stamp_Length 22
 305
 306 /* Type used to represent time stamp.  */
 307 typedef Char *Time_Stamp_Type;
 308
 309 /* Name_Id synonym used for file names.  */
 310 typedef Name_Id File_Name_Type;
 311
 312 /* Constant used to indicate no file found.  */
 313 #define No_File No_Name
 314
 315 /* Name_Id synonym used for unit names.  */
 316 typedef Name_Id Unit_Name_Type;
 317
 318 /* Definitions for mechanism type and values */
 319 typedef Int Mechanism_Type;
 320 #define Default            0
 321 #define By_Copy            (-1)
 322 #define By_Reference       (-2)
 323 #define By_Descriptor      (-3)
 324 #define By_Descriptor_UBS  (-4)
 325 #define By_Descriptor_UBSB (-5)
 326 #define By_Descriptor_UBA  (-6)
 327 #define By_Descriptor_S    (-7)
 328 #define By_Descriptor_SB   (-8)
 329 #define By_Descriptor_A    (-9)
 330 #define By_Descriptor_NCA  (-10)
 331
 332 /* Definitions of Reason codes for Raise_xxx_Error nodes */
 333 #define CE_Access_Check_Failed              0
 334 #define CE_Access_Parameter_Is_Null         1
 335 #define CE_Discriminant_Check_Failed        2
 336 #define CE_Divide_By_Zero                   3
 337 #define CE_Explicit_Raise                   4
 338 #define CE_Index_Check_Failed               5
 339 #define CE_Invalid_Data                     6
 340 #define CE_Length_Check_Failed              7
 341 #define CE_Null_Exception_Id                9
 342 #define CE_Null_Not_Allowed                 9
 343 #define CE_Overflow_Check_Failed           10
 344 #define CE_Partition_Check_Failed          11
 345 #define CE_Range_Check_Failed              12
 346 #define CE_Tag_Check_Failed                13
 347
 348 #define PE_Access_Before_Elaboration       14
 349 #define PE_Accessibility_Check_Failed      15
 350 #define PE_All_Guards_Closed               16
 351 #define PE_Duplicated_Entry_Address        17
 352 #define PE_Explicit_Raise                  18
 353 #define PE_Finalize_Raised_Exception       19
 354 #define PE_Implicit_Return                 20
 355 #define PE_Misaligned_Address_Value        21
 356 #define PE_Missing_Return                  22
 357 #define PE_Overlaid_Controlled_Object      23
 358 #define PE_Potentially_Blocking_Operation  24
 359 #define PE_Stubbed_Subprogram_Called       25
 360 #define PE_Unchecked_Union_Restriction     26
 361 #define PE_Illegal_RACW_E_4_18             27
 362
 363 #define SE_Empty_Storage_Pool              28
 364 #define SE_Explicit_Raise                  29
 365 #define SE_Infinite_Recursion              30
 366 #define SE_Object_Too_Large                31
 367 #define SE_Restriction_Violation           32
 368
 369 #define LAST_REASON_CODE                   31