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       Initialized : Boolean := False;
 667       --  Set to True when Source_Data is completely initialized
 668
 669       Project : Project_Id := No_Project;
 670       --  Project of the source
 671
 672       Location : Source_Ptr := No_Location;
 673       --  Location in the project file of the declaration of the source in
 674       --  package Naming.
 675
 676       Source_Dir_Rank : Natural := 0;
 677       --  The rank of the source directory in list declared with attribute
 678       --  Source_Dirs. Two source files with the same name cannot appears in
 679       --  different directory with the same rank. That can happen when the
 680       --  recursive notation <dir>/** is used in attribute Source_Dirs.
 681
 682       Language : Language_Ptr := No_Language_Index;
 683       --  Index of the language. This is an index into
 684       --  Project_Tree.Languages_Data.
 685
 686       In_Interfaces : Boolean := True;
 687       --  False when the source is not included in interfaces, when attribute
 688       --  Interfaces is declared.
 689
 690       Declared_In_Interfaces : Boolean := False;
 691       --  True when source is declared in attribute Interfaces
 692
 693       Alternate_Languages : Language_List := null;
 694       --  List of languages a header file may also be, in addition of language
 695       --  Language_Name.
 696
 697       Kind : Source_Kind := Spec;
 698       --  Kind of the source: spec, body or subunit
 699
 700       Unit : Unit_Index := No_Unit_Index;
 701       --  Name of the unit, if language is unit based. This is only set for
 702       --  those files that are part of the compilation set (for instance a
 703       --  file in an extended project that is overridden will not have this
 704       --  field set).
 705
 706       Index : Int := 0;
 707       --  Index of the source in a multi unit source file (the same Source_Data
 708       --  is duplicated several times when there are several units in the same
 709       --  file). Index is 0 if there is either no unit or a single one, and
 710       --  starts at 1 when there are multiple units
 711
 712       Compilable : Yes_No_Unknown := Unknown;
 713       --  Updated at the first call to Is_Compilable. Yes if source file is
 714       --  compilable.
 715
 716       In_The_Queue : Boolean := False;
 717       --  True if the source has been put in the queue
 718
 719       Locally_Removed : Boolean := False;
 720       --  True if the source has been "excluded"
 721
 722       Replaced_By : Source_Id := No_Source;
 723       --  Missing comment ???
 724
 725       File : File_Name_Type := No_File;
 726       --  Canonical file name of the source
 727
 728       Display_File : File_Name_Type := No_File;
 729       --  File name of the source, for display purposes
 730
 731       Path : Path_Information := No_Path_Information;
 732       --  Path name of the source
 733
 734       Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
 735       --  Time stamp of the source file
 736
 737       Object_Project : Project_Id := No_Project;
 738       --  Project where the object file is. This might be different from
 739       --  Project when using extending project files.
 740
 741       Object : File_Name_Type := No_File;
 742       --  File name of the object file
 743
 744       Current_Object_Path : Path_Name_Type := No_Path;
 745       --  Object path of an existing object file
 746
 747       Object_Path : Path_Name_Type := No_Path;
 748       --  Object path of the real object file
 749
 750       Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
 751       --  Object file time stamp
 752
 753       Dep_Name : File_Name_Type := No_File;
 754       --  Dependency file simple name
 755
 756       Current_Dep_Path : Path_Name_Type := No_Path;
 757       --  Path name of an existing dependency file
 758
 759       Dep_Path : Path_Name_Type := No_Path;
 760       --  Path name of the real dependency file
 761
 762       Dep_TS : aliased Osint.File_Attributes := Osint.Unknown_Attributes;
 763       --  Dependency file time stamp
 764
 765       Switches : File_Name_Type := No_File;
 766       --  File name of the switches file. For all languages, this is a file
 767       --  that ends with the .cswi extension.
 768
 769       Switches_Path : Path_Name_Type := No_Path;
 770       --  Path name of the switches file
 771
 772       Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
 773       --  Switches file time stamp
 774
 775       Naming_Exception : Boolean := False;
 776       --  True if the source has an exceptional name
 777
 778       Duplicate_Unit : Boolean := False;
 779       --  True when a duplicate unit has been reported for this source
 780
 781       Next_In_Lang : Source_Id := No_Source;
 782       --  Link to another source of the same language in the same project
 783
 784       Next_With_File_Name : Source_Id := No_Source;
 785       --  Link to another source with the same base file name
 786
 787    end record;
 788
 789    No_Source_Data : constant Source_Data :=
 790                       (Initialized            => False,
 791                        Project                => No_Project,
 792                        Location               => No_Location,
 793                        Source_Dir_Rank        => 0,
 794                        Language               => No_Language_Index,
 795                        In_Interfaces          => True,
 796                        Declared_In_Interfaces => False,
 797                        Alternate_Languages    => null,
 798                        Kind                   => Spec,
 799                        Unit                   => No_Unit_Index,
 800                        Index                  => 0,
 801                        Locally_Removed        => False,
 802                        Compilable             => Unknown,
 803                        In_The_Queue           => False,
 804                        Replaced_By            => No_Source,
 805                        File                   => No_File,
 806                        Display_File           => No_File,
 807                        Path                   => No_Path_Information,
 808                        Source_TS              => Empty_Time_Stamp,
 809                        Object_Project         => No_Project,
 810                        Object                 => No_File,
 811                        Current_Object_Path    => No_Path,
 812                        Object_Path            => No_Path,
 813                        Object_TS              => Empty_Time_Stamp,
 814                        Dep_Name               => No_File,
 815                        Current_Dep_Path       => No_Path,
 816                        Dep_Path               => No_Path,
 817                        Dep_TS                 => Osint.Unknown_Attributes,
 818                        Switches               => No_File,
 819                        Switches_Path          => No_Path,
 820                        Switches_TS            => Empty_Time_Stamp,
 821                        Naming_Exception       => False,
 822                        Duplicate_Unit         => False,
 823                        Next_In_Lang           => No_Source,
 824                        Next_With_File_Name    => No_Source);
 825
 826    package Source_Files_Htable is new Simple_HTable
 827      (Header_Num => Header_Num,
 828       Element    => Source_Id,
 829       No_Element => No_Source,
 830       Key        => File_Name_Type,
 831       Hash       => Hash,
 832       Equal      => "=");
 833    --  Mapping of source file names to source ids
 834
 835    package Source_Paths_Htable is new Simple_HTable
 836      (Header_Num => Header_Num,
 837       Element    => Source_Id,
 838       No_Element => No_Source,
 839       Key        => Path_Name_Type,
 840       Hash       => Hash,
 841       Equal      => "=");
 842    --  Mapping of source paths to source ids
 843
 844    package Unit_Sources_Htable is new Simple_HTable
 845      (Header_Num => Header_Num,
 846       Element    => Source_Id,
 847       No_Element => No_Source,
 848       Key        => Name_Id,
 849       Hash       => Hash,
 850       Equal      => "=");
 851
 852    type Verbosity is (Default, Medium, High);
 853    pragma Ordered (Verbosity);
 854    --  Verbosity when parsing GNAT Project Files
 855    --    Default is default (very quiet, if no errors).
 856    --    Medium is more verbose.
 857    --    High is extremely verbose.
 858
 859    Current_Verbosity : Verbosity := Default;
 860    --  The current value of the verbosity the project files are parsed with
 861
 862    type Lib_Kind is (Static, Dynamic, Relocatable);
 863
 864    type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
 865    --  Type to specify the symbol policy, when symbol control is supported.
 866    --  See full explanation about this type in package Symbols.
 867    --    Autonomous: Create a symbol file without considering any reference
 868    --    Compliant:  Try to be as compatible as possible with an existing ref
 869    --    Controlled: Fail if symbols are not the same as those in the reference
 870    --    Restricted: Restrict the symbols to those in the symbol file
 871    --    Direct:     The symbol file is used as is
 872
 873    type Symbol_Record is record
 874       Symbol_File   : Path_Name_Type := No_Path;
 875       Reference     : Path_Name_Type := No_Path;
 876       Symbol_Policy : Policy  := Autonomous;
 877    end record;
 878    --  Type to keep the symbol data to be used when building a shared library
 879
 880    No_Symbols : constant Symbol_Record :=
 881      (Symbol_File   => No_Path,
 882       Reference     => No_Path,
 883       Symbol_Policy => Autonomous);
 884    --  The default value of the symbol data
 885
 886    function Image (The_Casing : Casing_Type) return String;
 887    --  Similar to 'Image (but avoid use of this attribute in compiler)
 888
 889    function Value (Image : String) return Casing_Type;
 890    --  Similar to 'Value (but avoid use of this attribute in compiler)
 891    --  Raises Constraint_Error if not a Casing_Type image.
 892
 893    --  The following record contains data for a naming scheme
 894
 895    function Get_Object_Directory
 896      (Project             : Project_Id;
 897       Including_Libraries : Boolean;
 898       Only_If_Ada         : Boolean := False) return Path_Name_Type;
 899    --  Return the object directory to use for the project. This depends on
 900    --  whether we have a library project or a standard project. This function
 901    --  might return No_Name when no directory applies.
 902    --  If we have a a library project file and Including_Libraries is True then
 903    --  the library dir is returned instead of the object dir.
 904    --  If Only_If_Ada is True, then No_Name will be returned when the project
 905    --  doesn't Ada sources.
 906
 907    procedure Compute_All_Imported_Projects (Tree : Project_Tree_Ref);
 908    --  For all projects in the tree, compute the list of the projects imported
 909    --  directly or indirectly by project Project. The result is stored in
 910    --  Project.All_Imported_Projects for each project
 911
 912    function Ultimate_Extending_Project_Of
 913      (Proj : Project_Id) return Project_Id;
 914    --  Returns the ultimate extending project of project Proj. If project Proj
 915    --  is not extended, returns Proj.
 916
 917    type Project_List_Element;
 918    type Project_List is access all Project_List_Element;
 919    type Project_List_Element is record
 920       Project : Project_Id   := No_Project;
 921       Next    : Project_List := null;
 922    end record;
 923    --  A list of projects
 924
 925    procedure Free_List
 926      (List         : in out Project_List;
 927       Free_Project : Boolean);
 928    --  Free the list of projects, if Free_Project, each project is also freed
 929
 930    type Response_File_Format is
 931      (None,
 932       GNU,
 933       Object_List,
 934       Option_List,
 935       GCC,
 936       GCC_GNU,
 937       GCC_Object_List,
 938       GCC_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       Run_Path_Origin : Name_Id := No_Name;
 950       --  Specify the string (such as "$ORIGIN") to indicate paths relative to
 951       --  the directory of the executable in the run path option.
 952
 953       Library_Install_Name_Option : Name_Id := No_Name;
 954       --  When this is not an empty list, this option, followed by the single
 955       --  name of the shared library file is used when linking a shared
 956       --  library.
 957
 958       Separate_Run_Path_Options : Boolean := False;
 959       --  True if each directory needs to be specified in a separate run path
 960       --  option.
 961
 962       Executable_Suffix : Name_Id := No_Name;
 963       --  The suffix of executables, when specified in the configuration or in
 964       --  package Builder of the main project. When this is not specified, the
 965       --  executable suffix is the default for the platform.
 966
 967       --  Linking
 968
 969       Linker : Path_Name_Type := No_Path;
 970       --  Path name of the linker driver. Specified in the configuration or in
 971       --  the package Builder of the main project.
 972
 973       Map_File_Option : Name_Id := No_Name;
 974       --  Option to use when invoking the linker to build a map file
 975
 976       Trailing_Linker_Required_Switches : Name_List_Index := No_Name_List;
 977       --  The minimum options for the linker driver. Specified in the
 978       --  configuration.
 979
 980       Linker_Executable_Option : Name_List_Index := No_Name_List;
 981       --  The option(s) to indicate the name of the executable in the linker
 982       --  command. Specified in the configuration. When not specified, default
 983       --  to -o <executable name>.
 984
 985       Linker_Lib_Dir_Option : Name_Id := No_Name;
 986       --  The option to specify where to find a library for linking. Specified
 987       --  in the configuration. When not specified, defaults to "-L".
 988
 989       Linker_Lib_Name_Option : Name_Id := No_Name;
 990       --  The option to specify the name of a library for linking. Specified in
 991       --  the configuration. When not specified, defaults to "-l".
 992
 993       Max_Command_Line_Length : Natural := 0;
 994       --  When positive and when Resp_File_Format (see below) is not None,
 995       --  if the command line for the invocation of the linker would be greater
 996       --  than this value, a response file is used to invoke the linker.
 997
 998       Resp_File_Format : Response_File_Format := None;
 999       --  The format of a response file, when linking with a response file is
1000       --  supported.
1001
1002       Resp_File_Options : Name_List_Index := No_Name_List;
1003       --  The switches, if any, that precede the path name of the response
1004       --  file in the invocation of the linker.
1005
1006       --  Libraries
1007
1008       Library_Builder : Path_Name_Type  := No_Path;
1009       --  The executable to build library (specified in the configuration)
1010
1011       Lib_Support : Library_Support := None;
1012       --  The level of library support. Specified in the configuration. Support
1013       --  is none, static libraries only or both static and shared libraries.
1014
1015       Archive_Builder : Name_List_Index := No_Name_List;
1016       --  The name of the executable to build archives, with the minimum
1017       --  switches. Specified in the configuration.
1018
1019       Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
1020       --  The options to append object files to an archive
1021
1022       Archive_Indexer : Name_List_Index := No_Name_List;
1023       --  The name of the executable to index archives, with the minimum
1024       --  switches. Specified in the configuration.
1025
1026       Archive_Suffix : File_Name_Type := No_File;
1027       --  The suffix of archives. Specified in the configuration. When not
1028       --  specified, defaults to ".a".
1029
1030       Lib_Partial_Linker : Name_List_Index := No_Name_List;
1031
1032       --  Shared libraries
1033
1034       Shared_Lib_Driver : File_Name_Type := No_File;
1035       --  The driver to link shared libraries. Set with attribute Library_GCC.
1036       --  Default to gcc.
1037
1038       Shared_Lib_Prefix : File_Name_Type := No_File;
1039       --  Part of a shared library file name that precedes the name of the
1040       --  library. Specified in the configuration. When not specified, defaults
1041       --  to "lib".
1042
1043       Shared_Lib_Suffix : File_Name_Type := No_File;
1044       --  Suffix of shared libraries, after the library name in the shared
1045       --  library name. Specified in the configuration. When not specified,
1046       --  default to ".so".
1047
1048       Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1049       --  The minimum options to use when building a shared library
1050
1051       Lib_Version_Options : Name_List_Index := No_Name_List;
1052       --  The options to use to specify a library version
1053
1054       Symbolic_Link_Supported : Boolean := False;
1055       --  True if the platform supports symbolic link files
1056
1057       Lib_Maj_Min_Id_Supported : Boolean := False;
1058       --  True if platform supports library major and minor options, such as
1059       --  libname.so -> libname.so.2 -> libname.so.2.4
1060
1061       Auto_Init_Supported : Boolean := False;
1062       --  True if automatic initialisation is supported for shared stand-alone
1063       --  libraries.
1064    end record;
1065
1066    Default_Project_Config : constant Project_Configuration :=
1067                               (Target                        => No_Name,
1068                                Run_Path_Option               => No_Name_List,
1069                                Run_Path_Origin               => No_Name,
1070                                Library_Install_Name_Option   => No_Name,
1071                                Separate_Run_Path_Options     => False,
1072                                Executable_Suffix             => No_Name,
1073                                Linker                        => No_Path,
1074                                Map_File_Option               => No_Name,
1075                                Trailing_Linker_Required_Switches =>
1076                                  No_Name_List,
1077                                Linker_Executable_Option      => No_Name_List,
1078                                Linker_Lib_Dir_Option         => No_Name,
1079                                Linker_Lib_Name_Option        => No_Name,
1080                                Library_Builder               => No_Path,
1081                                Max_Command_Line_Length       => 0,
1082                                Resp_File_Format              => None,
1083                                Resp_File_Options             => No_Name_List,
1084                                Lib_Support                   => None,
1085                                Archive_Builder               => No_Name_List,
1086                                Archive_Builder_Append_Option => No_Name_List,
1087                                Archive_Indexer               => No_Name_List,
1088                                Archive_Suffix                => No_File,
1089                                Lib_Partial_Linker            => No_Name_List,
1090                                Shared_Lib_Driver             => No_File,
1091                                Shared_Lib_Prefix             => No_File,
1092                                Shared_Lib_Suffix             => No_File,
1093                                Shared_Lib_Min_Options        => No_Name_List,
1094                                Lib_Version_Options           => No_Name_List,
1095                                Symbolic_Link_Supported       => False,
1096                                Lib_Maj_Min_Id_Supported      => False,
1097                                Auto_Init_Supported           => False);
1098
1099    --  The following record describes a project file representation
1100
1101    --  Note that it is not specified if the path names of directories (source,
1102    --  object, library or exec directories) end with or without a directory
1103    --  separator.
1104
1105    type Project_Data is record
1106
1107       -------------
1108       -- General --
1109       -------------
1110
1111       Name : Name_Id := No_Name;
1112       --  The name of the project
1113
1114       Display_Name : Name_Id := No_Name;
1115       --  The name of the project with the spelling of its declaration
1116
1117       Qualifier : Project_Qualifier := Unspecified;
1118       --  The eventual qualifier for this project
1119
1120       Externally_Built : Boolean := False;
1121       --  True if the project is externally built. In such case, the Project
1122       --  Manager will not modify anything in this project.
1123
1124       Config : Project_Configuration;
1125
1126       Path : Path_Information := No_Path_Information;
1127       --  The path name of the project file. This include base name of the
1128       --  project file.
1129
1130       Virtual : Boolean := False;
1131       --  True for virtual extending projects
1132
1133       Location : Source_Ptr := No_Location;
1134       --  The location in the project file source of the reserved word project
1135
1136       ---------------
1137       -- Languages --
1138       ---------------
1139
1140       Languages : Language_Ptr := No_Language_Index;
1141       --  First index of the language data in the project.
1142       --  This is an index into the project_tree_data.languages_data.
1143       --  Traversing the list gives access to all the languages supported by
1144       --  the project.
1145
1146       --------------
1147       -- Projects --
1148       --------------
1149
1150       Mains : String_List_Id := Nil_String;
1151       --  List of mains specified by attribute Main
1152
1153       Extends : Project_Id := No_Project;
1154       --  The reference of the project file, if any, that this project file
1155       --  extends.
1156
1157       Extended_By : Project_Id := No_Project;
1158       --  The reference of the project file, if any, that extends this project
1159       --  file.
1160
1161       Decl : Declarations := No_Declarations;
1162       --  The declarations (variables, attributes and packages) of this project
1163       --  file.
1164
1165       Imported_Projects : Project_List;
1166       --  The list of all directly imported projects, if any
1167
1168       All_Imported_Projects : Project_List;
1169       --  The list of all projects imported directly or indirectly, if any.
1170       --  This does not include the project itself.
1171
1172       -----------------
1173       -- Directories --
1174       -----------------
1175
1176       Directory : Path_Information := No_Path_Information;
1177       --  Path name of the directory where the project file resides
1178
1179       Object_Directory : Path_Information := No_Path_Information;
1180       --  The path name of the object directory of this project file
1181
1182       Exec_Directory : Path_Information := No_Path_Information;
1183       --  The path name of the exec directory of this project file. Default is
1184       --  equal to Object_Directory.
1185
1186       -------------
1187       -- Library --
1188       -------------
1189
1190       Library : Boolean := False;
1191       --  True if this is a library project
1192
1193       Library_Name : Name_Id := No_Name;
1194       --  If a library project, name of the library
1195
1196       Library_Kind : Lib_Kind := Static;
1197       --  If a library project, kind of library
1198
1199       Library_Dir : Path_Information := No_Path_Information;
1200       --  If a library project, path name of the directory where the library
1201       --  resides.
1202
1203       Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1204       --  The timestamp of a library file in a library project
1205
1206       Library_Src_Dir : Path_Information := No_Path_Information;
1207       --  If a Stand-Alone Library project, path name of the directory where
1208       --  the sources of the interfaces of the library are copied. By default,
1209       --  if attribute Library_Src_Dir is not specified, sources of the
1210       --  interfaces are not copied anywhere.
1211
1212       Library_ALI_Dir : Path_Information := No_Path_Information;
1213       --  In a library project, path name of the directory where the ALI files
1214       --  are copied. If attribute Library_ALI_Dir is not specified, ALI files
1215       --  are copied in the Library_Dir.
1216
1217       Lib_Internal_Name : Name_Id := No_Name;
1218       --  If a library project, internal name store inside the library
1219
1220       Standalone_Library : Boolean := False;
1221       --  Indicate that this is a Standalone Library Project File
1222
1223       Lib_Interface_ALIs : String_List_Id := Nil_String;
1224       --  For Standalone Library Project Files, indicate the list of Interface
1225       --  ALI files.
1226
1227       Lib_Auto_Init : Boolean := False;
1228       --  For non static Stand-Alone Library Project Files, indicate if
1229       --  the library initialisation should be automatic.
1230
1231       Symbol_Data : Symbol_Record := No_Symbols;
1232       --  Symbol file name, reference symbol file name, symbol policy
1233
1234       Need_To_Build_Lib : Boolean := False;
1235       --  Indicates that the library of a Library Project needs to be built or
1236       --  rebuilt.
1237
1238       -------------
1239       -- Sources --
1240       -------------
1241       --  The sources for all languages including Ada are accessible through
1242       --  the Source_Iterator type
1243
1244       Interfaces_Defined : Boolean := False;
1245       --  True if attribute Interfaces is declared for the project or any
1246       --  project it extends.
1247
1248       Include_Path_File : Path_Name_Type := No_Path;
1249       --  The path name of the of the source search directory file.
1250       --  This is only used by gnatmake
1251
1252       Source_Dirs : String_List_Id := Nil_String;
1253       --  The list of all the source directories
1254
1255       Source_Dir_Ranks : Number_List_Index := No_Number_List;
1256
1257       Ada_Include_Path : String_Access := null;
1258       --  The cached value of source search path for this project file. Set by
1259       --  the first call to Prj.Env.Ada_Include_Path for the project. Do not
1260       --  use this field directly outside of the project manager, use
1261       --  Prj.Env.Ada_Include_Path instead.
1262
1263       Has_Multi_Unit_Sources : Boolean := False;
1264       --  Whether there is at least one source file containing multiple units
1265
1266       -------------------
1267       -- Miscellaneous --
1268       -------------------
1269
1270       Ada_Objects_Path : String_Access := null;
1271       --  The cached value of ADA_OBJECTS_PATH for this project file. Do not
1272       --  use this field directly outside of the compiler, use
1273       --  Prj.Env.Ada_Objects_Path instead.
1274
1275       Libgnarl_Needed : Yes_No_Unknown := Unknown;
1276       --  Set to True when libgnarl is needed to link
1277
1278       Objects_Path : String_Access := null;
1279       --  The cached value of the object dir path, used during the binding
1280       --  phase of gprbuild.
1281
1282       Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1283       --  The cached value of the object path temp file (including library
1284       --  dirs) for this project file.
1285
1286       Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1287       --  The cached value of the object path temp file (excluding library
1288       --  dirs) for this project file.
1289
1290       Config_File_Name : Path_Name_Type := No_Path;
1291       --  The path name of the configuration pragmas file, if any
1292
1293       Config_File_Temp : Boolean := False;
1294       --  An indication that the configuration pragmas file is a temporary file
1295       --  that must be deleted at the end.
1296
1297       Config_Checked : Boolean := False;
1298       --  A flag to avoid checking repetitively the configuration pragmas file
1299
1300       Depth : Natural := 0;
1301       --  The maximum depth of a project in the project graph. Depth of main
1302       --  project is 0.
1303
1304       Unkept_Comments : Boolean := False;
1305       --  True if there are comments in the project sources that cannot be kept
1306       --  in the project tree.
1307
1308    end record;
1309
1310    function Empty_Project return Project_Data;
1311    --  Return the representation of an empty project
1312
1313    function Is_Extending
1314      (Extending : Project_Id;
1315       Extended  : Project_Id) return Boolean;
1316    --  Return True if Extending is extending the Extended project
1317
1318    function Has_Ada_Sources (Data : Project_Id) return Boolean;
1319    --  Return True if the project has Ada sources
1320
1321    Project_Error : exception;
1322    --  Raised by some subprograms in Prj.Attr
1323
1324    package Units_Htable is new Simple_HTable
1325      (Header_Num => Header_Num,
1326       Element    => Unit_Index,
1327       No_Element => No_Unit_Index,
1328       Key        => Name_Id,
1329       Hash       => Hash,
1330       Equal      => "=");
1331    --  Mapping of unit names to indexes in the Units table
1332
1333    ---------------------
1334    -- Source_Iterator --
1335    ---------------------
1336
1337    type Source_Iterator is private;
1338
1339    function For_Each_Source
1340      (In_Tree  : Project_Tree_Ref;
1341       Project  : Project_Id := No_Project;
1342       Language : Name_Id := No_Name) return Source_Iterator;
1343    --  Returns an iterator for all the sources of a project tree, or a specific
1344    --  project, or a specific language.
1345
1346    function Element (Iter : Source_Iterator) return Source_Id;
1347    --  Return the current source (or No_Source if there are no more sources)
1348
1349    procedure Next (Iter : in out Source_Iterator);
1350    --  Move on to the next source
1351
1352    function Find_Source
1353      (In_Tree          : Project_Tree_Ref;
1354       Project          : Project_Id;
1355       In_Imported_Only : Boolean := False;
1356       In_Extended_Only : Boolean := False;
1357       Base_Name        : File_Name_Type) return Source_Id;
1358    --  Find the first source file with the given name either in the whole tree
1359    --  (if In_Imported_Only is False) or in the projects imported or extended
1360    --  by Project otherwise. In_Extended_Only implies In_Imported_Only, and
1361    --  will only look in Project and the projects it extends
1362
1363    -----------------------
1364    -- Project_Tree_Data --
1365    -----------------------
1366
1367    package Replaced_Source_HTable is new Simple_HTable
1368      (Header_Num => Header_Num,
1369       Element    => File_Name_Type,
1370       No_Element => No_File,
1371       Key        => File_Name_Type,
1372       Hash       => Hash,
1373       Equal      => "=");
1374
1375    type Private_Project_Tree_Data is private;
1376    --  Data for a project tree that is used only by the Project Manager
1377
1378    type Project_Tree_Data is
1379       record
1380          Name_Lists        : Name_List_Table.Instance;
1381          Number_Lists      : Number_List_Table.Instance;
1382          String_Elements   : String_Element_Table.Instance;
1383          Variable_Elements : Variable_Element_Table.Instance;
1384          Array_Elements    : Array_Element_Table.Instance;
1385          Arrays            : Array_Table.Instance;
1386          Packages          : Package_Table.Instance;
1387          Projects          : Project_List;
1388
1389          Replaced_Sources : Replaced_Source_HTable.Instance;
1390          --  The list of sources that have been replaced by sources with
1391          --  different file names.
1392
1393          Replaced_Source_Number : Natural := 0;
1394          --  The number of entries in Replaced_Sources
1395
1396          Units_HT : Units_Htable.Instance;
1397          --  Unit name to Unit_Index (and from there to Source_Id)
1398
1399          Source_Files_HT : Source_Files_Htable.Instance;
1400          --  Base source file names to Source_Id list.
1401
1402          Source_Paths_HT : Source_Paths_Htable.Instance;
1403          --  Full path to Source_Id
1404
1405          Source_Info_File_Name : String_Access := null;
1406          --  The name of the source info file, if specified by the builder
1407
1408          Source_Info_File_Exists : Boolean := False;
1409          --  True when a source info file has been successfully read
1410
1411          Private_Part : Private_Project_Tree_Data;
1412       end record;
1413    --  Data for a project tree
1414
1415    procedure Expect (The_Token : Token_Type; Token_Image : String);
1416    --  Check that the current token is The_Token. If it is not, then output
1417    --  an error message.
1418
1419    procedure Initialize (Tree : Project_Tree_Ref);
1420    --  This procedure must be called before using any services from the Prj
1421    --  hierarchy. Namet.Initialize must be called before Prj.Initialize.
1422
1423    procedure Reset (Tree : Project_Tree_Ref);
1424    --  This procedure resets all the tables that are used when processing a
1425    --  project file tree. Initialize must be called before the call to Reset.
1426
1427    package Project_Boolean_Htable is new Simple_HTable
1428      (Header_Num => Header_Num,
1429       Element    => Boolean,
1430       No_Element => False,
1431       Key        => Project_Id,
1432       Hash       => Hash,
1433       Equal      => "=");
1434    --  A table that associates a project to a boolean. This is used to detect
1435    --  whether a project was already processed for instance.
1436
1437    generic
1438       type State is limited private;
1439       with procedure Action
1440         (Project    : Project_Id;
1441          With_State : in out State);
1442    procedure For_Every_Project_Imported
1443      (By             : Project_Id;
1444       With_State     : in out State;
1445       Imported_First : Boolean := False);
1446    --  Call Action for each project imported directly or indirectly by project
1447    --  By, as well as extended projects.
1448    --
1449    --  The order of processing depends on Imported_First:
1450    --
1451    --    If False, Action is called according to the order of importation: if A
1452    --    imports B, directly or indirectly, Action will be called for A before
1453    --    it is called for B. If two projects import each other directly or
1454    --    indirectly (using at least one "limited with"), it is not specified
1455    --    for which of these two projects Action will be called first.
1456    --
1457    --    The order is reversed if Imported_First is True
1458    --
1459    --  With_State may be used by Action to choose a behavior or to report some
1460    --  global result.
1461
1462    function Extend_Name
1463      (File        : File_Name_Type;
1464       With_Suffix : String) return File_Name_Type;
1465    --  Replace the extension of File with With_Suffix
1466
1467    function Object_Name
1468      (Source_File_Name   : File_Name_Type;
1469       Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1470    --  Returns the object file name corresponding to a source file name
1471
1472    function Object_Name
1473      (Source_File_Name   : File_Name_Type;
1474       Source_Index       : Int;
1475       Index_Separator    : Character;
1476       Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1477    --  Returns the object file name corresponding to a unit in a multi-source
1478    --  file.
1479
1480    function Dependency_Name
1481      (Source_File_Name : File_Name_Type;
1482       Dependency       : Dependency_File_Kind) return File_Name_Type;
1483    --  Returns the dependency file name corresponding to a source file name
1484
1485    function Switches_Name
1486      (Source_File_Name : File_Name_Type) return File_Name_Type;
1487    --  Returns the switches file name corresponding to a source file name
1488
1489    -----------
1490    -- Flags --
1491    -----------
1492
1493    type Processing_Flags is private;
1494    --  Flags used while parsing and processing a project tree to configure the
1495    --  behavior of the parser, and indicate how to report error messages. This
1496    --  structure does not allocate memory and never needs to be freed
1497
1498    type Error_Warning is (Silent, Warning, Error);
1499    --  Severity of some situations, such as: no Ada sources in a project where
1500    --  Ada is one of the language.
1501    --
1502    --  When the situation occurs, the behaviour depends on the setting:
1503    --
1504    --    - Silent:  no action
1505    --    - Warning: issue a warning, does not cause the tool to fail
1506    --    - Error:   issue an error, causes the tool to fail
1507
1508    type Error_Handler is access procedure
1509      (Project    : Project_Id;
1510       Is_Warning : Boolean);
1511    --  This warngs when an error was found when parsing a project. The error
1512    --  itself is handled through Prj.Err (and Prj.Err.Finalize should be called
1513    --  to actually print the error). This ensures that duplicate error messages
1514    --  are always correctly removed, that errors msgs are sorted, and that all
1515    --  tools will report the same error to the user.
1516
1517    function Create_Flags
1518      (Report_Error               : Error_Handler;
1519       When_No_Sources            : Error_Warning;
1520       Require_Sources_Other_Lang : Boolean       := True;
1521       Allow_Duplicate_Basenames  : Boolean       := True;
1522       Compiler_Driver_Mandatory  : Boolean       := False;
1523       Error_On_Unknown_Language  : Boolean       := True;
1524       Require_Obj_Dirs           : Error_Warning := Error;
1525       Allow_Invalid_External     : Error_Warning := Error;
1526       Missing_Source_Files       : Error_Warning := Error)
1527       return Processing_Flags;
1528    --  Function used to create Processing_Flags structure
1529    --
1530    --  If Allow_Duplicate_Basenames, then files with the same base names are
1531    --  authorized within a project for source-based languages (never for unit
1532    --  based languages).
1533    --
1534    --  If Compiler_Driver_Mandatory is true, then a Compiler.Driver attribute
1535    --  for each language must be defined, or we will not look for its source
1536    --  files.
1537    --
1538    --  When_No_Sources indicates what should be done when no sources of a
1539    --  language are found in a project where this language is declared.
1540    --  If Require_Sources_Other_Lang is true, then all languages must have at
1541    --  least one source file, or an error is reported via When_No_Sources. If
1542    --  it is false, this is only required for Ada (and only if it is a language
1543    --  of the project). When this parameter is set to False, we do not check
1544    --  that a proper naming scheme is defined for languages other than Ada.
1545    --
1546    --  If Report_Error is null, use the standard error reporting mechanism
1547    --  (Errout). Otherwise, report errors using Report_Error.
1548    --
1549    --  If Error_On_Unknown_Language is true, an error is displayed if some of
1550    --  the source files listed in the project do not match any naming scheme
1551    --
1552    --  If Require_Obj_Dirs is true, then all object directories must exist
1553    --  (possibly after they have been created automatically if the appropriate
1554    --  switches were specified), or an error is raised.
1555    --
1556    --  If Allow_Invalid_External is Silent, then no error is reported when an
1557    --  invalid value is used for an external variable (and it doesn't match its
1558    --  type). Instead, the first possible value is used.
1559    --
1560    --  Missing_Source_Files indicates whether it is an error or a warning that
1561    --  a source file mentioned in the Source_Files attributes is not actually
1562    --  found in the source directories. This also impacts errors for missing
1563    --  source directories.
1564
1565    Gprbuild_Flags : constant Processing_Flags;
1566    Gprclean_Flags : constant Processing_Flags;
1567    Gnatmake_Flags : constant Processing_Flags;
1568    --  Flags used by the various tools. They all display the error messages
1569    --  through Prj.Err.
1570
1571    ----------------
1572    -- Temp Files --
1573    ----------------
1574
1575    procedure Record_Temp_File
1576      (Tree : Project_Tree_Ref;
1577       Path : Path_Name_Type);
1578    --  Record the path of a newly created temporary file, so that it can be
1579    --  deleted later.
1580
1581    procedure Delete_All_Temp_Files (Tree : Project_Tree_Ref);
1582    --  Delete all recorded temporary files.
1583    --  Does nothing if Debug.Debug_Flag_N is set
1584
1585    procedure Delete_Temporary_File
1586      (Tree : Project_Tree_Ref;
1587       Path : Path_Name_Type);
1588    --  Delete a temporary file from the disk. The file is also removed from the
1589    --  list of temporary files to delete at the end of the program, in case
1590    --  another program running on the same machine has recreated it.
1591    --  Does nothing if Debug.Debug_Flag_N is set
1592
1593    Virtual_Prefix : constant String := "v$";
1594    --  The prefix for virtual extending projects. Because of the '$', which is
1595    --  normally forbidden for project names, there cannot be any name clash.
1596
1597 private
1598
1599    All_Packages : constant String_List_Access := null;
1600
1601    No_Project_Tree : constant Project_Tree_Ref := null;
1602
1603    Ignored : constant Variable_Kind := Single;
1604
1605    Nil_Variable_Value : constant Variable_Value :=
1606                           (Project  => No_Project,
1607                            Kind     => Undefined,
1608                            Location => No_Location,
1609                            Default  => False);
1610
1611    type Source_Iterator is record
1612       In_Tree : Project_Tree_Ref;
1613
1614       Project      : Project_List;
1615       All_Projects : Boolean;
1616       --  Current project and whether we should move on to the next
1617
1618       Language : Language_Ptr;
1619       --  Current language processed
1620
1621       Language_Name : Name_Id;
1622       --  Only sources of this language will be returned (or all if No_Name)
1623
1624       Current : Source_Id;
1625    end record;
1626
1627    procedure Add_To_Buffer
1628      (S    : String;
1629       To   : in out String_Access;
1630       Last : in out Natural);
1631    --  Append a String to the Buffer
1632
1633    package Temp_Files_Table is new GNAT.Dynamic_Tables
1634      (Table_Component_Type => Path_Name_Type,
1635       Table_Index_Type     => Integer,
1636       Table_Low_Bound      => 1,
1637       Table_Initial        => 10,
1638       Table_Increment      => 10);
1639    --  Table to store the path name of all the created temporary files, so that
1640    --  they can be deleted at the end, or when the program is interrupted.
1641
1642    type Private_Project_Tree_Data is record
1643       Temp_Files   : Temp_Files_Table.Instance;
1644       --  Temporary files created as part of running tools (pragma files,
1645       --  mapping files,...)
1646
1647       Current_Source_Path_File : Path_Name_Type := No_Path;
1648       --  Current value of project source path file env var. Used to avoid
1649       --  setting the env var to the same value. When different from No_Path,
1650       --  this indicates that logical names (VMS) or environment variables were
1651       --  created and should be deassigned to avoid polluting the environment
1652       --  on VMS.
1653       --  gnatmake only
1654
1655       Current_Object_Path_File : Path_Name_Type := No_Path;
1656       --  Current value of project object path file env var. Used to avoid
1657       --  setting the env var to the same value.
1658       --  gnatmake only
1659
1660    end record;
1661    --  Type to represent the part of a project tree which is private to the
1662    --  Project Manager.
1663
1664    type Processing_Flags is record
1665       Require_Sources_Other_Lang : Boolean;
1666       Report_Error               : Error_Handler;
1667       When_No_Sources            : Error_Warning;
1668       Allow_Duplicate_Basenames  : Boolean;
1669       Compiler_Driver_Mandatory  : Boolean;
1670       Error_On_Unknown_Language  : Boolean;
1671       Require_Obj_Dirs           : Error_Warning;
1672       Allow_Invalid_External     : Error_Warning;
1673       Missing_Source_Files       : Error_Warning;
1674    end record;
1675
1676    Gprbuild_Flags : constant Processing_Flags :=
1677      (Report_Error               => null,
1678       When_No_Sources            => Warning,
1679       Require_Sources_Other_Lang => True,
1680       Allow_Duplicate_Basenames  => False,
1681       Compiler_Driver_Mandatory  => True,
1682       Error_On_Unknown_Language  => True,
1683       Require_Obj_Dirs           => Error,
1684       Allow_Invalid_External     => Error,
1685       Missing_Source_Files       => Error);
1686
1687    Gprclean_Flags : constant Processing_Flags :=
1688      (Report_Error               => null,
1689       When_No_Sources            => Warning,
1690       Require_Sources_Other_Lang => True,
1691       Allow_Duplicate_Basenames  => False,
1692       Compiler_Driver_Mandatory  => True,
1693       Error_On_Unknown_Language  => True,
1694       Require_Obj_Dirs           => Warning,
1695       Allow_Invalid_External     => Error,
1696       Missing_Source_Files       => Error);
1697
1698    Gnatmake_Flags : constant Processing_Flags :=
1699      (Report_Error               => null,
1700       When_No_Sources            => Error,
1701       Require_Sources_Other_Lang => False,
1702       Allow_Duplicate_Basenames  => False,
1703       Compiler_Driver_Mandatory  => False,
1704       Error_On_Unknown_Language  => False,
1705       Require_Obj_Dirs           => Error,
1706       Allow_Invalid_External     => Error,
1707       Missing_Source_Files       => Error);
1708
1709 end Prj;