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_Index is new Nat;
 311    --  Index of language data
 312
 313    No_Language_Index : constant Language_Index := 0;
 314    --  Constant indicating that there is no language data
 315
 316    procedure Display_Language_Name
 317      (In_Tree  : Project_Tree_Ref;
 318       Language : Language_Index);
 319    --  Output the name of a language
 320
 321    Max_Header_Num : constant := 6150;
 322    type Header_Num is range 0 .. Max_Header_Num;
 323    --  Size for hash table below. The upper bound is an arbitrary value, the
 324    --  value here was chosen after testing to determine a good compromise
 325    --  between speed of access and memory usage.
 326
 327    function Hash (Name : Name_Id)        return Header_Num;
 328    function Hash (Name : File_Name_Type) return Header_Num;
 329    function Hash (Name : Path_Name_Type) return Header_Num;
 330    --  Used for computing hash values for names put into above hash table
 331
 332    function Hash (Project : Project_Id) return Header_Num;
 333    --  Used for hash tables where Project_Id is the Key
 334
 335    type Language_Kind is (File_Based, Unit_Based);
 336    --  Type for the kind of language. All languages are file based, except Ada
 337    --  which is unit based.
 338
 339    type Dependency_File_Kind is (None, Makefile, ALI_File);
 340    --  Type of dependency to be checked: no dependency file, Makefile fragment
 341    --  or ALI file (for Ada).
 342
 343    Makefile_Dependency_Suffix : constant String := ".d";
 344    ALI_Dependency_Suffix      : constant String := ".ali";
 345
 346    Switches_Dependency_Suffix : constant String := ".cswi";
 347
 348    Binder_Exchange_Suffix     : constant String := ".bexch";
 349    --  Suffix for binder exchange files
 350
 351    Library_Exchange_Suffix     : constant String := ".lexch";
 352    --  Suffix for library exchange files
 353
 354    type Name_List_Index is new Nat;
 355    No_Name_List            : constant Name_List_Index := 0;
 356
 357    type Name_Node is record
 358       Name : Name_Id         := No_Name;
 359       Next : Name_List_Index := No_Name_List;
 360    end record;
 361
 362    package Name_List_Table is new GNAT.Dynamic_Tables
 363      (Table_Component_Type => Name_Node,
 364       Table_Index_Type     => Name_List_Index,
 365       Table_Low_Bound      => 1,
 366       Table_Initial        => 10,
 367       Table_Increment      => 100);
 368    --  The table for lists of names used in package Language_Processing
 369
 370    package Mapping_Files_Htable is new Simple_HTable
 371      (Header_Num => Header_Num,
 372       Element    => Path_Name_Type,
 373       No_Element => No_Path,
 374       Key        => Path_Name_Type,
 375       Hash       => Hash,
 376       Equal      => "=");
 377    --  A hash table to store the mapping files that are not used
 378
 379    type Lang_Naming_Data is record
 380       Dot_Replacement : File_Name_Type := No_File;
 381       --  The string to replace '.' in the source file name (for Ada)
 382
 383       Casing : Casing_Type := All_Lower_Case;
 384       --  The casing of the source file name (for Ada)
 385
 386       Separate_Suffix : File_Name_Type := No_File;
 387       --  String to append to unit name for source file name of an Ada subunit
 388
 389       Spec_Suffix : File_Name_Type := No_File;
 390       --  The string to append to the unit name for the
 391       --  source file name of a spec.
 392
 393       Body_Suffix : File_Name_Type := No_File;
 394       --  The string to append to the unit name for the
 395       --  source file name of a body.
 396    end record;
 397
 398    No_Lang_Naming_Data : constant Lang_Naming_Data :=
 399                            (Dot_Replacement => No_File,
 400                             Casing          => All_Lower_Case,
 401                             Separate_Suffix => No_File,
 402                             Spec_Suffix     => No_File,
 403                             Body_Suffix     => No_File);
 404
 405    type Source_Id is new Nat;
 406
 407    No_Source : constant Source_Id := 0;
 408
 409    type Path_Syntax_Kind is
 410      (Canonical,
 411       --  Unix style
 412
 413       Host);
 414       --  Host specific syntax, for example on VMS (the default)
 415
 416    type Language_Config is record
 417       Kind : Language_Kind := File_Based;
 418       --  Kind of language. All languages are file based, except Ada which is
 419       --  unit based.
 420
 421       Naming_Data : Lang_Naming_Data;
 422       --  The naming data for the languages (prefixes, etc.)
 423
 424       Include_Compatible_Languages : Name_List_Index := No_Name_List;
 425       --  The list of languages that are "include compatible" with this
 426       --  language. A language B (for example "C") is "include compatible" with
 427       --  a language A (for example "C++") if it is expected that sources of
 428       --  language A may "include" header files from language B.
 429
 430       Compiler_Driver : File_Name_Type := No_File;
 431       --  The name of the executable for the compiler of the language
 432
 433       Compiler_Driver_Path : String_Access := null;
 434       --  The path name of the executable for the compiler of the language
 435
 436       Compiler_Required_Switches : Name_List_Index := No_Name_List;
 437       --  The list of switches that are required as a minimum to invoke the
 438       --  compiler driver.
 439
 440       Path_Syntax                  : Path_Syntax_Kind := Host;
 441       --  Value may be Canonical (Unix style) or Host (host syntax, for example
 442       --  on VMS for DEC C).
 443
 444       Object_File_Suffix : Name_Id := No_Name;
 445
 446       Compilation_PIC_Option : Name_List_Index := No_Name_List;
 447       --  The option(s) to compile a source in Position Independent Code for
 448       --  shared libraries. Specified in the configuration. When not specified,
 449       --  there is no need for such switch.
 450
 451       Object_Generated             : Boolean := True;
 452       --  False in no object file is generated
 453
 454       Objects_Linked               : Boolean := True;
 455       --  False if object files are not use to link executables and build
 456       --  libraries.
 457
 458       Runtime_Library_Dir        : Name_Id := No_Name;
 459       --  Path name of the runtime library directory, if any
 460
 461       Runtime_Source_Dir        : Name_Id := No_Name;
 462       --  Path name of the runtime source directory, if any
 463
 464       Mapping_File_Switches  : Name_List_Index := No_Name_List;
 465       --  The option(s) to provide a mapping file to the compiler. Specified in
 466       --  the configuration. When value is No_Name_List, there is no mapping
 467       --  file.
 468
 469       Mapping_Spec_Suffix        : File_Name_Type       := No_File;
 470       --  Placeholder representing the spec suffix in a mapping file
 471
 472       Mapping_Body_Suffix        : File_Name_Type       := No_File;
 473       --  Placeholder representing the body suffix in a mapping file
 474
 475       Config_File_Switches       : Name_List_Index      := No_Name_List;
 476       --  The option(s) to provide a config file to the compiler. Specified in
 477       --  the configuration. When value is No_Name_List, there is no config
 478       --  file.
 479
 480       Dependency_Kind            : Dependency_File_Kind := None;
 481       --  The kind of dependency to be checked: none, Makefile fragment or
 482       --  ALI file (for Ada).
 483
 484       Dependency_Option          : Name_List_Index      := No_Name_List;
 485       --  The option(s) to be used to create the dependency file. When value is
 486       --  No_Name_List, there is not such option(s).
 487
 488       Compute_Dependency         : Name_List_Index      := No_Name_List;
 489       --  Hold the value of attribute Dependency_Driver, if declared for the
 490       --  language.
 491
 492       Include_Option             : Name_List_Index      := No_Name_List;
 493       --  Hold the value of attribute Include_Switches, if declared for the
 494       --  language.
 495
 496       Include_Path : Name_Id := No_Name;
 497       --  Name of environment variable declared by attribute Include_Path for
 498       --  the language.
 499
 500       Include_Path_File : Name_Id := No_Name;
 501       --  Name of environment variable declared by attribute Include_Path_File
 502       --  for the language.
 503
 504       Objects_Path : Name_Id := No_Name;
 505       --  Name of environment variable declared by attribute Objects_Path for
 506       --  the language.
 507
 508       Objects_Path_File : Name_Id := No_Name;
 509       --  Name of environment variable declared by attribute Objects_Path_File
 510       --  for the language.
 511
 512       Config_Body                : Name_Id         := No_Name;
 513       --  The template for a pragma Source_File_Name(_Project) for a specific
 514       --  file name of a body.
 515
 516       Config_Spec           : Name_Id         := No_Name;
 517       --  The template for a pragma Source_File_Name(_Project) for a specific
 518       --  file name of a spec.
 519
 520       Config_Body_Pattern   : Name_Id         := No_Name;
 521       --  The template for a pragma Source_File_Name(_Project) for a naming
 522       --  body pattern.
 523
 524       Config_Spec_Pattern   : Name_Id         := No_Name;
 525       --  The template for a pragma Source_File_Name(_Project) for a naming
 526       --  spec pattern.
 527
 528       Config_File_Unique         : Boolean         := False;
 529       --  Indicate if the config file specified to the compiler needs to be
 530       --  unique. If it is unique, then all config files are concatenated into
 531       --  a temp config file.
 532
 533       Binder_Driver              : File_Name_Type  := No_File;
 534       --  The name of the binder driver for the language, if any
 535
 536       Binder_Driver_Path         : Path_Name_Type  := No_Path;
 537       --  The path name of the binder driver
 538
 539       Binder_Required_Switches   : Name_List_Index      := No_Name_List;
 540       --  Hold the value of attribute Binder'Required_Switches for the language
 541
 542       Binder_Prefix              : Name_Id         := No_Name;
 543       --  Hold the value of attribute Binder'Prefix for the language
 544
 545       Toolchain_Version          : Name_Id         := No_Name;
 546       --  Hold the value of attribute Toolchain_Version for the language
 547
 548       Toolchain_Description      : Name_Id         := No_Name;
 549       --  Hold the value of attribute Toolchain_Description for the language
 550
 551    end record;
 552    --  Record describing the configuration of a language
 553
 554    No_Language_Config : constant Language_Config :=
 555                           (Kind                         => File_Based,
 556                            Naming_Data                  => No_Lang_Naming_Data,
 557                            Include_Compatible_Languages => No_Name_List,
 558                            Compiler_Driver              => No_File,
 559                            Compiler_Driver_Path         => null,
 560                            Compiler_Required_Switches   => No_Name_List,
 561                            Path_Syntax                  => Canonical,
 562                            Object_File_Suffix           => No_Name,
 563                            Compilation_PIC_Option       => No_Name_List,
 564                            Object_Generated             => True,
 565                            Objects_Linked               => True,
 566                            Runtime_Library_Dir          => No_Name,
 567                            Runtime_Source_Dir           => No_Name,
 568                            Mapping_File_Switches        => No_Name_List,
 569                            Mapping_Spec_Suffix          => No_File,
 570                            Mapping_Body_Suffix          => No_File,
 571                            Config_File_Switches         => No_Name_List,
 572                            Dependency_Kind              => Makefile,
 573                            Dependency_Option            => No_Name_List,
 574                            Compute_Dependency           => No_Name_List,
 575                            Include_Option               => No_Name_List,
 576                            Include_Path                 => No_Name,
 577                            Include_Path_File            => No_Name,
 578                            Objects_Path                 => No_Name,
 579                            Objects_Path_File            => No_Name,
 580                            Config_Body                  => No_Name,
 581                            Config_Spec                  => No_Name,
 582                            Config_Body_Pattern          => No_Name,
 583                            Config_Spec_Pattern          => No_Name,
 584                            Config_File_Unique           => False,
 585                            Binder_Driver                => No_File,
 586                            Binder_Driver_Path           => No_Path,
 587                            Binder_Required_Switches     => No_Name_List,
 588                            Binder_Prefix                => No_Name,
 589                            Toolchain_Version            => No_Name,
 590                            Toolchain_Description        => No_Name);
 591
 592    type Language_Data is record
 593       Name          : Name_Id         := No_Name;
 594       Display_Name  : Name_Id         := No_Name;
 595       Config        : Language_Config := No_Language_Config;
 596       First_Source  : Source_Id       := No_Source;
 597       Mapping_Files : Mapping_Files_Htable.Instance :=
 598                         Mapping_Files_Htable.Nil;
 599       Next          : Language_Index  := No_Language_Index;
 600    end record;
 601
 602    No_Language_Data : constant Language_Data :=
 603                         (Name          => No_Name,
 604                          Display_Name  => No_Name,
 605                          Config        => No_Language_Config,
 606                          First_Source  => No_Source,
 607                          Mapping_Files => Mapping_Files_Htable.Nil,
 608                          Next          => No_Language_Index);
 609
 610    package Language_Data_Table is new GNAT.Dynamic_Tables
 611      (Table_Component_Type => Language_Data,
 612       Table_Index_Type     => Language_Index,
 613       Table_Low_Bound      => 1,
 614       Table_Initial        => 10,
 615       Table_Increment      => 100);
 616    --  The table for lists of names used in package Language_Processing
 617
 618    type Alternate_Language_Id is new Nat;
 619
 620    No_Alternate_Language : constant Alternate_Language_Id := 0;
 621
 622    type Alternate_Language_Data is record
 623       Language : Language_Index := No_Language_Index;
 624       Next     : Alternate_Language_Id := No_Alternate_Language;
 625    end record;
 626
 627    package Alternate_Language_Table is new GNAT.Dynamic_Tables
 628      (Table_Component_Type => Alternate_Language_Data,
 629       Table_Index_Type     => Alternate_Language_Id,
 630       Table_Low_Bound      => 1,
 631       Table_Initial        => 10,
 632       Table_Increment      => 100);
 633    --  The table for storing the alternate languages of a header file that
 634    --  is used for several languages.
 635
 636    type Source_Kind is (Spec, Impl, Sep);
 637
 638    type Source_Data is record
 639       Project             : Project_Id            := No_Project;
 640       --  Project of the source
 641
 642       Language_Name       : Name_Id               := No_Name;
 643       --  Name of the language of the source
 644
 645       Language            : Language_Index        := No_Language_Index;
 646       --  Index of the language
 647
 648       Lang_Kind           : Language_Kind         := File_Based;
 649       --  Kind of the language
 650
 651       Compiled            : Boolean               := True;
 652       --  False when there is no compiler for the language
 653
 654       In_Interfaces       : Boolean               := True;
 655       --  False when the source is not included in interfaces, when attribute
 656       --  Interfaces is declared.
 657
 658       Declared_In_Interfaces : Boolean            := False;
 659       --  True when source is declared in attribute Interfaces
 660
 661       Alternate_Languages : Alternate_Language_Id := No_Alternate_Language;
 662       --  List of languages a header file may also be, in addition of
 663       --  language Language_Name.
 664
 665       Kind                : Source_Kind           := Spec;
 666       --  Kind of the source: spec, body or subunit
 667
 668       Dependency          : Dependency_File_Kind  := None;
 669       --  Kind of dependency: none, Makefile fragment or ALI file
 670
 671       Other_Part          : Source_Id             := No_Source;
 672       --  Source ID for the other part, if any: for a spec, indicates its body;
 673       --  for a body, indicates its spec.
 674
 675       Unit                : Name_Id               := No_Name;
 676       --  Name of the unit, if language is unit based
 677
 678       Index               : Int                   := 0;
 679       --  Index of the source in a multi unit source file
 680
 681       Locally_Removed     : Boolean               := False;
 682       --  True if the source has been "excluded"
 683
 684       Get_Object          : Boolean               := False;
 685       --  Indicates that the object of the source should be put in the global
 686       --  archive. This is for Ada, when only the closure of a main needs to
 687       --  be compiled/recompiled.
 688
 689       Replaced_By         : Source_Id             := No_Source;
 690
 691       File                : File_Name_Type        := No_File;
 692       --  Canonical file name of the source
 693
 694       Display_File        : File_Name_Type        := No_File;
 695       --  File name of the source, for display purposes
 696
 697       Path                : Path_Information      := No_Path_Information;
 698       --  Path name of the source
 699
 700       Source_TS           : Time_Stamp_Type       := Empty_Time_Stamp;
 701       --  Time stamp of the source file
 702
 703       Object_Project      : Project_Id            := No_Project;
 704       --  Project where the object file is. This might be different from
 705       --  Project when using extending project files.
 706
 707       Object_Exists       : Boolean               := True;
 708       --  True if an object file exists
 709
 710       Object_Linked          : Boolean            := True;
 711       --  False if the object file is not use to link executables or included
 712       --  in libraries.
 713
 714       Object              : File_Name_Type        := No_File;
 715       --  File name of the object file
 716
 717       Current_Object_Path : Path_Name_Type        := No_Path;
 718       --  Object path of an existing object file
 719
 720       Object_Path         : Path_Name_Type        := No_Path;
 721       --  Object path of the real object file
 722
 723       Object_TS           : Time_Stamp_Type       := Empty_Time_Stamp;
 724       --  Object file time stamp
 725
 726       Dep_Name            : File_Name_Type        := No_File;
 727       --  Dependency file simple name
 728
 729       Current_Dep_Path    : Path_Name_Type        := No_Path;
 730       --  Path name of an existing dependency file
 731
 732       Dep_Path            : Path_Name_Type        := No_Path;
 733       --  Path name of the real dependency file
 734
 735       Dep_TS              : Time_Stamp_Type       := Empty_Time_Stamp;
 736       --  Dependency file time stamp
 737
 738       Switches            : File_Name_Type        := No_File;
 739       --  File name of the switches file. For all languages, this is a file
 740       --  that ends with the .cswi extension.
 741
 742       Switches_Path       : Path_Name_Type        := No_Path;
 743       --  Path name of the switches file
 744
 745       Switches_TS         : Time_Stamp_Type       := Empty_Time_Stamp;
 746       --  Switches file time stamp
 747
 748       Naming_Exception    : Boolean               := False;
 749       --  True if the source has an exceptional name
 750
 751       Next_In_Sources     : Source_Id             := No_Source;
 752       --  Link to another source in the project tree
 753
 754       Next_In_Project     : Source_Id             := No_Source;
 755       --  Link to another source in the project
 756
 757       Next_In_Lang        : Source_Id             := No_Source;
 758       --  Link to another source of the same language
 759    end record;
 760
 761    No_Source_Data : constant Source_Data :=
 762                       (Project                => No_Project,
 763                        Language_Name          => No_Name,
 764                        Language               => No_Language_Index,
 765                        Lang_Kind              => File_Based,
 766                        Compiled               => True,
 767                        In_Interfaces          => True,
 768                        Declared_In_Interfaces => False,
 769                        Alternate_Languages    => No_Alternate_Language,
 770                        Kind                   => Spec,
 771                        Dependency             => None,
 772                        Other_Part             => No_Source,
 773                        Unit                   => No_Name,
 774                        Index                  => 0,
 775                        Locally_Removed        => False,
 776                        Get_Object             => False,
 777                        Replaced_By            => No_Source,
 778                        File                   => No_File,
 779                        Display_File           => No_File,
 780                        Path                   => No_Path_Information,
 781                        Source_TS              => Empty_Time_Stamp,
 782                        Object_Project         => No_Project,
 783                        Object_Exists          => True,
 784                        Object_Linked          => True,
 785                        Object                 => No_File,
 786                        Current_Object_Path    => No_Path,
 787                        Object_Path            => No_Path,
 788                        Object_TS              => Empty_Time_Stamp,
 789                        Dep_Name               => No_File,
 790                        Current_Dep_Path       => No_Path,
 791                        Dep_Path               => No_Path,
 792                        Dep_TS                 => Empty_Time_Stamp,
 793                        Switches               => No_File,
 794                        Switches_Path          => No_Path,
 795                        Switches_TS            => Empty_Time_Stamp,
 796                        Naming_Exception       => False,
 797                        Next_In_Sources        => No_Source,
 798                        Next_In_Project        => No_Source,
 799                        Next_In_Lang           => No_Source);
 800
 801    package Source_Data_Table is new GNAT.Dynamic_Tables
 802      (Table_Component_Type => Source_Data,
 803       Table_Index_Type     => Source_Id,
 804       Table_Low_Bound      => 1,
 805       Table_Initial        => 1000,
 806       Table_Increment      => 100);
 807    --  The table for the sources
 808
 809    package Source_Paths_Htable is new Simple_HTable
 810      (Header_Num => Header_Num,
 811       Element    => Source_Id,
 812       No_Element => No_Source,
 813       Key        => Path_Name_Type,
 814       Hash       => Hash,
 815       Equal      => "=");
 816    --  Mapping of source paths to source ids
 817
 818    package Unit_Sources_Htable is new Simple_HTable
 819      (Header_Num => Header_Num,
 820       Element    => Source_Id,
 821       No_Element => No_Source,
 822       Key        => Name_Id,
 823       Hash       => Hash,
 824       Equal      => "=");
 825
 826    type Verbosity is (Default, Medium, High);
 827    --  Verbosity when parsing GNAT Project Files
 828    --    Default is default (very quiet, if no errors).
 829    --    Medium is more verbose.
 830    --    High is extremely verbose.
 831
 832    Current_Verbosity : Verbosity := Default;
 833    --  The current value of the verbosity the project files are parsed with
 834
 835    type Lib_Kind is (Static, Dynamic, Relocatable);
 836
 837    type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
 838    --  Type to specify the symbol policy, when symbol control is supported.
 839    --  See full explanation about this type in package Symbols.
 840    --    Autonomous: Create a symbol file without considering any reference
 841    --    Compliant:  Try to be as compatible as possible with an existing ref
 842    --    Controlled: Fail if symbols are not the same as those in the reference
 843    --    Restricted: Restrict the symbols to those in the symbol file
 844    --    Direct:     The symbol file is used as is
 845
 846    type Symbol_Record is record
 847       Symbol_File   : Path_Name_Type := No_Path;
 848       Reference     : Path_Name_Type := No_Path;
 849       Symbol_Policy : Policy  := Autonomous;
 850    end record;
 851    --  Type to keep the symbol data to be used when building a shared library
 852
 853    No_Symbols : constant Symbol_Record :=
 854      (Symbol_File   => No_Path,
 855       Reference     => No_Path,
 856       Symbol_Policy => Autonomous);
 857    --  The default value of the symbol data
 858
 859    function Image (Casing : Casing_Type) return String;
 860    --  Similar to 'Image (but avoid use of this attribute in compiler)
 861
 862    function Value (Image : String) return Casing_Type;
 863    --  Similar to 'Value (but avoid use of this attribute in compiler)
 864    --  Raises Constraint_Error if not a Casing_Type image.
 865
 866    --  The following record contains data for a naming scheme
 867
 868    type Naming_Data is record
 869
 870       Dot_Replacement : File_Name_Type := No_File;
 871       --  The string to replace '.' in the source file name (for Ada)
 872
 873       Casing : Casing_Type := All_Lower_Case;
 874       --  The casing of the source file name (for Ada)
 875
 876       Spec_Suffix : Array_Element_Id := No_Array_Element;
 877       --  The string to append to the unit name for the
 878       --  source file name of a spec.
 879       --  Indexed by the programming language.
 880
 881       Body_Suffix : Array_Element_Id := No_Array_Element;
 882       --  The string to append to the unit name for the
 883       --  source file name of a body.
 884       --  Indexed by the programming language.
 885
 886       Separate_Suffix : File_Name_Type := No_File;
 887       --  String to append to unit name for source file name of an Ada subunit
 888
 889       Specs : Array_Element_Id := No_Array_Element;
 890       --  An associative array mapping individual specs to source file names
 891       --  This is specific to unit-based languages.
 892
 893       Bodies : Array_Element_Id := No_Array_Element;
 894       --  An associative array mapping individual bodies to source file names
 895       --  This is specific to unit-based languages.
 896
 897       Specification_Exceptions : Array_Element_Id := No_Array_Element;
 898       --  An associative array listing spec file names that do not have the
 899       --  spec suffix. Not used by Ada. Indexed by programming language name.
 900
 901       Implementation_Exceptions : Array_Element_Id := No_Array_Element;
 902       --  An associative array listing body file names that do not have the
 903       --  body suffix. Not used by Ada. Indexed by programming language name.
 904
 905    end record;
 906
 907    function Spec_Suffix_Of
 908      (In_Tree  : Project_Tree_Ref;
 909       Language : String;
 910       Naming   : Naming_Data) return String;
 911
 912    function Spec_Suffix_Id_Of
 913      (In_Tree  : Project_Tree_Ref;
 914       Language : String;
 915       Naming   : Naming_Data) return File_Name_Type;
 916
 917    function Spec_Suffix_Id_Of
 918      (In_Tree     : Project_Tree_Ref;
 919       Language_Id : Name_Id;
 920       Naming      : Naming_Data) return File_Name_Type;
 921
 922    procedure Set_Spec_Suffix
 923      (In_Tree  : Project_Tree_Ref;
 924       Language : String;
 925       Naming   : in out Naming_Data;
 926       Suffix   : File_Name_Type);
 927
 928    function Body_Suffix_Id_Of
 929      (In_Tree  : Project_Tree_Ref;
 930       Language : String;
 931       Naming   : Naming_Data) return File_Name_Type;
 932
 933    function Body_Suffix_Id_Of
 934      (In_Tree     : Project_Tree_Ref;
 935       Language_Id : Name_Id;
 936       Naming      : Naming_Data) return File_Name_Type;
 937
 938    function Body_Suffix_Of
 939      (In_Tree  : Project_Tree_Ref;
 940       Language : String;
 941       Naming   : Naming_Data) return String;
 942
 943    procedure Set_Body_Suffix
 944      (In_Tree  : Project_Tree_Ref;
 945       Language : String;
 946       Naming   : in out Naming_Data;
 947       Suffix   : File_Name_Type);
 948
 949    function Objects_Exist_For
 950      (Language : String;
 951       In_Tree  : Project_Tree_Ref) return Boolean;
 952
 953    function Standard_Naming_Data
 954      (Tree : Project_Tree_Ref := No_Project_Tree) return Naming_Data;
 955    pragma Inline (Standard_Naming_Data);
 956    --  The standard GNAT naming scheme when Tree is No_Project_Tree.
 957    --  Otherwise, return the default naming scheme for the project tree Tree,
 958    --  which must have been Initialized.
 959
 960    function Same_Naming_Scheme
 961      (Left, Right : Naming_Data) return Boolean;
 962    --  Returns True if Left and Right are the same naming scheme
 963    --  not considering Specs and Bodies.
 964
 965    type Project_List is new Nat;
 966    Empty_Project_List : constant Project_List := 0;
 967    --  A list of project files
 968
 969    type Project_Element is record
 970       Project : Project_Id   := No_Project;
 971       Next    : Project_List := Empty_Project_List;
 972    end record;
 973    --  Element in a list of project files. Next is the id of the next
 974    --  project file in the list.
 975
 976    package Project_List_Table is new GNAT.Dynamic_Tables
 977      (Table_Component_Type => Project_Element,
 978       Table_Index_Type     => Project_List,
 979       Table_Low_Bound      => 1,
 980       Table_Initial        => 100,
 981       Table_Increment      => 100);
 982    --  The table that contains the lists of project files
 983
 984    type Response_File_Format is
 985      (None,
 986       GNU,
 987       Object_List,
 988       Option_List);
 989    --  The format of the different response files
 990
 991    type Project_Configuration is record
 992       Target                        : Name_Id         := No_Name;
 993       --  The target of the configuration, when specified
 994
 995       Run_Path_Option               : Name_List_Index := No_Name_List;
 996       --  The option to use when linking to specify the path where to look for
 997       --  libraries.
 998
 999       Separate_Run_Path_Options     : Boolean := False;
