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 procedure Display_Language_Name
318 (Language : Language_Ptr);
319 -- Output the name of a language
321 Max_Header_Num : constant := 6150;
322 type Header_Num is range 0 .. Max_Header_Num;
323 -- Size for hash table below. The upper bound is an arbitrary value, the
324 -- value here was chosen after testing to determine a good compromise
325 -- between speed of access and memory usage.
327 function Hash (Name : Name_Id) return Header_Num;
328 function Hash (Name : File_Name_Type) return Header_Num;
329 function Hash (Name : Path_Name_Type) return Header_Num;
330 -- Used for computing hash values for names put into above hash table
332 function Hash (Project : Project_Id) return Header_Num;
333 -- Used for hash tables where Project_Id is the Key
335 type Language_Kind is (File_Based, Unit_Based);
336 -- Type for the kind of language. All languages are file based, except Ada
337 -- which is unit based.
339 type Dependency_File_Kind is (None, Makefile, ALI_File);
340 -- Type of dependency to be checked: no dependency file, Makefile fragment
341 -- or ALI file (for Ada).
343 Makefile_Dependency_Suffix : constant String := ".d";
344 ALI_Dependency_Suffix : constant String := ".ali";
346 Switches_Dependency_Suffix : constant String := ".cswi";
348 Binder_Exchange_Suffix : constant String := ".bexch";
349 -- Suffix for binder exchange files
351 Library_Exchange_Suffix : constant String := ".lexch";
352 -- Suffix for library exchange files
354 type Name_List_Index is new Nat;
355 No_Name_List : constant Name_List_Index := 0;
357 type Name_Node is record
358 Name : Name_Id := No_Name;
359 Next : Name_List_Index := No_Name_List;
362 package Name_List_Table is new GNAT.Dynamic_Tables
363 (Table_Component_Type => Name_Node,
364 Table_Index_Type => Name_List_Index,
365 Table_Low_Bound => 1,
367 Table_Increment => 100);
368 -- The table for lists of names used in package Language_Processing
370 package Mapping_Files_Htable is new Simple_HTable
371 (Header_Num => Header_Num,
372 Element => Path_Name_Type,
373 No_Element => No_Path,
374 Key => Path_Name_Type,
377 -- A hash table to store the mapping files that are not used
379 type Lang_Naming_Data is record
380 Dot_Replacement : File_Name_Type := No_File;
381 -- The string to replace '.' in the source file name (for Ada)
383 Casing : Casing_Type := All_Lower_Case;
384 -- The casing of the source file name (for Ada)
386 Separate_Suffix : File_Name_Type := No_File;
387 -- String to append to unit name for source file name of an Ada subunit
389 Spec_Suffix : File_Name_Type := No_File;
390 -- The string to append to the unit name for the
391 -- source file name of a spec.
393 Body_Suffix : File_Name_Type := No_File;
394 -- The string to append to the unit name for the
395 -- source file name of a body.
398 No_Lang_Naming_Data : constant Lang_Naming_Data :=
399 (Dot_Replacement => No_File,
400 Casing => All_Lower_Case,
401 Separate_Suffix => No_File,
402 Spec_Suffix => No_File,
403 Body_Suffix => No_File);
405 type Source_Id is new Nat;
407 No_Source : constant Source_Id := 0;
409 type Path_Syntax_Kind is
414 -- Host specific syntax, for example on VMS (the default)
416 type Language_Config is record
417 Kind : Language_Kind := File_Based;
418 -- Kind of language. All languages are file based, except Ada which is
421 Naming_Data : Lang_Naming_Data;
422 -- The naming data for the languages (prefixes, etc.)
424 Include_Compatible_Languages : Name_List_Index := No_Name_List;
425 -- The list of languages that are "include compatible" with this
426 -- language. A language B (for example "C") is "include compatible" with
427 -- a language A (for example "C++") if it is expected that sources of
428 -- language A may "include" header files from language B.
430 Compiler_Driver : File_Name_Type := No_File;
431 -- The name of the executable for the compiler of the language
433 Compiler_Driver_Path : String_Access := null;
434 -- The path name of the executable for the compiler of the language
436 Compiler_Required_Switches : Name_List_Index := No_Name_List;
437 -- The list of switches that are required as a minimum to invoke the
440 Path_Syntax : Path_Syntax_Kind := Host;
441 -- Value may be Canonical (Unix style) or Host (host syntax, for example
442 -- on VMS for DEC C).
444 Object_File_Suffix : Name_Id := No_Name;
446 Compilation_PIC_Option : Name_List_Index := No_Name_List;
447 -- The option(s) to compile a source in Position Independent Code for
448 -- shared libraries. Specified in the configuration. When not specified,
449 -- there is no need for such switch.
451 Object_Generated : Boolean := True;
452 -- False in no object file is generated
454 Objects_Linked : Boolean := True;
455 -- False if object files are not use to link executables and build
458 Runtime_Library_Dir : Name_Id := No_Name;
459 -- Path name of the runtime library directory, if any
461 Runtime_Source_Dir : Name_Id := No_Name;
462 -- Path name of the runtime source directory, if any
464 Mapping_File_Switches : Name_List_Index := No_Name_List;
465 -- The option(s) to provide a mapping file to the compiler. Specified in
466 -- the configuration. When value is No_Name_List, there is no mapping
469 Mapping_Spec_Suffix : File_Name_Type := No_File;
470 -- Placeholder representing the spec suffix in a mapping file
472 Mapping_Body_Suffix : File_Name_Type := No_File;
473 -- Placeholder representing the body suffix in a mapping file
475 Config_File_Switches : Name_List_Index := No_Name_List;
476 -- The option(s) to provide a config file to the compiler. Specified in
477 -- the configuration. When value is No_Name_List, there is no config
480 Dependency_Kind : Dependency_File_Kind := None;
481 -- The kind of dependency to be checked: none, Makefile fragment or
482 -- ALI file (for Ada).
484 Dependency_Option : Name_List_Index := No_Name_List;
485 -- The option(s) to be used to create the dependency file. When value is
486 -- No_Name_List, there is not such option(s).
488 Compute_Dependency : Name_List_Index := No_Name_List;
489 -- Hold the value of attribute Dependency_Driver, if declared for the
492 Include_Option : Name_List_Index := No_Name_List;
493 -- Hold the value of attribute Include_Switches, if declared for the
496 Include_Path : Name_Id := No_Name;
497 -- Name of environment variable declared by attribute Include_Path for
500 Include_Path_File : Name_Id := No_Name;
501 -- Name of environment variable declared by attribute Include_Path_File
504 Objects_Path : Name_Id := No_Name;
505 -- Name of environment variable declared by attribute Objects_Path for
508 Objects_Path_File : Name_Id := No_Name;
509 -- Name of environment variable declared by attribute Objects_Path_File
512 Config_Body : Name_Id := No_Name;
513 -- The template for a pragma Source_File_Name(_Project) for a specific
514 -- file name of a body.
516 Config_Spec : Name_Id := No_Name;
517 -- The template for a pragma Source_File_Name(_Project) for a specific
518 -- file name of a spec.
520 Config_Body_Pattern : Name_Id := No_Name;
521 -- The template for a pragma Source_File_Name(_Project) for a naming
524 Config_Spec_Pattern : Name_Id := No_Name;
525 -- The template for a pragma Source_File_Name(_Project) for a naming
528 Config_File_Unique : Boolean := False;
529 -- Indicate if the config file specified to the compiler needs to be
530 -- unique. If it is unique, then all config files are concatenated into
531 -- a temp config file.
533 Binder_Driver : File_Name_Type := No_File;
534 -- The name of the binder driver for the language, if any
536 Binder_Driver_Path : Path_Name_Type := No_Path;
537 -- The path name of the binder driver
539 Binder_Required_Switches : Name_List_Index := No_Name_List;
540 -- Hold the value of attribute Binder'Required_Switches for the language
542 Binder_Prefix : Name_Id := No_Name;
543 -- Hold the value of attribute Binder'Prefix for the language
545 Toolchain_Version : Name_Id := No_Name;
546 -- Hold the value of attribute Toolchain_Version for the language
548 Toolchain_Description : Name_Id := No_Name;
549 -- Hold the value of attribute Toolchain_Description for the language
552 -- Record describing the configuration of a language
554 No_Language_Config : constant Language_Config :=
556 Naming_Data => No_Lang_Naming_Data,
557 Include_Compatible_Languages => No_Name_List,
558 Compiler_Driver => No_File,
559 Compiler_Driver_Path => null,
560 Compiler_Required_Switches => No_Name_List,
561 Path_Syntax => Canonical,
562 Object_File_Suffix => No_Name,
563 Compilation_PIC_Option => No_Name_List,
564 Object_Generated => True,
565 Objects_Linked => True,
566 Runtime_Library_Dir => No_Name,
567 Runtime_Source_Dir => No_Name,
568 Mapping_File_Switches => No_Name_List,
569 Mapping_Spec_Suffix => No_File,
570 Mapping_Body_Suffix => No_File,
571 Config_File_Switches => No_Name_List,
572 Dependency_Kind => Makefile,
573 Dependency_Option => No_Name_List,
574 Compute_Dependency => No_Name_List,
575 Include_Option => No_Name_List,
576 Include_Path => No_Name,
577 Include_Path_File => No_Name,
578 Objects_Path => No_Name,
579 Objects_Path_File => No_Name,
580 Config_Body => No_Name,
581 Config_Spec => No_Name,
582 Config_Body_Pattern => No_Name,
583 Config_Spec_Pattern => No_Name,
584 Config_File_Unique => False,
585 Binder_Driver => No_File,
586 Binder_Driver_Path => No_Path,
587 Binder_Required_Switches => No_Name_List,
588 Binder_Prefix => No_Name,
589 Toolchain_Version => No_Name,
590 Toolchain_Description => No_Name);
592 type Language_Data is record
593 Name : Name_Id := No_Name;
594 Display_Name : Name_Id := No_Name;
595 Config : Language_Config := No_Language_Config;
596 First_Source : Source_Id := No_Source;
597 Mapping_Files : Mapping_Files_Htable.Instance :=
598 Mapping_Files_Htable.Nil;
599 Next : Language_Ptr := No_Language_Index;
602 No_Language_Data : constant Language_Data :=
604 Display_Name => No_Name,
605 Config => No_Language_Config,
606 First_Source => No_Source,
607 Mapping_Files => Mapping_Files_Htable.Nil,
608 Next => No_Language_Index);
610 type Alternate_Language_Id is new Nat;
612 No_Alternate_Language : constant Alternate_Language_Id := 0;
614 type Alternate_Language_Data is record
615 Language : Language_Ptr := No_Language_Index;
616 Next : Alternate_Language_Id := No_Alternate_Language;
619 package Alternate_Language_Table is new GNAT.Dynamic_Tables
620 (Table_Component_Type => Alternate_Language_Data,
621 Table_Index_Type => Alternate_Language_Id,
622 Table_Low_Bound => 1,
624 Table_Increment => 100);
625 -- The table for storing the alternate languages of a header file that
626 -- is used for several languages.
628 type Source_Kind is (Spec, Impl, Sep);
630 type Source_Data is record
631 Project : Project_Id := No_Project;
632 -- Project of the source
634 Language : Language_Ptr := No_Language_Index;
635 -- Index of the language. This is an index into
636 -- project_tree.languages_data
638 Lang_Kind : Language_Kind := File_Based;
639 -- Kind of the language
641 Compiled : Boolean := True;
642 -- False when there is no compiler for the language
644 In_Interfaces : Boolean := True;
645 -- False when the source is not included in interfaces, when attribute
646 -- Interfaces is declared.
648 Declared_In_Interfaces : Boolean := False;
649 -- True when source is declared in attribute Interfaces
651 Alternate_Languages : Alternate_Language_Id := No_Alternate_Language;
652 -- List of languages a header file may also be, in addition of
653 -- language Language_Name.
655 Kind : Source_Kind := Spec;
656 -- Kind of the source: spec, body or subunit
658 Dependency : Dependency_File_Kind := None;
659 -- Kind of dependency: none, Makefile fragment or ALI file
661 Other_Part : Source_Id := No_Source;
662 -- Source ID for the other part, if any: for a spec, indicates its body;
663 -- for a body, indicates its spec.
665 Unit : Name_Id := No_Name;
666 -- Name of the unit, if language is unit based
669 -- Index of the source in a multi unit source file
671 Locally_Removed : Boolean := False;
672 -- True if the source has been "excluded"
674 Get_Object : Boolean := False;
675 -- Indicates that the object of the source should be put in the global
676 -- archive. This is for Ada, when only the closure of a main needs to
677 -- be compiled/recompiled.
679 Replaced_By : Source_Id := No_Source;
681 File : File_Name_Type := No_File;
682 -- Canonical file name of the source
684 Display_File : File_Name_Type := No_File;
685 -- File name of the source, for display purposes
687 Path : Path_Information := No_Path_Information;
688 -- Path name of the source
690 Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
691 -- Time stamp of the source file
693 Object_Project : Project_Id := No_Project;
694 -- Project where the object file is. This might be different from
695 -- Project when using extending project files.
697 Object_Exists : Boolean := True;
698 -- True if an object file exists
700 Object_Linked : Boolean := True;
701 -- False if the object file is not use to link executables or included
704 Object : File_Name_Type := No_File;
705 -- File name of the object file
707 Current_Object_Path : Path_Name_Type := No_Path;
708 -- Object path of an existing object file
710 Object_Path : Path_Name_Type := No_Path;
711 -- Object path of the real object file
713 Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
714 -- Object file time stamp
716 Dep_Name : File_Name_Type := No_File;
717 -- Dependency file simple name
719 Current_Dep_Path : Path_Name_Type := No_Path;
720 -- Path name of an existing dependency file
722 Dep_Path : Path_Name_Type := No_Path;
723 -- Path name of the real dependency file
725 Dep_TS : Time_Stamp_Type := Empty_Time_Stamp;
726 -- Dependency file time stamp
728 Switches : File_Name_Type := No_File;
729 -- File name of the switches file. For all languages, this is a file
730 -- that ends with the .cswi extension.
732 Switches_Path : Path_Name_Type := No_Path;
733 -- Path name of the switches file
735 Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
736 -- Switches file time stamp
738 Naming_Exception : Boolean := False;
739 -- True if the source has an exceptional name
741 Next_In_Sources : Source_Id := No_Source;
742 -- Link to another source in the project tree
744 Next_In_Project : Source_Id := No_Source;
745 -- Link to another source in the project
747 Next_In_Lang : Source_Id := No_Source;
748 -- Link to another source of the same language
751 No_Source_Data : constant Source_Data :=
752 (Project => No_Project,
753 Language => No_Language_Index,
754 Lang_Kind => File_Based,
756 In_Interfaces => True,
757 Declared_In_Interfaces => False,
758 Alternate_Languages => No_Alternate_Language,
761 Other_Part => No_Source,
764 Locally_Removed => False,
766 Replaced_By => No_Source,
768 Display_File => No_File,
769 Path => No_Path_Information,
770 Source_TS => Empty_Time_Stamp,
771 Object_Project => No_Project,
772 Object_Exists => True,
773 Object_Linked => True,
775 Current_Object_Path => No_Path,
776 Object_Path => No_Path,
777 Object_TS => Empty_Time_Stamp,
779 Current_Dep_Path => No_Path,
781 Dep_TS => Empty_Time_Stamp,
783 Switches_Path => No_Path,
784 Switches_TS => Empty_Time_Stamp,
785 Naming_Exception => False,
786 Next_In_Sources => No_Source,
787 Next_In_Project => No_Source,
788 Next_In_Lang => No_Source);
790 package Source_Data_Table is new GNAT.Dynamic_Tables
791 (Table_Component_Type => Source_Data,
792 Table_Index_Type => Source_Id,
793 Table_Low_Bound => 1,
794 Table_Initial => 1000,
795 Table_Increment => 100);
796 -- The table for the sources
798 package Source_Paths_Htable is new Simple_HTable
799 (Header_Num => Header_Num,
800 Element => Source_Id,
801 No_Element => No_Source,
802 Key => Path_Name_Type,
805 -- Mapping of source paths to source ids
807 package Unit_Sources_Htable is new Simple_HTable
808 (Header_Num => Header_Num,
809 Element => Source_Id,
810 No_Element => No_Source,
815 type Verbosity is (Default, Medium, High);
816 -- Verbosity when parsing GNAT Project Files
817 -- Default is default (very quiet, if no errors).
818 -- Medium is more verbose.
819 -- High is extremely verbose.
821 Current_Verbosity : Verbosity := Default;
822 -- The current value of the verbosity the project files are parsed with
824 type Lib_Kind is (Static, Dynamic, Relocatable);
826 type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
827 -- Type to specify the symbol policy, when symbol control is supported.
828 -- See full explanation about this type in package Symbols.
829 -- Autonomous: Create a symbol file without considering any reference
830 -- Compliant: Try to be as compatible as possible with an existing ref
831 -- Controlled: Fail if symbols are not the same as those in the reference
832 -- Restricted: Restrict the symbols to those in the symbol file
833 -- Direct: The symbol file is used as is
835 type Symbol_Record is record
836 Symbol_File : Path_Name_Type := No_Path;
837 Reference : Path_Name_Type := No_Path;
838 Symbol_Policy : Policy := Autonomous;
840 -- Type to keep the symbol data to be used when building a shared library
842 No_Symbols : constant Symbol_Record :=
843 (Symbol_File => No_Path,
844 Reference => No_Path,
845 Symbol_Policy => Autonomous);
846 -- The default value of the symbol data
848 function Image (Casing : Casing_Type) return String;
849 -- Similar to 'Image (but avoid use of this attribute in compiler)
851 function Value (Image : String) return Casing_Type;
852 -- Similar to 'Value (but avoid use of this attribute in compiler)
853 -- Raises Constraint_Error if not a Casing_Type image.
855 -- The following record contains data for a naming scheme
857 type Naming_Data is record
859 Dot_Replacement : File_Name_Type := No_File;
860 -- The string to replace '.' in the source file name (for Ada)
862 Casing : Casing_Type := All_Lower_Case;
863 -- The casing of the source file name (for Ada)
865 Spec_Suffix : Array_Element_Id := No_Array_Element;
866 -- The string to append to the unit name for the
867 -- source file name of a spec.
868 -- Indexed by the programming language.
870 Body_Suffix : Array_Element_Id := No_Array_Element;
871 -- The string to append to the unit name for the
872 -- source file name of a body.
873 -- Indexed by the programming language.
875 Separate_Suffix : File_Name_Type := No_File;
876 -- String to append to unit name for source file name of an Ada subunit
878 Specs : Array_Element_Id := No_Array_Element;
879 -- An associative array mapping individual specs to source file names
880 -- This is specific to unit-based languages.
882 Bodies : Array_Element_Id := No_Array_Element;
883 -- An associative array mapping individual bodies to source file names
884 -- This is specific to unit-based languages.
886 Specification_Exceptions : Array_Element_Id := No_Array_Element;
887 -- An associative array listing spec file names that do not have the
888 -- spec suffix. Not used by Ada. Indexed by programming language name.
890 Implementation_Exceptions : Array_Element_Id := No_Array_Element;
891 -- An associative array listing body file names that do not have the
892 -- body suffix. Not used by Ada. Indexed by programming language name.
896 function Spec_Suffix_Of
897 (In_Tree : Project_Tree_Ref;
899 Naming : Naming_Data) return String;
901 function Spec_Suffix_Id_Of
902 (In_Tree : Project_Tree_Ref;
904 Naming : Naming_Data) return File_Name_Type;
906 function Spec_Suffix_Id_Of
907 (In_Tree : Project_Tree_Ref;
908 Language_Id : Name_Id;
909 Naming : Naming_Data) return File_Name_Type;
911 procedure Set_Spec_Suffix
912 (In_Tree : Project_Tree_Ref;
914 Naming : in out Naming_Data;
915 Suffix : File_Name_Type);
917 function Body_Suffix_Id_Of
918 (In_Tree : Project_Tree_Ref;
920 Naming : Naming_Data) return File_Name_Type;
922 function Body_Suffix_Id_Of
923 (In_Tree : Project_Tree_Ref;
924 Language_Id : Name_Id;
925 Naming : Naming_Data) return File_Name_Type;
927 function Body_Suffix_Of
928 (In_Tree : Project_Tree_Ref;
930 Naming : Naming_Data) return String;
932 procedure Set_Body_Suffix
933 (In_Tree : Project_Tree_Ref;
935 Naming : in out Naming_Data;
936 Suffix : File_Name_Type);
938 function Objects_Exist_For
940 In_Tree : Project_Tree_Ref) return Boolean;
942 function Standard_Naming_Data
943 (Tree : Project_Tree_Ref := No_Project_Tree) return Naming_Data;
944 pragma Inline (Standard_Naming_Data);
945 -- The standard GNAT naming scheme when Tree is No_Project_Tree.
946 -- Otherwise, return the default naming scheme for the project tree Tree,
947 -- which must have been Initialized.
949 function Same_Naming_Scheme
950 (Left, Right : Naming_Data) return Boolean;
951 -- Returns True if Left and Right are the same naming scheme
952 -- not considering Specs and Bodies.
954 type Project_List is new Nat;
955 Empty_Project_List : constant Project_List := 0;
956 -- A list of project files
958 type Project_Element is record
959 Project : Project_Id := No_Project;
960 Next : Project_List := Empty_Project_List;
962 -- Element in a list of project files. Next is the id of the next
963 -- project file in the list.
965 package Project_List_Table is new GNAT.Dynamic_Tables
966 (Table_Component_Type => Project_Element,
967 Table_Index_Type => Project_List,
968 Table_Low_Bound => 1,
969 Table_Initial => 100,
970 Table_Increment => 100);
971 -- The table that contains the lists of project files
973 type Response_File_Format is
978 -- The format of the different response files
980 type Project_Configuration is record
981 Target : Name_Id := No_Name;
982 -- The target of the configuration, when specified
984 Run_Path_Option : Name_List_Index := No_Name_List;
985 -- The option to use when linking to specify the path where to look for
988 Separate_Run_Path_Options : Boolean := False;
989 -- True if each directory needs to be specified in a separate run path
992 Executable_Suffix : Name_Id := No_Name;
993 -- The suffix of executables, when specified in the configuration or in
994 -- package Builder of the main project. When this is not specified, the
995 -- executable suffix is the default for the platform.
999 Linker : Path_Name_Type := No_Path;
1000 -- Path name of the linker driver. Specified in the configuration or in
1001 -- the package Builder of the main project.
1003 Map_File_Option : Name_Id := No_Name;
1004 -- Option to use when invoking the linker to build a map file
1006 Minimum_Linker_Options : Name_List_Index := No_Name_List;
1007 -- The minimum options for the linker driver. Specified in the
1010 Linker_Executable_Option : Name_List_Index := No_Name_List;
1011 -- The option(s) to indicate the name of the executable in the linker
1012 -- command. Specified in the configuration. When not specified, default
1013 -- to -o <executable name>.
1015 Linker_Lib_Dir_Option : Name_Id := No_Name;
1016 -- The option to specify where to find a library for linking. Specified
1017 -- in the configuration. When not specified, defaults to "-L".
1019 Linker_Lib_Name_Option : Name_Id := No_Name;
1020 -- The option to specify the name of a library for linking. Specified in
1021 -- the configuration. When not specified, defaults to "-l".
1023 Max_Command_Line_Length : Natural := 0;
1024 -- When positive and when Resp_File_Format (see below) is not None,
1025 -- if the command line for the invocation of the linker would be greater
1026 -- than this value, a response file is used to invoke the linker.
1028 Resp_File_Format : Response_File_Format := None;
1029 -- The format of a response file, when linking with a response file is
1032 Resp_File_Options : Name_List_Index := No_Name_List;
1033 -- The switches, if any, that precede the path name of the response
1034 -- file in the invocation of the linker.
1038 Library_Builder : Path_Name_Type := No_Path;
1039 -- The executable to build library (specified in the configuration)
1041 Lib_Support : Library_Support := None;
1042 -- The level of library support. Specified in the configuration. Support
1043 -- is none, static libraries only or both static and shared libraries.
1045 Archive_Builder : Name_List_Index := No_Name_List;
1046 -- The name of the executable to build archives, with the minimum
1047 -- switches. Specified in the configuration.
1049 Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
1050 -- The options to append object files to an archive
1052 Archive_Indexer : Name_List_Index := No_Name_List;
1053 -- The name of the executable to index archives, with the minimum
1054 -- switches. Specified in the configuration.
1056 Archive_Suffix : File_Name_Type := No_File;
1057 -- The suffix of archives. Specified in the configuration. When not
1058 -- specified, defaults to ".a".
1060 Lib_Partial_Linker : Name_List_Index := No_Name_List;
1064 Shared_Lib_Driver : File_Name_Type := No_File;
1065 -- The driver to link shared libraries. Set with attribute Library_GCC.
1068 Shared_Lib_Prefix : File_Name_Type := No_File;
1069 -- Part of a shared library file name that precedes the name of the
1070 -- library. Specified in the configuration. When not specified, defaults
1073 Shared_Lib_Suffix : File_Name_Type := No_File;
1074 -- Suffix of shared libraries, after the library name in the shared
1075 -- library name. Specified in the configuration. When not specified,
1076 -- default to ".so".
1078 Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1079 -- The minimum options to use when building a shared library
1081 Lib_Version_Options : Name_List_Index := No_Name_List;
1082 -- The options to use to specify a library version
1084 Symbolic_Link_Supported : Boolean := False;
1085 -- True if the platform supports symbolic link files
1087 Lib_Maj_Min_Id_Supported : Boolean := False;
1088 -- True if platform supports library major and minor options, such as
1089 -- libname.so -> libname.so.2 -> libname.so.2.4
1091 Auto_Init_Supported : Boolean := False;
1092 -- True if automatic initialisation is supported for shared stand-alone
1096 Default_Project_Config : constant Project_Configuration :=
1098 Run_Path_Option => No_Name_List,
1099 Separate_Run_Path_Options => False,
1100 Executable_Suffix => No_Name,
1102 Map_File_Option => No_Name,
1103 Minimum_Linker_Options => No_Name_List,
1104 Linker_Executable_Option => No_Name_List,
1105 Linker_Lib_Dir_Option => No_Name,
1106 Linker_Lib_Name_Option => No_Name,
1107 Library_Builder => No_Path,
1108 Max_Command_Line_Length => 0,
1109 Resp_File_Format => None,
1110 Resp_File_Options => No_Name_List,
1111 Lib_Support => None,
1112 Archive_Builder => No_Name_List,
1113 Archive_Builder_Append_Option => No_Name_List,
1114 Archive_Indexer => No_Name_List,
1115 Archive_Suffix => No_File,
1116 Lib_Partial_Linker => No_Name_List,
1117 Shared_Lib_Driver => No_File,
1118 Shared_Lib_Prefix => No_File,
1119 Shared_Lib_Suffix => No_File,
1120 Shared_Lib_Min_Options => No_Name_List,
1121 Lib_Version_Options => No_Name_List,
1122 Symbolic_Link_Supported => False,
1123 Lib_Maj_Min_Id_Supported => False,
1124 Auto_Init_Supported => False);
1126 -- The following record describes a project file representation
1128 -- Note that it is not specified if the path names of directories (source,
1129 -- object, library or exec directories) end with or without a directory
1132 type Project_Data is record
1138 Name : Name_Id := No_Name;
1139 -- The name of the project
1141 Display_Name : Name_Id := No_Name;
1142 -- The name of the project with the spelling of its declaration
1144 Qualifier : Project_Qualifier := Unspecified;
1145 -- The eventual qualifier for this project
1147 Externally_Built : Boolean := False;
1148 -- True if the project is externally built. In such case, the Project
1149 -- Manager will not modify anything in this project.
1151 Config : Project_Configuration;
1153 Path : Path_Information := No_Path_Information;
1154 -- The path name of the project file
1156 Virtual : Boolean := False;
1157 -- True for virtual extending projects
1159 Location : Source_Ptr := No_Location;
1160 -- The location in the project file source of the reserved word project
1162 Naming : Naming_Data := Standard_Naming_Data;
1163 -- The naming scheme of this project file
1169 Languages : Language_Ptr := No_Language_Index;
1170 -- First index of the language data in the project.
1171 -- This is an index into the project_tree_data.languages_data.
1172 -- Traversing the list gives access to all the languages supported by
1179 Mains : String_List_Id := Nil_String;
1180 -- List of mains specified by attribute Main
1182 Extends : Project_Id := No_Project;
1183 -- The reference of the project file, if any, that this project file
1186 Extended_By : Project_Id := No_Project;
1187 -- The reference of the project file, if any, that extends this project
1190 Decl : Declarations := No_Declarations;
1191 -- The declarations (variables, attributes and packages) of this project
1194 Imported_Projects : Project_List := Empty_Project_List;
1195 -- The list of all directly imported projects, if any
1197 All_Imported_Projects : Project_List := Empty_Project_List;
1198 -- The list of all projects imported directly or indirectly, if any
1204 Directory : Path_Information := No_Path_Information;
1205 -- Path name of the directory where the project file resides
1207 Dir_Path : String_Access;
1208 -- Same as Directory.Name, but as an access to String
1210 Object_Directory : Path_Information := No_Path_Information;
1211 -- The path name of the object directory of this project file
1213 Exec_Directory : Path_Information := No_Path_Information;
1214 -- The path name of the exec directory of this project file. Default is
1215 -- equal to Object_Directory.
1221 Library : Boolean := False;
1222 -- True if this is a library project
1224 Library_Name : Name_Id := No_Name;
1225 -- If a library project, name of the library
1227 Library_Kind : Lib_Kind := Static;
1228 -- If a library project, kind of library
1230 Library_Dir : Path_Information := No_Path_Information;
1231 -- If a library project, path name of the directory where the library
1234 Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1235 -- The timestamp of a library file in a library project
1237 Library_Src_Dir : Path_Information := No_Path_Information;
1238 -- If a Stand-Alone Library project, path name of the directory where
1239 -- the sources of the interfaces of the library are copied. By default,
1240 -- if attribute Library_Src_Dir is not specified, sources of the
1241 -- interfaces are not copied anywhere.
1243 Library_ALI_Dir : Path_Information := No_Path_Information;
1244 -- In a library project, path name of the directory where the ALI files
1245 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1246 -- are copied in the Library_Dir.
1248 Lib_Internal_Name : Name_Id := No_Name;
1249 -- If a library project, internal name store inside the library
1251 Standalone_Library : Boolean := False;
1252 -- Indicate that this is a Standalone Library Project File
1254 Lib_Interface_ALIs : String_List_Id := Nil_String;
1255 -- For Standalone Library Project Files, indicate the list of Interface
1258 Lib_Auto_Init : Boolean := False;
1259 -- For non static Stand-Alone Library Project Files, indicate if
1260 -- the library initialisation should be automatic.
1262 Symbol_Data : Symbol_Record := No_Symbols;
1263 -- Symbol file name, reference symbol file name, symbol policy
1265 Need_To_Build_Lib : Boolean := False;
1266 -- Indicates that the library of a Library Project needs to be built or
1273 Ada_Sources_Present : Boolean := True;
1274 -- True if there are Ada sources in the project
1276 Other_Sources_Present : Boolean := True;
1277 -- True if there are non-Ada sources in the project
1279 Ada_Sources : String_List_Id := Nil_String;
1280 -- The list of all the Ada source file names (gnatmake only)
1282 First_Source : Source_Id := No_Source;
1283 Last_Source : Source_Id := No_Source;
1284 -- Head and tail of the list of sources
1286 Interfaces_Defined : Boolean := False;
1287 -- True if attribute Interfaces is declared for the project or any
1288 -- project it extends.
1290 Imported_Directories_Switches : Argument_List_Access := null;
1291 -- List of the source search switches (-I<source dir>) to be used when
1294 Include_Path : String_Access := null;
1295 -- The search source path for the project. Used as the value for an
1296 -- environment variable, specified by attribute Include_Path
1297 -- (<language>). The names of the environment variables are in component
1298 -- Include_Path of the records Language_Config.
1300 Include_Path_File : Path_Name_Type := No_Path;
1301 -- The path name of the of the source search directory file
1303 Include_Data_Set : Boolean := False;
1304 -- Set True when Imported_Directories_Switches or Include_Path are set
1306 Source_Dirs : String_List_Id := Nil_String;
1307 -- The list of all the source directories
1309 Known_Order_Of_Source_Dirs : Boolean := True;
1310 -- False, if there is any /** in the Source_Dirs, because in this case
1311 -- the ordering of the source subdirs depend on the OS. If True,
1312 -- duplicate file names in the same project file are allowed.
1314 Ada_Include_Path : String_Access := null;
1315 -- The cached value of source search path for this project file. Set by
1316 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1317 -- use this field directly outside of the project manager, use
1318 -- Prj.Env.Ada_Include_Path instead.
1324 Ada_Objects_Path : String_Access := null;
1325 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1326 -- use this field directly outside of the compiler, use
1327 -- Prj.Env.Ada_Objects_Path instead.
1329 Libgnarl_Needed : Yes_No_Unknown := Unknown;
1330 -- Set to True when libgnarl is needed to link
1332 Objects_Path : String_Access := null;
1333 -- The cached value of the object dir path, used during the binding
1334 -- phase of gprbuild.
1336 Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1337 -- The cached value of the object path temp file (including library
1338 -- dirs) for this project file.
1340 Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1341 -- The cached value of the object path temp file (excluding library
1342 -- dirs) for this project file.
1344 Config_File_Name : Path_Name_Type := No_Path;
1345 -- The path name of the configuration pragmas file, if any
1347 Config_File_Temp : Boolean := False;
1348 -- An indication that the configuration pragmas file is a temporary file
1349 -- that must be deleted at the end.
1351 Config_Checked : Boolean := False;
1352 -- A flag to avoid checking repetitively the configuration pragmas file
1354 Checked : Boolean := False;
1355 -- A flag to avoid checking repetitively the naming scheme of this
1358 Seen : Boolean := False;
1359 -- A flag to mark a project as "visited" to avoid processing the same
1360 -- project several time.
1362 Depth : Natural := 0;
1363 -- The maximum depth of a project in the project graph. Depth of main
1366 Unkept_Comments : Boolean := False;
1367 -- True if there are comments in the project sources that cannot be kept
1368 -- in the project tree.
1372 function Empty_Project (Tree : Project_Tree_Ref) return Project_Data;
1373 -- Return the representation of an empty project in project Tree tree.
1374 -- The project tree Tree must have been Initialized and/or Reset.
1376 function Is_Extending
1377 (Extending : Project_Id;
1378 Extended : Project_Id;
1379 In_Tree : Project_Tree_Ref) return Boolean;
1380 -- ??? needs comment
1382 function Is_A_Language
1383 (Data : Project_Data;
1384 Language_Name : Name_Id) return Boolean;
1385 -- Return True when Language_Name (which must be lower case) is one of the
1386 -- languages used for the project.
1388 Project_Error : exception;
1389 -- Raised by some subprograms in Prj.Attr
1391 package Project_Table is new GNAT.Dynamic_Tables (
1392 Table_Component_Type => Project_Data,
1393 Table_Index_Type => Project_Id,
1394 Table_Low_Bound => 1,
1395 Table_Initial => 100,
1396 Table_Increment => 100);
1397 -- The set of all project files
1399 type Spec_Or_Body is (Specification, Body_Part);
1401 type File_Name_Data is record
1402 Name : File_Name_Type := No_File;
1404 Display_Name : File_Name_Type := No_File;
1405 Path : Path_Information := No_Path_Information;
1406 Project : Project_Id := No_Project;
1407 Needs_Pragma : Boolean := False;
1409 -- File and Path name of a spec or body
1411 type File_Names_Data is array (Spec_Or_Body) of File_Name_Data;
1413 type Unit_Index is new Nat;
1414 No_Unit_Index : constant Unit_Index := 0;
1415 type Unit_Data is record
1416 Name : Name_Id := No_Name;
1417 File_Names : File_Names_Data;
1419 -- Name and File and Path names of a unit, with a reference to its
1420 -- GNAT Project File(s).
1422 package Unit_Table is new GNAT.Dynamic_Tables
1423 (Table_Component_Type => Unit_Data,
1424 Table_Index_Type => Unit_Index,
1425 Table_Low_Bound => 1,
1426 Table_Initial => 100,
1427 Table_Increment => 100);
1428 -- Table of all units in a project tree
1430 package Units_Htable is new Simple_HTable
1431 (Header_Num => Header_Num,
1432 Element => Unit_Index,
1433 No_Element => No_Unit_Index,
1437 -- Mapping of unit names to indexes in the Units table
1439 type Unit_Project is record
1440 Unit : Unit_Index := No_Unit_Index;
1441 Project : Project_Id := No_Project;
1444 No_Unit_Project : constant Unit_Project := (No_Unit_Index, No_Project);
1446 package Files_Htable is new Simple_HTable
1447 (Header_Num => Header_Num,
1448 Element => Unit_Project,
1449 No_Element => No_Unit_Project,
1450 Key => File_Name_Type,
1453 -- Mapping of file names to indexes in the Units table
1455 type Private_Project_Tree_Data is private;
1456 -- Data for a project tree that is used only by the Project Manager
1458 type Project_Tree_Data is
1460 -- Languages and sources of the project
1462 First_Language : Language_Ptr := No_Language_Index;
1465 First_Source : Source_Id := No_Source;
1470 Name_Lists : Name_List_Table.Instance;
1471 String_Elements : String_Element_Table.Instance;
1472 Variable_Elements : Variable_Element_Table.Instance;
1473 Array_Elements : Array_Element_Table.Instance;
1474 Arrays : Array_Table.Instance;
1475 Packages : Package_Table.Instance;
1476 Project_Lists : Project_List_Table.Instance;
1477 Projects : Project_Table.Instance;
1478 Sources : Source_Data_Table.Instance;
1479 Alt_Langs : Alternate_Language_Table.Instance;
1480 Units : Unit_Table.Instance;
1481 Units_HT : Units_Htable.Instance;
1482 Files_HT : Files_Htable.Instance;
1483 Source_Paths_HT : Source_Paths_Htable.Instance;
1484 Unit_Sources_HT : Unit_Sources_Htable.Instance;
1488 Private_Part : Private_Project_Tree_Data;
1490 -- Data for a project tree
1492 type Put_Line_Access is access procedure
1494 Project : Project_Id;
1495 In_Tree : Project_Tree_Ref);
1496 -- Use to customize error reporting in Prj.Proc and Prj.Nmsc
1498 procedure Expect (The_Token : Token_Type; Token_Image : String);
1499 -- Check that the current token is The_Token. If it is not, then output
1500 -- an error message.
1502 procedure Initialize (Tree : Project_Tree_Ref);
1503 -- This procedure must be called before using any services from the Prj
1504 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1506 procedure Reset (Tree : Project_Tree_Ref);
1507 -- This procedure resets all the tables that are used when processing a
1508 -- project file tree. Initialize must be called before the call to Reset.
1510 procedure Register_Default_Naming_Scheme
1511 (Language : Name_Id;
1512 Default_Spec_Suffix : File_Name_Type;
1513 Default_Body_Suffix : File_Name_Type;
1514 In_Tree : Project_Tree_Ref);
1515 -- Register the default suffixes for a given language. These extensions
1516 -- will be ignored if the user has specified a new naming scheme in a
1519 -- Otherwise, this information will be automatically added to Naming_Data
1520 -- when a project is processed, in the lists Spec_Suffix and Body_Suffix.
1523 type State is limited private;
1524 with procedure Action
1525 (Project : Project_Id;
1526 With_State : in out State);
1527 procedure For_Every_Project_Imported
1529 In_Tree : Project_Tree_Ref;
1530 With_State : in out State);
1531 -- Call Action for each project imported directly or indirectly by project
1532 -- By. Action is called according to the order of importation: if A
1533 -- imports B, directly or indirectly, Action will be called for A before
1534 -- it is called for B. If two projects import each other directly or
1535 -- indirectly (using at least one "limited with"), it is not specified
1536 -- for which of these two projects Action will be called first. Projects
1537 -- that are extended by other projects are not considered. With_State may
1538 -- be used by Action to choose a behavior or to report some global result.
1540 function Extend_Name
1541 (File : File_Name_Type;
1542 With_Suffix : String) return File_Name_Type;
1543 -- Replace the extension of File with With_Suffix
1545 function Object_Name
1546 (Source_File_Name : File_Name_Type;
1547 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1548 -- Returns the object file name corresponding to a source file name
1550 function Dependency_Name
1551 (Source_File_Name : File_Name_Type;
1552 Dependency : Dependency_File_Kind) return File_Name_Type;
1553 -- Returns the dependency file name corresponding to a source file name
1555 function Switches_Name
1556 (Source_File_Name : File_Name_Type) return File_Name_Type;
1557 -- Returns the switches file name corresponding to a source file name
1563 procedure Record_Temp_File (Path : Path_Name_Type);
1564 -- Record the path of a newly created temporary file, so that it can be
1567 procedure Delete_All_Temp_Files;
1568 -- Delete all recorded temporary files
1572 All_Packages : constant String_List_Access := null;
1574 No_Project_Tree : constant Project_Tree_Ref := null;
1576 Ignored : constant Variable_Kind := Single;
1578 Nil_Variable_Value : constant Variable_Value :=
1579 (Project => No_Project,
1581 Location => No_Location,
1584 Virtual_Prefix : constant String := "v$";
1585 -- The prefix for virtual extending projects. Because of the '$', which is
1586 -- normally forbidden for project names, there cannot be any name clash.
1588 Empty_Name : Name_Id;
1589 -- Name_Id for an empty name (no characters). Initialized in procedure
1592 Empty_File_Name : File_Name_Type;
1593 -- Empty File_Name_Type (no characters). Initialized in procedure
1596 procedure Add_To_Buffer
1598 To : in out String_Access;
1599 Last : in out Natural);
1600 -- Append a String to the Buffer
1602 type Naming_Id is new Nat;
1604 package Naming_Table is new GNAT.Dynamic_Tables
1605 (Table_Component_Type => Naming_Data,
1606 Table_Index_Type => Naming_Id,
1607 Table_Low_Bound => 1,
1609 Table_Increment => 100);
1610 -- Table storing the naming data for gnatmake/gprmake
1612 package Path_File_Table is new GNAT.Dynamic_Tables
1613 (Table_Component_Type => Path_Name_Type,
1614 Table_Index_Type => Natural,
1615 Table_Low_Bound => 1,
1616 Table_Initial => 50,
1617 Table_Increment => 100);
1618 -- Table storing all the temp path file names.
1619 -- Used by Delete_All_Path_Files.
1621 package Source_Path_Table is new GNAT.Dynamic_Tables
1622 (Table_Component_Type => Name_Id,
1623 Table_Index_Type => Natural,
1624 Table_Low_Bound => 1,
1625 Table_Initial => 50,
1626 Table_Increment => 100);
1627 -- A table to store the source dirs before creating the source path file
1629 package Object_Path_Table is new GNAT.Dynamic_Tables
1630 (Table_Component_Type => Path_Name_Type,
1631 Table_Index_Type => Natural,
1632 Table_Low_Bound => 1,
1633 Table_Initial => 50,
1634 Table_Increment => 100);
1635 -- A table to store the object dirs, before creating the object path file
1637 type Private_Project_Tree_Data is record
1638 Namings : Naming_Table.Instance;
1639 Path_Files : Path_File_Table.Instance;
1640 Source_Paths : Source_Path_Table.Instance;
1641 Object_Paths : Object_Path_Table.Instance;
1642 Default_Naming : Naming_Data;
1644 -- Type to represent the part of a project tree which is private to the