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. 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 COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- This package defines the internal data structures used for representation
27 -- of Ada Library Information (ALI) acquired from the ALI files generated by
30 with Casing; use Casing;
31 with Gnatvsn; use Gnatvsn;
32 with Namet; use Namet;
33 with Rident; use Rident;
35 with Types; use Types;
37 with GNAT.HTable; use GNAT.HTable;
45 -- The various entries are stored in tables with distinct subscript ranges.
46 -- The following type definitions show the ranges used for the subscripts
47 -- (Id values) for the various tables.
49 type ALI_Id is range 0 .. 999_999;
50 -- Id values used for ALIs table entries
52 type Unit_Id is range 1_000_000 .. 1_999_999;
53 -- Id values used for Unit table entries
55 type With_Id is range 2_000_000 .. 2_999_999;
56 -- Id values used for Withs table entries
58 type Arg_Id is range 3_000_000 .. 3_999_999;
59 -- Id values used for argument table entries
61 type Sdep_Id is range 4_000_000 .. 4_999_999;
62 -- Id values used for Sdep table entries
64 type Source_Id is range 5_000_000 .. 5_999_999;
65 -- Id values used for Source table entries
67 type Interrupt_State_Id is range 6_000_000 .. 6_999_999;
68 -- Id values used for Interrupt_State table entries
70 type Priority_Specific_Dispatching_Id is range 7_000_000 .. 7_999_999;
71 -- Id values used for Priority_Specific_Dispatching table entries
77 -- Each ALI file read generates an entry in the ALIs table
79 No_ALI_Id : constant ALI_Id := ALI_Id'First;
80 -- Special value indicating no ALI entry
82 First_ALI_Entry : constant ALI_Id := No_ALI_Id + 1;
83 -- Id of first actual entry in table
85 type Main_Program_Type is (None, Proc, Func);
86 -- Indicator of whether unit can be used as main program
88 type ALIs_Record is record
90 Afile : File_Name_Type;
93 Ofile_Full_Name : File_Name_Type;
94 -- Full name of object file corresponding to the ALI file
96 Sfile : File_Name_Type;
97 -- Name of source file that generates this ALI file (which is equal
98 -- to the name of the source file in the first unit table entry for
99 -- this ALI file, since the body if present is always first).
101 Ver : String (1 .. Ver_Len_Max);
102 -- Value of library version (V line in ALI file). Not set if
103 -- V lines are ignored as a result of the Ignore_Lines parameter.
106 -- Length of characters stored in Ver. Not set if V lines are ignored as
107 -- a result of the Ignore_Lines parameter.
109 SAL_Interface : Boolean;
110 -- Set True when this is an interface to a standalone library
112 First_Unit : Unit_Id;
113 -- Id of first Unit table entry for this file
116 -- Id of last Unit table entry for this file
118 First_Sdep : Sdep_Id;
119 -- Id of first Sdep table entry for this file
122 -- Id of last Sdep table entry for this file
124 Main_Program : Main_Program_Type;
125 -- Indicator of whether first unit can be used as main program. Not set
126 -- if 'M' appears in Ignore_Lines.
129 -- Indicates priority value if Main_Program field indicates that this
130 -- can be a main program. A value of -1 (No_Main_Priority) indicates
131 -- that no parameter was found, or no M line was present. Not set if
132 -- 'M' appears in Ignore_Lines.
135 -- Indicates processor if Main_Program field indicates that this can
136 -- be a main program. A value of -1 (No_Main_CPU) indicates that no C
137 -- parameter was found, or no M line was present. Not set if 'M' appears
140 Time_Slice_Value : Int;
141 -- Indicates value of time slice parameter from T=xxx on main program
142 -- line. A value of -1 indicates that no T=xxx parameter was found, or
143 -- no M line was present. Not set if 'M' appears in Ignore_Lines.
145 Allocator_In_Body : Boolean;
146 -- Set True if an AB switch appears on the main program line. False
147 -- if no M line, or AB not present, or 'M appears in Ignore_Lines.
149 WC_Encoding : Character;
150 -- Wide character encoding if main procedure. Otherwise not relevant.
151 -- Not set if 'M' appears in Ignore_Lines.
153 Locking_Policy : Character;
154 -- Indicates locking policy for units in this file. Space means tasking
155 -- was not used, or that no Locking_Policy pragma was present or that
156 -- this is a language defined unit. Otherwise set to first character
157 -- (upper case) of policy name. Not set if 'P' appears in Ignore_Lines.
159 Queuing_Policy : Character;
160 -- Indicates queuing policy for units in this file. Space means tasking
161 -- was not used, or that no Queuing_Policy pragma was present or that
162 -- this is a language defined unit. Otherwise set to first character
163 -- (upper case) of policy name. Not set if 'P' appears in Ignore_Lines.
165 Task_Dispatching_Policy : Character;
166 -- Indicates task dispatching policy for units in this file. Space means
167 -- tasking was not used, or that no Task_Dispatching_Policy pragma was
168 -- present or that this is a language defined unit. Otherwise set to
169 -- first character (upper case) of policy name. Not set if 'P' appears
172 Compile_Errors : Boolean;
173 -- Set to True if compile errors for unit. Note that No_Object will
174 -- always be set as well in this case. Not set if 'P' appears in
177 Float_Format : Character;
178 -- Set to float format (set to I if no float-format given). Not set if
179 -- 'P' appears in Ignore_Lines.
182 -- Set to True if no object file generated. Not set if 'P' appears in
185 Normalize_Scalars : Boolean;
186 -- Set to True if file was compiled with Normalize_Scalars. Not set if
187 -- 'P' appears in Ignore_Lines.
189 Unit_Exception_Table : Boolean;
190 -- Set to True if unit exception table pointer generated. Not set if 'P'
191 -- appears in Ignore_Lines.
193 Zero_Cost_Exceptions : Boolean;
194 -- Set to True if file was compiled with zero cost exceptions. Not set
195 -- if 'P' appears in Ignore_Lines.
197 Restrictions : Restrictions_Info;
198 -- Restrictions information reconstructed from R lines
200 First_Interrupt_State : Interrupt_State_Id;
201 Last_Interrupt_State : Interrupt_State_Id'Base;
202 -- These point to the first and last entries in the interrupt state
203 -- table for this unit. If no entries, then Last_Interrupt_State =
204 -- First_Interrupt_State - 1 (that's why the 'Base reference is there,
205 -- it can be one less than the lower bound of the subtype). Not set if
206 -- 'I' appears in Ignore_Lines
208 First_Specific_Dispatching : Priority_Specific_Dispatching_Id;
209 Last_Specific_Dispatching : Priority_Specific_Dispatching_Id'Base;
210 -- These point to the first and last entries in the priority specific
211 -- dispatching table for this unit. If there are no entries, then
212 -- Last_Specific_Dispatching = First_Specific_Dispatching - 1. That
213 -- is why the 'Base reference is there, it can be one less than the
214 -- lower bound of the subtype. Not set if 'S' appears in Ignore_Lines.
218 No_Main_Priority : constant Int := -1;
219 -- Code for no main priority set
221 No_Main_CPU : constant Int := -1;
222 -- Code for no main cpu set
224 package ALIs is new Table.Table (
225 Table_Component_Type => ALIs_Record,
226 Table_Index_Type => ALI_Id,
227 Table_Low_Bound => First_ALI_Entry,
228 Table_Initial => 500,
229 Table_Increment => 200,
230 Table_Name => "ALIs");
236 -- Each unit within an ALI file generates an entry in the unit table
238 No_Unit_Id : constant Unit_Id := Unit_Id'First;
239 -- Special value indicating no unit table entry
241 First_Unit_Entry : constant Unit_Id := No_Unit_Id + 1;
242 -- Id of first actual entry in table
244 type Unit_Type is (Is_Spec, Is_Body, Is_Spec_Only, Is_Body_Only);
245 -- Indicates type of entry, if both body and spec appear in the ALI file,
246 -- then the first unit is marked Is_Body, and the second is marked Is_Spec.
247 -- If only a spec appears, then it is marked as Is_Spec_Only, and if only
248 -- a body appears, then it is marked Is_Body_Only).
250 subtype Version_String is String (1 .. 8);
251 -- Version string, taken from unit record
253 type Unit_Record is record
256 -- Corresponding ALI entry
258 Uname : Unit_Name_Type;
261 Sfile : File_Name_Type;
262 -- Name of source file
265 -- Indicates presence of PR parameter for a preelaborated package
268 -- Indicates presence of NE parameter for a unit that has does not
269 -- have an elaboration routine (since it has no elaboration code).
272 -- Indicates presence of PU parameter for a package having pragma Pure
274 Dynamic_Elab : Boolean;
275 -- Set to True if the unit was compiled with dynamic elaboration checks
276 -- (i.e. either -gnatE or pragma Elaboration_Checks (RM) was used to
277 -- compile the unit).
279 Elaborate_Body : Boolean;
280 -- Indicates presence of EB parameter for a package which has a pragma
281 -- Elaborate_Body, and also for generic package instantiations.
283 Set_Elab_Entity : Boolean;
284 -- Indicates presence of EE parameter for a unit which has an
285 -- elaboration entity which must be set true as part of the
286 -- elaboration of the entity.
289 -- Indicates presence of RA parameter for a package that declares at
290 -- least one Remote Access to Class_Wide (RACW) object.
292 Remote_Types : Boolean;
293 -- Indicates presence of RT parameter for a package which has a
294 -- pragma Remote_Types.
296 Shared_Passive : Boolean;
297 -- Indicates presence of SP parameter for a package which has a pragma
301 -- Indicates presence of RC parameter for a package which has a pragma
302 -- Remote_Call_Interface.
304 Predefined : Boolean;
305 -- Indicates if unit is language predefined (or a child of such a unit)
308 -- Indicates if unit is an internal unit (or a child of such a unit)
310 First_With : With_Id;
311 -- Id of first withs table entry for this file
314 -- Id of last withs table entry for this file
317 -- Id of first args table entry for this file
320 -- Id of last args table entry for this file
325 Is_Generic : Boolean;
326 -- True for generic unit (i.e. a generic declaration, or a generic
327 -- body). False for a non-generic unit.
329 Unit_Kind : Character;
330 -- Indicates the nature of the unit. 'p' for Packages and 's' for
333 Version : Version_String;
336 Icasing : Casing_Type;
337 -- Indicates casing of identifiers in source file for this unit. This
338 -- is used for informational output, and also for constructing the main
339 -- unit if it is being built in Ada.
341 Kcasing : Casing_Type;
342 -- Indicates casing of keywords in source file for this unit. This is
343 -- used for informational output, and also for constructing the main
344 -- unit if it is being built in Ada.
346 Elab_Position : aliased Natural;
347 -- Initialized to zero. Set non-zero when a unit is chosen and
348 -- placed in the elaboration order. The value represents the
349 -- ordinal position in the elaboration order.
351 Init_Scalars : Boolean;
352 -- Set True if IS qualifier appears in ALI file, indicating that
353 -- an Initialize_Scalars pragma applies to the unit.
355 SAL_Interface : Boolean;
356 -- Set True when this is an interface to a standalone library
358 Directly_Scanned : Boolean;
359 -- True iff it is a unit from an ALI file specified to gnatbind
361 Body_Needed_For_SAL : Boolean;
362 -- Indicates that the source for the body of the unit (subprogram,
363 -- package, or generic unit) must be included in a standalone library.
365 Elaborate_Body_Desirable : Boolean;
366 -- Indicates that the front end elaboration circuitry decided that it
367 -- would be a good idea if this package had Elaborate_Body. The binder
368 -- will attempt, but does not promise, to place the elaboration call
369 -- for the body right after the call for the spec, or at least as close
370 -- together as possible.
372 Optimize_Alignment : Character;
373 -- Optimize_Alignment setting. Set to L/S/T/O for OL/OS/OT/OO present
375 Has_Finalizer : Boolean;
376 -- Indicates whether a package body or a spec has a library-level
377 -- finalization routine.
380 package Units is new Table.Table (
381 Table_Component_Type => Unit_Record,
382 Table_Index_Type => Unit_Id,
383 Table_Low_Bound => First_Unit_Entry,
384 Table_Initial => 100,
385 Table_Increment => 200,
386 Table_Name => "Unit");
388 ---------------------------
389 -- Interrupt State Table --
390 ---------------------------
392 -- An entry is made in this table for each I (interrupt state) line
393 -- encountered in the input ALI file. The First/Last_Interrupt_Id
394 -- fields of the ALI file entry show the range of entries defined
395 -- within a particular ALI file.
397 type Interrupt_State_Record is record
399 -- Id from interrupt state entry
401 Interrupt_State : Character;
402 -- State from interrupt state entry ('u'/'r'/'s')
404 IS_Pragma_Line : Nat;
405 -- Line number of Interrupt_State pragma
408 package Interrupt_States is new Table.Table (
409 Table_Component_Type => Interrupt_State_Record,
410 Table_Index_Type => Interrupt_State_Id'Base,
411 Table_Low_Bound => Interrupt_State_Id'First,
412 Table_Initial => 100,
413 Table_Increment => 200,
414 Table_Name => "Interrupt_States");
416 -----------------------------------------
417 -- Priority Specific Dispatching Table --
418 -----------------------------------------
420 -- An entry is made in this table for each S (priority specific
421 -- dispatching) line encountered in the input ALI file. The
422 -- First/Last_Specific_Dispatching_Id fields of the ALI file
423 -- entry show the range of entries defined within a particular
426 type Specific_Dispatching_Record is record
427 Dispatching_Policy : Character;
428 -- First character (upper case) of the corresponding policy name
430 First_Priority : Nat;
431 -- Lower bound of the priority range to which the specified dispatching
435 -- Upper bound of the priority range to which the specified dispatching
438 PSD_Pragma_Line : Nat;
439 -- Line number of Priority_Specific_Dispatching pragma
442 package Specific_Dispatching is new Table.Table (
443 Table_Component_Type => Specific_Dispatching_Record,
444 Table_Index_Type => Priority_Specific_Dispatching_Id'Base,
445 Table_Low_Bound => Priority_Specific_Dispatching_Id'First,
446 Table_Initial => 100,
447 Table_Increment => 200,
448 Table_Name => "Priority_Specific_Dispatching");
454 -- These switches record status information about ali files that
455 -- have been read, for quick reference without searching tables.
457 -- Note: a switch will be left set at its default value if the line
458 -- which might otherwise set it is ignored (from Ignore_Lines).
460 Dynamic_Elaboration_Checks_Specified : Boolean := False;
461 -- Set to False by Initialize_ALI. Set to True if Scan_ALI reads
462 -- a unit for which dynamic elaboration checking is enabled.
464 Float_Format_Specified : Character := ' ';
465 -- Set to blank by Initialize_ALI. Set to appropriate float format
466 -- character (V or I, see Opt.Float_Format) if an ali file that
467 -- is read contains an F line setting the floating point format.
469 Initialize_Scalars_Used : Boolean := False;
470 -- Set True if an ali file contains the Initialize_Scalars flag
472 Locking_Policy_Specified : Character := ' ';
473 -- Set to blank by Initialize_ALI. Set to the appropriate locking policy
474 -- character if an ali file contains a P line setting the locking policy.
476 No_Normalize_Scalars_Specified : Boolean := False;
477 -- Set to False by Initialize_ALI. Set to True if an ali file indicates
478 -- that the file was compiled without normalize scalars.
480 No_Object_Specified : Boolean := False;
481 -- Set to False by Initialize_ALI. Set to True if an ali file contains
482 -- the No_Object flag.
484 Normalize_Scalars_Specified : Boolean := False;
485 -- Set to False by Initialize_ALI. Set to True if an ali file indicates
486 -- that the file was compiled in Normalize_Scalars mode.
488 Queuing_Policy_Specified : Character := ' ';
489 -- Set to blank by Initialize_ALI. Set to the appropriate queuing policy
490 -- character if an ali file contains a P line setting the queuing policy.
492 Cumulative_Restrictions : Restrictions_Info := No_Restrictions;
493 -- This variable records the cumulative contributions of R lines in all
494 -- ali files, showing whether a restriction pragma exists anywhere, and
495 -- accumulating the aggregate knowledge of violations.
497 Stack_Check_Switch_Set : Boolean := False;
498 -- Set to True if at least one ALI file contains '-fstack-check' in its
501 Static_Elaboration_Model_Used : Boolean := False;
502 -- Set to False by Initialize_ALI. Set to True if any ALI file for a
503 -- non-internal unit compiled with the static elaboration model is
506 Task_Dispatching_Policy_Specified : Character := ' ';
507 -- Set to blank by Initialize_ALI. Set to the appropriate task dispatching
508 -- policy character if an ali file contains a P line setting the
509 -- task dispatching policy.
511 Unreserve_All_Interrupts_Specified : Boolean := False;
512 -- Set to False by Initialize_ALI. Set to True if an ali file is read that
513 -- has P line specifying unreserve all interrupts mode.
515 Zero_Cost_Exceptions_Specified : Boolean := False;
516 -- Set to False by Initialize_ALI. Set to True if an ali file is read that
517 -- has a P line specifying the generation of zero cost exceptions.
523 -- Each With line (W line) in an ALI file generates a Withs table entry
525 -- Note: there will be no entries in this table if 'W' lines are ignored
527 No_With_Id : constant With_Id := With_Id'First;
528 -- Special value indicating no withs table entry
530 First_With_Entry : constant With_Id := No_With_Id + 1;
531 -- Id of first actual entry in table
533 type With_Record is record
535 Uname : Unit_Name_Type;
538 Sfile : File_Name_Type;
539 -- Name of source file, set to No_File in generic case
541 Afile : File_Name_Type;
542 -- Name of ALI file, set to No_File in generic case
545 -- Indicates presence of E parameter
547 Elaborate_All : Boolean;
548 -- Indicates presence of EA parameter
550 Elab_All_Desirable : Boolean;
551 -- Indicates presence of AD parameter
553 Elab_Desirable : Boolean;
554 -- Indicates presence of ED parameter
556 SAL_Interface : Boolean := False;
557 -- True if the Unit is an Interface of a Stand-Alone Library
559 Limited_With : Boolean := False;
560 -- True if unit is named in a limited_with_clause
563 package Withs is new Table.Table (
564 Table_Component_Type => With_Record,
565 Table_Index_Type => With_Id,
566 Table_Low_Bound => First_With_Entry,
567 Table_Initial => 5000,
568 Table_Increment => 200,
569 Table_Name => "Withs");
571 ---------------------
572 -- Arguments Table --
573 ---------------------
575 -- Each Arg line (A line) in an ALI file generates an Args table entry
577 -- Note: there will be no entries in this table if 'A' lines are ignored
579 No_Arg_Id : constant Arg_Id := Arg_Id'First;
580 -- Special value indicating no args table entry
582 First_Arg_Entry : constant Arg_Id := No_Arg_Id + 1;
583 -- Id of first actual entry in table
585 package Args is new Table.Table (
586 Table_Component_Type => String_Ptr,
587 Table_Index_Type => Arg_Id,
588 Table_Low_Bound => First_Arg_Entry,
589 Table_Initial => 1000,
590 Table_Increment => 100,
591 Table_Name => "Args");
593 --------------------------
594 -- Linker_Options Table --
595 --------------------------
597 -- If an ALI file has one of more Linker_Options lines, then a single
598 -- entry is made in this table. If more than one Linker_Options lines
599 -- appears in a given ALI file, then the arguments are concatenated
600 -- to form the entry in this table, using a NUL character as the
601 -- separator, and a final NUL character is appended to the end.
603 -- Note: there will be no entries in this table if 'L' lines are ignored
605 type Linker_Option_Record is record
607 -- Name entry containing concatenated list of Linker_Options
608 -- arguments separated by NUL and ended by NUL as described above.
611 -- Unit_Id for the entry
613 Internal_File : Boolean;
614 -- Set True if the linker options are from an internal file. This is
615 -- used to insert certain standard entries after all the user entries
616 -- but before the entries from the run-time.
618 Original_Pos : Positive;
619 -- Keep track of original position in the linker options table. This
620 -- is used to implement a stable sort when we sort the linker options
624 -- The indexes of active entries in this table range from 1 to the
625 -- value of Linker_Options.Last. The zero'th element is for sort call.
627 package Linker_Options is new Table.Table (
628 Table_Component_Type => Linker_Option_Record,
629 Table_Index_Type => Integer,
630 Table_Low_Bound => 0,
631 Table_Initial => 200,
632 Table_Increment => 400,
633 Table_Name => "Linker_Options");
639 -- The notes table records entries from N lines
641 type Notes_Record is record
642 Pragma_Type : Character;
643 -- 'A', 'C', 'I', 'S', 'T' for Annotate/Comment/Ident/Subtitle/Title
646 -- Line number of pragma
649 -- Column number of pragma
652 -- Unit_Id for the entry
654 Pragma_Args : Name_Id;
655 -- Pragma arguments. No_Name if no arguments, otherwise a single
656 -- name table entry consisting of all the characters on the notes
657 -- line from the first non-blank character following the source
658 -- location to the last character on the line.
661 -- The indexes of active entries in this table range from 1 to the
662 -- value of Linker_Options.Last. The zero'th element is for convenience
663 -- if the table needs to be sorted.
665 package Notes is new Table.Table (
666 Table_Component_Type => Notes_Record,
667 Table_Index_Type => Integer,
668 Table_Low_Bound => 0,
669 Table_Initial => 200,
670 Table_Increment => 400,
671 Table_Name => "Notes");
673 -------------------------------------------
674 -- External Version Reference Hash Table --
675 -------------------------------------------
677 -- This hash table keeps track of external version reference strings
678 -- as read from E lines in the ali file. The stored values do not
679 -- include the terminating quote characters.
681 -- Note: there will be no entries in this table if 'E' lines are ignored
683 type Vindex is range 0 .. 98;
684 -- Type to define range of headers
686 function SHash (S : String_Ptr) return Vindex;
687 -- Hash function for this table
689 function SEq (F1, F2 : String_Ptr) return Boolean;
690 -- Equality function for this table
692 package Version_Ref is new Simple_HTable (
693 Header_Num => Vindex,
700 -------------------------
701 -- No_Dependency Table --
702 -------------------------
704 -- Each R line for a No_Dependency Restriction generates an entry in
705 -- this No_Dependency table.
707 type No_Dep_Record is record
709 -- ALI File containing the entry
711 No_Dep_Unit : Name_Id;
712 -- Id for names table entry including entire name, including periods
715 package No_Deps is new Table.Table (
716 Table_Component_Type => No_Dep_Record,
717 Table_Index_Type => Integer,
718 Table_Low_Bound => 0,
719 Table_Initial => 200,
720 Table_Increment => 400,
721 Table_Name => "No_Deps");
723 ------------------------------------
724 -- Sdep (Source Dependency) Table --
725 ------------------------------------
727 -- Each source dependency (D line) in an ALI file generates an entry in the
730 -- Note: there will be no entries in this table if 'D' lines are ignored
732 No_Sdep_Id : constant Sdep_Id := Sdep_Id'First;
733 -- Special value indicating no Sdep table entry
735 First_Sdep_Entry : Sdep_Id := No_Sdep_Id + 1;
736 -- Id of first Sdep entry for current ali file. This is initialized to the
737 -- first Sdep entry in the table, and then incremented appropriately as
738 -- successive ALI files are scanned.
740 type Sdep_Record is record
742 Sfile : File_Name_Type;
743 -- Name of source file
745 Stamp : Time_Stamp_Type;
746 -- Time stamp value. Note that this will be all zero characters for the
747 -- dummy entries for missing or non-dependent files.
750 -- Checksum value. Note that this will be all zero characters for the
751 -- dummy entries for missing or non-dependent files
753 Dummy_Entry : Boolean;
754 -- Set True for dummy entries that correspond to missing files or files
755 -- where no dependency relationship exists.
757 Subunit_Name : Name_Id;
758 -- Name_Id for subunit name if present, else No_Name
760 Rfile : File_Name_Type;
761 -- Reference file name. Same as Sfile unless a Source_Reference pragma
762 -- was used, in which case it reflects the name used in the pragma.
765 -- Starting line number in file. Always 1, unless a Source_Reference
766 -- pragma was used, in which case it reflects the line number value
767 -- given in the pragma.
771 package Sdep is new Table.Table (
772 Table_Component_Type => Sdep_Record,
773 Table_Index_Type => Sdep_Id,
774 Table_Low_Bound => First_Sdep_Entry,
775 Table_Initial => 5000,
776 Table_Increment => 200,
777 Table_Name => "Sdep");
779 ----------------------------
780 -- Use of Name Table Info --
781 ----------------------------
783 -- All unit names and file names are entered into the Names table. The Info
784 -- fields of these entries are used as follows:
786 -- Unit name Info field has Unit_Id of unit table entry
787 -- ALI file name Info field has ALI_Id of ALI table entry
788 -- Source file name Info field has Source_Id of source table entry
790 --------------------------
791 -- Cross-Reference Data --
792 --------------------------
794 -- The following table records cross-reference sections, there is one entry
795 -- for each X header line in the ALI file for an xref section.
797 -- Note: there will be no entries in this table if 'X' lines are ignored
799 type Xref_Section_Record is record
801 -- Dependency number for file (entry in Sdep.Table)
803 File_Name : File_Name_Type;
807 -- First entry in Xref_Entity table
810 -- Last entry in Xref_Entity table
813 package Xref_Section is new Table.Table (
814 Table_Component_Type => Xref_Section_Record,
815 Table_Index_Type => Nat,
816 Table_Low_Bound => 1,
818 Table_Increment => 300,
819 Table_Name => "Xref_Section");
821 -- The following is used to indicate whether a typeref field is present
822 -- for the entity, and if so what kind of typeref field.
825 Tref_None, -- No typeref present
826 Tref_Access, -- Access type typeref (points to designated type)
827 Tref_Derived, -- Derived type typeref (points to parent type)
828 Tref_Type); -- All other cases
830 type Visibility_Kind is
831 (Global, -- Library level entity
832 Static, -- Static C/C++ entity
833 Other); -- Local and other entity
835 -- The following table records entities for which xrefs are recorded
837 type Xref_Entity_Record is record
839 -- Line number of definition
842 -- Set to the identification character for the entity. See section
843 -- "Cross-Reference Entity Identifiers" in lib-xref.ads for details.
846 -- Column number of definition
848 Visibility : Visibility_Kind;
849 -- Visibility of entity
854 Iref_File_Num : Sdep_Id;
855 -- This field is set to the dependency reference for the file containing
856 -- the generic entity that this one instantiates, or to No_Sdep_Id if
857 -- the current entity is not an instantiation
860 -- This field is set to the line number in Iref_File_Num of the generic
861 -- entity that this one instantiates, or to zero if the current entity
862 -- is not an instantiation.
865 -- This field is set to the line number of a renaming reference if
866 -- one is present, or to zero if no renaming reference is present
869 -- This field is set to the column number of a renaming reference
870 -- if one is present, or to zero if no renaming reference is present.
873 -- Indicates if a typeref is present, and if so what kind. Set to
874 -- Tref_None if no typeref field is present.
876 Tref_File_Num : Sdep_Id;
877 -- This field is set to No_Sdep_Id if no typeref is present, or
878 -- if the typeref refers to an entity in standard. Otherwise it
879 -- it is the dependency reference for the file containing the
880 -- declaration of the typeref entity.
883 -- This field is set to zero if no typeref is present, or if the
884 -- typeref refers to an entity in standard. Otherwise it contains
885 -- the line number of the declaration of the typeref entity.
887 Tref_Type : Character;
888 -- This field is set to blank if no typeref is present, or if the
889 -- typeref refers to an entity in standard. Otherwise it contains
890 -- the identification character for the typeref entity. See section
891 -- "Cross-Reference Entity Identifiers" in lib-xref.ads for details.
894 -- This field is set to zero if no typeref is present, or if the
895 -- typeref refers to an entity in standard. Otherwise it contains
896 -- the column number of the declaration of the parent type.
898 Tref_Standard_Entity : Name_Id;
899 -- This field is set to No_Name if no typeref is present or if the
900 -- typeref refers to a declared entity rather than an entity in
901 -- package Standard. If there is a typeref that references an
902 -- entity in package Standard, then this field is a Name_Id
903 -- reference for the entity name.
905 Oref_File_Num : Sdep_Id;
906 -- This field is set to No_Sdep_Id if the entity doesn't override any
907 -- other entity, or to the dependency reference for the overridden
912 -- These two fields are set to the line and column of the overridden
916 -- Index into Xref table of first cross-reference
919 -- Index into Xref table of last cross-reference. The value in
920 -- Last_Xref can be less than the First_Xref value to indicate
921 -- that no entries are present in the Xref Table.
924 package Xref_Entity is new Table.Table (
925 Table_Component_Type => Xref_Entity_Record,
926 Table_Index_Type => Nat,
927 Table_Low_Bound => 1,
928 Table_Initial => 500,
929 Table_Increment => 300,
930 Table_Name => "Xref_Entity");
932 Array_Index_Reference : constant Character := '*';
933 Interface_Reference : constant Character := 'I';
934 -- Some special types of references. In the ALI file itself, these
935 -- are output as attributes of the entity, not as references, but
936 -- there is no provision in Xref_Entity_Record for storing multiple
939 -- The following table records actual cross-references
941 type Xref_Record is record
943 -- Set to the file dependency number for the cross-reference. Note
944 -- that if no file entry is present explicitly, this is just a copy
945 -- of the reference for the current cross-reference section.
948 -- Line number for the reference. This is zero when referencing a
949 -- predefined entity, but in this case Name is set.
952 -- Indicates type of reference, using code used in ALI file:
956 -- c = completion of private or incomplete type
957 -- x = type extension
958 -- i = implicit reference
959 -- Array_Index_Reference = reference to the index of an array
960 -- Interface_Reference = reference to an interface implemented
962 -- See description in lib-xref.ads for further details
965 -- Column number for the reference
967 Name : Name_Id := No_Name;
968 -- This is only used when referencing a predefined entity. Currently,
969 -- this only occurs for array indexes.
971 -- Note: for instantiation references, Rtype is set to ' ', and Col is
972 -- set to zero. One or more such entries can follow any other reference.
973 -- When there is more than one such entry, this is to be read as:
974 -- e.g. ref1 ref2 ref3
975 -- ref1 is a reference to an entity that was instantied at ref2.
976 -- ref2 itself is also the result of an instantiation, that took
979 Imported_Lang : Name_Id := No_Name;
980 Imported_Name : Name_Id := No_Name;
981 -- Language and name of imported entity reference
984 package Xref is new Table.Table (
985 Table_Component_Type => Xref_Record,
986 Table_Index_Type => Nat,
987 Table_Low_Bound => 1,
988 Table_Initial => 2000,
989 Table_Increment => 300,
990 Table_Name => "Xref");
992 --------------------------------------
993 -- Subprograms for Reading ALI File --
994 --------------------------------------
996 procedure Initialize_ALI;
997 -- Initialize the ALI tables. Also resets all switch values to defaults
1000 (F : File_Name_Type;
1001 T : Text_Buffer_Ptr;
1002 Ignore_ED : Boolean;
1004 Read_Xref : Boolean := False;
1005 Read_Lines : String := "";
1006 Ignore_Lines : String := "X";
1007 Ignore_Errors : Boolean := False;
1008 Directly_Scanned : Boolean := False) return ALI_Id;
1009 -- Given the text, T, of an ALI file, F, scan and store the information
1010 -- from the file, and return the Id of the resulting entry in the ALI
1011 -- table. Switch settings may be modified as described above in the
1012 -- switch description settings.
1014 -- Ignore_ED is normally False. If set to True, it indicates that
1015 -- all AD/ED (elaboration desirable) indications in the ALI file are
1016 -- to be ignored. This parameter is obsolete now that the -f switch
1017 -- is removed from gnatbind, and should be removed ???
1019 -- Err determines the action taken on an incorrectly formatted file.
1020 -- If Err is False, then an error message is output, and the program
1021 -- is terminated. If Err is True, then no error message is output,
1022 -- and No_ALI_Id is returned.
1024 -- Ignore_Lines requests that Scan_ALI ignore any lines that start
1025 -- with any given key character. The default value of X causes all
1026 -- Xref lines to be ignored. The corresponding data in the ALI
1027 -- tables will not be filled in this case. It is not possible
1028 -- to ignore U (unit) lines, they are always read.
1030 -- Read_Lines requests that Scan_ALI process only lines that start
1031 -- with one of the given characters. The corresponding data in the
1032 -- ALI file for any characters not given in the list will not be
1033 -- set. The default value of the null string indicates that all
1034 -- lines should be read (unless Ignore_Lines is specified). U
1035 -- (unit) lines are always read regardless of the value of this
1038 -- Note: either Ignore_Lines or Read_Lines should be non-null, but not
1039 -- both. If both are provided then only the Read_Lines value is used,
1040 -- and the Ignore_Lines parameter is ignored.
1042 -- Read_XREF is set True to read and acquire the cross-reference
1043 -- information. If Read_XREF is set to True, then the effect is to ignore
1044 -- all lines other than U, W, D and X lines and the Ignore_Lines and
1045 -- Read_Lines parameters are ignored (i.e. the use of True for Read_XREF
1046 -- is equivalent to specifying an argument of "UWDX" for Read_Lines.
1048 -- Ignore_Errors is normally False. If it is set True, then Scan_ALI
1049 -- will do its best to scan through a file and extract all information
1050 -- it can, even if there are errors. In this case Err is only set if
1051 -- Scan_ALI was completely unable to process the file (e.g. it did not
1052 -- look like an ALI file at all). Ignore_Errors is intended to improve
1053 -- the downward compatibility of new compilers with old tools.
1055 -- Directly_Scanned is normally False. If it is set to True, then the
1056 -- units (spec and/or body) corresponding to the ALI file are marked as
1057 -- such. It is used to decide for what units gnatbind should generate
1058 -- the symbols corresponding to 'Version or 'Body_Version in
1059 -- Stand-Alone Libraries.