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