gcc/ada/ali.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                  A L I                                   --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2012, 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.  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.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  This package defines the internal data structures used for representation
  27 --  of Ada Library Information (ALI) acquired from the ALI files generated by
  28 --  the front end.
  29
  30 with Casing;  use Casing;
  31 with Gnatvsn; use Gnatvsn;
  32 with Namet;   use Namet;
  33 with Rident;  use Rident;
  34 with Table;
  35 with Types;   use Types;
  36
  37 with GNAT.HTable; use GNAT.HTable;
  38
  39 package ALI is
  40
  41    --------------
  42    -- Id Types --
  43    --------------
  44
  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.
  48
  49    type ALI_Id is range 0 .. 999_999;
  50    --  Id values used for ALIs table entries
  51
  52    type Unit_Id is range 1_000_000 .. 1_999_999;
  53    --  Id values used for Unit table entries
  54
  55    type With_Id is range 2_000_000 .. 2_999_999;
  56    --  Id values used for Withs table entries
  57
  58    type Arg_Id is range 3_000_000 .. 3_999_999;
  59    --  Id values used for argument table entries
  60
  61    type Sdep_Id is range 4_000_000 .. 4_999_999;
  62    --  Id values used for Sdep table entries
  63
  64    type Source_Id is range 5_000_000 .. 5_999_999;
  65    --  Id values used for Source table entries
  66
  67    type Interrupt_State_Id is range 6_000_000 .. 6_999_999;
  68    --  Id values used for Interrupt_State table entries
  69
  70    type Priority_Specific_Dispatching_Id is range 7_000_000 .. 7_999_999;
  71    --  Id values used for Priority_Specific_Dispatching table entries
  72
  73    --------------------
  74    -- ALI File Table --
  75    --------------------
  76
  77    --  Each ALI file read generates an entry in the ALIs table
  78
  79    No_ALI_Id : constant ALI_Id := ALI_Id'First;
  80    --  Special value indicating no ALI entry
  81
  82    First_ALI_Entry : constant ALI_Id := No_ALI_Id + 1;
  83    --  Id of first actual entry in table
  84
  85    type Main_Program_Type is (None, Proc, Func);
  86    --  Indicator of whether unit can be used as main program
  87
  88    type ALIs_Record is record
  89
  90       Afile : File_Name_Type;
  91       --  Name of ALI file
  92
  93       Ofile_Full_Name : File_Name_Type;
  94       --  Full name of object file corresponding to the ALI file
  95
  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).
 100
 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.
 104
 105       Ver_Len : Natural;
 106       --  Length of characters stored in Ver. Not set if V lines are ignored as
 107       --  a result of the Ignore_Lines parameter.
 108
 109       SAL_Interface : Boolean;
 110       --  Set True when this is an interface to a standalone library
 111
 112       First_Unit : Unit_Id;
 113       --  Id of first Unit table entry for this file
 114
 115       Last_Unit : Unit_Id;
 116       --  Id of last Unit table entry for this file
 117
 118       First_Sdep : Sdep_Id;
 119       --  Id of first Sdep table entry for this file
 120
 121       Last_Sdep : Sdep_Id;
 122       --  Id of last Sdep table entry for this file
 123
 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.
 127
 128       Main_Priority : Int;
 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.
 133
 134       Main_CPU : Int;
 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
 138       --  in Ignore_Lines.
 139
 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.
 144
 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.
 148
 149       WC_Encoding : Character;
 150       --  Wide character encoding if main procedure. Otherwise not relevant.
 151       --  Not set if 'M' appears in Ignore_Lines.
 152
 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.
 158
 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.
 164
 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
 170       --  in Ignore_Lines.
 171
 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
 175       --  Ignore_Lines.
 176
 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.
 180
 181       No_Object : Boolean;
 182       --  Set to True if no object file generated. Not set if 'P' appears in
 183       --  Ignore_Lines.
 184
 185       Normalize_Scalars : Boolean;
 186       --  Set to True if file was compiled with Normalize_Scalars. Not set if
 187       --  'P' appears in Ignore_Lines.
 188
 189       Unit_Exception_Table : Boolean;
 190       --  Set to True if unit exception table pointer generated. Not set if 'P'
 191       --  appears in Ignore_Lines.
 192
 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.
 196
 197       Restrictions : Restrictions_Info;
 198       --  Restrictions information reconstructed from R lines
 199
 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
 207
 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.
 215
 216    end record;
 217
 218    No_Main_Priority : constant Int := -1;
 219    --  Code for no main priority set
 220
 221    No_Main_CPU : constant Int := -1;
 222    --  Code for no main cpu set
 223
 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");
 231
 232    ----------------
 233    -- Unit Table --
 234    ----------------
 235
 236    --  Each unit within an ALI file generates an entry in the unit table
 237
 238    No_Unit_Id : constant Unit_Id := Unit_Id'First;
 239    --  Special value indicating no unit table entry
 240
 241    First_Unit_Entry : constant Unit_Id := No_Unit_Id + 1;
 242    --  Id of first actual entry in table
 243
 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).
 249
 250    subtype Version_String is String (1 .. 8);
 251    --  Version string, taken from unit record
 252
 253    type Unit_Record is record
 254
 255       My_ALI : ALI_Id;
 256       --  Corresponding ALI entry
 257
 258       Uname : Unit_Name_Type;
 259       --  Name of Unit
 260
 261       Sfile : File_Name_Type;
 262       --  Name of source file
 263
 264       Preelab : Boolean;
 265       --  Indicates presence of PR parameter for a preelaborated package
 266
 267       No_Elab : Boolean;
 268       --  Indicates presence of NE parameter for a unit that has does not
 269       --  have an elaboration routine (since it has no elaboration code).
 270
 271       Pure : Boolean;
 272       --  Indicates presence of PU parameter for a package having pragma Pure
 273
 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).
 278
 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.
 282
 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.
 287
 288       Has_RACW : Boolean;
 289       --  Indicates presence of RA parameter for a package that declares at
 290       --  least one Remote Access to Class_Wide (RACW) object.
 291
 292       Remote_Types : Boolean;
 293       --  Indicates presence of RT parameter for a package which has a
 294       --  pragma Remote_Types.
 295
 296       Shared_Passive : Boolean;
 297       --  Indicates presence of SP parameter for a package which has a pragma
 298       --  Shared_Passive.
 299
 300       RCI : Boolean;
 301       --  Indicates presence of RC parameter for a package which has a pragma
 302       --  Remote_Call_Interface.
 303
 304       Predefined : Boolean;
 305       --  Indicates if unit is language predefined (or a child of such a unit)
 306
 307       Internal : Boolean;
 308       --  Indicates if unit is an internal unit (or a child of such a unit)
 309
 310       First_With : With_Id;
 311       --  Id of first withs table entry for this file
 312
 313       Last_With : With_Id;
 314       --  Id of last withs table entry for this file
 315
 316       First_Arg : Arg_Id;
 317       --  Id of first args table entry for this file
 318
 319       Last_Arg : Arg_Id;
 320       --  Id of last args table entry for this file
 321
 322       Utype : Unit_Type;
 323       --  Type of entry
 324
 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.
 328
 329       Unit_Kind : Character;
 330       --  Indicates the nature of the unit. 'p' for Packages and 's' for
 331       --  subprograms.
 332
 333       Version : Version_String;
 334       --  Version of unit
 335
 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.
 340
 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.
 345
 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.
 350
 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.
 354
 355       SAL_Interface : Boolean;
 356       --  Set True when this is an interface to a standalone library
 357
 358       Directly_Scanned : Boolean;
 359       --  True iff it is a unit from an ALI file specified to gnatbind
 360
 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.
 364
 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.
 371
 372       Optimize_Alignment : Character;
 373       --  Optimize_Alignment setting. Set to L/S/T/O for OL/OS/OT/OO present
 374
 375       Has_Finalizer : Boolean;
 376       --  Indicates whether a package body or a spec has a library-level
 377       --  finalization routine.
 378    end record;
 379
 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");
 387
 388    ---------------------------
 389    -- Interrupt State Table --
 390    ---------------------------
 391
 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.
 396
 397    type Interrupt_State_Record is record
 398       Interrupt_Id : Nat;
 399       --  Id from interrupt state entry
 400
 401       Interrupt_State : Character;
 402       --  State from interrupt state entry ('u'/'r'/'s')
 403
 404       IS_Pragma_Line : Nat;
 405       --  Line number of Interrupt_State pragma
 406    end record;
 407
 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");
 415
 416    -----------------------------------------
 417    -- Priority Specific Dispatching Table --
 418    -----------------------------------------
 419
 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
 424    --  ALI file.
 425
 426    type Specific_Dispatching_Record is record
 427       Dispatching_Policy : Character;
 428       --  First character (upper case) of the corresponding policy name
 429
 430       First_Priority     : Nat;
 431       --  Lower bound of the priority range to which the specified dispatching
 432       --  policy applies.
 433
 434       Last_Priority      : Nat;
 435       --  Upper bound of the priority range to which the specified dispatching
 436       --  policy applies.
 437
 438       PSD_Pragma_Line : Nat;
 439       --  Line number of Priority_Specific_Dispatching pragma
 440    end record;
 441
 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");
 449
 450    --------------
 451    -- Switches --
 452    --------------
 453
 454    --  These switches record status information about ali files that
 455    --  have been read, for quick reference without searching tables.
 456
 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).
 459
 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.
 463
 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.
 468
 469    Initialize_Scalars_Used : Boolean := False;
 470    --  Set True if an ali file contains the Initialize_Scalars flag
 471
 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.
 475
 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.
 479
 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.
 483
 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.
 487
 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.
 491
 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.
 496
 497    Stack_Check_Switch_Set : Boolean := False;
 498    --  Set to True if at least one ALI file contains '-fstack-check' in its
 499    --  argument list.
 500
 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
 504    --  encountered.
 505
 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.
 510
 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.
 514
 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.
 518
 519    -----------------
 520    -- Withs Table --
 521    -----------------
 522
 523    --  Each With line (W line) in an ALI file generates a Withs table entry
 524
 525    --  Note: there will be no entries in this table if 'W' lines are ignored
 526
 527    No_With_Id : constant With_Id := With_Id'First;
 528    --  Special value indicating no withs table entry
 529
 530    First_With_Entry : constant With_Id := No_With_Id + 1;
 531    --  Id of first actual entry in table
 532
 533    type With_Record is record
 534
 535       Uname : Unit_Name_Type;
 536       --  Name of Unit
 537
 538       Sfile : File_Name_Type;
 539       --  Name of source file, set to No_File in generic case
 540
 541       Afile : File_Name_Type;
 542       --  Name of ALI file, set to No_File in generic case
 543
 544       Elaborate : Boolean;
 545       --  Indicates presence of E parameter
 546
 547       Elaborate_All : Boolean;
 548       --  Indicates presence of EA parameter
 549
 550       Elab_All_Desirable : Boolean;
 551       --  Indicates presence of AD parameter
 552
 553       Elab_Desirable     : Boolean;
 554       --  Indicates presence of ED parameter
 555
 556       SAL_Interface : Boolean := False;
 557       --  True if the Unit is an Interface of a Stand-Alone Library
 558
 559       Limited_With : Boolean := False;
 560       --  True if unit is named in a limited_with_clause
 561
 562       Implicit_With_From_Instantiation : Boolean := False;
 563       --  True if this is an implicit with from a generic instantiation
 564    end record;
 565
 566    package Withs is new Table.Table (
 567      Table_Component_Type => With_Record,
 568      Table_Index_Type     => With_Id,
 569      Table_Low_Bound      => First_With_Entry,
 570      Table_Initial        => 5000,
 571      Table_Increment      => 200,
 572      Table_Name           => "Withs");
 573
 574    ---------------------
 575    -- Arguments Table --
 576    ---------------------
 577
 578    --  Each Arg line (A line) in an ALI file generates an Args table entry
 579
 580    --  Note: there will be no entries in this table if 'A' lines are ignored
 581
 582    No_Arg_Id : constant Arg_Id := Arg_Id'First;
 583    --  Special value indicating no args table entry
 584
 585    First_Arg_Entry : constant Arg_Id := No_Arg_Id + 1;
 586    --  Id of first actual entry in table
 587
 588    package Args is new Table.Table (
 589      Table_Component_Type => String_Ptr,
 590      Table_Index_Type     => Arg_Id,
 591      Table_Low_Bound      => First_Arg_Entry,
 592      Table_Initial        => 1000,
 593      Table_Increment      => 100,
 594      Table_Name           => "Args");
 595
 596    --------------------------
 597    -- Linker_Options Table --
 598    --------------------------
 599
 600    --  If an ALI file has one of more Linker_Options lines, then a single
 601    --  entry is made in this table. If more than one Linker_Options lines
 602    --  appears in a given ALI file, then the arguments are concatenated
 603    --  to form the entry in this table, using a NUL character as the
 604    --  separator, and a final NUL character is appended to the end.
 605
 606    --  Note: there will be no entries in this table if 'L' lines are ignored
 607
 608    type Linker_Option_Record is record
 609       Name : Name_Id;
 610       --  Name entry containing concatenated list of Linker_Options
 611       --  arguments separated by NUL and ended by NUL as described above.
 612
 613       Unit : Unit_Id;
 614       --  Unit_Id for the entry
 615
 616       Internal_File : Boolean;
 617       --  Set True if the linker options are from an internal file. This is
 618       --  used to insert certain standard entries after all the user entries
 619       --  but before the entries from the run-time.
 620
 621       Original_Pos : Positive;
 622       --  Keep track of original position in the linker options table. This
 623       --  is used to implement a stable sort when we sort the linker options
 624       --  table.
 625    end record;
 626
 627    --  The indexes of active entries in this table range from 1 to the
 628    --  value of Linker_Options.Last. The zero'th element is for sort call.
 629
 630    package Linker_Options is new Table.Table (
 631      Table_Component_Type => Linker_Option_Record,
 632      Table_Index_Type     => Integer,
 633      Table_Low_Bound      => 0,
 634      Table_Initial        => 200,
 635      Table_Increment      => 400,
 636      Table_Name           => "Linker_Options");
 637
 638    -----------------
 639    -- Notes Table --
 640    -----------------
 641
 642    --  The notes table records entries from N lines
 643
 644    type Notes_Record is record
 645       Pragma_Type : Character;
 646       --  'A', 'C', 'I', 'S', 'T' for Annotate/Comment/Ident/Subtitle/Title
 647
 648       Pragma_Line : Nat;
 649       --  Line number of pragma
 650
 651       Pragma_Col : Nat;
 652       --  Column number of pragma
 653
 654       Unit : Unit_Id;
 655       --  Unit_Id for the entry
 656
 657       Pragma_Args : Name_Id;
 658       --  Pragma arguments. No_Name if no arguments, otherwise a single
 659       --  name table entry consisting of all the characters on the notes
 660       --  line from the first non-blank character following the source
 661       --  location to the last character on the line.
 662    end record;
 663
 664    --  The indexes of active entries in this table range from 1 to the
 665    --  value of Linker_Options.Last. The zero'th element is for convenience
 666    --  if the table needs to be sorted.
 667
 668    package Notes is new Table.Table (
 669      Table_Component_Type => Notes_Record,
 670      Table_Index_Type     => Integer,
 671      Table_Low_Bound      => 0,
 672      Table_Initial        => 200,
 673      Table_Increment      => 400,
 674      Table_Name           => "Notes");
 675
 676    -------------------------------------------
 677    -- External Version Reference Hash Table --
 678    -------------------------------------------
 679
 680    --  This hash table keeps track of external version reference strings
 681    --  as read from E lines in the ali file. The stored values do not
 682    --  include the terminating quote characters.
 683
 684    --  Note: there will be no entries in this table if 'E' lines are ignored
 685
 686    type Vindex is range 0 .. 98;
 687    --  Type to define range of headers
 688
 689    function SHash (S : String_Ptr) return Vindex;
 690    --  Hash function for this table
 691
 692    function SEq (F1, F2 : String_Ptr) return Boolean;
 693    --  Equality function for this table
 694
 695    package Version_Ref is new Simple_HTable (
 696      Header_Num => Vindex,
 697      Element    => Boolean,
 698      No_Element => False,
 699      Key        => String_Ptr,
 700      Hash       => SHash,
 701      Equal      => SEq);
 702
 703    -------------------------
 704    -- No_Dependency Table --
 705    -------------------------
 706
 707    --  Each R line for a No_Dependency Restriction generates an entry in
 708    --  this No_Dependency table.
 709
 710    type No_Dep_Record is record
 711       ALI_File : ALI_Id;
 712       --  ALI File containing the entry
 713
 714       No_Dep_Unit : Name_Id;
 715       --  Id for names table entry including entire name, including periods
 716    end record;
 717
 718    package No_Deps is new Table.Table (
 719      Table_Component_Type => No_Dep_Record,
 720      Table_Index_Type     => Integer,
 721      Table_Low_Bound      => 0,
 722      Table_Initial        => 200,
 723      Table_Increment      => 400,
 724      Table_Name           => "No_Deps");
 725
 726    ------------------------------------
 727    -- Sdep (Source Dependency) Table --
 728    ------------------------------------
 729
 730    --  Each source dependency (D line) in an ALI file generates an entry in the
 731    --  Sdep table.
 732
 733    --  Note: there will be no entries in this table if 'D' lines are ignored
 734
 735    No_Sdep_Id : constant Sdep_Id := Sdep_Id'First;
 736    --  Special value indicating no Sdep table entry
 737
 738    First_Sdep_Entry : Sdep_Id := No_Sdep_Id + 1;
 739    --  Id of first Sdep entry for current ali file. This is initialized to the
 740    --  first Sdep entry in the table, and then incremented appropriately as
 741    --  successive ALI files are scanned.
 742
 743    type Sdep_Record is record
 744
 745       Sfile : File_Name_Type;
 746       --  Name of source file
 747
 748       Stamp : Time_Stamp_Type;
 749       --  Time stamp value. Note that this will be all zero characters for the
 750       --  dummy entries for missing or non-dependent files.
 751
 752       Checksum : Word;
 753       --  Checksum value. Note that this will be all zero characters for the
 754       --  dummy entries for missing or non-dependent files
 755
 756       Dummy_Entry : Boolean;
 757       --  Set True for dummy entries that correspond to missing files or files
 758       --  where no dependency relationship exists.
 759
 760       Subunit_Name : Name_Id;
 761       --  Name_Id for subunit name if present, else No_Name
 762
 763       Rfile : File_Name_Type;
 764       --  Reference file name. Same as Sfile unless a Source_Reference pragma
 765       --  was used, in which case it reflects the name used in the pragma.
 766
 767       Start_Line : Nat;
 768       --  Starting line number in file. Always 1, unless a Source_Reference
 769       --  pragma was used, in which case it reflects the line number value
 770       --  given in the pragma.
 771
 772    end record;
 773
 774    package Sdep is new Table.Table (
 775      Table_Component_Type => Sdep_Record,
 776      Table_Index_Type     => Sdep_Id,
 777      Table_Low_Bound      => First_Sdep_Entry,
 778      Table_Initial        => 5000,
 779      Table_Increment      => 200,
 780      Table_Name           => "Sdep");
 781
 782    ----------------------------
 783    -- Use of Name Table Info --
 784    ----------------------------
 785
 786    --  All unit names and file names are entered into the Names table. The Info
 787    --  fields of these entries are used as follows:
 788
 789    --    Unit name           Info field has Unit_Id of unit table entry
 790    --    ALI file name       Info field has ALI_Id of ALI table entry
 791    --    Source file name    Info field has Source_Id of source table entry
 792
 793    --------------------------
 794    -- Cross-Reference Data --
 795    --------------------------
 796
 797    --  The following table records cross-reference sections, there is one entry
 798    --  for each X header line in the ALI file for an xref section.
 799
 800    --  Note: there will be no entries in this table if 'X' lines are ignored
 801
 802    type Xref_Section_Record is record
 803       File_Num : Sdep_Id;
 804       --  Dependency number for file (entry in Sdep.Table)
 805
 806       File_Name : File_Name_Type;
 807       --  Name of file
 808
 809       First_Entity : Nat;
 810       --  First entry in Xref_Entity table
 811
 812       Last_Entity : Nat;
 813       --  Last entry in Xref_Entity table
 814    end record;
 815
 816    package Xref_Section is new Table.Table (
 817      Table_Component_Type => Xref_Section_Record,
 818      Table_Index_Type     => Nat,
 819      Table_Low_Bound      => 1,
 820      Table_Initial        => 50,
 821      Table_Increment      => 300,
 822      Table_Name           => "Xref_Section");
 823
 824    --  The following is used to indicate whether a typeref field is present
 825    --  for the entity, and if so what kind of typeref field.
 826
 827    type Tref_Kind is (
 828      Tref_None,    --  No typeref present
 829      Tref_Access,  --  Access type typeref (points to designated type)
 830      Tref_Derived, --  Derived type typeref (points to parent type)
 831      Tref_Type);   --  All other cases
 832
 833    type Visibility_Kind is
 834      (Global, --  Library level entity
 835       Static, --  Static C/C++ entity
 836       Other); --  Local and other entity
 837
 838    --  The following table records entities for which xrefs are recorded
 839
 840    type Xref_Entity_Record is record
 841       Line : Pos;
 842       --  Line number of definition
 843
 844       Etype : Character;
 845       --  Set to the identification character for the entity. See section
 846       --  "Cross-Reference Entity Identifiers" in lib-xref.ads for details.
 847
 848       Col : Pos;
 849       --  Column number of definition
 850
 851       Visibility : Visibility_Kind;
 852       --  Visibility of entity
 853
 854       Entity : Name_Id;
 855       --  Name of entity
 856
 857       Iref_File_Num : Sdep_Id;
 858       --  This field is set to the dependency reference for the file containing
 859       --  the generic entity that this one instantiates, or to No_Sdep_Id if
 860       --  the current entity is not an instantiation
 861
 862       Iref_Line : Nat;
 863       --  This field is set to the line number in Iref_File_Num of the generic
 864       --  entity that this one instantiates, or to zero if the current entity
 865       --  is not an instantiation.
 866
 867       Rref_Line : Nat;
 868       --  This field is set to the line number of a renaming reference if
 869       --  one is present, or to zero if no renaming reference is present
 870
 871       Rref_Col : Nat;
 872       --  This field is set to the column number of a renaming reference
 873       --  if one is present, or to zero if no renaming reference is present.
 874
 875       Tref : Tref_Kind;
 876       --  Indicates if a typeref is present, and if so what kind. Set to
 877       --  Tref_None if no typeref field is present.
 878
 879       Tref_File_Num : Sdep_Id;
 880       --  This field is set to No_Sdep_Id if no typeref is present, or
 881       --  if the typeref refers to an entity in standard. Otherwise it
 882       --  it is the dependency reference for the file containing the
 883       --  declaration of the typeref entity.
 884
 885       Tref_Line : Nat;
 886       --  This field is set to zero if no typeref is present, or if the
 887       --  typeref refers to an entity in standard. Otherwise it contains
 888       --  the line number of the declaration of the typeref entity.
 889
 890       Tref_Type : Character;
 891       --  This field is set to blank if no typeref is present, or if the
 892       --  typeref refers to an entity in standard. Otherwise it contains
 893       --  the identification character for the typeref entity. See section
 894       --  "Cross-Reference Entity Identifiers" in lib-xref.ads for details.
 895
 896       Tref_Col : Nat;
 897       --  This field is set to zero if no typeref is present, or if the
 898       --  typeref refers to an entity in standard. Otherwise it contains
 899       --  the column number of the declaration of the parent type.
 900
 901       Tref_Standard_Entity : Name_Id;
 902       --  This field is set to No_Name if no typeref is present or if the
 903       --  typeref refers to a declared entity rather than an entity in
 904       --  package Standard. If there is a typeref that references an
 905       --  entity in package Standard, then this field is a Name_Id
 906       --  reference for the entity name.
 907
 908       Oref_File_Num : Sdep_Id;
 909       --  This field is set to No_Sdep_Id if the entity doesn't override any
 910       --  other entity, or to the dependency reference for the overridden
 911       --  entity.
 912
 913       Oref_Line : Nat;
 914       Oref_Col  : Nat;
 915       --  These two fields are set to the line and column of the overridden
 916       --  entity.
 917
 918       First_Xref : Nat;
 919       --  Index into Xref table of first cross-reference
 920
 921       Last_Xref : Nat;
 922       --  Index into Xref table of last cross-reference. The value in
 923       --  Last_Xref can be less than the First_Xref value to indicate
 924       --  that no entries are present in the Xref Table.
 925    end record;
 926
 927    package Xref_Entity is new Table.Table (
 928      Table_Component_Type => Xref_Entity_Record,
 929      Table_Index_Type     => Nat,
 930      Table_Low_Bound      => 1,
 931      Table_Initial        => 500,
 932      Table_Increment      => 300,
 933      Table_Name           => "Xref_Entity");
 934
 935    Array_Index_Reference : constant Character := '*';
 936    Interface_Reference   : constant Character := 'I';
 937    --  Some special types of references. In the ALI file itself, these
 938    --  are output as attributes of the entity, not as references, but
 939    --  there is no provision in Xref_Entity_Record for storing multiple
 940    --  such references.
 941
 942    --  The following table records actual cross-references
 943
 944    type Xref_Record is record
 945       File_Num : Sdep_Id;
 946       --  Set to the file dependency number for the cross-reference. Note
 947       --  that if no file entry is present explicitly, this is just a copy
 948       --  of the reference for the current cross-reference section.
 949
 950       Line : Nat;
 951       --  Line number for the reference. This is zero when referencing a
 952       --  predefined entity, but in this case Name is set.
 953
 954       Rtype : Character;
 955       --  Indicates type of reference, using code used in ALI file:
 956       --    r = reference
 957       --    m = modification
 958       --    b = body entity
 959       --    c = completion of private or incomplete type
 960       --    x = type extension
 961       --    i = implicit reference
 962       --    Array_Index_Reference = reference to the index of an array
 963       --    Interface_Reference   = reference to an interface implemented
 964       --                            by the type
 965       --  See description in lib-xref.ads for further details
 966
 967       Col : Nat;
 968       --  Column number for the reference
 969
 970       Name : Name_Id := No_Name;
 971       --  This is only used when referencing a predefined entity. Currently,
 972       --  this only occurs for array indexes.
 973
 974       --  Note: for instantiation references, Rtype is set to ' ', and Col is
 975       --  set to zero. One or more such entries can follow any other reference.
 976       --  When there is more than one such entry, this is to be read as:
 977       --     e.g. ref1  ref2  ref3
 978       --     ref1 is a reference to an entity that was instantied at ref2.
 979       --     ref2 itself is also the result of an instantiation, that took
 980       --     place at ref3
 981
 982       Imported_Lang : Name_Id := No_Name;
 983       Imported_Name : Name_Id := No_Name;
 984       --  Language and name of imported entity reference
 985    end record;
 986
 987    package Xref is new Table.Table (
 988      Table_Component_Type => Xref_Record,
 989      Table_Index_Type     => Nat,
 990      Table_Low_Bound      => 1,
 991      Table_Initial        => 2000,
 992      Table_Increment      => 300,
 993      Table_Name           => "Xref");
 994
 995    --------------------------------------
 996    -- Subprograms for Reading ALI File --
 997    --------------------------------------
 998
 999    procedure Initialize_ALI;
