gcc/ada/prj.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                  P R J                                   --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2001-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 --  The following package declares the data types for GNAT project.
  27 --  These data types may be used by GNAT Project-aware tools.
  28
  29 --  Children of these package implements various services on these data types.
  30 --  See in particular Prj.Pars and Prj.Env.
  31
  32 with Casing; use Casing;
  33 with Namet;  use Namet;
  34 with Scans;  use Scans;
  35 with Types;  use Types;
  36
  37 with GNAT.Dynamic_HTables; use GNAT.Dynamic_HTables;
  38 with GNAT.Dynamic_Tables;
  39 with GNAT.OS_Lib;          use GNAT.OS_Lib;
  40
  41 package Prj is
  42
  43    All_Other_Names : constant Name_Id := Names_High_Bound;
  44    --  Name used to replace others as an index of an associative array
  45    --  attribute in situations where this is allowed.
  46
  47    Subdirs : String_Ptr := null;
  48    --  The value after the equal sign in switch --subdirs=...
  49    --  Contains the relative subdirectory.
  50
  51    type Library_Support is (None, Static_Only, Full);
  52    --  Support for Library Project File.
  53    --  - None: Library Project Files are not supported at all
  54    --  - Static_Only: Library Project Files are only supported for static
  55    --    libraries.
  56    --  - Full: Library Project Files are supported for static and dynamic
  57    --    (shared) libraries.
  58
  59    type Yes_No_Unknown is (Yes, No, Unknown);
  60    --  Tri-state to decide if -lgnarl is needed when linking
  61
  62    type Mode is (Multi_Language, Ada_Only);
  63    --  Ada_Only: mode for gnatmake, gnatclean, gnatname, the GNAT driver
  64    --  Multi_Language: mode for gprbuild, gprclean
  65
  66    type Project_Qualifier is
  67      (Unspecified,
  68       Standard,
  69       Library,
  70       Configuration,
  71       Dry,
  72       Aggregate,
  73       Aggregate_Library);
  74    --  Qualifiers that can prefix the reserved word "project" in a project
  75    --  file:
  76    --    Standard:             standard project ...
  77    --    Library:              library project is ...
  78    --    Dry:                  abstract project is
  79    --    Aggregate:            aggregate project is
  80    --    Aggregate_Library:    aggregate library project is ...
  81    --    Configuration:        configuration project is ...
  82
  83    function Get_Mode return Mode;
  84    pragma Inline (Get_Mode);
  85
  86    procedure Set_Mode (New_Mode : Mode);
  87    pragma Inline (Set_Mode);
  88
  89    Default_Language_Is_Ada : Boolean := True;
  90    --  If no language was defined in the project or the configuration file, it
  91    --  is an error, unless this variable is True, in which case it defaults to
  92    --  Ada. Calling Set_Mode will reset this variable, default is for Ada_Only.
  93
  94    Must_Check_Configuration : Boolean := False;
  95    --  True when the contents of the configuration file must be checked. This
  96    --  is in general only needed by gprbuild itself, since other applications
  97    --  can ignore such errors when they don't need to build directly. Calling
  98    --  Set_Mode will reset this variable, default is for Ada_Only.
  99
 100    All_Packages : constant String_List_Access;
 101    --  Default value of parameter Packages of procedures Parse, in Prj.Pars and
 102    --  Prj.Part, indicating that all packages should be checked.
 103
 104    type Project_Tree_Data;
 105    type Project_Tree_Ref is access all Project_Tree_Data;
 106    --  Reference to a project tree. Several project trees may exist in memory
 107    --  at the same time.
 108
 109    No_Project_Tree : constant Project_Tree_Ref;
 110
 111    procedure Free (Tree : in out Project_Tree_Ref);
 112    --  Free memory associated with the tree
 113
 114    function Default_Ada_Spec_Suffix return File_Name_Type;
 115    pragma Inline (Default_Ada_Spec_Suffix);
 116    --  The name for the standard GNAT suffix for Ada spec source file name
 117    --  ".ads". Initialized by Prj.Initialize.
 118
 119    function Default_Ada_Body_Suffix return File_Name_Type;
 120    pragma Inline (Default_Ada_Body_Suffix);
 121    --  The name for the standard GNAT suffix for Ada body source file name
 122    --  ".adb". Initialized by Prj.Initialize.
 123
 124    function Slash return Path_Name_Type;
 125    pragma Inline (Slash);
 126    --  "/", used as the path of locally removed files
 127
 128    Config_Project_File_Extension : String := ".cgpr";
 129    Project_File_Extension : String := ".gpr";
 130    --  The standard config and user project file name extensions. They are not
 131    --  constants, because Canonical_Case_File_Name is called on these variables
 132    --  in the body of Prj.
 133
 134    type Error_Warning is (Silent, Warning, Error);
 135    --  Severity of some situations, such as: no Ada sources in a project where
 136    --  Ada is one of the language.
 137    --
 138    --  When the situation occurs, the behaviour depends on the setting:
 139    --
 140    --    - Silent:  no action
 141    --    - Warning: issue a warning, does not cause the tool to fail
 142    --    - Error:   issue an error, causes the tool to fail
 143
 144    function Empty_File   return File_Name_Type;
 145    function Empty_String return Name_Id;
 146    --  Return the id for an empty string ""
 147
 148    type Path_Information is record
 149       Name         : Path_Name_Type := No_Path;
 150       Display_Name : Path_Name_Type := No_Path;
 151    end record;
 152
 153    No_Path_Information : constant Path_Information := (No_Path, No_Path);
 154
 155    type Project_Data;
 156    type Project_Id is access all Project_Data;
 157    No_Project : constant Project_Id := null;
 158    --  Id of a Project File
 159
 160    type String_List_Id is new Nat;
 161    Nil_String : constant String_List_Id := 0;
 162    type String_Element is record
 163       Value         : Name_Id        := No_Name;
 164       Index         : Int            := 0;
 165       Display_Value : Name_Id        := No_Name;
 166       Location      : Source_Ptr     := No_Location;
 167       Flag          : Boolean        := False;
 168       Next          : String_List_Id := Nil_String;
 169    end record;
 170    --  To hold values for string list variables and array elements.
 171    --  Component Flag may be used for various purposes. For source
 172    --  directories, it indicates if the directory contains Ada source(s).
 173
 174    package String_Element_Table is new GNAT.Dynamic_Tables
 175      (Table_Component_Type => String_Element,
 176       Table_Index_Type     => String_List_Id,
 177       Table_Low_Bound      => 1,
 178       Table_Initial        => 200,
 179       Table_Increment      => 100);
 180    --  The table for string elements in string lists
 181
 182    type Variable_Kind is (Undefined, List, Single);
 183    --  Different kinds of variables
 184
 185    subtype Defined_Variable_Kind is Variable_Kind range List .. Single;
 186    --  The defined kinds of variables
 187
 188    Ignored : constant Variable_Kind;
 189    --  Used to indicate that a package declaration must be ignored
 190    --  while processing the project tree (unknown package name).
 191
 192    type Variable_Value (Kind : Variable_Kind := Undefined) is record
 193       Project  : Project_Id := No_Project;
 194       Location : Source_Ptr := No_Location;
 195       Default  : Boolean    := False;
 196       case Kind is
 197          when Undefined =>
 198             null;
 199          when List =>
 200             Values : String_List_Id := Nil_String;
 201          when Single =>
 202             Value : Name_Id := No_Name;
 203             Index : Int     := 0;
 204       end case;
 205    end record;
 206    --  Values for variables and array elements. Default is True if the
 207    --  current value is the default one for the variable
 208
 209    Nil_Variable_Value : constant Variable_Value;
 210    --  Value of a non existing variable or array element
 211
 212    type Variable_Id is new Nat;
 213    No_Variable : constant Variable_Id := 0;
 214    type Variable is record
 215       Next  : Variable_Id := No_Variable;
 216       Name  : Name_Id;
 217       Value : Variable_Value;
 218    end record;
 219    --  To hold the list of variables in a project file and in packages
 220
 221    package Variable_Element_Table is new GNAT.Dynamic_Tables
 222      (Table_Component_Type => Variable,
 223       Table_Index_Type     => Variable_Id,
 224       Table_Low_Bound      => 1,
 225       Table_Initial        => 200,
 226       Table_Increment      => 100);
 227    --  The table of variable in list of variables
 228
 229    type Array_Element_Id is new Nat;
 230    No_Array_Element : constant Array_Element_Id := 0;
 231    type Array_Element is record
 232       Index                : Name_Id;
 233       Src_Index            : Int := 0;
 234       Index_Case_Sensitive : Boolean := True;
 235       Value                : Variable_Value;
 236       Next                 : Array_Element_Id := No_Array_Element;
 237    end record;
 238    --  Each Array_Element represents an array element and is linked (Next)
 239    --  to the next array element, if any, in the array.
 240
 241    package Array_Element_Table is new GNAT.Dynamic_Tables
 242      (Table_Component_Type => Array_Element,
 243       Table_Index_Type     => Array_Element_Id,
 244       Table_Low_Bound      => 1,
 245       Table_Initial        => 200,
 246       Table_Increment      => 100);
 247    --  The table that contains all array elements
 248
 249    type Array_Id is new Nat;
 250    No_Array : constant Array_Id := 0;
 251    type Array_Data is record
 252       Name     : Name_Id          := No_Name;
 253       Location : Source_Ptr       := No_Location;
 254       Value    : Array_Element_Id := No_Array_Element;
 255       Next     : Array_Id         := No_Array;
 256    end record;
 257    --  Each Array_Data value represents an array.
 258    --  Value is the id of the first element.
 259    --  Next is the id of the next array in the project file or package.
 260
 261    package Array_Table is new GNAT.Dynamic_Tables
 262      (Table_Component_Type => Array_Data,
 263       Table_Index_Type     => Array_Id,
 264       Table_Low_Bound      => 1,
 265       Table_Initial        => 200,
 266       Table_Increment      => 100);
 267    --  The table that contains all arrays
 268
 269    type Package_Id is new Nat;
 270    No_Package : constant Package_Id := 0;
 271    type Declarations is record
 272       Variables  : Variable_Id := No_Variable;
 273       Attributes : Variable_Id := No_Variable;
 274       Arrays     : Array_Id    := No_Array;
 275       Packages   : Package_Id  := No_Package;
 276    end record;
 277    --  Contains the declarations (variables, single and array attributes,
 278    --  packages) for a project or a package in a project.
 279
 280    No_Declarations : constant Declarations :=
 281      (Variables  => No_Variable,
 282       Attributes => No_Variable,
 283       Arrays     => No_Array,
 284       Packages   => No_Package);
 285    --  Default value of Declarations: indicates that there is no declarations
 286
 287    type Package_Element is record
 288       Name   : Name_Id      := No_Name;
 289       Decl   : Declarations := No_Declarations;
 290       Parent : Package_Id   := No_Package;
 291       Next   : Package_Id   := No_Package;
 292    end record;
 293    --  A package (includes declarations that may include other packages)
 294
 295    package Package_Table is new GNAT.Dynamic_Tables
 296      (Table_Component_Type => Package_Element,
 297       Table_Index_Type     => Package_Id,
 298       Table_Low_Bound      => 1,
 299       Table_Initial        => 100,
 300       Table_Increment      => 100);
 301    --  The table that contains all packages
 302
 303    type Language_Data;
 304    type Language_Ptr is access all Language_Data;
 305    --  Index of language data
 306
 307    No_Language_Index : constant Language_Ptr := null;
 308    --  Constant indicating that there is no language data
 309
 310    Max_Header_Num : constant := 6150;
 311    type Header_Num is range 0 .. Max_Header_Num;
 312    --  Size for hash table below. The upper bound is an arbitrary value, the
 313    --  value here was chosen after testing to determine a good compromise
 314    --  between speed of access and memory usage.
 315
 316    function Hash (Name : Name_Id)        return Header_Num;
 317    function Hash (Name : File_Name_Type) return Header_Num;
 318    function Hash (Name : Path_Name_Type) return Header_Num;
 319    function Hash (Project : Project_Id) return Header_Num;
 320    --  Used for computing hash values for names put into above hash table
 321
 322    type Language_Kind is (File_Based, Unit_Based);
 323    --  Type for the kind of language. All languages are file based, except Ada
 324    --  which is unit based.
 325
 326    type Dependency_File_Kind is (None, Makefile, ALI_File);
 327    --  Type of dependency to be checked: no dependency file, Makefile fragment
 328    --  or ALI file (for Ada).
 329
 330    Makefile_Dependency_Suffix : constant String := ".d";
 331    ALI_Dependency_Suffix      : constant String := ".ali";
 332
 333    Switches_Dependency_Suffix : constant String := ".cswi";
 334
 335    Binder_Exchange_Suffix     : constant String := ".bexch";
 336    --  Suffix for binder exchange files
 337
 338    Library_Exchange_Suffix     : constant String := ".lexch";
 339    --  Suffix for library exchange files
 340
 341    type Name_List_Index is new Nat;
 342    No_Name_List            : constant Name_List_Index := 0;
 343
 344    type Name_Node is record
 345       Name : Name_Id         := No_Name;
 346       Next : Name_List_Index := No_Name_List;
 347    end record;
 348
 349    package Name_List_Table is new GNAT.Dynamic_Tables
 350      (Table_Component_Type => Name_Node,
 351       Table_Index_Type     => Name_List_Index,
 352       Table_Low_Bound      => 1,
 353       Table_Initial        => 10,
 354       Table_Increment      => 100);
 355    --  The table for lists of names used in package Language_Processing
 356
 357    package Mapping_Files_Htable is new Simple_HTable
 358      (Header_Num => Header_Num,
 359       Element    => Path_Name_Type,
 360       No_Element => No_Path,
 361       Key        => Path_Name_Type,
 362       Hash       => Hash,
 363       Equal      => "=");
 364    --  A hash table to store the mapping files that are not used
 365
 366    type Lang_Naming_Data is record
 367       Dot_Replacement : File_Name_Type := No_File;
 368       --  The string to replace '.' in the source file name (for Ada)
 369
 370       Casing : Casing_Type := All_Lower_Case;
 371       --  The casing of the source file name (for Ada)
 372
 373       Separate_Suffix : File_Name_Type := No_File;
 374       --  String to append to unit name for source file name of an Ada subunit
 375
 376       Spec_Suffix : File_Name_Type := No_File;
 377       --  The string to append to the unit name for the
 378       --  source file name of a spec.
 379
 380       Body_Suffix : File_Name_Type := No_File;
 381       --  The string to append to the unit name for the
 382       --  source file name of a body.
 383    end record;
 384
 385    No_Lang_Naming_Data : constant Lang_Naming_Data :=
 386                            (Dot_Replacement => No_File,
 387                             Casing          => All_Lower_Case,
 388                             Separate_Suffix => No_File,
 389                             Spec_Suffix     => No_File,
 390                             Body_Suffix     => No_File);
 391
 392    type Source_Data;
 393    type Source_Id is access all Source_Data;
 394
 395    No_Source : constant Source_Id := null;
 396
 397    type Path_Syntax_Kind is
 398      (Canonical,
 399       --  Unix style
 400
 401       Host);
 402       --  Host specific syntax, for example on VMS (the default)
 403
 404    type Language_Config is record
 405       Kind : Language_Kind := File_Based;
 406       --  Kind of language. All languages are file based, except Ada which is
 407       --  unit based.
 408
 409       Naming_Data : Lang_Naming_Data;
 410       --  The naming data for the languages (prefixes, etc.)
 411
 412       Include_Compatible_Languages : Name_List_Index := No_Name_List;
 413       --  The list of languages that are "include compatible" with this
 414       --  language. A language B (for example "C") is "include compatible" with
 415       --  a language A (for example "C++") if it is expected that sources of
 416       --  language A may "include" header files from language B.
 417
 418       Compiler_Driver : File_Name_Type := No_File;
 419       --  The name of the executable for the compiler of the language
 420
 421       Compiler_Driver_Path : String_Access := null;
 422       --  The path name of the executable for the compiler of the language
 423
 424       Compiler_Leading_Required_Switches : Name_List_Index := No_Name_List;
 425       --  The list of initial switches that are required as a minimum to invoke
 426       --  the compiler driver.
 427
 428       Compiler_Trailing_Required_Switches : Name_List_Index := No_Name_List;
 429       --  The list of final switches that are required as a minimum to invoke
 430       --  the compiler driver.
 431
 432       Path_Syntax                  : Path_Syntax_Kind := Host;
 433       --  Value may be Canonical (Unix style) or Host (host syntax, for example
 434       --  on VMS for DEC C).
 435
 436       Object_File_Suffix                 : Name_Id := No_Name;
 437       --  Optional alternate object file suffix
 438
 439       Object_File_Switches               : Name_List_Index := No_Name_List;
 440       --  Optional object file switches. When this is defined, the switches
 441       --  are used to specify the object file. The object file name is appended
 442       --  to the last switch in the list. Example: ("-o", "").
 443
 444       Compilation_PIC_Option : Name_List_Index := No_Name_List;
 445       --  The option(s) to compile a source in Position Independent Code for
 446       --  shared libraries. Specified in the configuration. When not specified,
 447       --  there is no need for such switch.
 448
 449       Object_Generated             : Boolean := True;
 450       --  False in no object file is generated
 451
 452       Objects_Linked               : Boolean := True;
 453       --  False if object files are not use to link executables and build
 454       --  libraries.
 455
 456       Runtime_Library_Dir        : Name_Id := No_Name;
 457       --  Path name of the runtime library directory, if any
 458
 459       Runtime_Source_Dir        : Name_Id := No_Name;
 460       --  Path name of the runtime source directory, if any
 461
 462       Mapping_File_Switches  : Name_List_Index := No_Name_List;
 463       --  The option(s) to provide a mapping file to the compiler. Specified in
 464       --  the configuration. When value is No_Name_List, there is no mapping
 465       --  file.
 466
 467       Mapping_Spec_Suffix        : File_Name_Type       := No_File;
 468       --  Placeholder representing the spec suffix in a mapping file
 469
 470       Mapping_Body_Suffix        : File_Name_Type       := No_File;
 471       --  Placeholder representing the body suffix in a mapping file
 472
 473       Config_File_Switches       : Name_List_Index      := No_Name_List;
 474       --  The option(s) to provide a config file to the compiler. Specified in
 475       --  the configuration. When value is No_Name_List, there is no config
 476       --  file.
 477
 478       Dependency_Kind            : Dependency_File_Kind := None;
 479       --  The kind of dependency to be checked: none, Makefile fragment or
 480       --  ALI file (for Ada).
 481
 482       Dependency_Option          : Name_List_Index      := No_Name_List;
 483       --  The option(s) to be used to create the dependency file. When value is
 484       --  No_Name_List, there is not such option(s).
 485
 486       Compute_Dependency         : Name_List_Index      := No_Name_List;
 487       --  Hold the value of attribute Dependency_Driver, if declared for the
 488       --  language.
 489
 490       Include_Option             : Name_List_Index      := No_Name_List;
 491       --  Hold the value of attribute Include_Switches, if declared for the
 492       --  language.
 493
 494       Include_Path : Name_Id := No_Name;
 495       --  Name of environment variable declared by attribute Include_Path for
 496       --  the language.
 497
 498       Include_Path_File : Name_Id := No_Name;
 499       --  Name of environment variable declared by attribute Include_Path_File
 500       --  for the language.
 501
 502       Objects_Path : Name_Id := No_Name;
 503       --  Name of environment variable declared by attribute Objects_Path for
 504       --  the language.
 505
 506       Objects_Path_File : Name_Id := No_Name;
 507       --  Name of environment variable declared by attribute Objects_Path_File
 508       --  for the language.
 509
 510       Config_Body                : Name_Id         := No_Name;
 511       --  The template for a pragma Source_File_Name(_Project) for a specific
 512       --  file name of a body.
 513
 514       Config_Spec           : Name_Id         := No_Name;
 515       --  The template for a pragma Source_File_Name(_Project) for a specific
 516       --  file name of a spec.
 517
 518       Config_Body_Pattern   : Name_Id         := No_Name;
 519       --  The template for a pragma Source_File_Name(_Project) for a naming
 520       --  body pattern.
 521
 522       Config_Spec_Pattern   : Name_Id         := No_Name;
 523       --  The template for a pragma Source_File_Name(_Project) for a naming
 524       --  spec pattern.
 525
 526       Config_File_Unique         : Boolean         := False;
 527       --  Indicate if the config file specified to the compiler needs to be
 528       --  unique. If it is unique, then all config files are concatenated into
 529       --  a temp config file.
 530
 531       Binder_Driver              : File_Name_Type  := No_File;
 532       --  The name of the binder driver for the language, if any
 533
 534       Binder_Driver_Path         : Path_Name_Type  := No_Path;
 535       --  The path name of the binder driver
 536
 537       Binder_Required_Switches   : Name_List_Index      := No_Name_List;
 538       --  Hold the value of attribute Binder'Required_Switches for the language
 539
 540       Binder_Prefix              : Name_Id         := No_Name;
 541       --  Hold the value of attribute Binder'Prefix for the language
 542
 543       Toolchain_Version          : Name_Id         := No_Name;
 544       --  Hold the value of attribute Toolchain_Version for the language
 545
 546       Toolchain_Description      : Name_Id         := No_Name;
 547       --  Hold the value of attribute Toolchain_Description for the language
 548
 549    end record;
 550    --  Record describing the configuration of a language
 551
 552    No_Language_Config : constant Language_Config :=
 553                           (Kind                         => File_Based,
 554                            Naming_Data                  => No_Lang_Naming_Data,
 555                            Include_Compatible_Languages => No_Name_List,
 556                            Compiler_Driver              => No_File,
 557                            Compiler_Driver_Path         => null,
 558                            Compiler_Leading_Required_Switches  => No_Name_List,
 559                            Compiler_Trailing_Required_Switches => No_Name_List,
 560                            Path_Syntax                  => Canonical,
 561                            Object_File_Suffix           => No_Name,
 562                            Object_File_Switches         => No_Name_List,
 563                            Compilation_PIC_Option       => No_Name_List,
 564                            Object_Generated             => True,
 565                            Objects_Linked               => True,
 566                            Runtime_Library_Dir          => No_Name,
 567                            Runtime_Source_Dir           => No_Name,
 568                            Mapping_File_Switches        => No_Name_List,
 569                            Mapping_Spec_Suffix          => No_File,
 570                            Mapping_Body_Suffix          => No_File,
 571                            Config_File_Switches         => No_Name_List,
 572                            Dependency_Kind              => Makefile,
 573                            Dependency_Option            => No_Name_List,
 574                            Compute_Dependency           => No_Name_List,
 575                            Include_Option               => No_Name_List,
 576                            Include_Path                 => No_Name,
 577                            Include_Path_File            => No_Name,
 578                            Objects_Path                 => No_Name,
 579                            Objects_Path_File            => No_Name,
 580                            Config_Body                  => No_Name,
 581                            Config_Spec                  => No_Name,
 582                            Config_Body_Pattern          => No_Name,
 583                            Config_Spec_Pattern          => No_Name,
 584                            Config_File_Unique           => False,
 585                            Binder_Driver                => No_File,
 586                            Binder_Driver_Path           => No_Path,
 587                            Binder_Required_Switches     => No_Name_List,
 588                            Binder_Prefix                => No_Name,
 589                            Toolchain_Version            => No_Name,
 590                            Toolchain_Description        => No_Name);
 591
 592    type Language_Data is record
 593       Name          : Name_Id         := No_Name;
 594       Display_Name  : Name_Id         := No_Name;
 595       Config        : Language_Config := No_Language_Config;
 596       First_Source  : Source_Id       := No_Source;
 597       Mapping_Files : Mapping_Files_Htable.Instance :=
 598                         Mapping_Files_Htable.Nil;
 599       Next          : Language_Ptr  := No_Language_Index;
 600    end record;
 601
 602    No_Language_Data : constant Language_Data :=
 603                         (Name          => No_Name,
 604                          Display_Name  => No_Name,
 605                          Config        => No_Language_Config,
 606                          First_Source  => No_Source,
 607                          Mapping_Files => Mapping_Files_Htable.Nil,
 608                          Next          => No_Language_Index);
 609
 610    type Language_List_Element;
 611    type Language_List is access all Language_List_Element;
 612    type Language_List_Element is record
 613       Language : Language_Ptr := No_Language_Index;
 614       Next     : Language_List;
 615    end record;
 616
 617    type Source_Kind is (Spec, Impl, Sep);
 618
 619    type Source_Data is record
 620       Project             : Project_Id            := No_Project;
 621       --  Project of the source
 622
 623       Language            : Language_Ptr        := No_Language_Index;
 624       --  Index of the language. This is an index into
 625       --  Project_Tree.Languages_Data.
 626
 627       Lang_Kind           : Language_Kind         := File_Based;
 628       --  Kind of the language
 629       --  ??? Should be in Language itself
 630
 631       Compiled            : Boolean               := True;
 632       --  False when there is no compiler for the language
 633
 634       In_Interfaces       : Boolean               := True;
 635       --  False when the source is not included in interfaces, when attribute
 636       --  Interfaces is declared.
 637
 638       Declared_In_Interfaces : Boolean            := False;
 639       --  True when source is declared in attribute Interfaces
 640
 641       Alternate_Languages : Language_List;
 642       --  List of languages a header file may also be, in addition of language
 643       --  Language_Name.
 644
 645       Kind                : Source_Kind           := Spec;
 646       --  Kind of the source: spec, body or subunit
 647
 648       Dependency          : Dependency_File_Kind  := None;
 649       --  Kind of dependency: none, Makefile fragment or ALI file
 650
 651       Other_Part          : Source_Id             := No_Source;
 652       --  Source ID for the other part, if any: for a spec, indicates its body;
 653       --  for a body, indicates its spec.
 654
 655       Unit                : Name_Id               := No_Name;
 656       --  Name of the unit, if language is unit based
 657
 658       Index               : Int                   := 0;
 659       --  Index of the source in a multi unit source file
 660
 661       Locally_Removed     : Boolean               := False;
 662       --  True if the source has been "excluded"
 663
 664       Get_Object          : Boolean               := False;
 665       --  Indicates that the object of the source should be put in the global
 666       --  archive. This is for Ada, when only the closure of a main needs to
 667       --  be compiled/recompiled.
 668
 669       Replaced_By         : Source_Id             := No_Source;
 670
 671       File                : File_Name_Type        := No_File;
 672       --  Canonical file name of the source
 673
 674       Display_File        : File_Name_Type        := No_File;
 675       --  File name of the source, for display purposes
 676
 677       Path                : Path_Information      := No_Path_Information;
 678       --  Path name of the source
 679       --  Path.Name is set to Slash for an excluded file that does not belong
 680       --  in the project in fact
 681
 682       Source_TS           : Time_Stamp_Type       := Empty_Time_Stamp;
 683       --  Time stamp of the source file
 684
 685       Object_Project      : Project_Id            := No_Project;
 686       --  Project where the object file is. This might be different from
 687       --  Project when using extending project files.
 688
 689       Object_Exists       : Boolean               := True;
 690       --  True if an object file exists
 691
 692       Object_Linked          : Boolean            := True;
 693       --  False if the object file is not use to link executables or included
 694       --  in libraries.
 695
 696       Object              : File_Name_Type        := No_File;
 697       --  File name of the object file
 698
 699       Current_Object_Path : Path_Name_Type        := No_Path;
 700       --  Object path of an existing object file
 701
 702       Object_Path         : Path_Name_Type        := No_Path;
 703       --  Object path of the real object file
 704
 705       Object_TS           : Time_Stamp_Type       := Empty_Time_Stamp;
 706       --  Object file time stamp
 707
 708       Dep_Name            : File_Name_Type        := No_File;
 709       --  Dependency file simple name
 710
 711       Current_Dep_Path    : Path_Name_Type        := No_Path;
 712       --  Path name of an existing dependency file
 713
 714       Dep_Path            : Path_Name_Type        := No_Path;
 715       --  Path name of the real dependency file
 716
 717       Dep_TS              : Time_Stamp_Type       := Empty_Time_Stamp;
 718       --  Dependency file time stamp
 719
 720       Switches            : File_Name_Type        := No_File;
 721       --  File name of the switches file. For all languages, this is a file
 722       --  that ends with the .cswi extension.
 723
 724       Switches_Path       : Path_Name_Type        := No_Path;
 725       --  Path name of the switches file
 726
 727       Switches_TS         : Time_Stamp_Type       := Empty_Time_Stamp;
 728       --  Switches file time stamp
 729
 730       Naming_Exception    : Boolean               := False;
 731       --  True if the source has an exceptional name
 732
 733       Next_In_Lang        : Source_Id             := No_Source;
 734       --  Link to another source of the same language in the same project
 735    end record;
 736
 737    No_Source_Data : constant Source_Data :=
 738                       (Project                => No_Project,
 739                        Language               => No_Language_Index,
 740                        Lang_Kind              => File_Based,
 741                        Compiled               => True,
 742                        In_Interfaces          => True,
 743                        Declared_In_Interfaces => False,
 744                        Alternate_Languages    => null,
 745                        Kind                   => Spec,
 746                        Dependency             => None,
 747                        Other_Part             => No_Source,
 748                        Unit                   => No_Name,
 749                        Index                  => 0,
 750                        Locally_Removed        => False,
 751                        Get_Object             => False,
 752                        Replaced_By            => No_Source,
 753                        File                   => No_File,
 754                        Display_File           => No_File,
 755                        Path                   => No_Path_Information,
 756                        Source_TS              => Empty_Time_Stamp,
 757                        Object_Project         => No_Project,
 758                        Object_Exists          => True,
 759                        Object_Linked          => True,
 760                        Object                 => No_File,
 761                        Current_Object_Path    => No_Path,
 762                        Object_Path            => No_Path,
 763                        Object_TS              => Empty_Time_Stamp,
 764                        Dep_Name               => No_File,
 765                        Current_Dep_Path       => No_Path,
 766                        Dep_Path               => No_Path,
 767                        Dep_TS                 => Empty_Time_Stamp,
 768                        Switches               => No_File,
 769                        Switches_Path          => No_Path,
 770                        Switches_TS            => Empty_Time_Stamp,
 771                        Naming_Exception       => False,
 772                        Next_In_Lang           => No_Source);
 773
 774    package Source_Paths_Htable is new Simple_HTable
 775      (Header_Num => Header_Num,
 776       Element    => Source_Id,
 777       No_Element => No_Source,
 778       Key        => Path_Name_Type,
 779       Hash       => Hash,
 780       Equal      => "=");
 781    --  Mapping of source paths to source ids
 782
 783    package Unit_Sources_Htable is new Simple_HTable
 784      (Header_Num => Header_Num,
 785       Element    => Source_Id,
 786       No_Element => No_Source,
 787       Key        => Name_Id,
 788       Hash       => Hash,
 789       Equal      => "=");
 790
 791    type Verbosity is (Default, Medium, High);
 792    --  Verbosity when parsing GNAT Project Files
 793    --    Default is default (very quiet, if no errors).
 794    --    Medium is more verbose.
 795    --    High is extremely verbose.
 796
 797    Current_Verbosity : Verbosity := Default;
 798    --  The current value of the verbosity the project files are parsed with
 799
 800    type Lib_Kind is (Static, Dynamic, Relocatable);
 801
 802    type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
 803    --  Type to specify the symbol policy, when symbol control is supported.
 804    --  See full explanation about this type in package Symbols.
 805    --    Autonomous: Create a symbol file without considering any reference
 806    --    Compliant:  Try to be as compatible as possible with an existing ref
 807    --    Controlled: Fail if symbols are not the same as those in the reference
 808    --    Restricted: Restrict the symbols to those in the symbol file
 809    --    Direct:     The symbol file is used as is
 810
 811    type Symbol_Record is record
 812       Symbol_File   : Path_Name_Type := No_Path;
 813       Reference     : Path_Name_Type := No_Path;
 814       Symbol_Policy : Policy  := Autonomous;
 815    end record;
 816    --  Type to keep the symbol data to be used when building a shared library
 817
 818    No_Symbols : constant Symbol_Record :=
 819      (Symbol_File   => No_Path,
 820       Reference     => No_Path,
 821       Symbol_Policy => Autonomous);
 822    --  The default value of the symbol data
 823
 824    function Image (Casing : Casing_Type) return String;
 825    --  Similar to 'Image (but avoid use of this attribute in compiler)
 826
 827    function Value (Image : String) return Casing_Type;
 828    --  Similar to 'Value (but avoid use of this attribute in compiler)
 829    --  Raises Constraint_Error if not a Casing_Type image.
 830
 831    --  The following record contains data for a naming scheme
 832
 833    type Naming_Data is record
 834
 835       Dot_Replacement : File_Name_Type := No_File;
 836       --  The string to replace '.' in the source file name (for Ada)
 837
 838       Casing : Casing_Type := All_Lower_Case;
 839       --  The casing of the source file name (for Ada)
 840
 841       Spec_Suffix : Array_Element_Id := No_Array_Element;
 842       --  The string to append to the unit name for the
 843       --  source file name of a spec.
 844       --  Indexed by the programming language.
 845
 846       Body_Suffix : Array_Element_Id := No_Array_Element;
 847       --  The string to append to the unit name for the
 848       --  source file name of a body.
 849       --  Indexed by the programming language.
 850
 851       Separate_Suffix : File_Name_Type := No_File;
 852       --  String to append to unit name for source file name of an Ada subunit
 853
 854       Specs : Array_Element_Id := No_Array_Element;
 855       --  An associative array mapping individual specs to source file names
 856       --  This is specific to unit-based languages.
 857
 858       Bodies : Array_Element_Id := No_Array_Element;
 859       --  An associative array mapping individual bodies to source file names
 860       --  This is specific to unit-based languages.
 861
 862       Specification_Exceptions : Array_Element_Id := No_Array_Element;
 863       --  An associative array listing spec file names that do not have the
 864       --  spec suffix. Not used by Ada. Indexed by programming language name.
 865
 866       Implementation_Exceptions : Array_Element_Id := No_Array_Element;
 867       --  An associative array listing body file names that do not have the
 868       --  body suffix. Not used by Ada. Indexed by programming language name.
 869
 870    end record;
 871
 872    function Spec_Suffix_Of
 873      (In_Tree  : Project_Tree_Ref;
 874       Language : String;
 875       Naming   : Naming_Data) return String;
 876
 877    function Spec_Suffix_Id_Of
 878      (In_Tree     : Project_Tree_Ref;
 879       Language_Id : Name_Id;
 880       Naming      : Naming_Data) return File_Name_Type;
 881
 882    procedure Set_Spec_Suffix
 883      (In_Tree  : Project_Tree_Ref;
 884       Language : String;
 885       Naming   : in out Naming_Data;
 886       Suffix   : File_Name_Type);
 887
 888    function Body_Suffix_Id_Of
 889      (In_Tree     : Project_Tree_Ref;
 890       Language_Id : Name_Id;
 891       Naming      : Naming_Data) return File_Name_Type;
 892
 893    function Body_Suffix_Of
 894      (In_Tree  : Project_Tree_Ref;
 895       Language : String;
 896       Naming   : Naming_Data) return String;
 897
 898    procedure Set_Body_Suffix
 899      (In_Tree  : Project_Tree_Ref;
 900       Language : String;
 901       Naming   : in out Naming_Data;
 902       Suffix   : File_Name_Type);
 903
 904    function Get_Object_Directory
 905      (Project             : Project_Id;
 906       Including_Libraries : Boolean;
 907       Only_If_Ada         : Boolean := False) return Path_Name_Type;
 908    --  Return the object directory to use for the project. This depends on
 909    --  whether we have a library project or a standard project. This function
 910    --  might return No_Name when no directory applies.
 911    --  If we have a a library project file and Including_Libraries is True then
 912    --  the library dir is returned instead of the object dir.
 913    --  If Only_If_Ada is True, then No_Name will be returned when the project
 914    --  doesn't Ada sources.
 915
 916    procedure Compute_All_Imported_Projects (Project : Project_Id);
 917    --  Compute, the list of the projects imported directly or indirectly by
 918    --  project Project. The result is stored in Project.All_Imported_Projects
 919
 920    function Ultimate_Extending_Project_Of
 921      (Proj : Project_Id) return Project_Id;
 922    --  Returns the ultimate extending project of project Proj. If project Proj
 923    --  is not extended, returns Proj.
 924
 925    function Standard_Naming_Data
 926      (Tree : Project_Tree_Ref := No_Project_Tree) return Naming_Data;
 927    pragma Inline (Standard_Naming_Data);
 928    --  The standard GNAT naming scheme when Tree is No_Project_Tree.
 929    --  Otherwise, return the default naming scheme for the project tree Tree,
 930    --  which must have been Initialized.
 931
 932    function Same_Naming_Scheme
 933      (Left, Right : Naming_Data) return Boolean;
 934    --  Returns True if Left and Right are the same naming scheme
 935    --  not considering Specs and Bodies.
 936
 937    type Project_List_Element;
 938    type Project_List is access all Project_List_Element;
 939    type Project_List_Element is record
 940       Project : Project_Id   := No_Project;
 941       Next    : Project_List := null;
 942    end record;
 943    --  A list of projects
 944
 945    procedure Free_List
 946      (List         : in out Project_List;
 947       Free_Project : Boolean);
 948    --  Free the list of projects, if Free_Project, each project is also freed
 949
 950    type Response_File_Format is
 951      (None,
 952       GNU,
 953       Object_List,
 954       Option_List);
 955    --  The format of the different response files
 956
 957    type Project_Configuration is record
 958       Target                        : Name_Id         := No_Name;
 959       --  The target of the configuration, when specified
 960
 961       Run_Path_Option               : Name_List_Index := No_Name_List;
 962       --  The option to use when linking to specify the path where to look for
 963       --  libraries.
 964
 965       Separate_Run_Path_Options     : Boolean := False;
 966       --  True if each directory needs to be specified in a separate run path
 967       --  option.
 968
 969       Executable_Suffix             : Name_Id         := No_Name;
 970       --  The suffix of executables, when specified in the configuration or in
 971       --  package Builder of the main project. When this is not specified, the
 972       --  executable suffix is the default for the platform.
 973
 974       --  Linking
 975
 976       Linker                        : Path_Name_Type  := No_Path;
 977       --  Path name of the linker driver. Specified in the configuration or in
 978       --  the package Builder of the main project.
 979
 980       Map_File_Option               : Name_Id := No_Name;
 981       --  Option to use when invoking the linker to build a map file
 982
 983       Minimum_Linker_Options        : Name_List_Index := No_Name_List;
 984       --  The minimum options for the linker driver. Specified in the
 985       --  configuration.
 986
 987       Linker_Executable_Option      : Name_List_Index := No_Name_List;
 988       --  The option(s) to indicate the name of the executable in the linker
 989       --  command. Specified in the configuration. When not specified, default
 990       --  to -o <executable name>.
 991
 992       Linker_Lib_Dir_Option         : Name_Id         := No_Name;
 993       --  The option to specify where to find a library for linking. Specified
 994       --  in the configuration. When not specified, defaults to "-L".
 995
 996       Linker_Lib_Name_Option        : Name_Id         := No_Name;
 997       --  The option to specify the name of a library for linking. Specified in
 998       --  the configuration. When not specified, defaults to "-l".
 999
