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-2009, 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
  28 --  by 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       Time_Slice_Value : Int;
 135       --  Indicates value of time slice parameter from T=xxx on main program
 136       --  line. A value of -1 indicates that no T=xxx parameter was found, or
 137       --  no M line was present. Not set if 'M' appears in Ignore_Lines.
 138
 139       WC_Encoding : Character;
 140       --  Wide character encoding if main procedure. Otherwise not relevant.
 141       --  Not set if 'M' appears in Ignore_Lines.
 142
 143       Locking_Policy : Character;
 144       --  Indicates locking policy for units in this file. Space means tasking
 145       --  was not used, or that no Locking_Policy pragma was present or that
 146       --  this is a language defined unit. Otherwise set to first character
 147       --  (upper case) of policy name. Not set if 'P' appears in Ignore_Lines.
 148
 149       Queuing_Policy : Character;
 150       --  Indicates queuing policy for units in this file. Space means tasking
 151       --  was not used, or that no Queuing_Policy pragma was present or that
 152       --  this is a language defined unit. Otherwise set to first character
 153       --  (upper case) of policy name. Not set if 'P' appears in Ignore_Lines.
 154
 155       Task_Dispatching_Policy : Character;
 156       --  Indicates task dispatching policy for units in this file. Space means
 157       --  tasking was not used, or that no Task_Dispatching_Policy pragma was
 158       --  present or that this is a language defined unit. Otherwise set to
 159       --  first character (upper case) of policy name. Not set if 'P' appears
 160       --  in Ignore_Lines.
 161
 162       Compile_Errors : Boolean;
 163       --  Set to True if compile errors for unit. Note that No_Object will
 164       --  always be set as well in this case. Not set if 'P' appears in
 165       --  Ignore_Lines.
 166
 167       Float_Format : Character;
 168       --  Set to float format (set to I if no float-format given). Not set if
 169       --  'P' appears in Ignore_Lines.
 170
 171       No_Object : Boolean;
 172       --  Set to True if no object file generated. Not set if 'P' appears in
 173       --  Ignore_Lines.
 174
 175       Normalize_Scalars : Boolean;
 176       --  Set to True if file was compiled with Normalize_Scalars. Not set if
 177       --  'P' appears in Ignore_Lines.
 178
 179       Unit_Exception_Table : Boolean;
 180       --  Set to True if unit exception table pointer generated. Not set if 'P'
 181       --  appears in Ignore_Lines.
 182
 183       Zero_Cost_Exceptions : Boolean;
 184       --  Set to True if file was compiled with zero cost exceptions. Not set
 185       --  if 'P' appears in Ignore_Lines.
 186
 187       Restrictions : Restrictions_Info;
 188       --  Restrictions information reconstructed from R lines
 189
 190       First_Interrupt_State : Interrupt_State_Id;
 191       Last_Interrupt_State  : Interrupt_State_Id'Base;
 192       --  These point to the first and last entries in the interrupt state
 193       --  table for this unit. If no entries, then Last_Interrupt_State =
 194       --  First_Interrupt_State - 1 (that's why the 'Base reference is there,
 195       --  it can be one less than the lower bound of the subtype). Not set if
 196       --  'I' appears in Ignore_Lines
 197
 198       First_Specific_Dispatching : Priority_Specific_Dispatching_Id;
 199       Last_Specific_Dispatching  : Priority_Specific_Dispatching_Id'Base;
 200       --  These point to the first and last entries in the priority specific
 201       --  dispatching table for this unit. If there are no entries, then
 202       --  Last_Specific_Dispatching = First_Specific_Dispatching - 1. That
 203       --  is why the 'Base reference is there, it can be one less than the
 204       --  lower bound of the subtype. Not set if 'S' appears in Ignore_Lines.
 205
 206    end record;
 207
 208    No_Main_Priority : constant Int := -1;
 209    --  Code for no main priority set
 210
 211    package ALIs is new Table.Table (
 212      Table_Component_Type => ALIs_Record,
 213      Table_Index_Type     => ALI_Id,
 214      Table_Low_Bound      => First_ALI_Entry,
 215      Table_Initial        => 500,
 216      Table_Increment      => 200,
 217      Table_Name           => "ALIs");
 218
 219    ----------------
 220    -- Unit Table --
 221    ----------------
 222
 223    --  Each unit within an ALI file generates an entry in the unit table
 224
 225    No_Unit_Id : constant Unit_Id := Unit_Id'First;
 226    --  Special value indicating no unit table entry
 227
 228    First_Unit_Entry : constant Unit_Id := No_Unit_Id + 1;
 229    --  Id of first actual entry in table
 230
 231    type Unit_Type is (Is_Spec, Is_Body, Is_Spec_Only, Is_Body_Only);
 232    --  Indicates type of entry, if both body and spec appear in the ALI file,
 233    --  then the first unit is marked Is_Body, and the second is marked Is_Spec.
 234    --  If only a spec appears, then it is marked as Is_Spec_Only, and if only
 235    --  a body appears, then it is marked Is_Body_Only).
 236
 237    subtype Version_String is String (1 .. 8);
 238    --  Version string, taken from unit record
 239
 240    type Unit_Record is record
 241
 242       My_ALI : ALI_Id;
 243       --  Corresponding ALI entry
 244
 245       Uname : Unit_Name_Type;
 246       --  Name of Unit
 247
 248       Sfile : File_Name_Type;
 249       --  Name of source file
 250
 251       Preelab : Boolean;
 252       --  Indicates presence of PR parameter for a preelaborated package
 253
 254       No_Elab : Boolean;
 255       --  Indicates presence of NE parameter for a unit that has does not
 256       --  have an elaboration routine (since it has no elaboration code).
 257
 258       Pure : Boolean;
 259       --  Indicates presence of PU parameter for a package having pragma Pure
 260
 261       Dynamic_Elab : Boolean;
 262       --  Set to True if the unit was compiled with dynamic elaboration checks
 263       --  (i.e. either -gnatE or pragma Elaboration_Checks (RM) was used to
 264       --  compile the unit).
 265
 266       Elaborate_Body : Boolean;
 267       --  Indicates presence of EB parameter for a package which has a pragma
 268       --  Elaborate_Body, and also for generic package instantiations.
 269
 270       Set_Elab_Entity : Boolean;
 271       --  Indicates presence of EE parameter for a unit which has an
 272       --  elaboration entity which must be set true as part of the
 273       --  elaboration of the entity.
 274
 275       Has_RACW : Boolean;
 276       --  Indicates presence of RA parameter for a package that declares at
 277       --  least one Remote Access to Class_Wide (RACW) object.
 278
 279       Remote_Types : Boolean;
 280       --  Indicates presence of RT parameter for a package which has a
 281       --  pragma Remote_Types.
 282
 283       Shared_Passive : Boolean;
 284       --  Indicates presence of SP parameter for a package which has a pragma
 285       --  Shared_Passive.
 286
 287       RCI : Boolean;
 288       --  Indicates presence of RC parameter for a package which has a pragma
 289       --  Remote_Call_Interface.
 290
 291       Predefined : Boolean;
 292       --  Indicates if unit is language predefined (or a child of such a unit)
 293
 294       Internal : Boolean;
 295       --  Indicates if unit is an internal unit (or a child of such a unit)
 296
 297       First_With : With_Id;
 298       --  Id of first withs table entry for this file
 299
 300       Last_With : With_Id;
 301       --  Id of last withs table entry for this file
 302
 303       First_Arg : Arg_Id;
 304       --  Id of first args table entry for this file
 305
 306       Last_Arg : Arg_Id;
 307       --  Id of last args table entry for this file
 308
 309       Utype : Unit_Type;
 310       --  Type of entry
 311
 312       Is_Generic : Boolean;
 313       --  True for generic unit (i.e. a generic declaration, or a generic
 314       --  body). False for a non-generic unit.
 315
 316       Unit_Kind : Character;
 317       --  Indicates the nature of the unit. 'p' for Packages and 's' for
 318       --  subprograms.
 319
 320       Version : Version_String;
 321       --  Version of unit
 322
 323       Icasing : Casing_Type;
 324       --  Indicates casing of identifiers in source file for this unit. This
 325       --  is used for informational output, and also for constructing the main
 326       --  unit if it is being built in Ada.
 327
 328       Kcasing : Casing_Type;
 329       --  Indicates casing of keywords in source file for this unit. This is
 330       --  used for informational output, and also for constructing the main
 331       --  unit if it is being built in Ada.
 332
 333       Elab_Position : aliased Natural;
 334       --  Initialized to zero. Set non-zero when a unit is chosen and
 335       --  placed in the elaboration order. The value represents the
 336       --  ordinal position in the elaboration order.
 337
 338       Init_Scalars : Boolean;
 339       --  Set True if IS qualifier appears in ALI file, indicating that
 340       --  an Initialize_Scalars pragma applies to the unit.
 341
 342       SAL_Interface : Boolean;
 343       --  Set True when this is an interface to a standalone library
 344
 345       Directly_Scanned : Boolean;
 346       --  True iff it is a unit from an ALI file specified to gnatbind
 347
 348       Body_Needed_For_SAL : Boolean;
 349       --  Indicates that the source for the body of the unit (subprogram,
 350       --  package, or generic unit) must be included in a standalone library.
 351
 352       Elaborate_Body_Desirable : Boolean;
 353       --  Indicates that the front end elaboration circuitry decided that it
 354       --  would be a good idea if this package had Elaborate_Body. The binder
 355       --  will attempt, but does not promise, to place the elaboration call
 356       --  for the body right after the call for the spec, or at least as close
 357       --  together as possible.
 358
 359       Optimize_Alignment : Character;
 360       --  Optimize_Alignment setting. Set to L/S/T/O for OL/OS/OT/OO present
 361
 362    end record;
 363
 364    package Units is new Table.Table (
 365      Table_Component_Type => Unit_Record,
 366      Table_Index_Type     => Unit_Id,
 367      Table_Low_Bound      => First_Unit_Entry,
 368      Table_Initial        => 100,
 369      Table_Increment      => 200,
 370      Table_Name           => "Unit");
 371
 372    ---------------------------
 373    -- Interrupt State Table --
 374    ---------------------------
 375
 376    --  An entry is made in this table for each I (interrupt state) line
 377    --  encountered in the input ALI file. The First/Last_Interrupt_Id
 378    --  fields of the ALI file entry show the range of entries defined
 379    --  within a particular ALI file.
 380
 381    type Interrupt_State_Record is record
 382       Interrupt_Id : Nat;
 383       --  Id from interrupt state entry
 384
 385       Interrupt_State : Character;
 386       --  State from interrupt state entry ('u'/'r'/'s')
 387
 388       IS_Pragma_Line : Nat;
 389       --  Line number of Interrupt_State pragma
 390    end record;
 391
 392    package Interrupt_States is new Table.Table (
 393      Table_Component_Type => Interrupt_State_Record,
 394      Table_Index_Type     => Interrupt_State_Id'Base,
 395      Table_Low_Bound      => Interrupt_State_Id'First,
 396      Table_Initial        => 100,
 397      Table_Increment      => 200,
 398      Table_Name           => "Interrupt_States");
 399
 400    -----------------------------------------
 401    -- Priority Specific Dispatching Table --
 402    -----------------------------------------
 403
 404    --  An entry is made in this table for each S (priority specific
 405    --  dispatching) line encountered in the input ALI file. The
 406    --  First/Last_Specific_Dispatching_Id fields of the ALI file
 407    --  entry show the range of entries defined within a particular
 408    --  ALI file.
 409
 410    type Specific_Dispatching_Record is record
 411       Dispatching_Policy : Character;
 412       --  First character (upper case) of the corresponding policy name
 413
 414       First_Priority     : Nat;
 415       --  Lower bound of the priority range to which the specified dispatching
 416       --  policy applies.
 417
 418       Last_Priority      : Nat;
 419       --  Upper bound of the priority range to which the specified dispatching
 420       --  policy applies.
 421
 422       PSD_Pragma_Line : Nat;
 423       --  Line number of Priority_Specific_Dispatching pragma
 424    end record;
 425
 426    package Specific_Dispatching is new Table.Table (
 427      Table_Component_Type => Specific_Dispatching_Record,
 428      Table_Index_Type     => Priority_Specific_Dispatching_Id'Base,
 429      Table_Low_Bound      => Priority_Specific_Dispatching_Id'First,
 430      Table_Initial        => 100,
 431      Table_Increment      => 200,
 432      Table_Name           => "Priority_Specific_Dispatching");
 433
 434    --------------
 435    -- Switches --
 436    --------------
 437
 438    --  These switches record status information about ali files that
 439    --  have been read, for quick reference without searching tables.
 440
 441    --  Note: a switch will be left set at its default value if the line
 442    --  which might otherwise set it is ignored (from Ignore_Lines).
 443
 444    Dynamic_Elaboration_Checks_Specified : Boolean := False;
 445    --  Set to False by Initialize_ALI. Set to True if Scan_ALI reads
 446    --  a unit for which dynamic elaboration checking is enabled.
 447
 448    Float_Format_Specified : Character := ' ';
 449    --  Set to blank by Initialize_ALI. Set to appropriate float format
 450    --  character (V or I, see Opt.Float_Format) if an ali file that
 451    --  is read contains an F line setting the floating point format.
 452
 453    Initialize_Scalars_Used : Boolean := False;
 454    --  Set True if an ali file contains the Initialize_Scalars flag
 455
 456    Locking_Policy_Specified : Character := ' ';
 457    --  Set to blank by Initialize_ALI. Set to the appropriate locking policy
 458    --  character if an ali file contains a P line setting the locking policy.
 459
 460    No_Normalize_Scalars_Specified : Boolean := False;
 461    --  Set to False by Initialize_ALI. Set to True if an ali file indicates
 462    --  that the file was compiled without normalize scalars.
 463
 464    No_Object_Specified : Boolean := False;
 465    --  Set to False by Initialize_ALI. Set to True if an ali file contains
 466    --  the No_Object flag.
 467
 468    Normalize_Scalars_Specified : Boolean := False;
 469    --  Set to False by Initialize_ALI. Set to True if an ali file indicates
 470    --  that the file was compiled in Normalize_Scalars mode.
 471
 472    Queuing_Policy_Specified : Character := ' ';
 473    --  Set to blank by Initialize_ALI. Set to the appropriate queuing policy
 474    --  character if an ali file contains a P line setting the queuing policy.
 475
 476    Cumulative_Restrictions : Restrictions_Info := No_Restrictions;
 477    --  This variable records the cumulative contributions of R lines in all
 478    --  ali files, showing whether a restriction pragma exists anywhere, and
 479    --  accumulating the aggregate knowledge of violations.
 480
 481    Stack_Check_Switch_Set : Boolean := False;
 482    --  Set to True if at least one ALI file contains '-fstack-check' in its
 483    --  argument list.
 484
 485    Static_Elaboration_Model_Used : Boolean := False;
 486    --  Set to False by Initialize_ALI. Set to True if any ALI file for a
 487    --  non-internal unit compiled with the static elaboration model is
 488    --  encountered.
 489
 490    Task_Dispatching_Policy_Specified : Character := ' ';
 491    --  Set to blank by Initialize_ALI. Set to the appropriate task dispatching
 492    --  policy character if an ali file contains a P line setting the
 493    --  task dispatching policy.
 494
 495    Unreserve_All_Interrupts_Specified : Boolean := False;
 496    --  Set to False by Initialize_ALI. Set to True if an ali file is read that
 497    --  has  P line specifying unreserve all interrupts mode.
 498
 499    Zero_Cost_Exceptions_Specified : Boolean := False;
 500    --  Set to False by Initialize_ALI. Set to True if an ali file is read that
 501    --  has a P line specifying the generation of zero cost exceptions.
 502
 503    -----------------
 504    -- Withs Table --
 505    -----------------
 506
 507    --  Each With line (W line) in an ALI file generates a Withs table entry
 508
 509    --  Note: there will be no entries in this table if 'W' lines are ignored
 510
 511    No_With_Id : constant With_Id := With_Id'First;
 512    --  Special value indicating no withs table entry
 513
 514    First_With_Entry : constant With_Id := No_With_Id + 1;
 515    --  Id of first actual entry in table
 516
 517    type With_Record is record
 518
 519       Uname : Unit_Name_Type;
 520       --  Name of Unit
 521
 522       Sfile : File_Name_Type;
 523       --  Name of source file, set to No_File in generic case
 524
 525       Afile : File_Name_Type;
 526       --  Name of ALI file, set to No_File in generic case
 527
 528       Elaborate : Boolean;
 529       --  Indicates presence of E parameter
 530
 531       Elaborate_All : Boolean;
 532       --  Indicates presence of EA parameter
 533
 534       Elab_All_Desirable : Boolean;
 535       --  Indicates presence of AD parameter
 536
 537       Elab_Desirable     : Boolean;
 538       --  Indicates presence of ED parameter
 539
 540       SAL_Interface : Boolean := False;
 541       --  True if the Unit is an Interface of a Stand-Alone Library
 542
 543       Limited_With : Boolean := False;
 544       --  True if unit is named in a limited_with_clause
 545    end record;
 546
 547    package Withs is new Table.Table (
 548      Table_Component_Type => With_Record,
 549      Table_Index_Type     => With_Id,
 550      Table_Low_Bound      => First_With_Entry,
 551      Table_Initial        => 5000,
 552      Table_Increment      => 200,
 553      Table_Name           => "Withs");
 554
 555    ---------------------
 556    -- Arguments Table --
 557    ---------------------
 558
 559    --  Each Arg line (A line) in an ALI file generates an Args table entry
 560
 561    --  Note: there will be no entries in this table if 'A' lines are ignored
 562
 563    No_Arg_Id : constant Arg_Id := Arg_Id'First;
 564    --  Special value indicating no args table entry
 565
 566    First_Arg_Entry : constant Arg_Id := No_Arg_Id + 1;
 567    --  Id of first actual entry in table
 568
 569    package Args is new Table.Table (
 570      Table_Component_Type => String_Ptr,
 571      Table_Index_Type     => Arg_Id,
 572      Table_Low_Bound      => First_Arg_Entry,
 573      Table_Initial        => 1000,
 574      Table_Increment      => 100,
 575      Table_Name           => "Args");
 576
 577    --------------------------
 578    -- Linker_Options Table --
 579    --------------------------
 580
 581    --  If an ALI file has one of more Linker_Options lines, then a single
 582    --  entry is made in this table. If more than one Linker_Options lines
 583    --  appears in a given ALI file, then the arguments are concatenated
 584    --  to form the entry in this table, using a NUL character as the
 585    --  separator, and a final NUL character is appended to the end.
 586
 587    --  Note: there will be no entries in this table if 'L' lines are ignored
 588
 589    type Linker_Option_Record is record
 590       Name : Name_Id;
 591       --  Name entry containing concatenated list of Linker_Options
 592       --  arguments separated by NUL and ended by NUL as described above.
 593
 594       Unit : Unit_Id;
 595       --  Unit_Id for the entry
 596
 597       Internal_File : Boolean;
 598       --  Set True if the linker options are from an internal file. This is
 599       --  used to insert certain standard entries after all the user entries
 600       --  but before the entries from the run-time.
 601
 602       Original_Pos : Positive;
 603       --  Keep track of original position in the linker options table. This
 604       --  is used to implement a stable sort when we sort the linker options
 605       --  table.
 606    end record;
 607
 608    --  The indexes of active entries in this table range from 1 to the
 609    --  value of Linker_Options.Last. The zero'th element is for sort call.
 610
 611    package Linker_Options is new Table.Table (
 612      Table_Component_Type => Linker_Option_Record,
 613      Table_Index_Type     => Integer,
 614      Table_Low_Bound      => 0,
 615      Table_Initial        => 200,
 616      Table_Increment      => 400,
 617      Table_Name           => "Linker_Options");
 618
 619    -----------------
 620    -- Notes Table --
 621    -----------------
 622
 623    --  The notes table records entries from N lines
 624
 625    type Notes_Record is record
 626       Pragma_Type : Character;
 627       --  'A', 'C', 'I', 'S', 'T' for Annotate/Comment/Ident/Subtitle/Title
 628
 629       Pragma_Line : Nat;
 630       --  Line number of pragma
 631
 632       Pragma_Col : Nat;
 633       --  Column number of pragma
 634
 635       Unit : Unit_Id;
 636       --  Unit_Id for the entry
 637
 638       Pragma_Args : Name_Id;
 639       --  Pragma arguments. No_Name if no arguments, otherwise a single
 640       --  name table entry consisting of all the characters on the notes
 641       --  line from the first non-blank character following the source
 642       --  location to the last character on the line.
 643    end record;
 644
 645    --  The indexes of active entries in this table range from 1 to the
 646    --  value of Linker_Options.Last. The zero'th element is for convenience
 647    --  if the table needs to be sorted.
 648
 649    package Notes is new Table.Table (
 650      Table_Component_Type => Notes_Record,
 651      Table_Index_Type     => Integer,
 652      Table_Low_Bound      => 0,
 653      Table_Initial        => 200,
 654      Table_Increment      => 400,
 655      Table_Name           => "Notes");
 656
 657    -------------------------------------------
 658    -- External Version Reference Hash Table --
 659    -------------------------------------------
 660
 661    --  This hash table keeps track of external version reference strings
 662    --  as read from E lines in the ali file. The stored values do not
 663    --  include the terminating quote characters.
 664
 665    --  Note: there will be no entries in this table if 'E' lines are ignored
 666
 667    type Vindex is range 0 .. 98;
 668    --  Type to define range of headers
 669
 670    function SHash (S : String_Ptr) return Vindex;
 671    --  Hash function for this table
 672
 673    function SEq (F1, F2 : String_Ptr) return Boolean;
 674    --  Equality function for this table
 675
 676    package Version_Ref is new Simple_HTable (
 677      Header_Num => Vindex,
 678      Element    => Boolean,
 679      No_Element => False,
 680      Key        => String_Ptr,
 681      Hash       => SHash,
 682      Equal      => SEq);
 683
 684    -------------------------
 685    -- No_Dependency Table --
 686    -------------------------
 687
 688    --  Each R line for a No_Dependency Restriction generates an entry in
 689    --  this No_Dependency table.
 690
 691    type No_Dep_Record is record
 692       ALI_File : ALI_Id;
 693       --  ALI File containing the entry
 694
 695       No_Dep_Unit : Name_Id;
 696       --  Id for names table entry including entire name, including periods
 697    end record;
 698
 699    package No_Deps is new Table.Table (
 700      Table_Component_Type => No_Dep_Record,
 701      Table_Index_Type     => Integer,
 702      Table_Low_Bound      => 0,
 703      Table_Initial        => 200,
 704      Table_Increment      => 400,
 705      Table_Name           => "No_Deps");
 706
 707    ------------------------------------
 708    -- Sdep (Source Dependency) Table --
 709    ------------------------------------
 710
 711    --  Each source dependency (D line) in an ALI file generates an entry in the
 712    --  Sdep table.
 713
 714    --  Note: there will be no entries in this table if 'D' lines are ignored
 715
 716    No_Sdep_Id : constant Sdep_Id := Sdep_Id'First;
 717    --  Special value indicating no Sdep table entry
 718
 719    First_Sdep_Entry : Sdep_Id := No_Sdep_Id + 1;
 720    --  Id of first Sdep entry for current ali file. This is initialized to the
 721    --  first Sdep entry in the table, and then incremented appropriately as
 722    --  successive ALI files are scanned.
 723
 724    type Sdep_Record is record
 725
 726       Sfile : File_Name_Type;
 727       --  Name of source file
 728
 729       Stamp : Time_Stamp_Type;
 730       --  Time stamp value. Note that this will be all zero characters for the
 731       --  dummy entries for missing or non-dependent files.
 732
 733       Checksum : Word;
 734       --  Checksum value. Note that this will be all zero characters for the
 735       --  dummy entries for missing or non-dependent files
 736
 737       Dummy_Entry : Boolean;
 738       --  Set True for dummy entries that correspond to missing files or files
 739       --  where no dependency relationship exists.
 740
 741       Subunit_Name : Name_Id;
 742       --  Name_Id for subunit name if present, else No_Name
 743
 744       Rfile : File_Name_Type;
 745       --  Reference file name. Same as Sfile unless a Source_Reference pragma
 746       --  was used, in which case it reflects the name used in the pragma.
 747
 748       Start_Line : Nat;
 749       --  Starting line number in file. Always 1, unless a Source_Reference
 750       --  pragma was used, in which case it reflects the line number value
 751       --  given in the pragma.
 752
 753    end record;
 754
 755    package Sdep is new Table.Table (
 756      Table_Component_Type => Sdep_Record,
 757      Table_Index_Type     => Sdep_Id,
 758      Table_Low_Bound      => First_Sdep_Entry,
 759      Table_Initial        => 5000,
 760      Table_Increment      => 200,
 761      Table_Name           => "Sdep");
 762
 763    ----------------------------
 764    -- Use of Name Table Info --
 765    ----------------------------
 766
 767    --  All unit names and file names are entered into the Names table. The Info
 768    --  fields of these entries are used as follows:
 769
 770    --    Unit name           Info field has Unit_Id of unit table entry
 771    --    ALI file name       Info field has ALI_Id of ALI table entry
 772    --    Source file name    Info field has Source_Id of source table entry
 773
 774    --------------------------
 775    -- Cross-Reference Data --
 776    --------------------------
 777
 778    --  The following table records cross-reference sections, there is one entry
 779    --  for each X header line in the ALI file for an xref section.
 780
 781    --  Note: there will be no entries in this table if 'X' lines are ignored
 782
 783    type Xref_Section_Record is record
 784       File_Num : Sdep_Id;
 785       --  Dependency number for file (entry in Sdep.Table)
 786
 787       File_Name : File_Name_Type;
 788       --  Name of file
 789
 790       First_Entity : Nat;
 791       --  First entry in Xref_Entity table
 792
 793       Last_Entity : Nat;
 794       --  Last entry in Xref_Entity table
 795    end record;
 796
 797    package Xref_Section is new Table.Table (
 798      Table_Component_Type => Xref_Section_Record,
 799      Table_Index_Type     => Nat,
 800      Table_Low_Bound      => 1,
 801      Table_Initial        => 50,
 802      Table_Increment      => 300,
 803      Table_Name           => "Xref_Section");
 804
 805    --  The following is used to indicate whether a typeref field is present
 806    --  for the entity, and if so what kind of typeref field.
 807
 808    type Tref_Kind is (
 809      Tref_None,    --  No typeref present
 810      Tref_Access,  --  Access type typeref (points to designated type)
 811      Tref_Derived, --  Derived type typeref (points to parent type)
 812      Tref_Type);   --  All other cases
 813
 814    type Visibility_Kind is
 815      (Global, --  Library level entity
 816       Static, --  Static C/C++ entity
 817       Other); --  Local and other entity
 818
 819    --  The following table records entities for which xrefs are recorded
 820
 821    type Xref_Entity_Record is record
 822       Line : Pos;
 823       --  Line number of definition
 824
 825       Etype : Character;
 826       --  Set to the identification character for the entity. See section
 827       --  "Cross-Reference Entity Identifiers" in lib-xref.ads for details.
 828
 829       Col : Pos;
 830       --  Column number of definition
 831
 832       Visibility : Visibility_Kind;
 833       --  Visiblity of entity
 834
 835       Entity : Name_Id;
 836       --  Name of entity
 837
 838       Iref_File_Num : Sdep_Id;
 839       --  This field is set to the dependency reference for the file containing
 840       --  the generic entity that this one instantiates, or to No_Sdep_Id if
 841       --  the current entity is not an instantiation
 842
 843       Iref_Line : Nat;
 844       --  This field is set to the line number in Iref_File_Num of the generic
 845       --  entity that this one instantiates, or to zero if the current entity
 846       --  is not an instantiation.
 847
 848       Rref_Line : Nat;
 849       --  This field is set to the line number of a renaming reference if
 850       --  one is present, or to zero if no renaming reference is present
 851
 852       Rref_Col : Nat;
 853       --  This field is set to the column number of a renaming reference
 854       --  if one is present, or to zero if no renaming reference is present.
 855
 856       Tref : Tref_Kind;
 857       --  Indicates if a typeref is present, and if so what kind. Set to
 858       --  Tref_None if no typeref field is present.
 859
 860       Tref_File_Num : Sdep_Id;
 861       --  This field is set to No_Sdep_Id if no typeref is present, or
 862       --  if the typeref refers to an entity in standard. Otherwise it
 863       --  it is the dependency reference for the file containing the
 864       --  declaration of the typeref entity.
 865
 866       Tref_Line : Nat;
 867       --  This field is set to zero if no typeref is present, or if the
 868       --  typeref refers to an entity in standard. Otherwise it contains
 869       --  the line number of the declaration of the typeref entity.
 870
 871       Tref_Type : Character;
 872       --  This field is set to blank if no typeref is present, or if the
 873       --  typeref refers to an entity in standard. Otherwise it contains
 874       --  the identification character for the typeref entity. See section
 875       --  "Cross-Reference Entity Identifiers" in lib-xref.ads for details.
 876
 877       Tref_Col : Nat;
 878       --  This field is set to zero if no typeref is present, or if the
 879       --  typeref refers to an entity in standard. Otherwise it contains
 880       --  the column number of the declaration of the parent type.
 881
 882       Tref_Standard_Entity : Name_Id;
 883       --  This field is set to No_Name if no typeref is present or if the
 884       --  typeref refers to a declared entity rather than an entity in
 885       --  package Standard. If there is a typeref that references an
 886       --  entity in package Standard, then this field is a Name_Id
 887       --  reference for the entity name.
 888
 889       Oref_File_Num : Sdep_Id;
 890       --  This field is set to No_Sdep_Id if the entity doesn't override any
 891       --  other entity, or to the dependency reference for the overridden
 892       --  entity.
 893
 894       Oref_Line : Nat;
 895       Oref_Col  : Nat;
 896       --  These two fields are set to the line and column of the overridden
 897       --  entity.
 898
 899       First_Xref : Nat;
 900       --  Index into Xref table of first cross-reference
 901
 902       Last_Xref : Nat;
 903       --  Index into Xref table of last cross-reference. The value in
 904       --  Last_Xref can be less than the First_Xref value to indicate
 905       --  that no entries are present in the Xref Table.
 906    end record;
 907
 908    package Xref_Entity is new Table.Table (
 909      Table_Component_Type => Xref_Entity_Record,
 910      Table_Index_Type     => Nat,
 911      Table_Low_Bound      => 1,
 912      Table_Initial        => 500,
 913      Table_Increment      => 300,
 914      Table_Name           => "Xref_Entity");
 915
 916    Array_Index_Reference : constant Character := '*';
 917    Interface_Reference   : constant Character := 'I';
 918    --  Some special types of references. In the ALI file itself, these
 919    --  are output as attributes of the entity, not as references, but
 920    --  there is no provision in Xref_Entity_Record for storing multiple
 921    --  such references.
 922
 923    --  The following table records actual cross-references
 924
 925    type Xref_Record is record
 926       File_Num : Sdep_Id;
 927       --  Set to the file dependency number for the cross-reference. Note
 928       --  that if no file entry is present explicitly, this is just a copy
 929       --  of the reference for the current cross-reference section.
 930
 931       Line : Nat;
 932       --  Line number for the reference. This is zero when referencing a
 933       --  predefined entity, but in this case Name is set.
 934
 935       Rtype : Character;
 936       --  Indicates type of reference, using code used in ALI file:
 937       --    r = reference
 938       --    m = modification
 939       --    b = body entity
 940       --    c = completion of private or incomplete type
 941       --    x = type extension
 942       --    i = implicit reference
 943       --    Array_Index_Reference = reference to the index of an array
 944       --    Interface_Reference   = reference to an interface implemented
 945       --                            by the type
 946       --  See description in lib-xref.ads for further details
 947
 948       Col : Nat;
 949       --  Column number for the reference
 950
 951       Name : Name_Id := No_Name;
 952       --  This is only used when referencing a predefined entity. Currently,
 953       --  this only occurs for array indexes.
 954
 955       --  Note: for instantiation references, Rtype is set to ' ', and Col is
 956       --  set to zero. One or more such entries can follow any other reference.
 957       --  When there is more than one such entry, this is to be read as:
 958       --     e.g. ref1  ref2  ref3
 959       --     ref1 is a reference to an entity that was instantied at ref2.
 960       --     ref2 itself is also the result of an instantiation, that took
 961       --     place at ref3
 962    end record;
 963
 964    package Xref is new Table.Table (
 965      Table_Component_Type => Xref_Record,
 966      Table_Index_Type     => Nat,
 967      Table_Low_Bound      => 1,
 968      Table_Initial        => 2000,
 969      Table_Increment      => 300,
 970      Table_Name           => "Xref");
 971
 972    --------------------------------------
 973    -- Subprograms for Reading ALI File --
 974    --------------------------------------
 975
 976    procedure Initialize_ALI;
 977    --  Initialize the ALI tables. Also resets all switch values to defaults
 978
 979    function Scan_ALI
 980      (F                : File_Name_Type;
 981       T                : Text_Buffer_Ptr;
 982       Ignore_ED        : Boolean;
 983       Err              : Boolean;
 984       Read_Xref        : Boolean := False;
 985       Read_Lines       : String  := "";
 986       Ignore_Lines     : String  := "X";
 987       Ignore_Errors    : Boolean := False;
 988       Directly_Scanned : Boolean := False) return ALI_Id;
 989    --  Given the text, T, of an ALI file, F, scan and store the information
 990    --  from the file, and return the Id of the resulting entry in the ALI
 991    --  table. Switch settings may be modified as described above in the
 992    --  switch description settings.
 993    --
 994    --    Ignore_ED is normally False. If set to True, it indicates that
 995    --    all AD/ED (elaboration desirable) indications in the ALI file are
 996    --    to be ignored. This parameter is obsolete now that the -f switch
 997    --    is removed from gnatbind, and should be removed ???
 998    --
 999    --    Err determines the action taken on an incorrectly formatted file.