1000    --  Initialize the ALI tables. Also resets all switch values to defaults
1001
1002    function Scan_ALI
1003      (F                : File_Name_Type;
1004       T                : Text_Buffer_Ptr;
1005       Ignore_ED        : Boolean;
1006       Err              : Boolean;
1007       Read_Xref        : Boolean := False;
1008       Read_Lines       : String  := "";
1009       Ignore_Lines     : String  := "X";
1010       Ignore_Errors    : Boolean := False;
1011       Directly_Scanned : Boolean := False) return ALI_Id;
1012    --  Given the text, T, of an ALI file, F, scan and store the information
1013    --  from the file, and return the Id of the resulting entry in the ALI
1014    --  table. Switch settings may be modified as described above in the
1015    --  switch description settings.
1016    --
1017    --    Ignore_ED is normally False. If set to True, it indicates that
1018    --    all AD/ED (elaboration desirable) indications in the ALI file are
1019    --    to be ignored. This parameter is obsolete now that the -f switch
1020    --    is removed from gnatbind, and should be removed ???
1021    --
1022    --    Err determines the action taken on an incorrectly formatted file.
1023    --    If Err is False, then an error message is output, and the program
1024    --    is terminated. If Err is True, then no error message is output,
1025    --    and No_ALI_Id is returned.
1026    --
1027    --    Ignore_Lines requests that Scan_ALI ignore any lines that start
1028    --    with any given key character. The default value of X causes all
1029    --    Xref lines to be ignored. The corresponding data in the ALI
1030    --    tables will not be filled in this case. It is not possible
1031    --    to ignore U (unit) lines, they are always read.
1032    --
1033    --    Read_Lines requests that Scan_ALI process only lines that start
1034    --    with one of the given characters. The corresponding data in the
1035    --    ALI file for any characters not given in the list will not be
1036    --    set. The default value of the null string indicates that all
1037    --    lines should be read (unless Ignore_Lines is specified). U
1038    --    (unit) lines are always read regardless of the value of this
1039    --    parameter.
1040    --
1041    --    Note: either Ignore_Lines or Read_Lines should be non-null, but not
1042    --    both. If both are provided then only the Read_Lines value is used,
1043    --    and the Ignore_Lines parameter is ignored.
1044    --
1045    --    Read_XREF is set True to read and acquire the cross-reference
1046    --    information. If Read_XREF is set to True, then the effect is to ignore
1047    --    all lines other than U, W, D and X lines and the Ignore_Lines and
1048    --    Read_Lines parameters are ignored (i.e. the use of True for Read_XREF
1049    --    is equivalent to specifying an argument of "UWDX" for Read_Lines.
1050    --
1051    --    Ignore_Errors is normally False. If it is set True, then Scan_ALI
1052    --    will do its best to scan through a file and extract all information
1053    --    it can, even if there are errors. In this case Err is only set if
1054    --    Scan_ALI was completely unable to process the file (e.g. it did not
1055    --    look like an ALI file at all). Ignore_Errors is intended to improve
1056    --    the downward compatibility of new compilers with old tools.
1057    --
1058    --    Directly_Scanned is normally False. If it is set to True, then the
1059    --    units (spec and/or body) corresponding to the ALI file are marked as
1060    --    such. It is used to decide for what units gnatbind should generate
1061    --    the symbols corresponding to 'Version or 'Body_Version in
1062    --    Stand-Alone Libraries.
1063
1064 end ALI;