1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2008, 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 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. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 -- This package contains host independent type definitions which are used
35 -- in more than one unit in the compiler. They are gathered here for easy
36 -- reference, though in some cases the full description is found in the
37 -- relevant module which implements the definition. The main reason that they
38 -- are not in their "natural" specs is that this would cause a lot of inter-
39 -- spec dependencies, and in particular some awkward circular dependencies
40 -- would have to be dealt with.
42 -- WARNING: There is a C version of this package. Any changes to this source
43 -- file must be properly reflected in the C header file types.h declarations.
45 -- Note: the declarations in this package reflect an expectation that the host
46 -- machine has an efficient integer base type with a range at least 32 bits
47 -- 2s-complement. If there are any machines for which this is not a correct
48 -- assumption, a significant number of changes will be required!
51 with Unchecked_Conversion;
52 with Unchecked_Deallocation;
57 -------------------------------
58 -- General Use Integer Types --
59 -------------------------------
61 type Int is range -2 ** 31 .. +2 ** 31 - 1;
62 -- Signed 32-bit integer
64 type Dint is range -2 ** 63 .. +2 ** 63 - 1;
65 -- Double length (64-bit) integer
67 subtype Nat is Int range 0 .. Int'Last;
68 -- Non-negative Int values
70 subtype Pos is Int range 1 .. Int'Last;
71 -- Positive Int values
73 type Word is mod 2 ** 32;
74 -- Unsigned 32-bit integer
76 type Short is range -32768 .. +32767;
77 for Short'Size use 16;
78 -- 16-bit signed integer
80 type Byte is mod 2 ** 8;
82 -- 8-bit unsigned integer
84 type size_t is mod 2 ** Standard'Address_Size;
85 -- Memory size value, for use in calls to C routines
87 --------------------------------------
88 -- 8-Bit Character and String Types --
89 --------------------------------------
91 -- We use Standard.Character and Standard.String freely, since we are
92 -- compiling ourselves, and we properly implement the required 8-bit
93 -- character code as required in Ada 95. This section defines a few
94 -- general use constants and subtypes.
96 EOF : constant Character := ASCII.SUB;
97 -- The character SUB (16#1A#) is used in DOS and other systems derived
98 -- from DOS (XP, NT etc) to signal the end of a text file. Internally
99 -- all source files are ended by an EOF character, even on Unix systems.
100 -- An EOF character acts as the end of file only as the last character
101 -- of a source buffer, in any other position, it is treated as a blank
102 -- if it appears between tokens, and as an illegal character otherwise.
103 -- This makes life easier dealing with files that originated from DOS,
104 -- including concatenated files with interspersed EOF characters.
106 subtype Graphic_Character is Character range ' ' .. '~';
107 -- Graphic characters, as defined in ARM
109 subtype Line_Terminator is Character range ASCII.LF .. ASCII.CR;
110 -- Line terminator characters (LF, VT, FF, CR)
112 -- This definition is dubious now that we have two more wide character
113 -- sequences that constitute a line terminator. Every reference to this
114 -- subtype needs checking to make sure the wide character case is handled
115 -- appropriately. ???
117 subtype Upper_Half_Character is
118 Character range Character'Val (16#80#) .. Character'Val (16#FF#);
119 -- Characters with the upper bit set
121 type Character_Ptr is access all Character;
122 type String_Ptr is access all String;
123 -- Standard character and string pointers
125 procedure Free is new Unchecked_Deallocation (String, String_Ptr);
126 -- Procedure for freeing dynamically allocated String values
128 subtype Big_String is String (Positive);
129 type Big_String_Ptr is access all Big_String;
130 for Big_String_Ptr'Storage_Size use 0;
131 -- Virtual type for handling imported big strings
133 function To_Big_String_Ptr is
134 new Unchecked_Conversion (System.Address, Big_String_Ptr);
135 -- Used to obtain Big_String_Ptr values from external addresses
137 subtype Word_Hex_String is String (1 .. 8);
138 -- Type used to represent Word value as 8 hex digits, with lower case
139 -- letters for the alphabetic cases.
141 function Get_Hex_String (W : Word) return Word_Hex_String;
142 -- Convert word value to 8-character hex string
144 -----------------------------------------
145 -- Types Used for Text Buffer Handling --
146 -----------------------------------------
148 -- We can not use type String for text buffers, since we must use the
149 -- standard 32-bit integer as an index value, since we count on all index
150 -- values being the same size.
152 type Text_Ptr is new Int;
153 -- Type used for subscripts in text buffer
155 type Text_Buffer is array (Text_Ptr range <>) of Character;
156 -- Text buffer used to hold source file or library information file
158 type Text_Buffer_Ptr is access all Text_Buffer;
159 -- Text buffers for input files are allocated dynamically and this type
160 -- is used to reference these text buffers.
162 procedure Free is new Unchecked_Deallocation (Text_Buffer, Text_Buffer_Ptr);
163 -- Procedure for freeing dynamically allocated text buffers
165 ------------------------------------------
166 -- Types Used for Source Input Handling --
167 ------------------------------------------
169 type Logical_Line_Number is range 0 .. Int'Last;
170 for Logical_Line_Number'Size use 32;
171 -- Line number type, used for storing logical line numbers (i.e. line
172 -- numbers that include effects of any Source_Reference pragmas in the
173 -- source file). The value zero indicates a line containing a source
176 No_Line_Number : constant Logical_Line_Number := 0;
177 -- Special value used to indicate no line number
179 type Physical_Line_Number is range 1 .. Int'Last;
180 for Physical_Line_Number'Size use 32;
181 -- Line number type, used for storing physical line numbers (i.e. line
182 -- numbers in the physical file being compiled, unaffected by the presence
183 -- of source reference pragmas.
185 type Column_Number is range 0 .. 32767;
186 for Column_Number'Size use 16;
187 -- Column number (assume that 2**15 - 1 is large enough). The range for
188 -- this type is used to compute Hostparm.Max_Line_Length. See also the
189 -- processing for -gnatyM in Stylesw).
191 No_Column_Number : constant Column_Number := 0;
192 -- Special value used to indicate no column number
194 subtype Source_Buffer is Text_Buffer;
195 -- Type used to store text of a source file . The buffer for the main
196 -- source (the source specified on the command line) has a lower bound
197 -- starting at zero. Subsequent subsidiary sources have lower bounds which
198 -- are one greater than the previous upper bound.
200 subtype Big_Source_Buffer is Text_Buffer (0 .. Text_Ptr'Last);
201 -- This is a virtual type used as the designated type of the access
202 -- type Source_Buffer_Ptr, see Osint.Read_Source_File for details.
204 type Source_Buffer_Ptr is access all Big_Source_Buffer;
205 for Source_Buffer_Ptr'Storage_Size use 0;
206 -- Pointer to source buffer. We use virtual origin addressing for source
207 -- buffers, with thin pointers. The pointer points to a virtual instance
208 -- of type Big_Source_Buffer, where the actual type is in fact of type
209 -- Source_Buffer. The address is adjusted so that the virtual origin
210 -- addressing works correctly. See Osint.Read_Source_Buffer for further
213 subtype Source_Ptr is Text_Ptr;
214 -- Type used to represent a source location, which is a subscript of a
215 -- character in the source buffer. As noted above, different source
216 -- buffers have different ranges, so it is possible to tell from a
217 -- Source_Ptr value which source it refers to. Note that negative numbers
218 -- are allowed to accommodate the following special values.
220 No_Location : constant Source_Ptr := -1;
221 -- Value used to indicate no source position set in a node. A test for
222 -- a Source_Ptr value being > No_Location is the approved way to test
223 -- for a standard value that does not include No_Location or any of the
224 -- following special definitions. One important use of No_Location is to
225 -- label generated nodes that we don't want the debugger to see in normal
226 -- mode (very often we conditionalize so that we set No_Location in normal
227 -- mode and the corresponding source line in -gnatD mode).
229 Standard_Location : constant Source_Ptr := -2;
230 -- Used for all nodes in the representation of package Standard other than
231 -- nodes representing the contents of Standard.ASCII. Note that testing for
232 -- a value being <= Standard_Location tests for both Standard_Location and
233 -- for Standard_ASCII_Location.
235 Standard_ASCII_Location : constant Source_Ptr := -3;
236 -- Used for all nodes in the presentation of package Standard.ASCII
238 System_Location : constant Source_Ptr := -4;
239 -- Used to identify locations of pragmas scanned by Targparm, where we
240 -- know the location is in System, but we don't know exactly what line.
242 First_Source_Ptr : constant Source_Ptr := 0;
243 -- Starting source pointer index value for first source program
245 -------------------------------------
246 -- Range Definitions for Tree Data --
247 -------------------------------------
249 -- The tree has fields that can hold any of the following types:
251 -- Pointers to other tree nodes (type Node_Id)
252 -- List pointers (type List_Id)
253 -- Element list pointers (type Elist_Id)
254 -- Names (type Name_Id)
255 -- Strings (type String_Id)
256 -- Universal integers (type Uint)
257 -- Universal reals (type Ureal)
259 -- In most contexts, the strongly typed interface determines which of
260 -- these types is present. However, there are some situations (involving
261 -- untyped traversals of the tree), where it is convenient to be easily
262 -- able to distinguish these values. The underlying representation in all
263 -- cases is an integer type Union_Id, and we ensure that the range of
264 -- the various possible values for each of the above types is disjoint
265 -- so that this distinction is possible.
267 type Union_Id is new Int;
268 -- The type in the tree for a union of possible ID values
270 -- Note: it is also helpful for debugging purposes to make these ranges
271 -- distinct. If a bug leads to misidentification of a value, then it will
272 -- typically result in an out of range value and a Constraint_Error.
274 List_Low_Bound : constant := -100_000_000;
275 -- The List_Id values are subscripts into an array of list headers which
276 -- has List_Low_Bound as its lower bound. This value is chosen so that all
277 -- List_Id values are negative, and the value zero is in the range of both
278 -- List_Id and Node_Id values (see further description below).
280 List_High_Bound : constant := 0;
281 -- Maximum List_Id subscript value. This allows up to 100 million list Id
282 -- values, which is in practice infinite, and there is no need to check the
283 -- range. The range overlaps the node range by one element (with value
284 -- zero), which is used both for the Empty node, and for indicating no
285 -- list. The fact that the same value is used is convenient because it
286 -- means that the default value of Empty applies to both nodes and lists,
287 -- and also is more efficient to test for.
289 Node_Low_Bound : constant := 0;
290 -- The tree Id values start at zero, because we use zero for Empty (to
291 -- allow a zero test for Empty). Actual tree node subscripts start at 0
292 -- since Empty is a legitimate node value.
294 Node_High_Bound : constant := 099_999_999;
295 -- Maximum number of nodes that can be allocated is 100 million, which
296 -- is in practice infinite, and there is no need to check the range.
298 Elist_Low_Bound : constant := 100_000_000;
299 -- The Elist_Id values are subscripts into an array of elist headers which
300 -- has Elist_Low_Bound as its lower bound.
302 Elist_High_Bound : constant := 199_999_999;
303 -- Maximum Elist_Id subscript value. This allows up to 100 million Elists,
304 -- which is in practice infinite and there is no need to check the range.
306 Elmt_Low_Bound : constant := 200_000_000;
307 -- Low bound of element Id values. The use of these values is internal to
308 -- the Elists package, but the definition of the range is included here
309 -- since it must be disjoint from other Id values. The Elmt_Id values are
310 -- subscripts into an array of list elements which has this as lower bound.
312 Elmt_High_Bound : constant := 299_999_999;
313 -- Upper bound of Elmt_Id values. This allows up to 100 million element
314 -- list members, which is in practice infinite (no range check needed).
316 Names_Low_Bound : constant := 300_000_000;
317 -- Low bound for name Id values
319 Names_High_Bound : constant := 399_999_999;
320 -- Maximum number of names that can be allocated is 100 million, which is
321 -- in practice infinite and there is no need to check the range.
323 Strings_Low_Bound : constant := 400_000_000;
324 -- Low bound for string Id values
326 Strings_High_Bound : constant := 499_999_999;
327 -- Maximum number of strings that can be allocated is 100 million, which
328 -- is in practice infinite and there is no need to check the range.
330 Ureal_Low_Bound : constant := 500_000_000;
331 -- Low bound for Ureal values
333 Ureal_High_Bound : constant := 599_999_999;
334 -- Maximum number of Ureal values stored is 100_000_000 which is in
335 -- practice infinite so that no check is required.
337 Uint_Low_Bound : constant := 600_000_000;
338 -- Low bound for Uint values
340 Uint_Table_Start : constant := 2_000_000_000;
341 -- Location where table entries for universal integers start (see
342 -- Uintp spec for details of the representation of Uint values).
344 Uint_High_Bound : constant := 2_099_999_999;
345 -- The range of Uint values is very large, since a substantial part
346 -- of this range is used to store direct values, see Uintp for details.
348 -- The following subtype definitions are used to provide convenient names
349 -- for membership tests on Int values to see what data type range they
350 -- lie in. Such tests appear only in the lowest level packages.
352 subtype List_Range is Union_Id
353 range List_Low_Bound .. List_High_Bound;
355 subtype Node_Range is Union_Id
356 range Node_Low_Bound .. Node_High_Bound;
358 subtype Elist_Range is Union_Id
359 range Elist_Low_Bound .. Elist_High_Bound;
361 subtype Elmt_Range is Union_Id
362 range Elmt_Low_Bound .. Elmt_High_Bound;
364 subtype Names_Range is Union_Id
365 range Names_Low_Bound .. Names_High_Bound;
367 subtype Strings_Range is Union_Id
368 range Strings_Low_Bound .. Strings_High_Bound;
370 subtype Uint_Range is Union_Id
371 range Uint_Low_Bound .. Uint_High_Bound;
373 subtype Ureal_Range is Union_Id
374 range Ureal_Low_Bound .. Ureal_High_Bound;
376 ----------------------------
377 -- Types for Atree Package --
378 ----------------------------
380 -- Node_Id values are used to identify nodes in the tree. They are
381 -- subscripts into the Node table declared in package Tree. Note that
382 -- the special values Empty and Error are subscripts into this table,
383 -- See package Atree for further details.
385 type Node_Id is range Node_Low_Bound .. Node_High_Bound;
386 -- Type used to identify nodes in the tree
388 subtype Entity_Id is Node_Id;
389 -- A synonym for node types, used in the entity package to refer to
390 -- nodes that are entities (i.e. nodes with an Nkind of N_Defining_xxx)
391 -- All such nodes are extended nodes and these are the only extended
392 -- nodes, so that in practice entity and extended nodes are synonymous.
394 subtype Node_Or_Entity_Id is Node_Id;
395 -- A synonym for node types, used in cases where a given value may be used
396 -- to represent either a node or an entity. We like to minimize such uses
397 -- for obvious reasons of logical type consistency, but where such uses
398 -- occur, they should be documented by use of this type.
400 Empty : constant Node_Id := Node_Low_Bound;
401 -- Used to indicate null node. A node is actually allocated with this
402 -- Id value, so that Nkind (Empty) = N_Empty. Note that Node_Low_Bound
403 -- is zero, so Empty = No_List = zero.
405 Empty_List_Or_Node : constant := 0;
406 -- This constant is used in situations (e.g. initializing empty fields)
407 -- where the value set will be used to represent either an empty node
408 -- or a non-existent list, depending on the context.
410 Error : constant Node_Id := Node_Low_Bound + 1;
411 -- Used to indicate that there was an error in the source program. A node
412 -- is actually allocated at this address, so that Nkind (Error) = N_Error.
414 Empty_Or_Error : constant Node_Id := Error;
415 -- Since Empty and Error are the first two Node_Id values, the test for
416 -- N <= Empty_Or_Error tests to see if N is Empty or Error. This definition
417 -- provides convenient self-documentation for such tests.
419 First_Node_Id : constant Node_Id := Node_Low_Bound;
420 -- Subscript of first allocated node. Note that Empty and Error are both
421 -- allocated nodes, whose Nkind fields can be accessed without error.
423 ------------------------------
424 -- Types for Nlists Package --
425 ------------------------------
427 -- List_Id values are used to identify node lists in the tree. They are
428 -- subscripts into the Lists table declared in package Tree. Note that the
429 -- special value Error_List is a subscript in this table, but the value
430 -- No_List is *not* a valid subscript, and any attempt to apply list
431 -- operations to No_List will cause a (detected) error.
433 type List_Id is range List_Low_Bound .. List_High_Bound;
434 -- Type used to identify a node list
436 No_List : constant List_Id := List_High_Bound;
437 -- Used to indicate absence of a list. Note that the value is zero, which
438 -- is the same as Empty, which is helpful in initializing nodes where a
439 -- value of zero can represent either an empty node or an empty list.
441 Error_List : constant List_Id := List_Low_Bound;
442 -- Used to indicate that there was an error in the source program in a
443 -- context which would normally require a list. This node appears to be
444 -- an empty list to the list operations (a null list is actually allocated
445 -- which has this Id value).
447 First_List_Id : constant List_Id := Error_List;
448 -- Subscript of first allocated list header
450 ------------------------------
451 -- Types for Elists Package --
452 ------------------------------
454 -- Element list Id values are used to identify element lists stored in the
455 -- tree (see package Tree for further details). They are formed by adding a
456 -- bias (Element_List_Bias) to subscript values in the same array that is
457 -- used for node list headers.
459 type Elist_Id is range Elist_Low_Bound .. Elist_High_Bound;
460 -- Type used to identify an element list (Elist header table subscript)
462 No_Elist : constant Elist_Id := Elist_Low_Bound;
463 -- Used to indicate absence of an element list. Note that this is not
464 -- an actual Elist header, so element list operations on this value
467 First_Elist_Id : constant Elist_Id := No_Elist + 1;
468 -- Subscript of first allocated Elist header
470 -- Element Id values are used to identify individual elements of an
471 -- element list (see package Elists for further details).
473 type Elmt_Id is range Elmt_Low_Bound .. Elmt_High_Bound;
474 -- Type used to identify an element list
476 No_Elmt : constant Elmt_Id := Elmt_Low_Bound;
477 -- Used to represent empty element
479 First_Elmt_Id : constant Elmt_Id := No_Elmt + 1;
480 -- Subscript of first allocated Elmt table entry
482 -------------------------------
483 -- Types for Stringt Package --
484 -------------------------------
486 -- String_Id values are used to identify entries in the strings table. They
487 -- are subscripts into the strings table defined in package Strings.
489 -- Note that with only a few exceptions, which are clearly documented, the
490 -- type String_Id should be regarded as a private type. In particular it is
491 -- never appropriate to perform arithmetic operations using this type.
493 type String_Id is range Strings_Low_Bound .. Strings_High_Bound;
494 -- Type used to identify entries in the strings table
496 No_String : constant String_Id := Strings_Low_Bound;
497 -- Used to indicate missing string Id. Note that the value zero is used
498 -- to indicate a missing data value for all the Int types in this section.
500 First_String_Id : constant String_Id := No_String + 1;
501 -- First subscript allocated in string table
503 -------------------------
504 -- Character Code Type --
505 -------------------------
507 -- The type Char is used for character data internally in the compiler, but
508 -- character codes in the source are represented by the Char_Code type.
509 -- Each character literal in the source is interpreted as being one of the
510 -- 16#8000_0000 possible Wide_Wide_Character codes, and a unique Integer
511 -- Value is assigned, corresponding to the UTF_32 value, which also
512 -- corresponds to the POS value in the Wide_Wide_Character type, and also
513 -- corresponds to the POS value in the Wide_Character and Character types
514 -- for values that are in appropriate range. String literals are similarly
515 -- interpreted as a sequence of such codes.
517 type Char_Code_Base is mod 2 ** 32;
518 for Char_Code_Base'Size use 32;
520 subtype Char_Code is Char_Code_Base range 0 .. 16#7FFF_FFFF#;
521 for Char_Code'Value_Size use 32;
522 for Char_Code'Object_Size use 32;
524 function Get_Char_Code (C : Character) return Char_Code;
525 pragma Inline (Get_Char_Code);
526 -- Function to obtain internal character code from source character. For
527 -- the moment, the internal character code is simply the Pos value of the
528 -- input source character, but we provide this interface for possible
529 -- later support of alternative character sets.
531 function In_Character_Range (C : Char_Code) return Boolean;
532 pragma Inline (In_Character_Range);
533 -- Determines if the given character code is in range of type Character,
534 -- and if so, returns True. If not, returns False.
536 function In_Wide_Character_Range (C : Char_Code) return Boolean;
537 pragma Inline (In_Wide_Character_Range);
538 -- Determines if the given character code is in range of the type
539 -- Wide_Character, and if so, returns True. If not, returns False.
541 function Get_Character (C : Char_Code) return Character;
542 pragma Inline (Get_Character);
543 -- For a character C that is in Character range (see above function), this
544 -- function returns the corresponding Character value. It is an error to
545 -- call Get_Character if C is not in Character range.
547 function Get_Wide_Character (C : Char_Code) return Wide_Character;
548 -- For a character C that is in Wide_Character range (see above function),
549 -- this function returns the corresponding Wide_Character value. It is an
550 -- error to call Get_Wide_Character if C is not in Wide_Character range.
552 ---------------------------------------
553 -- Types used for Library Management --
554 ---------------------------------------
556 type Unit_Number_Type is new Int;
557 -- Unit number. The main source is unit 0, and subsidiary sources have
558 -- non-zero numbers starting with 1. Unit numbers are used to index the
559 -- file table in Lib.
561 Main_Unit : constant Unit_Number_Type := 0;
562 -- Unit number value for main unit
564 No_Unit : constant Unit_Number_Type := -1;
565 -- Special value used to signal no unit
567 type Source_File_Index is new Int range -1 .. Int'Last;
568 -- Type used to index the source file table (see package Sinput)
570 Internal_Source_File : constant Source_File_Index :=
571 Source_File_Index'First;
572 -- Value used to indicate the buffer for the source-code-like strings
573 -- internally created withing the compiler (see package Sinput)
575 No_Source_File : constant Source_File_Index := 0;
576 -- Value used to indicate no source file present
578 -----------------------------------
579 -- Representation of Time Stamps --
580 -----------------------------------
582 -- All compiled units are marked with a time stamp which is derived from
583 -- the source file (we assume that the host system has the concept of a
584 -- file time stamp which is modified when a file is modified). These
585 -- time stamps are used to ensure consistency of the set of units that
586 -- constitutes a library. Time stamps are 12 character strings with
587 -- with the following format:
592 -- MM month (2 digits 01-12)
593 -- DD day (2 digits 01-31)
594 -- HH hour (2 digits 00-23)
595 -- MM minutes (2 digits 00-59)
596 -- SS seconds (2 digits 00-59)
598 -- In the case of Unix systems (and other systems which keep the time in
599 -- GMT), the time stamp is the GMT time of the file, not the local time.
600 -- This solves problems in using libraries across networks with clients
601 -- spread across multiple time-zones.
603 Time_Stamp_Length : constant := 14;
604 -- Length of time stamp value
606 subtype Time_Stamp_Index is Natural range 1 .. Time_Stamp_Length;
607 type Time_Stamp_Type is new String (Time_Stamp_Index);
608 -- Type used to represent time stamp
610 Empty_Time_Stamp : constant Time_Stamp_Type := (others => ' ');
611 -- Value representing an empty or missing time stamp. Looks less than any
612 -- real time stamp if two time stamps are compared. Note that although this
613 -- is not private, clients should not rely on the exact way in which this
614 -- string is represented, and instead should use the subprograms below.
616 Dummy_Time_Stamp : constant Time_Stamp_Type := (others => '0');
617 -- This is used for dummy time stamp values used in the D lines for
618 -- non-existent files, and is intended to be an impossible value.
620 function "=" (Left, Right : Time_Stamp_Type) return Boolean;
621 function "<=" (Left, Right : Time_Stamp_Type) return Boolean;
622 function ">=" (Left, Right : Time_Stamp_Type) return Boolean;
623 function "<" (Left, Right : Time_Stamp_Type) return Boolean;
624 function ">" (Left, Right : Time_Stamp_Type) return Boolean;
625 -- Comparison functions on time stamps. Note that two time stamps are
626 -- defined as being equal if they have the same day/month/year and the
627 -- hour/minutes/seconds values are within 2 seconds of one another. This
628 -- deals with rounding effects in library file time stamps caused by
629 -- copying operations during installation. We have particularly noticed
630 -- that WinNT seems susceptible to such changes.
632 -- Note : the Empty_Time_Stamp value looks equal to itself, and less than
633 -- any non-empty time stamp value.
635 procedure Split_Time_Stamp
636 (TS : Time_Stamp_Type;
643 -- Given a time stamp, decompose it into its components
645 procedure Make_Time_Stamp
652 TS : out Time_Stamp_Type);
653 -- Given the components of a time stamp, initialize the value
655 -----------------------------------------------
656 -- Types used for Pragma Suppress Management --
657 -----------------------------------------------
659 type Check_Id is new Nat;
660 -- Type used to represent a check id
662 No_Check_Id : constant := 0;
663 -- Check_Id value used to indicate no check
665 Access_Check : constant := 1;
666 Accessibility_Check : constant := 2;
667 Alignment_Check : constant := 3;
668 Discriminant_Check : constant := 4;
669 Division_Check : constant := 5;
670 Elaboration_Check : constant := 6;
671 Index_Check : constant := 7;
672 Length_Check : constant := 8;
673 Overflow_Check : constant := 9;
674 Range_Check : constant := 10;
675 Storage_Check : constant := 11;
676 Tag_Check : constant := 12;
677 Validity_Check : constant := 13;
678 -- Values used to represent individual predefined checks
680 All_Checks : constant := 14;
681 -- Value used to represent All_Checks value
683 subtype Predefined_Check_Id is Check_Id range 1 .. All_Checks;
684 -- Subtype for predefined checks, including All_Checks
686 -- The following array contains an entry for each recognized check name
687 -- for pragma Suppress. It is used to represent current settings of scope
688 -- based suppress actions from pragma Suppress or command line settings.
690 -- Note: when Suppress_Array (All_Checks) is True, then generally all other
691 -- specific check entries are set True, except for the Elaboration_Check
692 -- entry which is set only if an explicit Suppress for this check is given.
693 -- The reason for this non-uniformity is that we do not want All_Checks to
694 -- suppress elaboration checking when using the static elaboration model.
695 -- We recognize only an explicit suppress of Elaboration_Check as a signal
696 -- that the static elaboration checking should skip a compile time check.
698 type Suppress_Array is array (Predefined_Check_Id) of Boolean;
699 pragma Pack (Suppress_Array);
701 -- To add a new check type to GNAT, the following steps are required:
703 -- 1. Add an entry to Snames spec and body for the new name
704 -- 2. Add an entry to the definition of Check_Id above
705 -- 3. Add a new function to Checks to handle the new check test
706 -- 4. Add a new Do_xxx_Check flag to Sinfo (if required)
707 -- 5. Add appropriate checks for the new test
709 -----------------------------------
710 -- Global Exception Declarations --
711 -----------------------------------
713 -- This section contains declarations of exceptions that are used
714 -- throughout the compiler or in other GNAT tools.
716 Unrecoverable_Error : exception;
717 -- This exception is raised to immediately terminate the compilation of the
718 -- current source program. Used in situations where things are bad enough
719 -- that it doesn't seem worth continuing (e.g. max errors reached, or a
720 -- required file is not found). Also raised when the compiler finds itself
721 -- in trouble after an error (see Comperr).
723 Terminate_Program : exception;
724 -- This exception is raised to immediately terminate the tool being
725 -- executed. Each tool where this exception may be raised must have a
726 -- single exception handler that contains only a null statement and that is
727 -- the last statement of the program. If needed, procedure Set_Exit_Status
728 -- is called with the appropriate exit status before raising
729 -- Terminate_Program.
731 ---------------------------------
732 -- Parameter Mechanism Control --
733 ---------------------------------
735 -- Function and parameter entities have a field that records the
736 -- passing mechanism. See specification of Sem_Mech for full details.
737 -- The following subtype is used to represent values of this type:
739 subtype Mechanism_Type is Int range -10 .. Int'Last;
740 -- Type used to represent a mechanism value. This is a subtype rather
741 -- than a type to avoid some annoying processing problems with certain
742 -- routines in Einfo (processing them to create the corresponding C).
744 ------------------------------
745 -- Run-Time Exception Codes --
746 ------------------------------
748 -- When the code generator generates a run-time exception, it provides a
749 -- reason code which is one of the following. This reason code is used to
750 -- select the appropriate run-time routine to be called, determining both
751 -- the exception to be raised, and the message text to be added.
753 -- The prefix CE/PE/SE indicates the exception to be raised
754 -- CE = Constraint_Error
755 -- PE = Program_Error
756 -- SE = Storage_Error
758 -- The remaining part of the name indicates the message text to be added,
759 -- where all letters are lower case, and underscores are converted to
760 -- spaces (for example CE_Invalid_Data adds the text "invalid data").
762 -- To add a new code, you need to do the following:
764 -- 1. Modify the type and subtype declarations below appropriately,
765 -- keeping things in alphabetical order.
767 -- 2. Modify the corresponding definitions in types.h, including
768 -- the definition of last_reason_code.
770 -- 3. Add a new routine in Ada.Exceptions with the appropriate call
771 -- and static string constant. Note that there is more than one
772 -- version of a-except.adb which must be modified.
774 type RT_Exception_Code is
775 (CE_Access_Check_Failed, -- 00
776 CE_Access_Parameter_Is_Null, -- 01
777 CE_Discriminant_Check_Failed, -- 02
778 CE_Divide_By_Zero, -- 03
779 CE_Explicit_Raise, -- 04
780 CE_Index_Check_Failed, -- 05
781 CE_Invalid_Data, -- 06
782 CE_Length_Check_Failed, -- 07
783 CE_Null_Exception_Id, -- 08
784 CE_Null_Not_Allowed, -- 09
785 CE_Overflow_Check_Failed, -- 10
786 CE_Partition_Check_Failed, -- 11
787 CE_Range_Check_Failed, -- 12
788 CE_Tag_Check_Failed, -- 13
790 PE_Access_Before_Elaboration, -- 14
791 PE_Accessibility_Check_Failed, -- 15
792 PE_All_Guards_Closed, -- 16
793 PE_Current_Task_In_Entry_Body, -- 17
794 PE_Duplicated_Entry_Address, -- 18
795 PE_Explicit_Raise, -- 19
796 PE_Finalize_Raised_Exception, -- 20
797 PE_Implicit_Return, -- 21
798 PE_Misaligned_Address_Value, -- 22
799 PE_Missing_Return, -- 23
800 PE_Overlaid_Controlled_Object, -- 24
801 PE_Potentially_Blocking_Operation, -- 25
802 PE_Stubbed_Subprogram_Called, -- 26
803 PE_Unchecked_Union_Restriction, -- 27
804 PE_Non_Transportable_Actual, -- 28
806 SE_Empty_Storage_Pool, -- 29
807 SE_Explicit_Raise, -- 30
808 SE_Infinite_Recursion, -- 31
809 SE_Object_Too_Large); -- 32
811 subtype RT_CE_Exceptions is RT_Exception_Code range
812 CE_Access_Check_Failed ..
815 subtype RT_PE_Exceptions is RT_Exception_Code range
816 PE_Access_Before_Elaboration ..
817 PE_Non_Transportable_Actual;
819 subtype RT_SE_Exceptions is RT_Exception_Code range
820 SE_Empty_Storage_Pool ..
OSDN Git Service
