gcc/ada/prj.ads

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