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