1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2008, 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 function Default_Ada_Spec_Suffix return File_Name_Type;
120 pragma Inline (Default_Ada_Spec_Suffix);
121 -- The name for the standard GNAT suffix for Ada spec source file name
122 -- ".ads". Initialized by Prj.Initialize.
124 function Default_Ada_Body_Suffix return File_Name_Type;
125 pragma Inline (Default_Ada_Body_Suffix);
126 -- The name for the standard GNAT suffix for Ada body source file name
127 -- ".adb". Initialized by Prj.Initialize.
129 function Slash return Path_Name_Type;
130 pragma Inline (Slash);
131 -- "/", used as the path of locally removed files
133 Config_Project_File_Extension : String := ".cgpr";
134 Project_File_Extension : String := ".gpr";
135 -- The standard config and user project file name extensions. They are not
136 -- constants, because Canonical_Case_File_Name is called on these variables
137 -- in the body of Prj.
139 type Error_Warning is (Silent, Warning, Error);
140 -- Severity of some situations, such as: no Ada sources in a project where
141 -- Ada is one of the language.
143 -- When the situation occurs, the behaviour depends on the setting:
145 -- - Silent: no action
146 -- - Warning: issue a warning, does not cause the tool to fail
147 -- - Error: issue an error, causes the tool to fail
149 function Empty_File return File_Name_Type;
150 function Empty_String return Name_Id;
151 -- Return the id for an empty string ""
153 type Path_Information is record
154 Name : Path_Name_Type := No_Path;
155 Display_Name : Path_Name_Type := No_Path;
158 No_Path_Information : constant Path_Information := (No_Path, No_Path);
160 type Project_Id is new Nat;
161 No_Project : constant Project_Id := 0;
162 -- Id of a Project File
164 type String_List_Id is new Nat;
165 Nil_String : constant String_List_Id := 0;
166 type String_Element is record
167 Value : Name_Id := No_Name;
169 Display_Value : Name_Id := No_Name;
170 Location : Source_Ptr := No_Location;
171 Flag : Boolean := False;
172 Next : String_List_Id := Nil_String;
174 -- To hold values for string list variables and array elements.
175 -- Component Flag may be used for various purposes. For source
176 -- directories, it indicates if the directory contains Ada source(s).
178 package String_Element_Table is new GNAT.Dynamic_Tables
179 (Table_Component_Type => String_Element,
180 Table_Index_Type => String_List_Id,
181 Table_Low_Bound => 1,
182 Table_Initial => 200,
183 Table_Increment => 100);
184 -- The table for string elements in string lists
186 type Variable_Kind is (Undefined, List, Single);
187 -- Different kinds of variables
189 subtype Defined_Variable_Kind is Variable_Kind range List .. Single;
190 -- The defined kinds of variables
192 Ignored : constant Variable_Kind;
193 -- Used to indicate that a package declaration must be ignored
194 -- while processing the project tree (unknown package name).
196 type Variable_Value (Kind : Variable_Kind := Undefined) is record
197 Project : Project_Id := No_Project;
198 Location : Source_Ptr := No_Location;
199 Default : Boolean := False;
204 Values : String_List_Id := Nil_String;
206 Value : Name_Id := No_Name;
210 -- Values for variables and array elements. Default is True if the
211 -- current value is the default one for the variable
213 Nil_Variable_Value : constant Variable_Value;
214 -- Value of a non existing variable or array element
216 type Variable_Id is new Nat;
217 No_Variable : constant Variable_Id := 0;
218 type Variable is record
219 Next : Variable_Id := No_Variable;
221 Value : Variable_Value;
223 -- To hold the list of variables in a project file and in packages
225 package Variable_Element_Table is new GNAT.Dynamic_Tables
226 (Table_Component_Type => Variable,
227 Table_Index_Type => Variable_Id,
228 Table_Low_Bound => 1,
229 Table_Initial => 200,
230 Table_Increment => 100);
231 -- The table of variable in list of variables
233 type Array_Element_Id is new Nat;
234 No_Array_Element : constant Array_Element_Id := 0;
235 type Array_Element is record
237 Src_Index : Int := 0;
238 Index_Case_Sensitive : Boolean := True;
239 Value : Variable_Value;
240 Next : Array_Element_Id := No_Array_Element;
242 -- Each Array_Element represents an array element and is linked (Next)
243 -- to the next array element, if any, in the array.
245 package Array_Element_Table is new GNAT.Dynamic_Tables
246 (Table_Component_Type => Array_Element,
247 Table_Index_Type => Array_Element_Id,
248 Table_Low_Bound => 1,
249 Table_Initial => 200,
250 Table_Increment => 100);
251 -- The table that contains all array elements
253 type Array_Id is new Nat;
254 No_Array : constant Array_Id := 0;
255 type Array_Data is record
256 Name : Name_Id := No_Name;
257 Location : Source_Ptr := No_Location;
258 Value : Array_Element_Id := No_Array_Element;
259 Next : Array_Id := No_Array;
261 -- Each Array_Data value represents an array.
262 -- Value is the id of the first element.
263 -- Next is the id of the next array in the project file or package.
265 package Array_Table is new GNAT.Dynamic_Tables
266 (Table_Component_Type => Array_Data,
267 Table_Index_Type => Array_Id,
268 Table_Low_Bound => 1,
269 Table_Initial => 200,
270 Table_Increment => 100);
271 -- The table that contains all arrays
273 type Package_Id is new Nat;
274 No_Package : constant Package_Id := 0;
275 type Declarations is record
276 Variables : Variable_Id := No_Variable;
277 Attributes : Variable_Id := No_Variable;
278 Arrays : Array_Id := No_Array;
279 Packages : Package_Id := No_Package;
281 -- Contains the declarations (variables, single and array attributes,
282 -- packages) for a project or a package in a project.
284 No_Declarations : constant Declarations :=
285 (Variables => No_Variable,
286 Attributes => No_Variable,
288 Packages => No_Package);
289 -- Default value of Declarations: indicates that there is no declarations
291 type Package_Element is record
292 Name : Name_Id := No_Name;
293 Decl : Declarations := No_Declarations;
294 Parent : Package_Id := No_Package;
295 Next : Package_Id := No_Package;
297 -- A package (includes declarations that may include other packages)
299 package Package_Table is new GNAT.Dynamic_Tables
300 (Table_Component_Type => Package_Element,
301 Table_Index_Type => Package_Id,
302 Table_Low_Bound => 1,
303 Table_Initial => 100,
304 Table_Increment => 100);
305 -- The table that contains all packages
307 type Language_Index is new Nat;
308 -- Index of language data
310 No_Language_Index : constant Language_Index := 0;
311 -- Constant indicating that there is no language data
313 procedure Display_Language_Name
314 (In_Tree : Project_Tree_Ref;
315 Language : Language_Index);
316 -- Output the name of a language
318 Max_Header_Num : constant := 6150;
319 type Header_Num is range 0 .. Max_Header_Num;
320 -- Size for hash table below. The upper bound is an arbitrary value, the
321 -- value here was chosen after testing to determine a good compromise
322 -- between speed of access and memory usage.
324 function Hash (Name : Name_Id) return Header_Num;
325 function Hash (Name : File_Name_Type) return Header_Num;
326 function Hash (Name : Path_Name_Type) return Header_Num;
327 -- Used for computing hash values for names put into above hash table
329 function Hash (Project : Project_Id) return Header_Num;
330 -- Used for hash tables where Project_Id is the Key
332 type Language_Kind is (File_Based, Unit_Based);
333 -- Type for the kind of language. All languages are file based, except Ada
334 -- which is unit based.
336 type Dependency_File_Kind is (None, Makefile, ALI_File);
337 -- Type of dependency to be checked: no dependency file, Makefile fragment
338 -- or ALI file (for Ada).
340 Makefile_Dependency_Suffix : constant String := ".d";
341 ALI_Dependency_Suffix : constant String := ".ali";
343 Switches_Dependency_Suffix : constant String := ".cswi";
345 Binder_Exchange_Suffix : constant String := ".bexch";
346 -- Suffix for binder exchange files
348 Library_Exchange_Suffix : constant String := ".lexch";
349 -- Suffix for library exchange files
351 type Name_List_Index is new Nat;
352 No_Name_List : constant Name_List_Index := 0;
354 type Name_Node is record
355 Name : Name_Id := No_Name;
356 Next : Name_List_Index := No_Name_List;
359 package Name_List_Table is new GNAT.Dynamic_Tables
360 (Table_Component_Type => Name_Node,
361 Table_Index_Type => Name_List_Index,
362 Table_Low_Bound => 1,
364 Table_Increment => 100);
365 -- The table for lists of names used in package Language_Processing
367 package Mapping_Files_Htable is new Simple_HTable
368 (Header_Num => Header_Num,
369 Element => Path_Name_Type,
370 No_Element => No_Path,
371 Key => Path_Name_Type,
374 -- A hash table to store the mapping files that are not used
376 type Lang_Naming_Data is record
377 Dot_Replacement : File_Name_Type := No_File;
378 -- The string to replace '.' in the source file name (for Ada)
380 Casing : Casing_Type := All_Lower_Case;
381 -- The casing of the source file name (for Ada)
383 Separate_Suffix : File_Name_Type := No_File;
384 -- String to append to unit name for source file name of an Ada subunit
386 Spec_Suffix : File_Name_Type := No_File;
387 -- The string to append to the unit name for the
388 -- source file name of a spec.
390 Body_Suffix : File_Name_Type := No_File;
391 -- The string to append to the unit name for the
392 -- source file name of a body.
395 No_Lang_Naming_Data : constant Lang_Naming_Data :=
396 (Dot_Replacement => No_File,
397 Casing => All_Lower_Case,
398 Separate_Suffix => No_File,
399 Spec_Suffix => No_File,
400 Body_Suffix => No_File);
402 type Source_Id is new Nat;
404 No_Source : constant Source_Id := 0;
406 type Path_Syntax_Kind is
411 -- Host specific syntax, for example on VMS (the default)
413 type Language_Config is record
414 Kind : Language_Kind := File_Based;
415 -- Kind of language. All languages are file based, except Ada which is
418 Naming_Data : Lang_Naming_Data;
419 -- The naming data for the languages (prefixes, etc.)
421 Include_Compatible_Languages : Name_List_Index := No_Name_List;
422 -- The list of languages that are "include compatible" with this
423 -- language. A language B (for example "C") is "include compatible" with
424 -- a language A (for example "C++") if it is expected that sources of
425 -- language A may "include" header files from language B.
427 Compiler_Driver : File_Name_Type := No_File;
428 -- The name of the executable for the compiler of the language
430 Compiler_Driver_Path : String_Access := null;
431 -- The path name of the executable for the compiler of the language
433 Compiler_Required_Switches : Name_List_Index := No_Name_List;
434 -- The list of switches that are required as a minimum to invoke the
437 Path_Syntax : Path_Syntax_Kind := Host;
438 -- Value may be Canonical (Unix style) or Host (host syntax, for example
439 -- on VMS for DEC C).
441 Compilation_PIC_Option : Name_List_Index := No_Name_List;
442 -- The option(s) to compile a source in Position Independent Code for
443 -- shared libraries. Specified in the configuration. When not specified,
444 -- there is no need for such switch.
446 Object_Generated : Boolean := True;
447 -- False in no object file is generated
449 Objects_Linked : Boolean := True;
450 -- False if object files are not use to link executables and build
453 Runtime_Library_Dir : Name_Id := No_Name;
454 -- Path name of the runtime library directory, if any
456 Mapping_File_Switches : Name_List_Index := No_Name_List;
457 -- The option(s) to provide a mapping file to the compiler. Specified in
458 -- the configuration. When value is No_Name_List, there is no mapping
461 Mapping_Spec_Suffix : File_Name_Type := No_File;
462 -- Placeholder representing the spec suffix in a mapping file
464 Mapping_Body_Suffix : File_Name_Type := No_File;
465 -- Placeholder representing the body suffix in a mapping file
467 Config_File_Switches : Name_List_Index := No_Name_List;
468 -- The option(s) to provide a config file to the compiler. Specified in
469 -- the configuration. When value is No_Name_List, there is no config
472 Dependency_Kind : Dependency_File_Kind := None;
473 -- The kind of dependency to be checked: none, Makefile fragment or
474 -- ALI file (for Ada).
476 Dependency_Option : Name_List_Index := No_Name_List;
477 -- The option(s) to be used to create the dependency file. When value is
478 -- No_Name_List, there is not such option(s).
480 Compute_Dependency : Name_List_Index := No_Name_List;
481 -- Hold the value of attribute Dependency_Driver, if declared for the
484 Include_Option : Name_List_Index := No_Name_List;
485 -- Hold the value of attribute Include_Switches, if declared for the
488 Include_Path : Name_Id := No_Name;
489 -- Name of environment variable declared by attribute Include_Path for
492 Include_Path_File : Name_Id := No_Name;
493 -- Name of environment variable declared by attribute Include_Path_File
496 Objects_Path : Name_Id := No_Name;
497 -- Name of environment variable declared by attribute Objects_Path for
500 Objects_Path_File : Name_Id := No_Name;
501 -- Name of environment variable declared by attribute Objects_Path_File
504 Config_Body : Name_Id := No_Name;
505 -- The template for a pragma Source_File_Name(_Project) for a specific
506 -- file name of a body.
508 Config_Spec : Name_Id := No_Name;
509 -- The template for a pragma Source_File_Name(_Project) for a specific
510 -- file name of a spec.
512 Config_Body_Pattern : Name_Id := No_Name;
513 -- The template for a pragma Source_File_Name(_Project) for a naming
516 Config_Spec_Pattern : Name_Id := No_Name;
517 -- The template for a pragma Source_File_Name(_Project) for a naming
520 Config_File_Unique : Boolean := False;
521 -- Indicate if the config file specified to the compiler needs to be
522 -- unique. If it is unique, then all config files are concatenated into
523 -- a temp config file.
525 Binder_Driver : File_Name_Type := No_File;
526 -- The name of the binder driver for the language, if any
528 Binder_Driver_Path : Path_Name_Type := No_Path;
529 -- The path name of the binder driver
531 Binder_Required_Switches : Name_List_Index := No_Name_List;
532 -- Hold the value of attribute Binder'Required_Switches for the language
534 Binder_Prefix : Name_Id := No_Name;
535 -- Hold the value of attribute Binder'Prefix for the language
537 Toolchain_Version : Name_Id := No_Name;
538 -- Hold the value of attribute Toolchain_Version for the language
540 Toolchain_Description : Name_Id := No_Name;
541 -- Hold the value of attribute Toolchain_Description for the language
544 -- Record describing the configuration of a language
546 No_Language_Config : constant Language_Config :=
548 Naming_Data => No_Lang_Naming_Data,
549 Include_Compatible_Languages => No_Name_List,
550 Compiler_Driver => No_File,
551 Compiler_Driver_Path => null,
552 Compiler_Required_Switches => No_Name_List,
553 Path_Syntax => Canonical,
554 Compilation_PIC_Option => No_Name_List,
555 Object_Generated => True,
556 Objects_Linked => True,
557 Runtime_Library_Dir => No_Name,
558 Mapping_File_Switches => No_Name_List,
559 Mapping_Spec_Suffix => No_File,
560 Mapping_Body_Suffix => No_File,
561 Config_File_Switches => No_Name_List,
562 Dependency_Kind => Makefile,
563 Dependency_Option => No_Name_List,
564 Compute_Dependency => No_Name_List,
565 Include_Option => No_Name_List,
566 Include_Path => No_Name,
567 Include_Path_File => No_Name,
568 Objects_Path => No_Name,
569 Objects_Path_File => No_Name,
570 Config_Body => No_Name,
571 Config_Spec => No_Name,
572 Config_Body_Pattern => No_Name,
573 Config_Spec_Pattern => No_Name,
574 Config_File_Unique => False,
575 Binder_Driver => No_File,
576 Binder_Driver_Path => No_Path,
577 Binder_Required_Switches => No_Name_List,
578 Binder_Prefix => No_Name,
579 Toolchain_Version => No_Name,
580 Toolchain_Description => No_Name);
582 type Language_Data is record
583 Name : Name_Id := No_Name;
584 Display_Name : Name_Id := No_Name;
585 Config : Language_Config := No_Language_Config;
586 First_Source : Source_Id := No_Source;
587 Mapping_Files : Mapping_Files_Htable.Instance :=
588 Mapping_Files_Htable.Nil;
589 Next : Language_Index := No_Language_Index;
592 No_Language_Data : constant Language_Data :=
594 Display_Name => No_Name,
595 Config => No_Language_Config,
596 First_Source => No_Source,
597 Mapping_Files => Mapping_Files_Htable.Nil,
598 Next => No_Language_Index);
600 package Language_Data_Table is new GNAT.Dynamic_Tables
601 (Table_Component_Type => Language_Data,
602 Table_Index_Type => Language_Index,
603 Table_Low_Bound => 1,
605 Table_Increment => 100);
606 -- The table for lists of names used in package Language_Processing
608 type Alternate_Language_Id is new Nat;
610 No_Alternate_Language : constant Alternate_Language_Id := 0;
612 type Alternate_Language_Data is record
613 Language : Language_Index := No_Language_Index;
614 Next : Alternate_Language_Id := No_Alternate_Language;
617 package Alternate_Language_Table is new GNAT.Dynamic_Tables
618 (Table_Component_Type => Alternate_Language_Data,
619 Table_Index_Type => Alternate_Language_Id,
620 Table_Low_Bound => 1,
622 Table_Increment => 100);
623 -- The table for storing the alternate languages of a header file that
624 -- is used for several languages.
626 type Source_Kind is (Spec, Impl, Sep);
628 type Source_Data is record
629 Project : Project_Id := No_Project;
630 -- Project of the source
632 Language_Name : Name_Id := No_Name;
633 -- Name of the language of the source
635 Language : Language_Index := No_Language_Index;
636 -- Index of the language
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
696 Object_Exists : Boolean := True;
697 -- True if an object file exists
699 Object_Linked : Boolean := True;
700 -- False if the object file is not use to link executables or included
703 Object : File_Name_Type := No_File;
704 -- File name of the object file
706 Current_Object_Path : Path_Name_Type := No_Path;
707 -- Object path of an existing object file
709 Object_Path : Path_Name_Type := No_Path;
710 -- Object path of the real object file
712 Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
713 -- Object file time stamp
715 Dep_Name : File_Name_Type := No_File;
716 -- Dependency file simple name
718 Current_Dep_Path : Path_Name_Type := No_Path;
719 -- Path name of an existing dependency file
721 Dep_Path : Path_Name_Type := No_Path;
722 -- Path name of the real dependency file
724 Dep_TS : Time_Stamp_Type := Empty_Time_Stamp;
725 -- Dependency file time stamp
727 Switches : File_Name_Type := No_File;
728 -- File name of the switches file. For all languages, this is a file
729 -- that ends with the .cswi extension.
731 Switches_Path : Path_Name_Type := No_Path;
732 -- Path name of the switches file
734 Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
735 -- Switches file time stamp
737 Naming_Exception : Boolean := False;
738 -- True if the source has an exceptional name
740 Next_In_Sources : Source_Id := No_Source;
741 -- Link to another source in the project tree
743 Next_In_Project : Source_Id := No_Source;
744 -- Link to another source in the project
746 Next_In_Lang : Source_Id := No_Source;
747 -- Link to another source of the same language
750 No_Source_Data : constant Source_Data :=
751 (Project => No_Project,
752 Language_Name => No_Name,
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 type Verbosity is (Default, Medium, High);
808 -- Verbosity when parsing GNAT Project Files
809 -- Default is default (very quiet, if no errors).
810 -- Medium is more verbose.
811 -- High is extremely verbose.
813 Current_Verbosity : Verbosity := Default;
814 -- The current value of the verbosity the project files are parsed with
816 type Lib_Kind is (Static, Dynamic, Relocatable);
818 type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
819 -- Type to specify the symbol policy, when symbol control is supported.
820 -- See full explanation about this type in package Symbols.
821 -- Autonomous: Create a symbol file without considering any reference
822 -- Compliant: Try to be as compatible as possible with an existing ref
823 -- Controlled: Fail if symbols are not the same as those in the reference
824 -- Restricted: Restrict the symbols to those in the symbol file
825 -- Direct: The symbol file is used as is
827 type Symbol_Record is record
828 Symbol_File : Path_Name_Type := No_Path;
829 Reference : Path_Name_Type := No_Path;
830 Symbol_Policy : Policy := Autonomous;
832 -- Type to keep the symbol data to be used when building a shared library
834 No_Symbols : constant Symbol_Record :=
835 (Symbol_File => No_Path,
836 Reference => No_Path,
837 Symbol_Policy => Autonomous);
838 -- The default value of the symbol data
840 function Image (Casing : Casing_Type) return String;
841 -- Similar to 'Image (but avoid use of this attribute in compiler)
843 function Value (Image : String) return Casing_Type;
844 -- Similar to 'Value (but avoid use of this attribute in compiler)
845 -- Raises Constraint_Error if not a Casing_Type image.
847 -- The following record contains data for a naming scheme
849 type Naming_Data is record
851 Dot_Replacement : File_Name_Type := No_File;
852 -- The string to replace '.' in the source file name (for Ada)
854 Dot_Repl_Loc : Source_Ptr := No_Location;
856 Casing : Casing_Type := All_Lower_Case;
857 -- The casing of the source file name (for Ada)
859 Spec_Suffix : Array_Element_Id := No_Array_Element;
860 -- The string to append to the unit name for the
861 -- source file name of a spec.
862 -- Indexed by the programming language.
864 Ada_Spec_Suffix_Loc : Source_Ptr := No_Location;
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 Ada_Body_Suffix_Loc : Source_Ptr := No_Location;
873 Separate_Suffix : File_Name_Type := No_File;
874 -- String to append to unit name for source file name of an Ada subunit
876 Sep_Suffix_Loc : Source_Ptr := No_Location;
877 -- Position in the project file source where Separate_Suffix is defined
879 Specs : Array_Element_Id := No_Array_Element;
880 -- An associative array mapping individual specs to source file names
881 -- This is specific to Ada.
883 Bodies : Array_Element_Id := No_Array_Element;
884 -- An associative array mapping individual bodies to source file names
885 -- This is specific to Ada.
887 Specification_Exceptions : Array_Element_Id := No_Array_Element;
888 -- An associative array listing spec file names that do not have the
889 -- spec suffix. Not used by Ada. Indexed by programming language name.
891 Implementation_Exceptions : Array_Element_Id := No_Array_Element;
892 -- An associative array listing body file names that do not have the
893 -- body suffix. Not used by Ada. Indexed by programming language name.
897 function Spec_Suffix_Of
898 (In_Tree : Project_Tree_Ref;
900 Naming : Naming_Data) return String;
902 function Spec_Suffix_Id_Of
903 (In_Tree : Project_Tree_Ref;
905 Naming : Naming_Data) return File_Name_Type;
907 function Spec_Suffix_Id_Of
908 (In_Tree : Project_Tree_Ref;
909 Language_Id : Name_Id;
910 Naming : Naming_Data) return File_Name_Type;
912 procedure Set_Spec_Suffix
913 (In_Tree : Project_Tree_Ref;
915 Naming : in out Naming_Data;
916 Suffix : File_Name_Type);
918 function Body_Suffix_Id_Of
919 (In_Tree : Project_Tree_Ref;
921 Naming : Naming_Data) return File_Name_Type;
923 function Body_Suffix_Id_Of
924 (In_Tree : Project_Tree_Ref;
925 Language_Id : Name_Id;
926 Naming : Naming_Data) return File_Name_Type;
928 function Body_Suffix_Of
929 (In_Tree : Project_Tree_Ref;
931 Naming : Naming_Data) return String;
933 procedure Set_Body_Suffix
934 (In_Tree : Project_Tree_Ref;
936 Naming : in out Naming_Data;
937 Suffix : File_Name_Type);
939 function Objects_Exist_For
941 In_Tree : Project_Tree_Ref) return Boolean;
943 function Standard_Naming_Data
944 (Tree : Project_Tree_Ref := No_Project_Tree) return Naming_Data;
945 pragma Inline (Standard_Naming_Data);
946 -- The standard GNAT naming scheme when Tree is No_Project_Tree.
947 -- Otherwise, return the default naming scheme for the project tree Tree,
948 -- which must have been Initialized.
950 function Same_Naming_Scheme
951 (Left, Right : Naming_Data) return Boolean;
952 -- Returns True if Left and Right are the same naming scheme
953 -- not considering Specs and Bodies.
955 type Project_List is new Nat;
956 Empty_Project_List : constant Project_List := 0;
957 -- A list of project files
959 type Project_Element is record
960 Project : Project_Id := No_Project;
961 Next : Project_List := Empty_Project_List;
963 -- Element in a list of project files. Next is the id of the next
964 -- project file in the list.
966 package Project_List_Table is new GNAT.Dynamic_Tables
967 (Table_Component_Type => Project_Element,
968 Table_Index_Type => Project_List,
969 Table_Low_Bound => 1,
970 Table_Initial => 100,
971 Table_Increment => 100);
972 -- The table that contains the lists of project files
974 type Project_Configuration is record
975 Run_Path_Option : Name_List_Index := No_Name_List;
976 -- The option to use when linking to specify the path where to look for
979 Executable_Suffix : Name_Id := No_Name;
980 -- The suffix of executables, when specified in the configuration or in
981 -- package Builder of the main project. When this is not specified, the
982 -- executable suffix is the default for the platform.
986 Linker : Path_Name_Type := No_Path;
987 -- Path name of the linker driver. Specified in the configuration or in
988 -- the package Builder of the main project.
990 Map_File_Option : Name_Id := No_Name;
991 -- Option to use when invoking the linker to build a map file
993 Minimum_Linker_Options : Name_List_Index := No_Name_List;
994 -- The minimum options for the linker driver. Specified in the
997 Linker_Executable_Option : Name_List_Index := No_Name_List;
998 -- The option(s) to indicate the name of the executable in the linker
999 -- command. Specified in the configuration. When not specified, default
1000 -- to -o <executable name>.
1002 Linker_Lib_Dir_Option : Name_Id := No_Name;
1003 -- The option to specify where to find a library for linking. Specified
1004 -- in the configuration. When not specified, defaults to "-L".
1006 Linker_Lib_Name_Option : Name_Id := No_Name;
1007 -- The option to specify the name of a library for linking. Specified in
1008 -- the configuration. When not specified, defaults to "-l".
1012 Library_Builder : Path_Name_Type := No_Path;
1013 -- The executable to build library (specified in the configuration)
1015 Lib_Support : Library_Support := None;
1016 -- The level of library support. Specified in the configuration. Support
1017 -- is none, static libraries only or both static and shared libraries.
1019 Archive_Builder : Name_List_Index := No_Name_List;
1020 -- The name of the executable to build archives, with the minimum
1021 -- switches. Specified in the configuration.
1023 Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
1024 -- The options to append object files to an archive
1026 Archive_Indexer : Name_List_Index := No_Name_List;
1027 -- The name of the executable to index archives, with the minimum
1028 -- switches. Specified in the configuration.
1030 Archive_Suffix : File_Name_Type := No_File;
1031 -- The suffix of archives. Specified in the configuration. When not
1032 -- specified, defaults to ".a".
1034 Lib_Partial_Linker : Name_List_Index := No_Name_List;
1038 Shared_Lib_Driver : File_Name_Type := No_File;
1039 -- The driver to link shared libraries. Set with attribute Library_GCC.
1042 Shared_Lib_Prefix : File_Name_Type := No_File;
1043 -- Part of a shared library file name that precedes the name of the
1044 -- library. Specified in the configuration. When not specified, defaults
1047 Shared_Lib_Suffix : File_Name_Type := No_File;
1048 -- Suffix of shared libraries, after the library name in the shared
1049 -- library name. Specified in the configuration. When not specified,
1050 -- default to ".so".
1052 Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1053 -- The minimum options to use when building a shared library
1055 Lib_Version_Options : Name_List_Index := No_Name_List;
1056 -- The options to use to specify a library version
1058 Symbolic_Link_Supported : Boolean := False;
1059 -- True if the platform supports symbolic link files
1061 Lib_Maj_Min_Id_Supported : Boolean := False;
1062 -- True if platform supports library major and minor options, such as
1063 -- libname.so -> libname.so.2 -> libname.so.2.4
1065 Auto_Init_Supported : Boolean := False;
1066 -- True if automatic initialisation is supported for shared stand-alone
1070 Default_Project_Config : constant Project_Configuration :=
1071 (Run_Path_Option => No_Name_List,
1072 Executable_Suffix => No_Name,
1074 Map_File_Option => No_Name,
1075 Minimum_Linker_Options => No_Name_List,
1076 Linker_Executable_Option => No_Name_List,
1077 Linker_Lib_Dir_Option => No_Name,
1078 Linker_Lib_Name_Option => No_Name,
1079 Library_Builder => No_Path,
1080 Lib_Support => None,
1081 Archive_Builder => No_Name_List,
1082 Archive_Builder_Append_Option => No_Name_List,
1083 Archive_Indexer => No_Name_List,
1084 Archive_Suffix => No_File,
1085 Lib_Partial_Linker => No_Name_List,
1086 Shared_Lib_Driver => No_File,
1087 Shared_Lib_Prefix => No_File,
1088 Shared_Lib_Suffix => No_File,
1089 Shared_Lib_Min_Options => No_Name_List,
1090 Lib_Version_Options => No_Name_List,
1091 Symbolic_Link_Supported => False,
1092 Lib_Maj_Min_Id_Supported => False,
1093 Auto_Init_Supported => False);
1095 -- The following record describes a project file representation
1097 -- Note that it is not specified if the path names of directories (source,
1098 -- object, library or exec directories) end with or without a directory
1101 type Project_Data is record
1107 Name : Name_Id := No_Name;
1108 -- The name of the project
1110 Display_Name : Name_Id := No_Name;
1111 -- The name of the project with the spelling of its declaration
1113 Qualifier : Project_Qualifier := Unspecified;
1114 -- The eventual qualifier for this project
1116 Externally_Built : Boolean := False;
1117 -- True if the project is externally built. In such case, the Project
1118 -- Manager will not modify anything in this project.
1120 Config : Project_Configuration;
1122 Path : Path_Information := No_Path_Information;
1123 -- The path name of the project file
1125 Virtual : Boolean := False;
1126 -- True for virtual extending projects
1128 Location : Source_Ptr := No_Location;
1129 -- The location in the project file source of the reserved word project
1131 Naming : Naming_Data := Standard_Naming_Data;
1132 -- The naming scheme of this project file
1138 Languages : Name_List_Index := No_Name_List;
1139 -- The list of languages of the sources of this project
1141 Include_Language : Language_Index := No_Language_Index;
1143 First_Language_Processing : Language_Index := No_Language_Index;
1144 -- First index of the language data in the project
1146 Unit_Based_Language_Name : Name_Id := No_Name;
1147 Unit_Based_Language_Index : Language_Index := No_Language_Index;
1148 -- The name and index, if any, of the unit-based language of some
1149 -- sources of the project. There may be only one unit-based language
1156 First_Referred_By : Project_Id := No_Project;
1157 -- The project, if any, that was the first to be known as importing or
1158 -- extending this project
1160 Mains : String_List_Id := Nil_String;
1161 -- List of mains specified by attribute Main
1163 Extends : Project_Id := No_Project;
1164 -- The reference of the project file, if any, that this project file
1167 Extended_By : Project_Id := No_Project;
1168 -- The reference of the project file, if any, that extends this project
1171 Decl : Declarations := No_Declarations;
1172 -- The declarations (variables, attributes and packages) of this project
1175 Imported_Projects : Project_List := Empty_Project_List;
1176 -- The list of all directly imported projects, if any
1178 All_Imported_Projects : Project_List := Empty_Project_List;
1179 -- The list of all projects imported directly or indirectly, if any
1185 Directory : Path_Information := No_Path_Information;
1186 -- Path name of the directory where the project file resides
1188 Dir_Path : String_Access;
1189 -- Same as Directory.Name, but as an access to String
1191 Object_Directory : Path_Information := No_Path_Information;
1192 -- The path name of the object directory of this project file
1194 Exec_Directory : Path_Information := No_Path_Information;
1195 -- The path name of the exec directory of this project file. Default is
1196 -- equal to Object_Directory.
1202 Library : Boolean := False;
1203 -- True if this is a library project
1205 Library_Name : Name_Id := No_Name;
1206 -- If a library project, name of the library
1208 Library_Kind : Lib_Kind := Static;
1209 -- If a library project, kind of library
1211 Library_Dir : Path_Information := No_Path_Information;
1212 -- If a library project, path name of the directory where the library
1215 Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1216 -- The timestamp of a library file in a library project
1218 Library_Src_Dir : Path_Information := No_Path_Information;
1219 -- If a Stand-Alone Library project, path name of the directory where
1220 -- the sources of the interfaces of the library are copied. By default,
1221 -- if attribute Library_Src_Dir is not specified, sources of the
1222 -- interfaces are not copied anywhere.
1224 Library_ALI_Dir : Path_Information := No_Path_Information;
1225 -- In a library project, path name of the directory where the ALI files
1226 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1227 -- are copied in the Library_Dir.
1229 Lib_Internal_Name : Name_Id := No_Name;
1230 -- If a library project, internal name store inside the library
1232 Standalone_Library : Boolean := False;
1233 -- Indicate that this is a Standalone Library Project File
1235 Lib_Interface_ALIs : String_List_Id := Nil_String;
1236 -- For Standalone Library Project Files, indicate the list of Interface
1239 Lib_Auto_Init : Boolean := False;
1240 -- For non static Stand-Alone Library Project Files, indicate if
1241 -- the library initialisation should be automatic.
1243 Symbol_Data : Symbol_Record := No_Symbols;
1244 -- Symbol file name, reference symbol file name, symbol policy
1246 Need_To_Build_Lib : Boolean := False;
1247 -- Indicates that the library of a Library Project needs to be built or
1254 Ada_Sources_Present : Boolean := True;
1255 -- True if there are Ada sources in the project
1257 Other_Sources_Present : Boolean := True;
1258 -- True if there are non-Ada sources in the project
1260 Ada_Sources : String_List_Id := Nil_String;
1261 -- The list of all the Ada source file names (gnatmake only)
1263 First_Source : Source_Id := No_Source;
1264 Last_Source : Source_Id := No_Source;
1265 -- Head and tail of the list of sources
1267 Interfaces_Defined : Boolean := False;
1268 -- True if attribute Interfaces is declared for the project or any
1269 -- project it extends.
1271 Imported_Directories_Switches : Argument_List_Access := null;
1272 -- List of the source search switches (-I<source dir>) to be used when
1275 Include_Path : String_Access := null;
1276 -- The search source path for the project. Used as the value for an
1277 -- environment variable, specified by attribute Include_Path
1278 -- (<language>). The names of the environment variables are in component
1279 -- Include_Path of the records Language_Config.
1281 Include_Path_File : Path_Name_Type := No_Path;
1282 -- The path name of the of the source search directory file
1284 Include_Data_Set : Boolean := False;
1285 -- Set True when Imported_Directories_Switches or Include_Path are set
1287 Source_Dirs : String_List_Id := Nil_String;
1288 -- The list of all the source directories
1290 Known_Order_Of_Source_Dirs : Boolean := True;
1291 -- False, if there is any /** in the Source_Dirs, because in this case
1292 -- the ordering of the source subdirs depend on the OS. If True,
1293 -- duplicate file names in the same project file are allowed.
1295 Ada_Include_Path : String_Access := null;
1296 -- The cached value of source search path for this project file. Set by
1297 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1298 -- use this field directly outside of the project manager, use
1299 -- Prj.Env.Ada_Include_Path instead.
1305 Ada_Objects_Path : String_Access := null;
1306 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1307 -- use this field directly outside of the compiler, use
1308 -- Prj.Env.Ada_Objects_Path instead.
1310 Libgnarl_Needed : Yes_No_Unknown := Unknown;
1311 -- Set to True when libgnarl is needed to link
1313 Objects_Path : String_Access := null;
1314 -- The cached value of the object dir path, used during the binding
1315 -- phase of gprbuild.
1317 Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1318 -- The cached value of the object path temp file (including library
1319 -- dirs) for this project file.
1321 Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1322 -- The cached value of the object path temp file (excluding library
1323 -- dirs) for this project file.
1325 Config_File_Name : Path_Name_Type := No_Path;
1326 -- The path name of the configuration pragmas file, if any
1328 Config_File_Temp : Boolean := False;
1329 -- An indication that the configuration pragmas file is a temporary file
1330 -- that must be deleted at the end.
1332 Config_Checked : Boolean := False;
1333 -- A flag to avoid checking repetitively the configuration pragmas file
1335 Checked : Boolean := False;
1336 -- A flag to avoid checking repetitively the naming scheme of this
1339 Seen : Boolean := False;
1340 -- A flag to mark a project as "visited" to avoid processing the same
1341 -- project several time.
1343 Depth : Natural := 0;
1344 -- The maximum depth of a project in the project graph. Depth of main
1347 Unkept_Comments : Boolean := False;
1348 -- True if there are comments in the project sources that cannot be kept
1349 -- in the project tree.
1353 function Empty_Project (Tree : Project_Tree_Ref) return Project_Data;
1354 -- Return the representation of an empty project in project Tree tree.
1355 -- The project tree Tree must have been Initialized and/or Reset.
1357 function Is_Extending
1358 (Extending : Project_Id;
1359 Extended : Project_Id;
1360 In_Tree : Project_Tree_Ref) return Boolean;
1361 -- ??? needs comment
1363 function Is_A_Language
1364 (Tree : Project_Tree_Ref;
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 -- Languages and sources of the project
1444 First_Language : Language_Index := No_Language_Index;
1447 First_Source : Source_Id := No_Source;
1452 Languages_Data : Language_Data_Table.Instance;
1453 Name_Lists : Name_List_Table.Instance;
1454 String_Elements : String_Element_Table.Instance;
1455 Variable_Elements : Variable_Element_Table.Instance;
1456 Array_Elements : Array_Element_Table.Instance;
1457 Arrays : Array_Table.Instance;
1458 Packages : Package_Table.Instance;
1459 Project_Lists : Project_List_Table.Instance;
1460 Projects : Project_Table.Instance;
1461 Sources : Source_Data_Table.Instance;
1462 Alt_Langs : Alternate_Language_Table.Instance;
1463 Units : Unit_Table.Instance;
1464 Units_HT : Units_Htable.Instance;
1465 Files_HT : Files_Htable.Instance;
1466 Source_Paths_HT : Source_Paths_Htable.Instance;
1470 Private_Part : Private_Project_Tree_Data;
1472 -- Data for a project tree
1474 type Put_Line_Access is access procedure
1476 Project : Project_Id;
1477 In_Tree : Project_Tree_Ref);
1478 -- Use to customize error reporting in Prj.Proc and Prj.Nmsc
1480 procedure Expect (The_Token : Token_Type; Token_Image : String);
1481 -- Check that the current token is The_Token. If it is not, then output
1482 -- an error message.
1484 procedure Initialize (Tree : Project_Tree_Ref);
1485 -- This procedure must be called before using any services from the Prj
1486 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1488 procedure Reset (Tree : Project_Tree_Ref);
1489 -- This procedure resets all the tables that are used when processing a
1490 -- project file tree. Initialize must be called before the call to Reset.
1492 procedure Register_Default_Naming_Scheme
1493 (Language : Name_Id;
1494 Default_Spec_Suffix : File_Name_Type;
1495 Default_Body_Suffix : File_Name_Type;
1496 In_Tree : Project_Tree_Ref);
1497 -- Register the default suffixes for a given language. These extensions
1498 -- will be ignored if the user has specified a new naming scheme in a
1501 -- Otherwise, this information will be automatically added to Naming_Data
1502 -- when a project is processed, in the lists Spec_Suffix and Body_Suffix.
1505 type State is limited private;
1506 with procedure Action
1507 (Project : Project_Id;
1508 With_State : in out State);
1509 procedure For_Every_Project_Imported
1511 In_Tree : Project_Tree_Ref;
1512 With_State : in out State);
1513 -- Call Action for each project imported directly or indirectly by project
1514 -- By. Action is called according to the order of importation: if A
1515 -- imports B, directly or indirectly, Action will be called for A before
1516 -- it is called for B. If two projects import each other directly or
1517 -- indirectly (using at least one "limited with"), it is not specified
1518 -- for which of these two projects Action will be called first. Projects
1519 -- that are extended by other projects are not considered. With_State may
1520 -- be used by Action to choose a behavior or to report some global result.
1522 function Extend_Name
1523 (File : File_Name_Type;
1524 With_Suffix : String) return File_Name_Type;
1525 -- Replace the extension of File with With_Suffix
1527 function Object_Name
1528 (Source_File_Name : File_Name_Type) return File_Name_Type;
1529 -- Returns the object file name corresponding to a source file name
1531 function Dependency_Name
1532 (Source_File_Name : File_Name_Type;
1533 Dependency : Dependency_File_Kind) return File_Name_Type;
1534 -- Returns the dependency file name corresponding to a source file name
1536 function Switches_Name
1537 (Source_File_Name : File_Name_Type) return File_Name_Type;
1538 -- Returns the switches file name corresponding to a source file name
1544 procedure Record_Temp_File (Path : Path_Name_Type);
1545 -- Record the path of a newly created temporary file, so that it can be
1548 procedure Delete_All_Temp_Files;
1549 -- Delete all recorded temporary files
1553 All_Packages : constant String_List_Access := null;
1555 No_Project_Tree : constant Project_Tree_Ref := null;
1557 Ignored : constant Variable_Kind := Single;
1559 Nil_Variable_Value : constant Variable_Value :=
1560 (Project => No_Project,
1562 Location => No_Location,
1565 Virtual_Prefix : constant String := "v$";
1566 -- The prefix for virtual extending projects. Because of the '$', which is
1567 -- normally forbidden for project names, there cannot be any name clash.
1569 Empty_Name : Name_Id;
1570 -- Name_Id for an empty name (no characters). Initialized in procedure
1573 Empty_File_Name : File_Name_Type;
1574 -- Empty File_Name_Type (no characters). Initialized in procedure
1577 procedure Add_To_Buffer
1579 To : in out String_Access;
1580 Last : in out Natural);
1581 -- Append a String to the Buffer
1583 type Naming_Id is new Nat;
1585 package Naming_Table is new GNAT.Dynamic_Tables
1586 (Table_Component_Type => Naming_Data,
1587 Table_Index_Type => Naming_Id,
1588 Table_Low_Bound => 1,
1590 Table_Increment => 100);
1591 -- Table storing the naming data for gnatmake/gprmake
1593 package Path_File_Table is new GNAT.Dynamic_Tables
1594 (Table_Component_Type => Path_Name_Type,
1595 Table_Index_Type => Natural,
1596 Table_Low_Bound => 1,
1597 Table_Initial => 50,
1598 Table_Increment => 100);
1599 -- Table storing all the temp path file names.
1600 -- Used by Delete_All_Path_Files.
1602 package Source_Path_Table is new GNAT.Dynamic_Tables
1603 (Table_Component_Type => Name_Id,
1604 Table_Index_Type => Natural,
1605 Table_Low_Bound => 1,
1606 Table_Initial => 50,
1607 Table_Increment => 100);
1608 -- A table to store the source dirs before creating the source path file
1610 package Object_Path_Table is new GNAT.Dynamic_Tables
1611 (Table_Component_Type => Path_Name_Type,
1612 Table_Index_Type => Natural,
1613 Table_Low_Bound => 1,
1614 Table_Initial => 50,
1615 Table_Increment => 100);
1616 -- A table to store the object dirs, before creating the object path file
1618 type Private_Project_Tree_Data is record
1619 Namings : Naming_Table.Instance;
1620 Path_Files : Path_File_Table.Instance;
1621 Source_Paths : Source_Path_Table.Instance;
1622 Object_Paths : Object_Path_Table.Instance;
1623 Default_Naming : Naming_Data;
1625 -- Type to represent the part of a project tree which is private to the