1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2009, Free Software Foundation, Inc. --
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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- The following package declares the data types for GNAT project.
27 -- These data types may be used by GNAT Project-aware tools.
29 -- Children of these package implements various services on these data types.
30 -- See in particular Prj.Pars and Prj.Env.
32 with Casing; use Casing;
33 with Namet; use Namet;
34 with Scans; use Scans;
35 with Types; use Types;
37 with GNAT.Dynamic_HTables; use GNAT.Dynamic_HTables;
38 with GNAT.Dynamic_Tables;
39 with GNAT.OS_Lib; use GNAT.OS_Lib;
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.
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.
51 Subdirs : String_Ptr := null;
52 -- The value after the equal sign in switch --subdirs=...
53 -- Contains the relative subdirectory.
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
60 -- - Full: Library Project Files are supported for static and dynamic
61 -- (shared) libraries.
63 type Yes_No_Unknown is (Yes, No, Unknown);
64 -- Tri-state to decide if -lgnarl is needed when linking
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
70 type Project_Qualifier is
77 -- Qualifiers that can prefix the reserved word "project" in a project
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 ...
85 function Get_Mode return Mode;
86 pragma Inline (Get_Mode);
88 procedure Set_Mode (New_Mode : Mode);
89 pragma Inline (Set_Mode);
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.
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.
102 function In_Configuration return Boolean;
103 pragma Inline (In_Configuration);
105 procedure Set_In_Configuration (Value : Boolean);
106 pragma Inline (Set_In_Configuration);
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.
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
117 No_Project_Tree : constant Project_Tree_Ref;
119 procedure Free (Tree : in out Project_Tree_Ref);
120 -- Free memory associated with the tree
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.
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.
132 function Slash return Path_Name_Type;
133 pragma Inline (Slash);
134 -- "/", used as the path of locally removed files
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.
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.
146 -- When the situation occurs, the behaviour depends on the setting:
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
152 function Empty_File return File_Name_Type;
153 function Empty_String return Name_Id;
154 -- Return the id for an empty string ""
156 type Path_Information is record
157 Name : Path_Name_Type := No_Path;
158 Display_Name : Path_Name_Type := No_Path;
161 No_Path_Information : constant Path_Information := (No_Path, No_Path);
163 type Project_Id is new Nat;
164 No_Project : constant Project_Id := 0;
165 -- Id of a Project File
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;
172 Display_Value : Name_Id := No_Name;
173 Location : Source_Ptr := No_Location;
174 Flag : Boolean := False;
175 Next : String_List_Id := Nil_String;
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).
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
189 type Variable_Kind is (Undefined, List, Single);
190 -- Different kinds of variables
192 subtype Defined_Variable_Kind is Variable_Kind range List .. Single;
193 -- The defined kinds of variables
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).
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;
207 Values : String_List_Id := Nil_String;
209 Value : Name_Id := No_Name;
213 -- Values for variables and array elements. Default is True if the
214 -- current value is the default one for the variable
216 Nil_Variable_Value : constant Variable_Value;
217 -- Value of a non existing variable or array element
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;
224 Value : Variable_Value;
226 -- To hold the list of variables in a project file and in packages
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
236 type Array_Element_Id is new Nat;
237 No_Array_Element : constant Array_Element_Id := 0;
238 type Array_Element is record
240 Src_Index : Int := 0;
241 Index_Case_Sensitive : Boolean := True;
242 Value : Variable_Value;
243 Next : Array_Element_Id := No_Array_Element;
245 -- Each Array_Element represents an array element and is linked (Next)
246 -- to the next array element, if any, in the array.
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
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;
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.
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
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;
284 -- Contains the declarations (variables, single and array attributes,
285 -- packages) for a project or a package in a project.
287 No_Declarations : constant Declarations :=
288 (Variables => No_Variable,
289 Attributes => No_Variable,
291 Packages => No_Package);
292 -- Default value of Declarations: indicates that there is no declarations
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;
300 -- A package (includes declarations that may include other packages)
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
311 type Language_Ptr is access all Language_Data;
312 -- Index of language data
314 No_Language_Index : constant Language_Ptr := null;
315 -- Constant indicating that there is no language data
317 Max_Header_Num : constant := 6150;
318 type Header_Num is range 0 .. Max_Header_Num;
319 -- Size for hash table below. The upper bound is an arbitrary value, the
320 -- value here was chosen after testing to determine a good compromise
321 -- between speed of access and memory usage.
323 function Hash (Name : Name_Id) return Header_Num;
324 function Hash (Name : File_Name_Type) return Header_Num;
325 function Hash (Name : Path_Name_Type) return Header_Num;
326 -- Used for computing hash values for names put into above hash table
328 function Hash (Project : Project_Id) return Header_Num;
329 -- Used for hash tables where Project_Id is the Key
331 type Language_Kind is (File_Based, Unit_Based);
332 -- Type for the kind of language. All languages are file based, except Ada
333 -- which is unit based.
335 type Dependency_File_Kind is (None, Makefile, ALI_File);
336 -- Type of dependency to be checked: no dependency file, Makefile fragment
337 -- or ALI file (for Ada).
339 Makefile_Dependency_Suffix : constant String := ".d";
340 ALI_Dependency_Suffix : constant String := ".ali";
342 Switches_Dependency_Suffix : constant String := ".cswi";
344 Binder_Exchange_Suffix : constant String := ".bexch";
345 -- Suffix for binder exchange files
347 Library_Exchange_Suffix : constant String := ".lexch";
348 -- Suffix for library exchange files
350 type Name_List_Index is new Nat;
351 No_Name_List : constant Name_List_Index := 0;
353 type Name_Node is record
354 Name : Name_Id := No_Name;
355 Next : Name_List_Index := No_Name_List;
358 package Name_List_Table is new GNAT.Dynamic_Tables
359 (Table_Component_Type => Name_Node,
360 Table_Index_Type => Name_List_Index,
361 Table_Low_Bound => 1,
363 Table_Increment => 100);
364 -- The table for lists of names used in package Language_Processing
366 package Mapping_Files_Htable is new Simple_HTable
367 (Header_Num => Header_Num,
368 Element => Path_Name_Type,
369 No_Element => No_Path,
370 Key => Path_Name_Type,
373 -- A hash table to store the mapping files that are not used
375 type Lang_Naming_Data is record
376 Dot_Replacement : File_Name_Type := No_File;
377 -- The string to replace '.' in the source file name (for Ada)
379 Casing : Casing_Type := All_Lower_Case;
380 -- The casing of the source file name (for Ada)
382 Separate_Suffix : File_Name_Type := No_File;
383 -- String to append to unit name for source file name of an Ada subunit
385 Spec_Suffix : File_Name_Type := No_File;
386 -- The string to append to the unit name for the
387 -- source file name of a spec.
389 Body_Suffix : File_Name_Type := No_File;
390 -- The string to append to the unit name for the
391 -- source file name of a body.
394 No_Lang_Naming_Data : constant Lang_Naming_Data :=
395 (Dot_Replacement => No_File,
396 Casing => All_Lower_Case,
397 Separate_Suffix => No_File,
398 Spec_Suffix => No_File,
399 Body_Suffix => No_File);
401 type Source_Id is new Nat;
403 No_Source : constant Source_Id := 0;
405 type Path_Syntax_Kind is
410 -- Host specific syntax, for example on VMS (the default)
412 type Language_Config is record
413 Kind : Language_Kind := File_Based;
414 -- Kind of language. All languages are file based, except Ada which is
417 Naming_Data : Lang_Naming_Data;
418 -- The naming data for the languages (prefixes, etc.)
420 Include_Compatible_Languages : Name_List_Index := No_Name_List;
421 -- The list of languages that are "include compatible" with this
422 -- language. A language B (for example "C") is "include compatible" with
423 -- a language A (for example "C++") if it is expected that sources of
424 -- language A may "include" header files from language B.
426 Compiler_Driver : File_Name_Type := No_File;
427 -- The name of the executable for the compiler of the language
429 Compiler_Driver_Path : String_Access := null;
430 -- The path name of the executable for the compiler of the language
432 Compiler_Required_Switches : Name_List_Index := No_Name_List;
433 -- The list of switches that are required as a minimum to invoke the
436 Path_Syntax : Path_Syntax_Kind := Host;
437 -- Value may be Canonical (Unix style) or Host (host syntax, for example
438 -- on VMS for DEC C).
440 Object_File_Suffix : Name_Id := No_Name;
442 Compilation_PIC_Option : Name_List_Index := No_Name_List;
443 -- The option(s) to compile a source in Position Independent Code for
444 -- shared libraries. Specified in the configuration. When not specified,
445 -- there is no need for such switch.
447 Object_Generated : Boolean := True;
448 -- False in no object file is generated
450 Objects_Linked : Boolean := True;
451 -- False if object files are not use to link executables and build
454 Runtime_Library_Dir : Name_Id := No_Name;
455 -- Path name of the runtime library directory, if any
457 Runtime_Source_Dir : Name_Id := No_Name;
458 -- Path name of the runtime source directory, if any
460 Mapping_File_Switches : Name_List_Index := No_Name_List;
461 -- The option(s) to provide a mapping file to the compiler. Specified in
462 -- the configuration. When value is No_Name_List, there is no mapping
465 Mapping_Spec_Suffix : File_Name_Type := No_File;
466 -- Placeholder representing the spec suffix in a mapping file
468 Mapping_Body_Suffix : File_Name_Type := No_File;
469 -- Placeholder representing the body suffix in a mapping file
471 Config_File_Switches : Name_List_Index := No_Name_List;
472 -- The option(s) to provide a config file to the compiler. Specified in
473 -- the configuration. When value is No_Name_List, there is no config
476 Dependency_Kind : Dependency_File_Kind := None;
477 -- The kind of dependency to be checked: none, Makefile fragment or
478 -- ALI file (for Ada).
480 Dependency_Option : Name_List_Index := No_Name_List;
481 -- The option(s) to be used to create the dependency file. When value is
482 -- No_Name_List, there is not such option(s).
484 Compute_Dependency : Name_List_Index := No_Name_List;
485 -- Hold the value of attribute Dependency_Driver, if declared for the
488 Include_Option : Name_List_Index := No_Name_List;
489 -- Hold the value of attribute Include_Switches, if declared for the
492 Include_Path : Name_Id := No_Name;
493 -- Name of environment variable declared by attribute Include_Path for
496 Include_Path_File : Name_Id := No_Name;
497 -- Name of environment variable declared by attribute Include_Path_File
500 Objects_Path : Name_Id := No_Name;
501 -- Name of environment variable declared by attribute Objects_Path for
504 Objects_Path_File : Name_Id := No_Name;
505 -- Name of environment variable declared by attribute Objects_Path_File
508 Config_Body : Name_Id := No_Name;
509 -- The template for a pragma Source_File_Name(_Project) for a specific
510 -- file name of a body.
512 Config_Spec : Name_Id := No_Name;
513 -- The template for a pragma Source_File_Name(_Project) for a specific
514 -- file name of a spec.
516 Config_Body_Pattern : Name_Id := No_Name;
517 -- The template for a pragma Source_File_Name(_Project) for a naming
520 Config_Spec_Pattern : Name_Id := No_Name;
521 -- The template for a pragma Source_File_Name(_Project) for a naming
524 Config_File_Unique : Boolean := False;
525 -- Indicate if the config file specified to the compiler needs to be
526 -- unique. If it is unique, then all config files are concatenated into
527 -- a temp config file.
529 Binder_Driver : File_Name_Type := No_File;
530 -- The name of the binder driver for the language, if any
532 Binder_Driver_Path : Path_Name_Type := No_Path;
533 -- The path name of the binder driver
535 Binder_Required_Switches : Name_List_Index := No_Name_List;
536 -- Hold the value of attribute Binder'Required_Switches for the language
538 Binder_Prefix : Name_Id := No_Name;
539 -- Hold the value of attribute Binder'Prefix for the language
541 Toolchain_Version : Name_Id := No_Name;
542 -- Hold the value of attribute Toolchain_Version for the language
544 Toolchain_Description : Name_Id := No_Name;
545 -- Hold the value of attribute Toolchain_Description for the language
548 -- Record describing the configuration of a language
550 No_Language_Config : constant Language_Config :=
552 Naming_Data => No_Lang_Naming_Data,
553 Include_Compatible_Languages => No_Name_List,
554 Compiler_Driver => No_File,
555 Compiler_Driver_Path => null,
556 Compiler_Required_Switches => No_Name_List,
557 Path_Syntax => Canonical,
558 Object_File_Suffix => No_Name,
559 Compilation_PIC_Option => No_Name_List,
560 Object_Generated => True,
561 Objects_Linked => True,
562 Runtime_Library_Dir => No_Name,
563 Runtime_Source_Dir => No_Name,
564 Mapping_File_Switches => No_Name_List,
565 Mapping_Spec_Suffix => No_File,
566 Mapping_Body_Suffix => No_File,
567 Config_File_Switches => No_Name_List,
568 Dependency_Kind => Makefile,
569 Dependency_Option => No_Name_List,
570 Compute_Dependency => No_Name_List,
571 Include_Option => No_Name_List,
572 Include_Path => No_Name,
573 Include_Path_File => No_Name,
574 Objects_Path => No_Name,
575 Objects_Path_File => No_Name,
576 Config_Body => No_Name,
577 Config_Spec => No_Name,
578 Config_Body_Pattern => No_Name,
579 Config_Spec_Pattern => No_Name,
580 Config_File_Unique => False,
581 Binder_Driver => No_File,
582 Binder_Driver_Path => No_Path,
583 Binder_Required_Switches => No_Name_List,
584 Binder_Prefix => No_Name,
585 Toolchain_Version => No_Name,
586 Toolchain_Description => No_Name);
588 type Language_Data is record
589 Name : Name_Id := No_Name;
590 Display_Name : Name_Id := No_Name;
591 Config : Language_Config := No_Language_Config;
592 First_Source : Source_Id := No_Source;
593 Mapping_Files : Mapping_Files_Htable.Instance :=
594 Mapping_Files_Htable.Nil;
595 Next : Language_Ptr := No_Language_Index;
598 No_Language_Data : constant Language_Data :=
600 Display_Name => No_Name,
601 Config => No_Language_Config,
602 First_Source => No_Source,
603 Mapping_Files => Mapping_Files_Htable.Nil,
604 Next => No_Language_Index);
606 type Alternate_Language_Id is new Nat;
608 No_Alternate_Language : constant Alternate_Language_Id := 0;
610 type Alternate_Language_Data is record
611 Language : Language_Ptr := No_Language_Index;
612 Next : Alternate_Language_Id := No_Alternate_Language;
615 package Alternate_Language_Table is new GNAT.Dynamic_Tables
616 (Table_Component_Type => Alternate_Language_Data,
617 Table_Index_Type => Alternate_Language_Id,
618 Table_Low_Bound => 1,
620 Table_Increment => 100);
621 -- The table for storing the alternate languages of a header file that
622 -- is used for several languages.
624 type Source_Kind is (Spec, Impl, Sep);
626 type Source_Data is record
627 Project : Project_Id := No_Project;
628 -- Project of the source
630 Language : Language_Ptr := No_Language_Index;
631 -- Index of the language. This is an index into
632 -- project_tree.languages_data
634 Lang_Kind : Language_Kind := File_Based;
635 -- Kind of the language
637 Compiled : Boolean := True;
638 -- False when there is no compiler for the language
640 In_Interfaces : Boolean := True;
641 -- False when the source is not included in interfaces, when attribute
642 -- Interfaces is declared.
644 Declared_In_Interfaces : Boolean := False;
645 -- True when source is declared in attribute Interfaces
647 Alternate_Languages : Alternate_Language_Id := No_Alternate_Language;
648 -- List of languages a header file may also be, in addition of
649 -- language Language_Name.
651 Kind : Source_Kind := Spec;
652 -- Kind of the source: spec, body or subunit
654 Dependency : Dependency_File_Kind := None;
655 -- Kind of dependency: none, Makefile fragment or ALI file
657 Other_Part : Source_Id := No_Source;
658 -- Source ID for the other part, if any: for a spec, indicates its body;
659 -- for a body, indicates its spec.
661 Unit : Name_Id := No_Name;
662 -- Name of the unit, if language is unit based
665 -- Index of the source in a multi unit source file
667 Locally_Removed : Boolean := False;
668 -- True if the source has been "excluded"
670 Get_Object : Boolean := False;
671 -- Indicates that the object of the source should be put in the global
672 -- archive. This is for Ada, when only the closure of a main needs to
673 -- be compiled/recompiled.
675 Replaced_By : Source_Id := No_Source;
677 File : File_Name_Type := No_File;
678 -- Canonical file name of the source
680 Display_File : File_Name_Type := No_File;
681 -- File name of the source, for display purposes
683 Path : Path_Information := No_Path_Information;
684 -- Path name of the source
686 Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
687 -- Time stamp of the source file
689 Object_Project : Project_Id := No_Project;
690 -- Project where the object file is. This might be different from
691 -- Project when using extending project files.
693 Object_Exists : Boolean := True;
694 -- True if an object file exists
696 Object_Linked : Boolean := True;
697 -- False if the object file is not use to link executables or included
700 Object : File_Name_Type := No_File;
701 -- File name of the object file
703 Current_Object_Path : Path_Name_Type := No_Path;
704 -- Object path of an existing object file
706 Object_Path : Path_Name_Type := No_Path;
707 -- Object path of the real object file
709 Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
710 -- Object file time stamp
712 Dep_Name : File_Name_Type := No_File;
713 -- Dependency file simple name
715 Current_Dep_Path : Path_Name_Type := No_Path;
716 -- Path name of an existing dependency file
718 Dep_Path : Path_Name_Type := No_Path;
719 -- Path name of the real dependency file
721 Dep_TS : Time_Stamp_Type := Empty_Time_Stamp;
722 -- Dependency file time stamp
724 Switches : File_Name_Type := No_File;
725 -- File name of the switches file. For all languages, this is a file
726 -- that ends with the .cswi extension.
728 Switches_Path : Path_Name_Type := No_Path;
729 -- Path name of the switches file
731 Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
732 -- Switches file time stamp
734 Naming_Exception : Boolean := False;
735 -- True if the source has an exceptional name
737 Next_In_Sources : Source_Id := No_Source;
738 -- Link to another source in the project tree
740 Next_In_Project : Source_Id := No_Source;
741 -- Link to another source in the project
743 Next_In_Lang : Source_Id := No_Source;
744 -- Link to another source of the same language
747 No_Source_Data : constant Source_Data :=
748 (Project => No_Project,
749 Language => No_Language_Index,
750 Lang_Kind => File_Based,
752 In_Interfaces => True,
753 Declared_In_Interfaces => False,
754 Alternate_Languages => No_Alternate_Language,
757 Other_Part => No_Source,
760 Locally_Removed => False,
762 Replaced_By => No_Source,
764 Display_File => No_File,
765 Path => No_Path_Information,
766 Source_TS => Empty_Time_Stamp,
767 Object_Project => No_Project,
768 Object_Exists => True,
769 Object_Linked => True,
771 Current_Object_Path => No_Path,
772 Object_Path => No_Path,
773 Object_TS => Empty_Time_Stamp,
775 Current_Dep_Path => No_Path,
777 Dep_TS => Empty_Time_Stamp,
779 Switches_Path => No_Path,
780 Switches_TS => Empty_Time_Stamp,
781 Naming_Exception => False,
782 Next_In_Sources => No_Source,
783 Next_In_Project => No_Source,
784 Next_In_Lang => No_Source);
786 package Source_Data_Table is new GNAT.Dynamic_Tables
787 (Table_Component_Type => Source_Data,
788 Table_Index_Type => Source_Id,
789 Table_Low_Bound => 1,
790 Table_Initial => 1000,
791 Table_Increment => 100);
792 -- The table for the sources
794 package Source_Paths_Htable is new Simple_HTable
795 (Header_Num => Header_Num,
796 Element => Source_Id,
797 No_Element => No_Source,
798 Key => Path_Name_Type,
801 -- Mapping of source paths to source ids
803 package Unit_Sources_Htable is new Simple_HTable
804 (Header_Num => Header_Num,
805 Element => Source_Id,
806 No_Element => No_Source,
811 type Verbosity is (Default, Medium, High);
812 -- Verbosity when parsing GNAT Project Files
813 -- Default is default (very quiet, if no errors).
814 -- Medium is more verbose.
815 -- High is extremely verbose.
817 Current_Verbosity : Verbosity := Default;
818 -- The current value of the verbosity the project files are parsed with
820 type Lib_Kind is (Static, Dynamic, Relocatable);
822 type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
823 -- Type to specify the symbol policy, when symbol control is supported.
824 -- See full explanation about this type in package Symbols.
825 -- Autonomous: Create a symbol file without considering any reference
826 -- Compliant: Try to be as compatible as possible with an existing ref
827 -- Controlled: Fail if symbols are not the same as those in the reference
828 -- Restricted: Restrict the symbols to those in the symbol file
829 -- Direct: The symbol file is used as is
831 type Symbol_Record is record
832 Symbol_File : Path_Name_Type := No_Path;
833 Reference : Path_Name_Type := No_Path;
834 Symbol_Policy : Policy := Autonomous;
836 -- Type to keep the symbol data to be used when building a shared library
838 No_Symbols : constant Symbol_Record :=
839 (Symbol_File => No_Path,
840 Reference => No_Path,
841 Symbol_Policy => Autonomous);
842 -- The default value of the symbol data
844 function Image (Casing : Casing_Type) return String;
845 -- Similar to 'Image (but avoid use of this attribute in compiler)
847 function Value (Image : String) return Casing_Type;
848 -- Similar to 'Value (but avoid use of this attribute in compiler)
849 -- Raises Constraint_Error if not a Casing_Type image.
851 -- The following record contains data for a naming scheme
853 type Naming_Data is record
855 Dot_Replacement : File_Name_Type := No_File;
856 -- The string to replace '.' in the source file name (for Ada)
858 Casing : Casing_Type := All_Lower_Case;
859 -- The casing of the source file name (for Ada)
861 Spec_Suffix : Array_Element_Id := No_Array_Element;
862 -- The string to append to the unit name for the
863 -- source file name of a spec.
864 -- Indexed by the programming language.
866 Body_Suffix : Array_Element_Id := No_Array_Element;
867 -- The string to append to the unit name for the
868 -- source file name of a body.
869 -- Indexed by the programming language.
871 Separate_Suffix : File_Name_Type := No_File;
872 -- String to append to unit name for source file name of an Ada subunit
874 Specs : Array_Element_Id := No_Array_Element;
875 -- An associative array mapping individual specs to source file names
876 -- This is specific to unit-based languages.
878 Bodies : Array_Element_Id := No_Array_Element;
879 -- An associative array mapping individual bodies to source file names
880 -- This is specific to unit-based languages.
882 Specification_Exceptions : Array_Element_Id := No_Array_Element;
883 -- An associative array listing spec file names that do not have the
884 -- spec suffix. Not used by Ada. Indexed by programming language name.
886 Implementation_Exceptions : Array_Element_Id := No_Array_Element;
887 -- An associative array listing body file names that do not have the
888 -- body suffix. Not used by Ada. Indexed by programming language name.
892 function Spec_Suffix_Of
893 (In_Tree : Project_Tree_Ref;
895 Naming : Naming_Data) return String;
897 function Spec_Suffix_Id_Of
898 (In_Tree : Project_Tree_Ref;
899 Language_Id : Name_Id;
900 Naming : Naming_Data) return File_Name_Type;
902 procedure Set_Spec_Suffix
903 (In_Tree : Project_Tree_Ref;
905 Naming : in out Naming_Data;
906 Suffix : File_Name_Type);
908 function Body_Suffix_Id_Of
909 (In_Tree : Project_Tree_Ref;
910 Language_Id : Name_Id;
911 Naming : Naming_Data) return File_Name_Type;
913 function Body_Suffix_Of
914 (In_Tree : Project_Tree_Ref;
916 Naming : Naming_Data) return String;
918 procedure Set_Body_Suffix
919 (In_Tree : Project_Tree_Ref;
921 Naming : in out Naming_Data;
922 Suffix : File_Name_Type);
924 function Standard_Naming_Data
925 (Tree : Project_Tree_Ref := No_Project_Tree) return Naming_Data;
926 pragma Inline (Standard_Naming_Data);
927 -- The standard GNAT naming scheme when Tree is No_Project_Tree.
928 -- Otherwise, return the default naming scheme for the project tree Tree,
929 -- which must have been Initialized.
931 function Same_Naming_Scheme
932 (Left, Right : Naming_Data) return Boolean;
933 -- Returns True if Left and Right are the same naming scheme
934 -- not considering Specs and Bodies.
936 type Project_List is new Nat;
937 Empty_Project_List : constant Project_List := 0;
938 -- A list of project files
940 type Project_Element is record
941 Project : Project_Id := No_Project;
942 Next : Project_List := Empty_Project_List;
944 -- Element in a list of project files. Next is the id of the next
945 -- project file in the list.
947 package Project_List_Table is new GNAT.Dynamic_Tables
948 (Table_Component_Type => Project_Element,
949 Table_Index_Type => Project_List,
950 Table_Low_Bound => 1,
951 Table_Initial => 100,
952 Table_Increment => 100);
953 -- The table that contains the lists of project files
955 type Response_File_Format is
960 -- The format of the different response files
962 type Project_Configuration is record
963 Target : Name_Id := No_Name;
964 -- The target of the configuration, when specified
966 Run_Path_Option : Name_List_Index := No_Name_List;
967 -- The option to use when linking to specify the path where to look for
970 Separate_Run_Path_Options : Boolean := False;
971 -- True if each directory needs to be specified in a separate run path
974 Executable_Suffix : Name_Id := No_Name;
975 -- The suffix of executables, when specified in the configuration or in
976 -- package Builder of the main project. When this is not specified, the
977 -- executable suffix is the default for the platform.
981 Linker : Path_Name_Type := No_Path;
982 -- Path name of the linker driver. Specified in the configuration or in
983 -- the package Builder of the main project.
985 Map_File_Option : Name_Id := No_Name;
986 -- Option to use when invoking the linker to build a map file
988 Minimum_Linker_Options : Name_List_Index := No_Name_List;
989 -- The minimum options for the linker driver. Specified in the
992 Linker_Executable_Option : Name_List_Index := No_Name_List;
993 -- The option(s) to indicate the name of the executable in the linker
994 -- command. Specified in the configuration. When not specified, default
995 -- to -o <executable name>.
997 Linker_Lib_Dir_Option : Name_Id := No_Name;
998 -- The option to specify where to find a library for linking. Specified
999 -- in the configuration. When not specified, defaults to "-L".
1001 Linker_Lib_Name_Option : Name_Id := No_Name;
1002 -- The option to specify the name of a library for linking. Specified in
1003 -- the configuration. When not specified, defaults to "-l".
1005 Max_Command_Line_Length : Natural := 0;
1006 -- When positive and when Resp_File_Format (see below) is not None,
1007 -- if the command line for the invocation of the linker would be greater
1008 -- than this value, a response file is used to invoke the linker.
1010 Resp_File_Format : Response_File_Format := None;
1011 -- The format of a response file, when linking with a response file is
1014 Resp_File_Options : Name_List_Index := No_Name_List;
1015 -- The switches, if any, that precede the path name of the response
1016 -- file in the invocation of the linker.
1020 Library_Builder : Path_Name_Type := No_Path;
1021 -- The executable to build library (specified in the configuration)
1023 Lib_Support : Library_Support := None;
1024 -- The level of library support. Specified in the configuration. Support
1025 -- is none, static libraries only or both static and shared libraries.
1027 Archive_Builder : Name_List_Index := No_Name_List;
1028 -- The name of the executable to build archives, with the minimum
1029 -- switches. Specified in the configuration.
1031 Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
1032 -- The options to append object files to an archive
1034 Archive_Indexer : Name_List_Index := No_Name_List;
1035 -- The name of the executable to index archives, with the minimum
1036 -- switches. Specified in the configuration.
1038 Archive_Suffix : File_Name_Type := No_File;
1039 -- The suffix of archives. Specified in the configuration. When not
1040 -- specified, defaults to ".a".
1042 Lib_Partial_Linker : Name_List_Index := No_Name_List;
1046 Shared_Lib_Driver : File_Name_Type := No_File;
1047 -- The driver to link shared libraries. Set with attribute Library_GCC.
1050 Shared_Lib_Prefix : File_Name_Type := No_File;
1051 -- Part of a shared library file name that precedes the name of the
1052 -- library. Specified in the configuration. When not specified, defaults
1055 Shared_Lib_Suffix : File_Name_Type := No_File;
1056 -- Suffix of shared libraries, after the library name in the shared
1057 -- library name. Specified in the configuration. When not specified,
1058 -- default to ".so".
1060 Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1061 -- The minimum options to use when building a shared library
1063 Lib_Version_Options : Name_List_Index := No_Name_List;
1064 -- The options to use to specify a library version
1066 Symbolic_Link_Supported : Boolean := False;
1067 -- True if the platform supports symbolic link files
1069 Lib_Maj_Min_Id_Supported : Boolean := False;
1070 -- True if platform supports library major and minor options, such as
1071 -- libname.so -> libname.so.2 -> libname.so.2.4
1073 Auto_Init_Supported : Boolean := False;
1074 -- True if automatic initialisation is supported for shared stand-alone
1078 Default_Project_Config : constant Project_Configuration :=
1080 Run_Path_Option => No_Name_List,
1081 Separate_Run_Path_Options => False,
1082 Executable_Suffix => No_Name,
1084 Map_File_Option => No_Name,
1085 Minimum_Linker_Options => No_Name_List,
1086 Linker_Executable_Option => No_Name_List,
1087 Linker_Lib_Dir_Option => No_Name,
1088 Linker_Lib_Name_Option => No_Name,
1089 Library_Builder => No_Path,
1090 Max_Command_Line_Length => 0,
1091 Resp_File_Format => None,
1092 Resp_File_Options => No_Name_List,
1093 Lib_Support => None,
1094 Archive_Builder => No_Name_List,
1095 Archive_Builder_Append_Option => No_Name_List,
1096 Archive_Indexer => No_Name_List,
1097 Archive_Suffix => No_File,
1098 Lib_Partial_Linker => No_Name_List,
1099 Shared_Lib_Driver => No_File,
1100 Shared_Lib_Prefix => No_File,
1101 Shared_Lib_Suffix => No_File,
1102 Shared_Lib_Min_Options => No_Name_List,
1103 Lib_Version_Options => No_Name_List,
1104 Symbolic_Link_Supported => False,
1105 Lib_Maj_Min_Id_Supported => False,
1106 Auto_Init_Supported => False);
1108 -- The following record describes a project file representation
1110 -- Note that it is not specified if the path names of directories (source,
1111 -- object, library or exec directories) end with or without a directory
1114 type Project_Data is record
1120 Name : Name_Id := No_Name;
1121 -- The name of the project
1123 Display_Name : Name_Id := No_Name;
1124 -- The name of the project with the spelling of its declaration
1126 Qualifier : Project_Qualifier := Unspecified;
1127 -- The eventual qualifier for this project
1129 Externally_Built : Boolean := False;
1130 -- True if the project is externally built. In such case, the Project
1131 -- Manager will not modify anything in this project.
1133 Config : Project_Configuration;
1135 Path : Path_Information := No_Path_Information;
1136 -- The path name of the project file
1138 Virtual : Boolean := False;
1139 -- True for virtual extending projects
1141 Location : Source_Ptr := No_Location;
1142 -- The location in the project file source of the reserved word project
1144 Naming : Naming_Data := Standard_Naming_Data;
1145 -- The naming scheme of this project file
1151 Languages : Language_Ptr := No_Language_Index;
1152 -- First index of the language data in the project.
1153 -- This is an index into the project_tree_data.languages_data.
1154 -- Traversing the list gives access to all the languages supported by
1161 Mains : String_List_Id := Nil_String;
1162 -- List of mains specified by attribute Main
1164 Extends : Project_Id := No_Project;
1165 -- The reference of the project file, if any, that this project file
1168 Extended_By : Project_Id := No_Project;
1169 -- The reference of the project file, if any, that extends this project
1172 Decl : Declarations := No_Declarations;
1173 -- The declarations (variables, attributes and packages) of this project
1176 Imported_Projects : Project_List := Empty_Project_List;
1177 -- The list of all directly imported projects, if any
1179 All_Imported_Projects : Project_List := Empty_Project_List;
1180 -- The list of all projects imported directly or indirectly, if any
1186 Directory : Path_Information := No_Path_Information;
1187 -- Path name of the directory where the project file resides
1189 Dir_Path : String_Access;
1190 -- Same as Directory.Name, but as an access to String
1192 Object_Directory : Path_Information := No_Path_Information;
1193 -- The path name of the object directory of this project file
1195 Exec_Directory : Path_Information := No_Path_Information;
1196 -- The path name of the exec directory of this project file. Default is
1197 -- equal to Object_Directory.
1203 Library : Boolean := False;
1204 -- True if this is a library project
1206 Library_Name : Name_Id := No_Name;
1207 -- If a library project, name of the library
1209 Library_Kind : Lib_Kind := Static;
1210 -- If a library project, kind of library
1212 Library_Dir : Path_Information := No_Path_Information;
1213 -- If a library project, path name of the directory where the library
1216 Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1217 -- The timestamp of a library file in a library project
1219 Library_Src_Dir : Path_Information := No_Path_Information;
1220 -- If a Stand-Alone Library project, path name of the directory where
1221 -- the sources of the interfaces of the library are copied. By default,
1222 -- if attribute Library_Src_Dir is not specified, sources of the
1223 -- interfaces are not copied anywhere.
1225 Library_ALI_Dir : Path_Information := No_Path_Information;
1226 -- In a library project, path name of the directory where the ALI files
1227 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1228 -- are copied in the Library_Dir.
1230 Lib_Internal_Name : Name_Id := No_Name;
1231 -- If a library project, internal name store inside the library
1233 Standalone_Library : Boolean := False;
1234 -- Indicate that this is a Standalone Library Project File
1236 Lib_Interface_ALIs : String_List_Id := Nil_String;
1237 -- For Standalone Library Project Files, indicate the list of Interface
1240 Lib_Auto_Init : Boolean := False;
1241 -- For non static Stand-Alone Library Project Files, indicate if
1242 -- the library initialisation should be automatic.
1244 Symbol_Data : Symbol_Record := No_Symbols;
1245 -- Symbol file name, reference symbol file name, symbol policy
1247 Need_To_Build_Lib : Boolean := False;
1248 -- Indicates that the library of a Library Project needs to be built or
1255 Ada_Sources_Present : Boolean := True;
1256 -- True if there are Ada sources in the project
1258 Other_Sources_Present : Boolean := True;
1259 -- True if there are non-Ada sources in the project
1261 Ada_Sources : String_List_Id := Nil_String;
1262 -- The list of all the Ada source file names (gnatmake only)
1264 First_Source : Source_Id := No_Source;
1265 Last_Source : Source_Id := No_Source;
1266 -- Head and tail of the list of sources
1268 Interfaces_Defined : Boolean := False;
1269 -- True if attribute Interfaces is declared for the project or any
1270 -- project it extends.
1272 Imported_Directories_Switches : Argument_List_Access := null;
1273 -- List of the source search switches (-I<source dir>) to be used when
1276 Include_Path : String_Access := null;
1277 -- The search source path for the project. Used as the value for an
1278 -- environment variable, specified by attribute Include_Path
1279 -- (<language>). The names of the environment variables are in component
1280 -- Include_Path of the records Language_Config.
1282 Include_Path_File : Path_Name_Type := No_Path;
1283 -- The path name of the of the source search directory file
1285 Include_Data_Set : Boolean := False;
1286 -- Set True when Imported_Directories_Switches or Include_Path are set
1288 Source_Dirs : String_List_Id := Nil_String;
1289 -- The list of all the source directories
1291 Known_Order_Of_Source_Dirs : Boolean := True;
1292 -- False, if there is any /** in the Source_Dirs, because in this case
1293 -- the ordering of the source subdirs depend on the OS. If True,
1294 -- duplicate file names in the same project file are allowed.
1296 Ada_Include_Path : String_Access := null;
1297 -- The cached value of source search path for this project file. Set by
1298 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1299 -- use this field directly outside of the project manager, use
1300 -- Prj.Env.Ada_Include_Path instead.
1306 Ada_Objects_Path : String_Access := null;
1307 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1308 -- use this field directly outside of the compiler, use
1309 -- Prj.Env.Ada_Objects_Path instead.
1311 Libgnarl_Needed : Yes_No_Unknown := Unknown;
1312 -- Set to True when libgnarl is needed to link
1314 Objects_Path : String_Access := null;
1315 -- The cached value of the object dir path, used during the binding
1316 -- phase of gprbuild.
1318 Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1319 -- The cached value of the object path temp file (including library
1320 -- dirs) for this project file.
1322 Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1323 -- The cached value of the object path temp file (excluding library
1324 -- dirs) for this project file.
1326 Config_File_Name : Path_Name_Type := No_Path;
1327 -- The path name of the configuration pragmas file, if any
1329 Config_File_Temp : Boolean := False;
1330 -- An indication that the configuration pragmas file is a temporary file
1331 -- that must be deleted at the end.
1333 Config_Checked : Boolean := False;
1334 -- A flag to avoid checking repetitively the configuration pragmas file
1336 Checked : Boolean := False;
1337 -- A flag to avoid checking repetitively the naming scheme of this
1340 Seen : Boolean := False;
1341 -- A flag to mark a project as "visited" to avoid processing the same
1342 -- project several time.
1344 Depth : Natural := 0;
1345 -- The maximum depth of a project in the project graph. Depth of main
1348 Unkept_Comments : Boolean := False;
1349 -- True if there are comments in the project sources that cannot be kept
1350 -- in the project tree.
1354 function Empty_Project (Tree : Project_Tree_Ref) return Project_Data;
1355 -- Return the representation of an empty project in project Tree tree.
1356 -- The project tree Tree must have been Initialized and/or Reset.
1358 function Is_Extending
1359 (Extending : Project_Id;
1360 Extended : Project_Id;
1361 In_Tree : Project_Tree_Ref) return Boolean;
1362 -- ??? needs comment
1364 function Is_A_Language
1365 (Data : Project_Data;
1366 Language_Name : Name_Id) return Boolean;
1367 -- Return True when Language_Name (which must be lower case) is one of the
1368 -- languages used for the project.
1370 Project_Error : exception;
1371 -- Raised by some subprograms in Prj.Attr
1373 package Project_Table is new GNAT.Dynamic_Tables (
1374 Table_Component_Type => Project_Data,
1375 Table_Index_Type => Project_Id,
1376 Table_Low_Bound => 1,
1377 Table_Initial => 100,
1378 Table_Increment => 100);
1379 -- The set of all project files
1381 type Spec_Or_Body is (Specification, Body_Part);
1383 type File_Name_Data is record
1384 Name : File_Name_Type := No_File;
1386 Display_Name : File_Name_Type := No_File;
1387 Path : Path_Information := No_Path_Information;
1388 Project : Project_Id := No_Project;
1389 Needs_Pragma : Boolean := False;
1391 -- File and Path name of a spec or body
1393 type File_Names_Data is array (Spec_Or_Body) of File_Name_Data;
1395 type Unit_Index is new Nat;
1396 No_Unit_Index : constant Unit_Index := 0;
1397 type Unit_Data is record
1398 Name : Name_Id := No_Name;
1399 File_Names : File_Names_Data;
1401 -- Name and File and Path names of a unit, with a reference to its
1402 -- GNAT Project File(s).
1404 package Unit_Table is new GNAT.Dynamic_Tables
1405 (Table_Component_Type => Unit_Data,
1406 Table_Index_Type => Unit_Index,
1407 Table_Low_Bound => 1,
1408 Table_Initial => 100,
1409 Table_Increment => 100);
1410 -- Table of all units in a project tree
1412 package Units_Htable is new Simple_HTable
1413 (Header_Num => Header_Num,
1414 Element => Unit_Index,
1415 No_Element => No_Unit_Index,
1419 -- Mapping of unit names to indexes in the Units table
1421 type Unit_Project is record
1422 Unit : Unit_Index := No_Unit_Index;
1423 Project : Project_Id := No_Project;
1426 No_Unit_Project : constant Unit_Project := (No_Unit_Index, No_Project);
1428 package Files_Htable is new Simple_HTable
1429 (Header_Num => Header_Num,
1430 Element => Unit_Project,
1431 No_Element => No_Unit_Project,
1432 Key => File_Name_Type,
1435 -- Mapping of file names to indexes in the Units table
1437 type Private_Project_Tree_Data is private;
1438 -- Data for a project tree that is used only by the Project Manager
1440 type Project_Tree_Data is
1442 -- sources of the project
1444 First_Source : Source_Id := No_Source;
1449 Name_Lists : Name_List_Table.Instance;
1450 String_Elements : String_Element_Table.Instance;
1451 Variable_Elements : Variable_Element_Table.Instance;
1452 Array_Elements : Array_Element_Table.Instance;
1453 Arrays : Array_Table.Instance;
1454 Packages : Package_Table.Instance;
1455 Project_Lists : Project_List_Table.Instance;
1456 Projects : Project_Table.Instance;
1457 Sources : Source_Data_Table.Instance;
1458 Alt_Langs : Alternate_Language_Table.Instance;
1459 Units : Unit_Table.Instance;
1460 Units_HT : Units_Htable.Instance;
1461 Files_HT : Files_Htable.Instance;
1462 Source_Paths_HT : Source_Paths_Htable.Instance;
1463 Unit_Sources_HT : Unit_Sources_Htable.Instance;
1467 Private_Part : Private_Project_Tree_Data;
1469 -- Data for a project tree
1471 type Put_Line_Access is access procedure
1473 Project : Project_Id;
1474 In_Tree : Project_Tree_Ref);
1475 -- Use to customize error reporting in Prj.Proc and Prj.Nmsc
1477 procedure Expect (The_Token : Token_Type; Token_Image : String);
1478 -- Check that the current token is The_Token. If it is not, then output
1479 -- an error message.
1481 procedure Initialize (Tree : Project_Tree_Ref);
1482 -- This procedure must be called before using any services from the Prj
1483 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1485 procedure Reset (Tree : Project_Tree_Ref);
1486 -- This procedure resets all the tables that are used when processing a
1487 -- project file tree. Initialize must be called before the call to Reset.
1489 procedure Register_Default_Naming_Scheme
1490 (Language : Name_Id;
1491 Default_Spec_Suffix : File_Name_Type;
1492 Default_Body_Suffix : File_Name_Type;
1493 In_Tree : Project_Tree_Ref);
1494 -- Register the default suffixes for a given language. These extensions
1495 -- will be ignored if the user has specified a new naming scheme in a
1498 -- Otherwise, this information will be automatically added to Naming_Data
1499 -- when a project is processed, in the lists Spec_Suffix and Body_Suffix.
1502 type State is limited private;
1503 with procedure Action
1504 (Project : Project_Id;
1505 With_State : in out State);
1506 procedure For_Every_Project_Imported
1508 In_Tree : Project_Tree_Ref;
1509 With_State : in out State);
1510 -- Call Action for each project imported directly or indirectly by project
1511 -- By. Action is called according to the order of importation: if A
1512 -- imports B, directly or indirectly, Action will be called for A before
1513 -- it is called for B. If two projects import each other directly or
1514 -- indirectly (using at least one "limited with"), it is not specified
1515 -- for which of these two projects Action will be called first. Projects
1516 -- that are extended by other projects are not considered. With_State may
1517 -- be used by Action to choose a behavior or to report some global result.
1519 function Extend_Name
1520 (File : File_Name_Type;
1521 With_Suffix : String) return File_Name_Type;
1522 -- Replace the extension of File with With_Suffix
1524 function Object_Name
1525 (Source_File_Name : File_Name_Type;
1526 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1527 -- Returns the object file name corresponding to a source file name
1529 function Dependency_Name
1530 (Source_File_Name : File_Name_Type;
1531 Dependency : Dependency_File_Kind) return File_Name_Type;
1532 -- Returns the dependency file name corresponding to a source file name
1534 function Switches_Name
1535 (Source_File_Name : File_Name_Type) return File_Name_Type;
1536 -- Returns the switches file name corresponding to a source file name
1542 procedure Record_Temp_File (Path : Path_Name_Type);
1543 -- Record the path of a newly created temporary file, so that it can be
1546 procedure Delete_All_Temp_Files;
1547 -- Delete all recorded temporary files
1551 All_Packages : constant String_List_Access := null;
1553 No_Project_Tree : constant Project_Tree_Ref := null;
1555 Ignored : constant Variable_Kind := Single;
1557 Nil_Variable_Value : constant Variable_Value :=
1558 (Project => No_Project,
1560 Location => No_Location,
1563 Virtual_Prefix : constant String := "v$";
1564 -- The prefix for virtual extending projects. Because of the '$', which is
1565 -- normally forbidden for project names, there cannot be any name clash.
1567 Empty_Name : Name_Id;
1568 -- Name_Id for an empty name (no characters). Initialized in procedure
1571 Empty_File_Name : File_Name_Type;
1572 -- Empty File_Name_Type (no characters). Initialized in procedure
1575 procedure Add_To_Buffer
1577 To : in out String_Access;
1578 Last : in out Natural);
1579 -- Append a String to the Buffer
1581 type Naming_Id is new Nat;
1583 package Naming_Table is new GNAT.Dynamic_Tables
1584 (Table_Component_Type => Naming_Data,
1585 Table_Index_Type => Naming_Id,
1586 Table_Low_Bound => 1,
1588 Table_Increment => 100);
1589 -- Table storing the naming data for gnatmake/gprmake
1591 package Path_File_Table is new GNAT.Dynamic_Tables
1592 (Table_Component_Type => Path_Name_Type,
1593 Table_Index_Type => Natural,
1594 Table_Low_Bound => 1,
1595 Table_Initial => 50,
1596 Table_Increment => 100);
1597 -- Table storing all the temp path file names.
1598 -- Used by Delete_All_Path_Files.
1600 package Source_Path_Table is new GNAT.Dynamic_Tables
1601 (Table_Component_Type => Name_Id,
1602 Table_Index_Type => Natural,
1603 Table_Low_Bound => 1,
1604 Table_Initial => 50,
1605 Table_Increment => 100);
1606 -- A table to store the source dirs before creating the source path file
1608 package Object_Path_Table is new GNAT.Dynamic_Tables
1609 (Table_Component_Type => Path_Name_Type,
1610 Table_Index_Type => Natural,
1611 Table_Low_Bound => 1,
1612 Table_Initial => 50,
1613 Table_Increment => 100);
1614 -- A table to store the object dirs, before creating the object path file
1616 type Private_Project_Tree_Data is record
1617 Namings : Naming_Table.Instance;
1618 Path_Files : Path_File_Table.Instance;
1619 Source_Paths : Source_Path_Table.Instance;
1620 Object_Paths : Object_Path_Table.Instance;
1621 Default_Naming : Naming_Data;
1623 -- Type to represent the part of a project tree which is private to the