gcc/ada/prj.ads

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