1000    --    If Err is False, then an error message is output, and the program
1001    --    is terminated. If Err is True, then no error message is output,
1002    --    and No_ALI_Id is returned.
1003    --
1004    --    Ignore_Lines requests that Scan_ALI ignore any lines that start
1005    --    with any given key character. The default value of X causes all
1006    --    Xref lines to be ignored. The corresponding data in the ALI
1007    --    tables will not be filled in this case. It is not possible
1008    --    to ignore U (unit) lines, they are always read.
1009    --
1010    --    Read_Lines requests that Scan_ALI process only lines that start
1011    --    with one of the given characters. The corresponding data in the
1012    --    ALI file for any characters not given in the list will not be
1013    --    set. The default value of the null string indicates that all
1014    --    lines should be read (unless Ignore_Lines is specified). U
1015    --    (unit) lines are always read regardless of the value of this
1016    --    parameter.
1017    --
1018    --    Note: either Ignore_Lines or Read_Lines should be non-null, but not
1019    --    both. If both are provided then only the Read_Lines value is used,
1020    --    and the Ignore_Lines parameter is ignored.
1021    --
1022    --    Read_XREF is set True to read and acquire the cross-reference
1023    --    information. If Read_XREF is set to True, then the effect is to ignore
1024    --    all lines other than U, W, D and X lines and the Ignore_Lines and
1025    --    Read_Lines parameters are ignored (i.e. the use of True for Read_XREF
1026    --    is equivalent to specifying an argument of "UWDX" for Read_Lines.
1027    --
1028    --    Ignore_Errors is normally False. If it is set True, then Scan_ALI
1029    --    will do its best to scan through a file and extract all information
1030    --    it can, even if there are errors. In this case Err is only set if
1031    --    Scan_ALI was completely unable to process the file (e.g. it did not
1032    --    look like an ALI file at all). Ignore_Errors is intended to improve
1033    --    the downward compatibility of new compilers with old tools.
1034    --
1035    --    Directly_Scanned is normally False. If it is set to True, then the
1036    --    units (spec and/or body) corresponding to the ALI file are marked as
1037    --    such. It is used to decide for what units gnatbind should generate
1038    --    the symbols corresponding to 'Version or 'Body_Version in
1039    --    Stand-Alone Libraries.
1040
1041 end ALI;