1000       Max_Command_Line_Length       : Natural         := 0;
1001       --  When positive and when Resp_File_Format (see below) is not None,
1002       --  if the command line for the invocation of the linker would be greater
1003       --  than this value, a response file is used to invoke the linker.
1004
1005       Resp_File_Format              : Response_File_Format := None;
1006       --  The format of a response file, when linking with a response file is
1007       --  supported.
1008
1009       Resp_File_Options             : Name_List_Index := No_Name_List;
1010       --  The switches, if any, that precede the path name of the response
1011       --  file in the invocation of the linker.
1012
1013       --  Libraries
1014
1015       Library_Builder               : Path_Name_Type  := No_Path;
1016       --  The executable to build library (specified in the configuration)
1017
1018       Lib_Support                   : Library_Support := None;
1019       --  The level of library support. Specified in the configuration. Support
1020       --  is none, static libraries only or both static and shared libraries.
1021
1022       Archive_Builder               : Name_List_Index := No_Name_List;
1023       --  The name of the executable to build archives, with the minimum
1024       --  switches. Specified in the configuration.
1025
1026       Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
1027       --  The options to append object files to an archive
1028
1029       Archive_Indexer               : Name_List_Index := No_Name_List;
1030       --  The name of the executable to index archives, with the minimum
1031       --  switches. Specified in the configuration.
1032
1033       Archive_Suffix                : File_Name_Type  := No_File;
1034       --  The suffix of archives. Specified in the configuration. When not
1035       --  specified, defaults to ".a".
1036
1037       Lib_Partial_Linker            : Name_List_Index := No_Name_List;
1038
1039       --  Shared libraries
1040
1041       Shared_Lib_Driver             : File_Name_Type  := No_File;
1042       --  The driver to link shared libraries. Set with attribute Library_GCC.
1043       --  Default to gcc.
1044
1045       Shared_Lib_Prefix             : File_Name_Type  := No_File;
1046       --  Part of a shared library file name that precedes the name of the
1047       --  library. Specified in the configuration. When not specified, defaults
1048       --  to "lib".
1049
1050       Shared_Lib_Suffix             : File_Name_Type  := No_File;
1051       --  Suffix of shared libraries, after the library name in the shared
1052       --  library name. Specified in the configuration. When not specified,
1053       --  default to ".so".
1054
1055       Shared_Lib_Min_Options        : Name_List_Index := No_Name_List;
1056       --  The minimum options to use when building a shared library
1057
1058       Lib_Version_Options           : Name_List_Index := No_Name_List;
1059       --  The options to use to specify a library version
1060
1061       Symbolic_Link_Supported       : Boolean         := False;
1062       --  True if the platform supports symbolic link files
1063
1064       Lib_Maj_Min_Id_Supported      : Boolean         := False;
1065       --  True if platform supports library major and minor options, such as
1066       --  libname.so -> libname.so.2 -> libname.so.2.4
1067
1068       Auto_Init_Supported           : Boolean         := False;
1069       --  True if automatic initialisation is supported for shared stand-alone
1070       --  libraries.
1071    end record;
1072
1073    Default_Project_Config : constant Project_Configuration :=
1074                               (Target                        => No_Name,
1075                                Run_Path_Option               => No_Name_List,
1076                                Separate_Run_Path_Options     => False,
1077                                Executable_Suffix             => No_Name,
1078                                Linker                        => No_Path,
1079                                Map_File_Option               => No_Name,
1080                                Minimum_Linker_Options        => No_Name_List,
1081                                Linker_Executable_Option      => No_Name_List,
1082                                Linker_Lib_Dir_Option         => No_Name,
1083                                Linker_Lib_Name_Option        => No_Name,
1084                                Library_Builder               => No_Path,
1085                                Max_Command_Line_Length       => 0,
1086                                Resp_File_Format              => None,
1087                                Resp_File_Options             => No_Name_List,
1088                                Lib_Support                   => None,
1089                                Archive_Builder               => No_Name_List,
1090                                Archive_Builder_Append_Option => No_Name_List,
1091                                Archive_Indexer               => No_Name_List,
1092                                Archive_Suffix                => No_File,
1093                                Lib_Partial_Linker            => No_Name_List,
1094                                Shared_Lib_Driver             => No_File,
1095                                Shared_Lib_Prefix             => No_File,
1096                                Shared_Lib_Suffix             => No_File,
1097                                Shared_Lib_Min_Options        => No_Name_List,
1098                                Lib_Version_Options           => No_Name_List,
1099                                Symbolic_Link_Supported       => False,
1100                                Lib_Maj_Min_Id_Supported      => False,
1101                                Auto_Init_Supported           => False);
1102
1103    --  The following record describes a project file representation
1104
1105    --  Note that it is not specified if the path names of directories (source,
1106    --  object, library or exec directories) end with or without a directory
1107    --  separator.
1108
1109    type Project_Data is record
1110
1111       -------------
1112       -- General --
1113       -------------
1114
1115       Name : Name_Id := No_Name;
1116       --  The name of the project
1117
1118       Display_Name : Name_Id := No_Name;
1119       --  The name of the project with the spelling of its declaration
1120
1121       Qualifier : Project_Qualifier := Unspecified;
1122       --  The eventual qualifier for this project
1123
1124       Externally_Built : Boolean := False;
1125       --  True if the project is externally built. In such case, the Project
1126       --  Manager will not modify anything in this project.
1127
1128       Config : Project_Configuration;
1129
1130       Path : Path_Information := No_Path_Information;
1131       --  The path name of the project file. This include base name of the
1132       --  project file.
1133
1134       Virtual : Boolean := False;
1135       --  True for virtual extending projects
1136
1137       Location : Source_Ptr := No_Location;
1138       --  The location in the project file source of the reserved word project
1139
1140       Naming : Naming_Data := Standard_Naming_Data;
1141       --  The naming scheme of this project file
1142
1143       ---------------
1144       -- Languages --
1145       ---------------
1146
1147       Languages : Language_Ptr := No_Language_Index;
1148       --  First index of the language data in the project.
1149       --  This is an index into the project_tree_data.languages_data.
1150       --  Traversing the list gives access to all the languages supported by
1151       --  the project.
1152
1153       --------------
1154       -- Projects --
1155       --------------
1156
1157       Mains : String_List_Id := Nil_String;
1158       --  List of mains specified by attribute Main
1159
1160       Extends : Project_Id := No_Project;
1161       --  The reference of the project file, if any, that this project file
1162       --  extends.
1163
1164       Extended_By : Project_Id := No_Project;
1165       --  The reference of the project file, if any, that extends this project
1166       --  file.
1167
1168       Decl : Declarations := No_Declarations;
1169       --  The declarations (variables, attributes and packages) of this project
1170       --  file.
1171
1172       Imported_Projects : Project_List;
1173       --  The list of all directly imported projects, if any
1174
1175       All_Imported_Projects : Project_List;
1176       --  The list of all projects imported directly or indirectly, if any
1177
1178       -----------------
1179       -- Directories --
1180       -----------------
1181
1182       Directory : Path_Information := No_Path_Information;
1183       --  Path name of the directory where the project file resides
1184
1185       Object_Directory : Path_Information := No_Path_Information;
1186       --  The path name of the object directory of this project file
1187
1188       Exec_Directory : Path_Information := No_Path_Information;
1189       --  The path name of the exec directory of this project file. Default is
1190       --  equal to Object_Directory.
1191
1192       -------------
1193       -- Library --
1194       -------------
1195
1196       Library : Boolean := False;
1197       --  True if this is a library project
1198
1199       Library_Name : Name_Id := No_Name;
1200       --  If a library project, name of the library
1201
1202       Library_Kind : Lib_Kind := Static;
1203       --  If a library project, kind of library
1204
1205       Library_Dir : Path_Information := No_Path_Information;
1206       --  If a library project, path name of the directory where the library
1207       --  resides.
1208
1209       Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1210       --  The timestamp of a library file in a library project
1211
1212       Library_Src_Dir : Path_Information := No_Path_Information;
1213       --  If a Stand-Alone Library project, path name of the directory where
1214       --  the sources of the interfaces of the library are copied. By default,
1215       --  if attribute Library_Src_Dir is not specified, sources of the
1216       --  interfaces are not copied anywhere.
1217
1218       Library_ALI_Dir : Path_Information := No_Path_Information;
1219       --  In a library project, path name of the directory where the ALI files
1220       --  are copied. If attribute Library_ALI_Dir is not specified, ALI files
1221       --  are copied in the Library_Dir.
1222
1223       Lib_Internal_Name : Name_Id := No_Name;
1224       --  If a library project, internal name store inside the library
1225
1226       Standalone_Library : Boolean := False;
1227       --  Indicate that this is a Standalone Library Project File
1228
1229       Lib_Interface_ALIs : String_List_Id := Nil_String;
1230       --  For Standalone Library Project Files, indicate the list of Interface
1231       --  ALI files.
1232
1233       Lib_Auto_Init : Boolean := False;
1234       --  For non static Stand-Alone Library Project Files, indicate if
1235       --  the library initialisation should be automatic.
1236
1237       Symbol_Data : Symbol_Record := No_Symbols;
1238       --  Symbol file name, reference symbol file name, symbol policy
1239
1240       Need_To_Build_Lib : Boolean := False;
1241       --  Indicates that the library of a Library Project needs to be built or
1242       --  rebuilt.
1243
1244       -------------
1245       -- Sources --
1246       -------------
1247       --  The sources for all languages including Ada are accessible through
1248       --  the Source_Iterator type
1249
1250       Interfaces_Defined      : Boolean := False;
1251       --  True if attribute Interfaces is declared for the project or any
1252       --  project it extends.
1253
1254       Include_Path : String_Access := null;
1255       --  The search source path for the project. Used as the value for an
1256       --  environment variable, specified by attribute Include_Path
1257       --  (<language>). The names of the environment variables are in component
1258       --  Include_Path of the records Language_Config.
1259
1260       Include_Path_File : Path_Name_Type := No_Path;
1261       --  The path name of the of the source search directory file
1262
1263       Include_Data_Set : Boolean := False;
1264       --  Set True when Imported_Directories_Switches or Include_Path are set
1265
1266       Source_Dirs : String_List_Id := Nil_String;
1267       --  The list of all the source directories
1268
1269       Known_Order_Of_Source_Dirs : Boolean := True;
1270       --  False, if there is any /** in the Source_Dirs, because in this case
1271       --  the ordering of the source subdirs depend on the OS. If True,
1272       --  duplicate file names in the same project file are allowed.
1273
1274       Ada_Include_Path : String_Access := null;
1275       --  The cached value of source search path for this project file. Set by
1276       --  the first call to Prj.Env.Ada_Include_Path for the project. Do not
1277       --  use this field directly outside of the project manager, use
1278       --  Prj.Env.Ada_Include_Path instead.
1279
1280       -------------------
1281       -- Miscellaneous --
1282       -------------------
1283
1284       Ada_Objects_Path : String_Access := null;
1285       --  The cached value of ADA_OBJECTS_PATH for this project file. Do not
1286       --  use this field directly outside of the compiler, use
1287       --  Prj.Env.Ada_Objects_Path instead.
1288
1289       Libgnarl_Needed : Yes_No_Unknown := Unknown;
1290       --  Set to True when libgnarl is needed to link
1291
1292       Objects_Path : String_Access := null;
1293       --  The cached value of the object dir path, used during the binding
1294       --  phase of gprbuild.
1295
1296       Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1297       --  The cached value of the object path temp file (including library
1298       --  dirs) for this project file.
1299
1300       Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1301       --  The cached value of the object path temp file (excluding library
1302       --  dirs) for this project file.
1303
1304       Config_File_Name : Path_Name_Type := No_Path;
1305       --  The path name of the configuration pragmas file, if any
1306
1307       Config_File_Temp : Boolean := False;
1308       --  An indication that the configuration pragmas file is a temporary file
1309       --  that must be deleted at the end.
1310
1311       Config_Checked : Boolean := False;
1312       --  A flag to avoid checking repetitively the configuration pragmas file
1313
1314       Depth : Natural := 0;
1315       --  The maximum depth of a project in the project graph. Depth of main
1316       --  project is 0.
1317
1318       Unkept_Comments : Boolean := False;
1319       --  True if there are comments in the project sources that cannot be kept
1320       --  in the project tree.
1321
1322    end record;
1323
1324    function Empty_Project (Tree : Project_Tree_Ref) return Project_Data;
1325    --  Return the representation of an empty project in project Tree tree.
1326    --  The project tree Tree must have been Initialized and/or Reset.
1327
1328    function Is_Extending
1329      (Extending : Project_Id;
1330       Extended  : Project_Id) return Boolean;
1331    --  Return True if Extending is extending the Extended project
1332
1333    function Is_A_Language
1334      (Project       : Project_Id;
1335       Language_Name : Name_Id) return Boolean;
1336    --  Return True when Language_Name (which must be lower case) is one of the
1337    --  languages used for the project.
1338
1339    function Has_Ada_Sources (Data : Project_Id) return Boolean;
1340    --  Return True if the project has Ada sources
1341
1342    function Has_Foreign_Sources (Data : Project_Id) return Boolean;
1343    --  Return True if the project has foreign sources
1344
1345    Project_Error : exception;
1346    --  Raised by some subprograms in Prj.Attr
1347
1348    subtype Spec_Or_Body is Source_Kind range Spec .. Impl;
1349    type File_Names_Data is array (Spec_Or_Body) of Source_Id;
1350    type Unit_Index is new Nat;
1351    No_Unit_Index : constant Unit_Index := 0;
1352    type Unit_Data is record
1353       Name       : Name_Id    := No_Name;
1354       File_Names : File_Names_Data;
1355    end record;
1356    --  Name and File and Path names of a unit, with a reference to its
1357    --  GNAT Project File(s).
1358
1359    package Unit_Table is new GNAT.Dynamic_Tables
1360      (Table_Component_Type => Unit_Data,
1361       Table_Index_Type     => Unit_Index,
1362       Table_Low_Bound      => 1,
1363       Table_Initial        => 100,
1364       Table_Increment      => 100);
1365    --  Table of all units in a project tree
1366
1367    package Units_Htable is new Simple_HTable
1368      (Header_Num => Header_Num,
1369       Element    => Unit_Index,
1370       No_Element => No_Unit_Index,
1371       Key        => Name_Id,
1372       Hash       => Hash,
1373       Equal      => "=");
1374    --  Mapping of unit names to indexes in the Units table
1375
1376    package Files_Htable is new Simple_HTable
1377      (Header_Num => Header_Num,
1378       Element    => Project_Id,
1379       No_Element => No_Project,
1380       Key        => File_Name_Type,
1381       Hash       => Hash,
1382       Equal      => "=");
1383    --  Mapping of file names to indexes in the Units table
1384
1385    ---------------------
1386    -- Source_Iterator --
1387    ---------------------
1388
1389    type Source_Iterator is private;
1390
1391    function For_Each_Source
1392      (In_Tree  : Project_Tree_Ref;
1393       Project  : Project_Id := No_Project;
1394       Language : Name_Id := No_Name) return Source_Iterator;
1395    --  Returns an iterator for all the sources of a project tree, or a specific
1396    --  project, or a specific language.
1397
1398    function Element (Iter : Source_Iterator) return Source_Id;
1399    --  Return the current source (or No_Source if there are no more sources)
1400
1401    procedure Next (Iter : in out Source_Iterator);
1402    --  Move on to the next source
1403
1404    -----------------------
1405    -- Project_Tree_Data --
1406    -----------------------
1407
1408    type Private_Project_Tree_Data is private;
1409    --  Data for a project tree that is used only by the Project Manager
1410
1411    type Project_Tree_Data is
1412       record
1413          Name_Lists        : Name_List_Table.Instance;
1414          String_Elements   : String_Element_Table.Instance;
1415          Variable_Elements : Variable_Element_Table.Instance;
1416          Array_Elements    : Array_Element_Table.Instance;
1417          Arrays            : Array_Table.Instance;
1418          Packages          : Package_Table.Instance;
1419          Projects          : Project_List;
1420          Units             : Unit_Table.Instance;
1421          Units_HT          : Units_Htable.Instance;
1422          Source_Paths_HT   : Source_Paths_Htable.Instance;
1423          Unit_Sources_HT   : Unit_Sources_Htable.Instance;
1424
1425          --  Private part
1426
1427          Private_Part : Private_Project_Tree_Data;
1428       end record;
1429    --  Data for a project tree
1430
1431    type Put_Line_Access is access procedure
1432      (Line    : String;
1433       Project : Project_Id;
1434       In_Tree : Project_Tree_Ref);
1435    --  Use to customize error reporting in Prj.Proc and Prj.Nmsc
1436
1437    procedure Expect (The_Token : Token_Type; Token_Image : String);
1438    --  Check that the current token is The_Token. If it is not, then output
1439    --  an error message.
1440
1441    procedure Initialize (Tree : Project_Tree_Ref);
1442    --  This procedure must be called before using any services from the Prj
1443    --  hierarchy. Namet.Initialize must be called before Prj.Initialize.
1444
1445    procedure Reset (Tree : Project_Tree_Ref);
1446    --  This procedure resets all the tables that are used when processing a
1447    --  project file tree. Initialize must be called before the call to Reset.
1448
1449    procedure Register_Default_Naming_Scheme
1450      (Language            : Name_Id;
1451       Default_Spec_Suffix : File_Name_Type;
1452       Default_Body_Suffix : File_Name_Type;
1453       In_Tree             : Project_Tree_Ref);
1454    --  Register the default suffixes for a given language. These extensions
1455    --  will be ignored if the user has specified a new naming scheme in a
1456    --  project file.
1457    --
1458    --  Otherwise, this information will be automatically added to Naming_Data
1459    --  when a project is processed, in the lists Spec_Suffix and Body_Suffix.
1460
1461    package Project_Boolean_Htable is new Simple_HTable
1462      (Header_Num => Header_Num,
1463       Element    => Boolean,
1464       No_Element => False,
1465       Key        => Project_Id,
1466       Hash       => Hash,
1467       Equal      => "=");
1468    --  A table that associates a project to a boolean. This is used to detect
1469    --  whether a project was already processed for instance.
1470
1471    generic
1472       type State is limited private;
1473       with procedure Action
1474         (Project    : Project_Id;
1475          With_State : in out State);
1476    procedure For_Every_Project_Imported
1477      (By             : Project_Id;
1478       With_State     : in out State;
1479       Imported_First : Boolean := False);
1480    --  Call Action for each project imported directly or indirectly by project
1481    --  By, as well as extended projects.
1482    --  The order of processing depends on Imported_First:
1483    --  If False, Action is called according to the order of importation: if A
1484    --  imports B, directly or indirectly, Action will be called for A before
1485    --  it is called for B. If two projects import each other directly or
1486    --  indirectly (using at least one "limited with"), it is not specified
1487    --  for which of these two projects Action will be called first.
1488    --  The order is reversed if Imported_First is True.
1489    --  With_State may be used by Action to choose a behavior or to report some
1490    --  global result.
1491
1492    function Extend_Name
1493      (File        : File_Name_Type;
1494       With_Suffix : String) return File_Name_Type;
1495    --  Replace the extension of File with With_Suffix
1496
1497    function Object_Name
1498      (Source_File_Name   : File_Name_Type;
1499       Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1500    --  Returns the object file name corresponding to a source file name
1501
1502    function Dependency_Name
1503      (Source_File_Name : File_Name_Type;
1504       Dependency       : Dependency_File_Kind) return File_Name_Type;
1505    --  Returns the dependency file name corresponding to a source file name
1506
1507    function Switches_Name
1508      (Source_File_Name : File_Name_Type) return File_Name_Type;
1509    --  Returns the switches file name corresponding to a source file name
1510
1511    ----------------
1512    -- Temp Files --
1513    ----------------
1514
1515    procedure Record_Temp_File (Path : Path_Name_Type);
1516    --  Record the path of a newly created temporary file, so that it can be
1517    --  deleted later.
1518
1519    procedure Delete_All_Temp_Files;
1520    --  Delete all recorded temporary files
1521
1522 private
1523
1524    All_Packages : constant String_List_Access := null;
1525
1526    No_Project_Tree : constant Project_Tree_Ref := null;
1527
1528    Ignored : constant Variable_Kind := Single;
1529
1530    Nil_Variable_Value : constant Variable_Value :=
1531                           (Project  => No_Project,
1532                            Kind     => Undefined,
1533                            Location => No_Location,
1534                            Default  => False);
1535
1536    Virtual_Prefix : constant String := "v$";
1537    --  The prefix for virtual extending projects. Because of the '$', which is
1538    --  normally forbidden for project names, there cannot be any name clash.
1539
1540    Empty_Name : Name_Id;
1541    --  Name_Id for an empty name (no characters). Initialized in procedure
1542    --  Initialize.
1543
1544    Empty_File_Name : File_Name_Type;
1545    --  Empty File_Name_Type (no characters). Initialized in procedure
1546    --  Initialize.
1547
1548    type Source_Iterator is record
1549       In_Tree : Project_Tree_Ref;
1550
1551       Project      : Project_List;
1552       All_Projects : Boolean;
1553       --  Current project and whether we should move on to the next
1554
1555       Language : Language_Ptr;
1556       --  Current language processed
1557
1558       Language_Name : Name_Id;
1559       --  Only sources of this language will be returned (or all if No_Name)
1560
1561       Current : Source_Id;
1562    end record;
1563
1564    procedure Add_To_Buffer
1565      (S    : String;
1566       To   : in out String_Access;
1567       Last : in out Natural);
1568    --  Append a String to the Buffer
1569
1570    type Naming_Id is new Nat;
1571
1572    package Naming_Table is new GNAT.Dynamic_Tables
1573      (Table_Component_Type => Naming_Data,
1574       Table_Index_Type     => Naming_Id,
1575       Table_Low_Bound      => 1,
1576       Table_Initial        => 5,
1577       Table_Increment      => 100);
1578    --  Table storing the naming data for gnatmake/gprmake
1579
1580    package Path_File_Table is new GNAT.Dynamic_Tables
1581      (Table_Component_Type => Path_Name_Type,
1582       Table_Index_Type     => Natural,
1583       Table_Low_Bound      => 1,
1584       Table_Initial        => 50,
1585       Table_Increment      => 100);
1586    --  Table storing all the temp path file names.
1587    --  Used by Delete_All_Path_Files.
1588
1589    package Source_Path_Table is new GNAT.Dynamic_Tables
1590      (Table_Component_Type => Name_Id,
1591       Table_Index_Type     => Natural,
1592       Table_Low_Bound      => 1,
1593       Table_Initial        => 50,
1594       Table_Increment      => 100);
1595    --  A table to store the source dirs before creating the source path file
1596
1597    package Object_Path_Table is new GNAT.Dynamic_Tables
1598      (Table_Component_Type => Path_Name_Type,
1599       Table_Index_Type     => Natural,
1600       Table_Low_Bound      => 1,
1601       Table_Initial        => 50,
1602       Table_Increment      => 100);
1603    --  A table to store the object dirs, before creating the object path file
1604
1605    type Private_Project_Tree_Data is record
1606       Namings        : Naming_Table.Instance;
1607       Path_Files     : Path_File_Table.Instance;
1608       Source_Paths   : Source_Path_Table.Instance;
1609       Object_Paths   : Object_Path_Table.Instance;
1610       Default_Naming : Naming_Data;
1611
1612       Current_Source_Path_File : Path_Name_Type := No_Path;
1613       --  Current value of project source path file env var. Used to avoid
1614       --  setting the env var to the same value.
1615
1616       Current_Object_Path_File : Path_Name_Type := No_Path;
1617       --  Current value of project object path file env var. Used to avoid
1618       --  setting the env var to the same value.
1619
1620       Ada_Path_Buffer : String_Access := new String (1 .. 1024);
1621       --  A buffer where values for ADA_INCLUDE_PATH and ADA_OBJECTS_PATH are
1622       --  stored.
1623
1624       Ada_Path_Length : Natural := 0;
1625       --  Index of the last valid character in Ada_Path_Buffer
1626
1627       Ada_Prj_Include_File_Set : Boolean := False;
1628       Ada_Prj_Objects_File_Set : Boolean := False;
1629       --  These flags are set to True when the corresponding environment
1630       --  variables are set and are used to give these environment variables an
1631       --  empty string value at the end of the program. This has no practical
1632       --  effect on most platforms, except on VMS where the logical names are
1633       --  deassigned, thus avoiding the pollution of the environment of the
1634       --  caller.
1635
1636       Fill_Mapping_File : Boolean := True;
1637
1638    end record;
1639    --  Type to represent the part of a project tree which is private to the
1640    --  Project Manager.
1641
1642 end Prj;