1000       --  True if each directory needs to be specified in a separate run path
1001       --  option.
1002
1003       Executable_Suffix             : Name_Id         := No_Name;
1004       --  The suffix of executables, when specified in the configuration or in
1005       --  package Builder of the main project. When this is not specified, the
1006       --  executable suffix is the default for the platform.
1007
1008       --  Linking
1009
1010       Linker                        : Path_Name_Type  := No_Path;
1011       --  Path name of the linker driver. Specified in the configuration or in
1012       --  the package Builder of the main project.
1013
1014       Map_File_Option               : Name_Id := No_Name;
1015       --  Option to use when invoking the linker to build a map file
1016
1017       Minimum_Linker_Options        : Name_List_Index := No_Name_List;
1018       --  The minimum options for the linker driver. Specified in the
1019       --  configuration.
1020
1021       Linker_Executable_Option      : Name_List_Index := No_Name_List;
1022       --  The option(s) to indicate the name of the executable in the linker
1023       --  command. Specified in the configuration. When not specified, default
1024       --  to -o <executable name>.
1025
1026       Linker_Lib_Dir_Option         : Name_Id         := No_Name;
1027       --  The option to specify where to find a library for linking. Specified
1028       --  in the configuration. When not specified, defaults to "-L".
1029
1030       Linker_Lib_Name_Option        : Name_Id         := No_Name;
1031       --  The option to specify the name of a library for linking. Specified in
1032       --  the configuration. When not specified, defaults to "-l".
1033
1034       Max_Command_Line_Length       : Natural         := 0;
1035       --  When positive and when Resp_File_Format (see below) is not None,
1036       --  if the command line for the invocation of the linker would be greater
1037       --  than this value, a response file is used to invoke the linker.
1038
1039       Resp_File_Format              : Response_File_Format := None;
1040       --  The format of a response file, when linking with a response file is
1041       --  supported.
1042
1043       Resp_File_Options             : Name_List_Index := No_Name_List;
1044       --  The switches, if any, that precede the path name of the response
1045       --  file in the invocation of the linker.
1046
1047       --  Libraries
1048
1049       Library_Builder               : Path_Name_Type  := No_Path;
1050       --  The executable to build library (specified in the configuration)
1051
1052       Lib_Support                   : Library_Support := None;
1053       --  The level of library support. Specified in the configuration. Support
1054       --  is none, static libraries only or both static and shared libraries.
1055
1056       Archive_Builder               : Name_List_Index := No_Name_List;
1057       --  The name of the executable to build archives, with the minimum
1058       --  switches. Specified in the configuration.
1059
1060       Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
1061       --  The options to append object files to an archive
1062
1063       Archive_Indexer               : Name_List_Index := No_Name_List;
1064       --  The name of the executable to index archives, with the minimum
1065       --  switches. Specified in the configuration.
1066
1067       Archive_Suffix                : File_Name_Type  := No_File;
1068       --  The suffix of archives. Specified in the configuration. When not
1069       --  specified, defaults to ".a".
1070
1071       Lib_Partial_Linker            : Name_List_Index := No_Name_List;
1072
1073       --  Shared libraries
1074
1075       Shared_Lib_Driver             : File_Name_Type  := No_File;
1076       --  The driver to link shared libraries. Set with attribute Library_GCC.
1077       --  Default to gcc.
1078
1079       Shared_Lib_Prefix             : File_Name_Type  := No_File;
1080       --  Part of a shared library file name that precedes the name of the
1081       --  library. Specified in the configuration. When not specified, defaults
1082       --  to "lib".
1083
1084       Shared_Lib_Suffix             : File_Name_Type  := No_File;
1085       --  Suffix of shared libraries, after the library name in the shared
1086       --  library name. Specified in the configuration. When not specified,
1087       --  default to ".so".
1088
1089       Shared_Lib_Min_Options        : Name_List_Index := No_Name_List;
1090       --  The minimum options to use when building a shared library
1091
1092       Lib_Version_Options           : Name_List_Index := No_Name_List;
1093       --  The options to use to specify a library version
1094
1095       Symbolic_Link_Supported       : Boolean         := False;
1096       --  True if the platform supports symbolic link files
1097
1098       Lib_Maj_Min_Id_Supported      : Boolean         := False;
1099       --  True if platform supports library major and minor options, such as
1100       --  libname.so -> libname.so.2 -> libname.so.2.4
1101
1102       Auto_Init_Supported           : Boolean         := False;
1103       --  True if automatic initialisation is supported for shared stand-alone
1104       --  libraries.
1105    end record;
1106
1107    Default_Project_Config : constant Project_Configuration :=
1108                               (Target                        => No_Name,
1109                                Run_Path_Option               => No_Name_List,
1110                                Separate_Run_Path_Options     => False,
1111                                Executable_Suffix             => No_Name,
1112                                Linker                        => No_Path,
1113                                Map_File_Option               => No_Name,
1114                                Minimum_Linker_Options        => No_Name_List,
1115                                Linker_Executable_Option      => No_Name_List,
1116                                Linker_Lib_Dir_Option         => No_Name,
1117                                Linker_Lib_Name_Option        => No_Name,
1118                                Library_Builder               => No_Path,
1119                                Max_Command_Line_Length       => 0,
1120                                Resp_File_Format              => None,
1121                                Resp_File_Options             => No_Name_List,
1122                                Lib_Support                   => None,
1123                                Archive_Builder               => No_Name_List,
1124                                Archive_Builder_Append_Option => No_Name_List,
1125                                Archive_Indexer               => No_Name_List,
1126                                Archive_Suffix                => No_File,
1127                                Lib_Partial_Linker            => No_Name_List,
1128                                Shared_Lib_Driver             => No_File,
1129                                Shared_Lib_Prefix             => No_File,
1130                                Shared_Lib_Suffix             => No_File,
1131                                Shared_Lib_Min_Options        => No_Name_List,
1132                                Lib_Version_Options           => No_Name_List,
1133                                Symbolic_Link_Supported       => False,
1134                                Lib_Maj_Min_Id_Supported      => False,
1135                                Auto_Init_Supported           => False);
1136
1137    --  The following record describes a project file representation
1138
1139    --  Note that it is not specified if the path names of directories (source,
1140    --  object, library or exec directories) end with or without a directory
1141    --  separator.
1142
1143    type Project_Data is record
1144
1145       -------------
1146       -- General --
1147       -------------
1148
1149       Name : Name_Id := No_Name;
1150       --  The name of the project
1151
1152       Display_Name : Name_Id := No_Name;
1153       --  The name of the project with the spelling of its declaration
1154
1155       Qualifier : Project_Qualifier := Unspecified;
1156       --  The eventual qualifier for this project
1157
1158       Externally_Built : Boolean := False;
1159       --  True if the project is externally built. In such case, the Project
1160       --  Manager will not modify anything in this project.
1161
1162       Config : Project_Configuration;
1163
1164       Path : Path_Information := No_Path_Information;
1165       --  The path name of the project file
1166
1167       Virtual : Boolean := False;
1168       --  True for virtual extending projects
1169
1170       Location : Source_Ptr := No_Location;
1171       --  The location in the project file source of the reserved word project
1172
1173       Naming : Naming_Data := Standard_Naming_Data;
1174       --  The naming scheme of this project file
1175
1176       ---------------
1177       -- Languages --
1178       ---------------
1179
1180       Languages : Name_List_Index := No_Name_List;
1181       --  The list of languages of the sources of this project
1182       --  mode: Ada_Only
1183
1184       Include_Language : Language_Index := No_Language_Index;
1185
1186       First_Language_Processing : Language_Index := No_Language_Index;
1187       --  First index of the language data in the project.
1188       --  This is an index into the project_tree_data.languages_data
1189       --  mode: Multi_Language
1190
1191       --------------
1192       -- Projects --
1193       --------------
1194
1195       Mains : String_List_Id := Nil_String;
1196       --  List of mains specified by attribute Main
1197
1198       Extends : Project_Id := No_Project;
1199       --  The reference of the project file, if any, that this project file
1200       --  extends.
1201
1202       Extended_By : Project_Id := No_Project;
1203       --  The reference of the project file, if any, that extends this project
1204       --  file.
1205
1206       Decl : Declarations := No_Declarations;
1207       --  The declarations (variables, attributes and packages) of this project
1208       --  file.
1209
1210       Imported_Projects : Project_List := Empty_Project_List;
1211       --  The list of all directly imported projects, if any
1212
1213       All_Imported_Projects : Project_List := Empty_Project_List;
1214       --  The list of all projects imported directly or indirectly, if any
1215
1216       -----------------
1217       -- Directories --
1218       -----------------
1219
1220       Directory : Path_Information := No_Path_Information;
1221       --  Path name of the directory where the project file resides
1222
1223       Dir_Path : String_Access;
1224       --  Same as Directory.Name, but as an access to String
1225
1226       Object_Directory : Path_Information := No_Path_Information;
1227       --  The path name of the object directory of this project file
1228
1229       Exec_Directory : Path_Information := No_Path_Information;
1230       --  The path name of the exec directory of this project file. Default is
1231       --  equal to Object_Directory.
1232
1233       -------------
1234       -- Library --
1235       -------------
1236
1237       Library : Boolean := False;
1238       --  True if this is a library project
1239
1240       Library_Name : Name_Id := No_Name;
1241       --  If a library project, name of the library
1242
1243       Library_Kind : Lib_Kind := Static;
1244       --  If a library project, kind of library
1245
1246       Library_Dir : Path_Information := No_Path_Information;
1247       --  If a library project, path name of the directory where the library
1248       --  resides.
1249
1250       Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1251       --  The timestamp of a library file in a library project
1252
1253       Library_Src_Dir : Path_Information := No_Path_Information;
1254       --  If a Stand-Alone Library project, path name of the directory where
1255       --  the sources of the interfaces of the library are copied. By default,
1256       --  if attribute Library_Src_Dir is not specified, sources of the
1257       --  interfaces are not copied anywhere.
1258
1259       Library_ALI_Dir : Path_Information := No_Path_Information;
1260       --  In a library project, path name of the directory where the ALI files
1261       --  are copied. If attribute Library_ALI_Dir is not specified, ALI files
1262       --  are copied in the Library_Dir.
1263
1264       Lib_Internal_Name : Name_Id := No_Name;
1265       --  If a library project, internal name store inside the library
1266
1267       Standalone_Library : Boolean := False;
1268       --  Indicate that this is a Standalone Library Project File
1269
1270       Lib_Interface_ALIs : String_List_Id := Nil_String;
1271       --  For Standalone Library Project Files, indicate the list of Interface
1272       --  ALI files.
1273
1274       Lib_Auto_Init : Boolean := False;
1275       --  For non static Stand-Alone Library Project Files, indicate if
1276       --  the library initialisation should be automatic.
1277
1278       Symbol_Data : Symbol_Record := No_Symbols;
1279       --  Symbol file name, reference symbol file name, symbol policy
1280
1281       Need_To_Build_Lib : Boolean := False;
1282       --  Indicates that the library of a Library Project needs to be built or
1283       --  rebuilt.
1284
1285       -------------
1286       -- Sources --
1287       -------------
1288
1289       Ada_Sources_Present : Boolean := True;
1290       --  True if there are Ada sources in the project
1291
1292       Other_Sources_Present : Boolean := True;
1293       --  True if there are non-Ada sources in the project
1294
1295       Ada_Sources : String_List_Id := Nil_String;
1296       --  The list of all the Ada source file names (gnatmake only)
1297
1298       First_Source : Source_Id := No_Source;
1299       Last_Source  : Source_Id := No_Source;
1300       --  Head and tail of the list of sources
1301
1302       Interfaces_Defined      : Boolean := False;
1303       --  True if attribute Interfaces is declared for the project or any
1304       --  project it extends.
1305
1306       Imported_Directories_Switches : Argument_List_Access := null;
1307       --  List of the source search switches (-I<source dir>) to be used when
1308       --  compiling.
1309
1310       Include_Path : String_Access := null;
1311       --  The search source path for the project. Used as the value for an
1312       --  environment variable, specified by attribute Include_Path
1313       --  (<language>). The names of the environment variables are in component
1314       --  Include_Path of the records Language_Config.
1315
1316       Include_Path_File : Path_Name_Type := No_Path;
1317       --  The path name of the of the source search directory file
1318
1319       Include_Data_Set : Boolean := False;
1320       --  Set True when Imported_Directories_Switches or Include_Path are set
1321
1322       Source_Dirs : String_List_Id := Nil_String;
1323       --  The list of all the source directories
1324
1325       Known_Order_Of_Source_Dirs : Boolean := True;
1326       --  False, if there is any /** in the Source_Dirs, because in this case
1327       --  the ordering of the source subdirs depend on the OS. If True,
1328       --  duplicate file names in the same project file are allowed.
1329
1330       Ada_Include_Path : String_Access := null;
1331       --  The cached value of source search path for this project file. Set by
1332       --  the first call to Prj.Env.Ada_Include_Path for the project. Do not
1333       --  use this field directly outside of the project manager, use
1334       --  Prj.Env.Ada_Include_Path instead.
1335
1336       -------------------
1337       -- Miscellaneous --
1338       -------------------
1339
1340       Ada_Objects_Path : String_Access := null;
1341       --  The cached value of ADA_OBJECTS_PATH for this project file. Do not
1342       --  use this field directly outside of the compiler, use
1343       --  Prj.Env.Ada_Objects_Path instead.
1344
1345       Libgnarl_Needed : Yes_No_Unknown := Unknown;
1346       --  Set to True when libgnarl is needed to link
1347
1348       Objects_Path : String_Access := null;
1349       --  The cached value of the object dir path, used during the binding
1350       --  phase of gprbuild.
1351
1352       Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1353       --  The cached value of the object path temp file (including library
1354       --  dirs) for this project file.
1355
1356       Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1357       --  The cached value of the object path temp file (excluding library
1358       --  dirs) for this project file.
1359
1360       Config_File_Name : Path_Name_Type := No_Path;
1361       --  The path name of the configuration pragmas file, if any
1362
1363       Config_File_Temp : Boolean := False;
1364       --  An indication that the configuration pragmas file is a temporary file
1365       --  that must be deleted at the end.
1366
1367       Config_Checked : Boolean := False;
1368       --  A flag to avoid checking repetitively the configuration pragmas file
1369
1370       Checked : Boolean := False;
1371       --  A flag to avoid checking repetitively the naming scheme of this
1372       --  project file.
1373
1374       Seen : Boolean := False;
1375       --  A flag to mark a project as "visited" to avoid processing the same
1376       --  project several time.
1377
1378       Depth : Natural := 0;
1379       --  The maximum depth of a project in the project graph. Depth of main
1380       --  project is 0.
1381
1382       Unkept_Comments : Boolean := False;
1383       --  True if there are comments in the project sources that cannot be kept
1384       --  in the project tree.
1385
1386    end record;
1387
1388    function Empty_Project (Tree : Project_Tree_Ref) return Project_Data;
1389    --  Return the representation of an empty project in project Tree tree.
1390    --  The project tree Tree must have been Initialized and/or Reset.
1391
1392    function Is_Extending
1393      (Extending : Project_Id;
1394       Extended  : Project_Id;
1395       In_Tree   : Project_Tree_Ref) return Boolean;
1396    --  ??? needs comment
1397
1398    function Is_A_Language
1399      (Tree          : Project_Tree_Ref;
1400       Data          : Project_Data;
1401       Language_Name : Name_Id) return Boolean;
1402    --  Return True when Language_Name (which must be lower case) is one of the
1403    --  languages used for the project.
1404
1405    Project_Error : exception;
1406    --  Raised by some subprograms in Prj.Attr
1407
1408    package Project_Table is new GNAT.Dynamic_Tables (
1409      Table_Component_Type => Project_Data,
1410      Table_Index_Type     => Project_Id,
1411      Table_Low_Bound      => 1,
1412      Table_Initial        => 100,
1413      Table_Increment      => 100);
1414    --  The set of all project files
1415
1416    type Spec_Or_Body is (Specification, Body_Part);
1417
1418    type File_Name_Data is record
1419       Name         : File_Name_Type   := No_File;
1420       Index        : Int              := 0;
1421       Display_Name : File_Name_Type   := No_File;
1422       Path         : Path_Information := No_Path_Information;
1423       Project      : Project_Id       := No_Project;
1424       Needs_Pragma : Boolean          := False;
1425    end record;
1426    --  File and Path name of a spec or body
1427
1428    type File_Names_Data is array (Spec_Or_Body) of File_Name_Data;
1429
1430    type Unit_Index is new Nat;
1431    No_Unit_Index : constant Unit_Index := 0;
1432    type Unit_Data is record
1433       Name       : Name_Id    := No_Name;
1434       File_Names : File_Names_Data;
1435    end record;
1436    --  Name and File and Path names of a unit, with a reference to its
1437    --  GNAT Project File(s).
1438
1439    package Unit_Table is new GNAT.Dynamic_Tables
1440      (Table_Component_Type => Unit_Data,
1441       Table_Index_Type     => Unit_Index,
1442       Table_Low_Bound      => 1,
1443       Table_Initial        => 100,
1444       Table_Increment      => 100);
1445    --  Table of all units in a project tree
1446
1447    package Units_Htable is new Simple_HTable
1448      (Header_Num => Header_Num,
1449       Element    => Unit_Index,
1450       No_Element => No_Unit_Index,
1451       Key        => Name_Id,
1452       Hash       => Hash,
1453       Equal      => "=");
1454    --  Mapping of unit names to indexes in the Units table
1455
1456    type Unit_Project is record
1457       Unit    : Unit_Index := No_Unit_Index;
1458       Project : Project_Id := No_Project;
1459    end record;
1460
1461    No_Unit_Project : constant Unit_Project := (No_Unit_Index, No_Project);
1462
1463    package Files_Htable is new Simple_HTable
1464      (Header_Num => Header_Num,
1465       Element    => Unit_Project,
1466       No_Element => No_Unit_Project,
1467       Key        => File_Name_Type,
1468       Hash       => Hash,
1469       Equal      => "=");
1470    --  Mapping of file names to indexes in the Units table
1471
1472    type Private_Project_Tree_Data is private;
1473    --  Data for a project tree that is used only by the Project Manager
1474
1475    type Project_Tree_Data is
1476       record
1477          --  Languages and sources of the project
1478
1479          First_Language : Language_Index  := No_Language_Index;
1480          --
1481
1482          First_Source : Source_Id := No_Source;
1483          --
1484
1485          --  Tables
1486
1487          Languages_Data    : Language_Data_Table.Instance;
1488          Name_Lists        : Name_List_Table.Instance;
1489          String_Elements   : String_Element_Table.Instance;
1490          Variable_Elements : Variable_Element_Table.Instance;
1491          Array_Elements    : Array_Element_Table.Instance;
1492          Arrays            : Array_Table.Instance;
1493          Packages          : Package_Table.Instance;
1494          Project_Lists     : Project_List_Table.Instance;
1495          Projects          : Project_Table.Instance;
1496          Sources           : Source_Data_Table.Instance;
1497          Alt_Langs         : Alternate_Language_Table.Instance;
1498          Units             : Unit_Table.Instance;
1499          Units_HT          : Units_Htable.Instance;
1500          Files_HT          : Files_Htable.Instance;
1501          Source_Paths_HT   : Source_Paths_Htable.Instance;
1502          Unit_Sources_HT   : Unit_Sources_Htable.Instance;
1503
1504          --  Private part
1505
1506          Private_Part : Private_Project_Tree_Data;
1507       end record;
1508    --  Data for a project tree
1509
1510    type Put_Line_Access is access procedure
1511      (Line    : String;
1512       Project : Project_Id;
1513       In_Tree : Project_Tree_Ref);
1514    --  Use to customize error reporting in Prj.Proc and Prj.Nmsc
1515
1516    procedure Expect (The_Token : Token_Type; Token_Image : String);
1517    --  Check that the current token is The_Token. If it is not, then output
1518    --  an error message.
1519
1520    procedure Initialize (Tree : Project_Tree_Ref);
1521    --  This procedure must be called before using any services from the Prj
1522    --  hierarchy. Namet.Initialize must be called before Prj.Initialize.
1523
1524    procedure Reset (Tree : Project_Tree_Ref);
1525    --  This procedure resets all the tables that are used when processing a
1526    --  project file tree. Initialize must be called before the call to Reset.
1527
1528    procedure Register_Default_Naming_Scheme
1529      (Language            : Name_Id;
1530       Default_Spec_Suffix : File_Name_Type;
1531       Default_Body_Suffix : File_Name_Type;
1532       In_Tree             : Project_Tree_Ref);
1533    --  Register the default suffixes for a given language. These extensions
1534    --  will be ignored if the user has specified a new naming scheme in a
1535    --  project file.
1536    --
1537    --  Otherwise, this information will be automatically added to Naming_Data
1538    --  when a project is processed, in the lists Spec_Suffix and Body_Suffix.
1539
1540    generic
1541       type State is limited private;
1542       with procedure Action
1543         (Project    : Project_Id;
1544          With_State : in out State);
1545    procedure For_Every_Project_Imported
1546      (By         : Project_Id;
1547       In_Tree    : Project_Tree_Ref;
1548       With_State : in out State);
1549    --  Call Action for each project imported directly or indirectly by project
1550    --  By. Action is called according to the order of importation: if A
1551    --  imports B, directly or indirectly, Action will be called for A before
1552    --  it is called for B. If two projects import each other directly or
1553    --  indirectly (using at least one "limited with"), it is not specified
1554    --  for which of these two projects Action will be called first. Projects
1555    --  that are extended by other projects are not considered. With_State may
1556    --  be used by Action to choose a behavior or to report some global result.
1557
1558    function Extend_Name
1559      (File        : File_Name_Type;
1560       With_Suffix : String) return File_Name_Type;
1561    --  Replace the extension of File with With_Suffix
1562
1563    function Object_Name
1564      (Source_File_Name   : File_Name_Type;
1565       Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1566    --  Returns the object file name corresponding to a source file name
1567
1568    function Dependency_Name
1569      (Source_File_Name : File_Name_Type;
1570       Dependency       : Dependency_File_Kind) return File_Name_Type;
1571    --  Returns the dependency file name corresponding to a source file name
1572
1573    function Switches_Name
1574      (Source_File_Name : File_Name_Type) return File_Name_Type;
1575    --  Returns the switches file name corresponding to a source file name
1576
1577    ----------------
1578    -- Temp Files --
1579    ----------------
1580
1581    procedure Record_Temp_File (Path : Path_Name_Type);
1582    --  Record the path of a newly created temporary file, so that it can be
1583    --  deleted later.
1584
1585    procedure Delete_All_Temp_Files;
1586    --  Delete all recorded temporary files
1587
1588 private
1589
1590    All_Packages : constant String_List_Access := null;
1591
1592    No_Project_Tree : constant Project_Tree_Ref := null;
1593
1594    Ignored : constant Variable_Kind := Single;
1595
1596    Nil_Variable_Value : constant Variable_Value :=
1597                           (Project  => No_Project,
1598                            Kind     => Undefined,
1599                            Location => No_Location,
1600                            Default  => False);
1601
1602    Virtual_Prefix : constant String := "v$";
1603    --  The prefix for virtual extending projects. Because of the '$', which is
1604    --  normally forbidden for project names, there cannot be any name clash.
1605
1606    Empty_Name : Name_Id;
1607    --  Name_Id for an empty name (no characters). Initialized in procedure
1608    --  Initialize.
1609
1610    Empty_File_Name : File_Name_Type;
1611    --  Empty File_Name_Type (no characters). Initialized in procedure
1612    --  Initialize.
1613
1614    procedure Add_To_Buffer
1615      (S    : String;
1616       To   : in out String_Access;
1617       Last : in out Natural);
1618    --  Append a String to the Buffer
1619
1620    type Naming_Id is new Nat;
1621
1622    package Naming_Table is new GNAT.Dynamic_Tables
1623      (Table_Component_Type => Naming_Data,
1624       Table_Index_Type     => Naming_Id,
1625       Table_Low_Bound      => 1,
1626       Table_Initial        => 5,
1627       Table_Increment      => 100);
1628    --  Table storing the naming data for gnatmake/gprmake
1629
1630    package Path_File_Table is new GNAT.Dynamic_Tables
1631      (Table_Component_Type => Path_Name_Type,
1632       Table_Index_Type     => Natural,
1633       Table_Low_Bound      => 1,
1634       Table_Initial        => 50,
1635       Table_Increment      => 100);
1636    --  Table storing all the temp path file names.
1637    --  Used by Delete_All_Path_Files.
1638
1639    package Source_Path_Table is new GNAT.Dynamic_Tables
1640      (Table_Component_Type => Name_Id,
1641       Table_Index_Type     => Natural,
1642       Table_Low_Bound      => 1,
1643       Table_Initial        => 50,
1644       Table_Increment      => 100);
1645    --  A table to store the source dirs before creating the source path file
1646
1647    package Object_Path_Table is new GNAT.Dynamic_Tables
1648      (Table_Component_Type => Path_Name_Type,
1649       Table_Index_Type     => Natural,
1650       Table_Low_Bound      => 1,
1651       Table_Initial        => 50,
1652       Table_Increment      => 100);
1653    --  A table to store the object dirs, before creating the object path file
1654
1655    type Private_Project_Tree_Data is record
1656       Namings        : Naming_Table.Instance;
1657       Path_Files     : Path_File_Table.Instance;
1658       Source_Paths   : Source_Path_Table.Instance;
1659       Object_Paths   : Object_Path_Table.Instance;
1660       Default_Naming : Naming_Data;
1661    end record;
1662    --  Type to represent the part of a project tree which is private to the
1663    --  Project Manager.
1664
1665 end Prj;