OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [gnu-dev/] [or1k-gcc/] [gcc/] [ada/] [types.ads] - Blame information for rev 706

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.