1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2011, Free Software Foundation, Inc. --
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. --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
27 -- GNAT was originally developed by the GNAT team at New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
30 ------------------------------------------------------------------------------
32 -- This package contains the declarations of entities in package Standard,
33 -- These values are initialized either by calling CStand.Create_Standard,
34 -- or by calling Stand.Tree_Read.
36 with Types; use Types;
40 type Standard_Entity_Type is (
41 -- This enumeration type contains an entry for each name in Standard
48 -- Types and subtypes defined in package Standard (in the order in which
49 -- they appear in the RM, so that the declarations are in the right
50 -- order for the purposes of ASIS traversals
54 S_Short_Short_Integer,
70 S_Wide_Wide_Character,
78 -- Enumeration literals for type Boolean
83 -- Exceptions declared in package Standard
91 -- Binary Operators declared in package Standard
113 -- Unary operators declared in package Standard
120 -- Constants defined in package ASCII (with value in hex).
121 -- First the thirty-two C0 control characters)
156 -- Here are the ones for Colonel Whitaker's O26 keypunch!
159 S_Quotation, -- 16#22#
163 S_Ampersand, -- 16#26#
166 S_Semicolon, -- 16#3B#
171 S_L_Bracket, -- 16#5B#
172 S_Back_Slash, -- 16#5C#
173 S_R_Bracket, -- 16#5D#
174 S_Circumflex, -- 16#5E#
175 S_Underline, -- 16#5F#
210 -- And one more control character, all on its own
215 Standard_Entity_Type range S_Boolean .. S_Duration;
217 subtype S_Exceptions is
218 Standard_Entity_Type range S_Constraint_Error .. S_Tasking_Error;
220 subtype S_ASCII_Names is
221 Standard_Entity_Type range S_NUL .. S_DEL;
223 subtype S_Binary_Ops is
224 Standard_Entity_Type range S_Op_Add .. S_Op_Xor;
226 subtype S_Unary_Ops is
227 Standard_Entity_Type range S_Op_Abs .. S_Op_Plus;
229 type Standard_Entity_Array_Type is array (Standard_Entity_Type) of Node_Id;
231 Standard_Entity : Standard_Entity_Array_Type;
232 -- This array contains pointers to the Defining Identifier nodes for each
233 -- of the visible entities defined in Standard_Entities_Type. The array is
234 -- initialized by the Create_Standard procedure.
236 Standard_Package_Node : Node_Id;
237 -- Points to the N_Package_Declaration node for standard. Also
238 -- initialized by the Create_Standard procedure.
240 -- The following Entities are the pointers to the Defining Identifier
241 -- nodes for some visible entities defined in Standard_Entities_Type.
243 SE : Standard_Entity_Array_Type renames Standard_Entity;
245 Standard_Standard : Entity_Id renames SE (S_Standard);
247 Standard_ASCII : Entity_Id renames SE (S_ASCII);
248 Standard_Character : Entity_Id renames SE (S_Character);
249 Standard_Wide_Character : Entity_Id renames SE (S_Wide_Character);
250 Standard_Wide_Wide_Character : Entity_Id renames SE (S_Wide_Wide_Character);
251 Standard_String : Entity_Id renames SE (S_String);
252 Standard_Wide_String : Entity_Id renames SE (S_Wide_String);
253 Standard_Wide_Wide_String : Entity_Id renames SE (S_Wide_Wide_String);
255 Standard_Boolean : Entity_Id renames SE (S_Boolean);
256 Standard_False : Entity_Id renames SE (S_False);
257 Standard_True : Entity_Id renames SE (S_True);
259 Standard_Duration : Entity_Id renames SE (S_Duration);
261 Standard_Natural : Entity_Id renames SE (S_Natural);
262 Standard_Positive : Entity_Id renames SE (S_Positive);
264 Standard_Constraint_Error : Entity_Id renames SE (S_Constraint_Error);
265 Standard_Numeric_Error : Entity_Id renames SE (S_Numeric_Error);
266 Standard_Program_Error : Entity_Id renames SE (S_Program_Error);
267 Standard_Storage_Error : Entity_Id renames SE (S_Storage_Error);
268 Standard_Tasking_Error : Entity_Id renames SE (S_Tasking_Error);
270 Standard_Short_Float : Entity_Id renames SE (S_Short_Float);
271 Standard_Float : Entity_Id renames SE (S_Float);
272 Standard_Long_Float : Entity_Id renames SE (S_Long_Float);
273 Standard_Long_Long_Float : Entity_Id renames SE (S_Long_Long_Float);
275 Standard_Short_Short_Integer : Entity_Id renames SE (S_Short_Short_Integer);
276 Standard_Short_Integer : Entity_Id renames SE (S_Short_Integer);
277 Standard_Integer : Entity_Id renames SE (S_Integer);
278 Standard_Long_Integer : Entity_Id renames SE (S_Long_Integer);
279 Standard_Long_Long_Integer : Entity_Id renames SE (S_Long_Long_Integer);
281 Standard_Op_Add : Entity_Id renames SE (S_Op_Add);
282 Standard_Op_And : Entity_Id renames SE (S_Op_And);
283 Standard_Op_Concat : Entity_Id renames SE (S_Op_Concat);
284 Standard_Op_Concatw : Entity_Id renames SE (S_Op_Concatw);
285 Standard_Op_Concatww : Entity_Id renames SE (S_Op_Concatww);
286 Standard_Op_Divide : Entity_Id renames SE (S_Op_Divide);
287 Standard_Op_Eq : Entity_Id renames SE (S_Op_Eq);
288 Standard_Op_Expon : Entity_Id renames SE (S_Op_Expon);
289 Standard_Op_Ge : Entity_Id renames SE (S_Op_Ge);
290 Standard_Op_Gt : Entity_Id renames SE (S_Op_Gt);
291 Standard_Op_Le : Entity_Id renames SE (S_Op_Le);
292 Standard_Op_Lt : Entity_Id renames SE (S_Op_Lt);
293 Standard_Op_Mod : Entity_Id renames SE (S_Op_Mod);
294 Standard_Op_Multiply : Entity_Id renames SE (S_Op_Multiply);
295 Standard_Op_Ne : Entity_Id renames SE (S_Op_Ne);
296 Standard_Op_Or : Entity_Id renames SE (S_Op_Or);
297 Standard_Op_Rem : Entity_Id renames SE (S_Op_Rem);
298 Standard_Op_Subtract : Entity_Id renames SE (S_Op_Subtract);
299 Standard_Op_Xor : Entity_Id renames SE (S_Op_Xor);
301 Standard_Op_Abs : Entity_Id renames SE (S_Op_Abs);
302 Standard_Op_Minus : Entity_Id renames SE (S_Op_Minus);
303 Standard_Op_Not : Entity_Id renames SE (S_Op_Not);
304 Standard_Op_Plus : Entity_Id renames SE (S_Op_Plus);
306 Last_Standard_Node_Id : Node_Id;
307 -- Highest Node_Id value used by Standard
309 Last_Standard_List_Id : List_Id;
310 -- Highest List_Id value used by Standard (including those used by
311 -- normal list headers, element list headers, and list elements)
313 Boolean_Literals : array (Boolean) of Entity_Id;
314 -- Entities for the two boolean literals, used by the expander
316 -------------------------------------
317 -- Semantic Phase Special Entities --
318 -------------------------------------
320 -- The semantic phase needs a number of entities for internal processing
321 -- that are logically at the level of Standard, and hence defined in this
322 -- package. However, they are never visible to a program, and are not
323 -- chained on to the Decls list of Standard. The names of all these
324 -- types are relevant only in certain debugging and error message
325 -- situations. They have names that are suitable for use in such
326 -- error messages (see body for actual names used).
328 Standard_Void_Type : Entity_Id;
329 -- This is a type used to represent the return type of procedures
331 Standard_Exception_Type : Entity_Id;
332 -- This is a type used to represent the Etype of exceptions
334 Standard_A_String : Entity_Id;
335 -- An access to String type used for building elements of tables
336 -- carrying the enumeration literal names.
338 Standard_A_Char : Entity_Id;
339 -- Access to character, used as a component of the exception type to denote
340 -- a thin pointer component.
342 Standard_Debug_Renaming_Type : Entity_Id;
343 -- A zero-size subtype of Integer, used as the type of variables used to
344 -- provide the debugger with name encodings for renaming declarations.
346 Predefined_Float_Types : Elist_Id;
347 -- Entities for predefined floating point types. These are used by
348 -- the semantic phase to select appropriate types for floating point
349 -- declarations. This list is ordered by preference. All types up to
350 -- Long_Long_Float_Type are considered for plain "digits N" declarations,
351 -- while selection of later types requires a range specification and
352 -- possibly other attributes or pragmas.
354 -- The entities labeled Any_xxx are used in situations where the full
355 -- characteristics of an entity are not yet known, e.g. Any_Character
356 -- is used to label a character literal before resolution is complete.
357 -- These entities are also used to construct appropriate references in
358 -- error messages ("expecting an integer type").
361 -- Used to represent some unknown identifier. Used to label undefined
362 -- identifier references to prevent cascaded errors.
364 Any_Type : Entity_Id;
365 -- Used to represent some unknown type. Plays an important role in
366 -- avoiding cascaded errors, since any node that remains labeled with
367 -- this type corresponds to an already issued error message. Any_Type
368 -- is propagated to avoid cascaded errors from a single type error.
370 Any_Access : Entity_Id;
371 -- Used to resolve the overloaded literal NULL
373 Any_Array : Entity_Id;
374 -- Used to represent some unknown array type
376 Any_Boolean : Entity_Id;
377 -- The context type of conditions in IF and WHILE statements
379 Any_Character : Entity_Id;
380 -- Any_Character is used to label character literals, which in general
381 -- will not have an explicit declaration (this is true of the predefined
384 Any_Composite : Entity_Id;
385 -- The type Any_Composite is used for aggregates before type resolution.
386 -- It is compatible with any array or non-limited record type.
388 Any_Discrete : Entity_Id;
389 -- Used to represent some unknown discrete type
391 Any_Fixed : Entity_Id;
392 -- Used to represent some unknown fixed-point type
394 Any_Integer : Entity_Id;
395 -- Used to represent some unknown integer type
397 Any_Modular : Entity_Id;
398 -- Used to represent the result type of a boolean operation on an integer
399 -- literal. The result is not Universal_Integer, because it is only legal
400 -- in a modular context.
402 Any_Numeric : Entity_Id;
403 -- Used to represent some unknown numeric type
405 Any_Real : Entity_Id;
406 -- Used to represent some unknown real type
408 Any_Scalar : Entity_Id;
409 -- Used to represent some unknown scalar type
411 Any_String : Entity_Id;
412 -- The type Any_String is used for string literals before type resolution.
413 -- It corresponds to array (Positive range <>) of character where the
414 -- component type is compatible with any character type, not just
415 -- Standard_Character.
417 Universal_Integer : Entity_Id;
418 -- Entity for universal integer type. The bounds of this type correspond
419 -- to the largest supported integer type (i.e. Long_Long_Integer). It is
420 -- the type used for runtime calculations in type universal integer.
422 Universal_Real : Entity_Id;
423 -- Entity for universal real type. The bounds of this type correspond to
424 -- to the largest supported real type (i.e. Long_Long_Float). It is the
425 -- type used for runtime calculations in type universal real. Note that
426 -- this type is always IEEE format, even if Long_Long_Float is Vax_Float
427 -- (and in that case the bounds don't correspond exactly).
429 Universal_Fixed : Entity_Id;
430 -- Entity for universal fixed type. This is a type with arbitrary
431 -- precision that can only appear in a context with a specific type.
432 -- Universal_Fixed labels the result of multiplication or division of
433 -- two fixed point numbers, and has no specified bounds (since, unlike
434 -- universal integer and universal real, it is never used for runtime
437 Standard_Integer_8 : Entity_Id;
438 Standard_Integer_16 : Entity_Id;
439 Standard_Integer_32 : Entity_Id;
440 Standard_Integer_64 : Entity_Id;
441 -- These are signed integer types with the indicated sizes, They are used
442 -- for the underlying implementation types for fixed-point and enumeration
445 Standard_Unsigned : Entity_Id;
446 -- An unsigned type of the same size as Standard_Integer
448 Abort_Signal : Entity_Id;
449 -- Entity for abort signal exception
451 Standard_Op_Rotate_Left : Entity_Id;
452 Standard_Op_Rotate_Right : Entity_Id;
453 Standard_Op_Shift_Left : Entity_Id;
454 Standard_Op_Shift_Right : Entity_Id;
455 Standard_Op_Shift_Right_Arithmetic : Entity_Id;
456 -- These entities are used for shift operators generated by the expander
463 -- Initializes entity values in this package from the current tree
464 -- file using Osint.Tree_Read. Note that Tree_Read includes all the
465 -- initialization that is carried out by Create_Standard.
467 procedure Tree_Write;
468 -- Writes out the entity values in this package to the current tree file
469 -- using Osint.Tree_Write.