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 : String_Ptr := null;
48 -- The value after the equal sign in switch --subdirs=...
49 -- Contains the relative subdirectory.
51 type Library_Support is (None, Static_Only, Full);
52 -- Support for Library Project File.
53 -- - None: Library Project Files are not supported at all
54 -- - Static_Only: Library Project Files are only supported for static
56 -- - Full: Library Project Files are supported for static and dynamic
57 -- (shared) libraries.
59 type Yes_No_Unknown is (Yes, No, Unknown);
60 -- Tri-state to decide if -lgnarl is needed when linking
62 type Project_Qualifier is
70 -- Qualifiers that can prefix the reserved word "project" in a project
72 -- Standard: standard project ...
73 -- Library: library project is ...
74 -- Dry: abstract project is
75 -- Aggregate: aggregate project is
76 -- Aggregate_Library: aggregate library project is ...
77 -- Configuration: configuration project is ...
79 All_Packages : constant String_List_Access;
80 -- Default value of parameter Packages of procedures Parse, in Prj.Pars and
81 -- Prj.Part, indicating that all packages should be checked.
83 type Project_Tree_Data;
84 type Project_Tree_Ref is access all Project_Tree_Data;
85 -- Reference to a project tree. Several project trees may exist in memory
88 No_Project_Tree : constant Project_Tree_Ref;
90 procedure Free (Tree : in out Project_Tree_Ref);
91 -- Free memory associated with the tree
93 Config_Project_File_Extension : String := ".cgpr";
94 Project_File_Extension : String := ".gpr";
95 -- The standard config and user project file name extensions. They are not
96 -- constants, because Canonical_Case_File_Name is called on these variables
97 -- in the body of Prj.
99 function Empty_File return File_Name_Type;
100 function Empty_String return Name_Id;
101 -- Return the id for an empty string ""
103 type Path_Information is record
104 Name : Path_Name_Type := No_Path;
105 Display_Name : Path_Name_Type := No_Path;
107 -- Directory names always end with a directory separator
109 No_Path_Information : constant Path_Information := (No_Path, No_Path);
112 type Project_Id is access all Project_Data;
113 No_Project : constant Project_Id := null;
114 -- Id of a Project File
116 type String_List_Id is new Nat;
117 Nil_String : constant String_List_Id := 0;
118 type String_Element is record
119 Value : Name_Id := No_Name;
121 Display_Value : Name_Id := No_Name;
122 Location : Source_Ptr := No_Location;
123 Flag : Boolean := False;
124 Next : String_List_Id := Nil_String;
126 -- To hold values for string list variables and array elements.
127 -- Component Flag may be used for various purposes. For source
128 -- directories, it indicates if the directory contains Ada source(s).
130 package String_Element_Table is new GNAT.Dynamic_Tables
131 (Table_Component_Type => String_Element,
132 Table_Index_Type => String_List_Id,
133 Table_Low_Bound => 1,
134 Table_Initial => 200,
135 Table_Increment => 100);
136 -- The table for string elements in string lists
138 type Variable_Kind is (Undefined, List, Single);
139 -- Different kinds of variables
141 subtype Defined_Variable_Kind is Variable_Kind range List .. Single;
142 -- The defined kinds of variables
144 Ignored : constant Variable_Kind;
145 -- Used to indicate that a package declaration must be ignored
146 -- while processing the project tree (unknown package name).
148 type Variable_Value (Kind : Variable_Kind := Undefined) is record
149 Project : Project_Id := No_Project;
150 Location : Source_Ptr := No_Location;
151 Default : Boolean := False;
156 Values : String_List_Id := Nil_String;
158 Value : Name_Id := No_Name;
162 -- Values for variables and array elements. Default is True if the
163 -- current value is the default one for the variable.
165 Nil_Variable_Value : constant Variable_Value;
166 -- Value of a non existing variable or array element
168 type Variable_Id is new Nat;
169 No_Variable : constant Variable_Id := 0;
170 type Variable is record
171 Next : Variable_Id := No_Variable;
173 Value : Variable_Value;
175 -- To hold the list of variables in a project file and in packages
177 package Variable_Element_Table is new GNAT.Dynamic_Tables
178 (Table_Component_Type => Variable,
179 Table_Index_Type => Variable_Id,
180 Table_Low_Bound => 1,
181 Table_Initial => 200,
182 Table_Increment => 100);
183 -- The table of variable in list of variables
185 type Array_Element_Id is new Nat;
186 No_Array_Element : constant Array_Element_Id := 0;
187 type Array_Element is record
189 Src_Index : Int := 0;
190 Index_Case_Sensitive : Boolean := True;
191 Value : Variable_Value;
192 Next : Array_Element_Id := No_Array_Element;
194 -- Each Array_Element represents an array element and is linked (Next)
195 -- to the next array element, if any, in the array.
197 package Array_Element_Table is new GNAT.Dynamic_Tables
198 (Table_Component_Type => Array_Element,
199 Table_Index_Type => Array_Element_Id,
200 Table_Low_Bound => 1,
201 Table_Initial => 200,
202 Table_Increment => 100);
203 -- The table that contains all array elements
205 type Array_Id is new Nat;
206 No_Array : constant Array_Id := 0;
207 type Array_Data is record
208 Name : Name_Id := No_Name;
209 Location : Source_Ptr := No_Location;
210 Value : Array_Element_Id := No_Array_Element;
211 Next : Array_Id := No_Array;
213 -- Each Array_Data value represents an array.
214 -- Value is the id of the first element.
215 -- Next is the id of the next array in the project file or package.
217 package Array_Table is new GNAT.Dynamic_Tables
218 (Table_Component_Type => Array_Data,
219 Table_Index_Type => Array_Id,
220 Table_Low_Bound => 1,
221 Table_Initial => 200,
222 Table_Increment => 100);
223 -- The table that contains all arrays
225 type Package_Id is new Nat;
226 No_Package : constant Package_Id := 0;
227 type Declarations is record
228 Variables : Variable_Id := No_Variable;
229 Attributes : Variable_Id := No_Variable;
230 Arrays : Array_Id := No_Array;
231 Packages : Package_Id := No_Package;
233 -- Contains the declarations (variables, single and array attributes,
234 -- packages) for a project or a package in a project.
236 No_Declarations : constant Declarations :=
237 (Variables => No_Variable,
238 Attributes => No_Variable,
240 Packages => No_Package);
241 -- Default value of Declarations: indicates that there is no declarations
243 type Package_Element is record
244 Name : Name_Id := No_Name;
245 Decl : Declarations := No_Declarations;
246 Parent : Package_Id := No_Package;
247 Next : Package_Id := No_Package;
249 -- A package (includes declarations that may include other packages)
251 package Package_Table is new GNAT.Dynamic_Tables
252 (Table_Component_Type => Package_Element,
253 Table_Index_Type => Package_Id,
254 Table_Low_Bound => 1,
255 Table_Initial => 100,
256 Table_Increment => 100);
257 -- The table that contains all packages
260 type Language_Ptr is access all Language_Data;
261 -- Index of language data
263 No_Language_Index : constant Language_Ptr := null;
264 -- Constant indicating that there is no language data
266 function Get_Language_From_Name
267 (Project : Project_Id;
268 Name : String) return Language_Ptr;
269 -- Get a language from a project. This might return null if no such
270 -- language exists in the project
272 Max_Header_Num : constant := 6150;
273 type Header_Num is range 0 .. Max_Header_Num;
274 -- Size for hash table below. The upper bound is an arbitrary value, the
275 -- value here was chosen after testing to determine a good compromise
276 -- between speed of access and memory usage.
278 function Hash (Name : Name_Id) return Header_Num;
279 function Hash (Name : File_Name_Type) return Header_Num;
280 function Hash (Name : Path_Name_Type) return Header_Num;
281 function Hash (Project : Project_Id) return Header_Num;
282 -- Used for computing hash values for names put into hash tables
284 type Language_Kind is (File_Based, Unit_Based);
285 -- Type for the kind of language. All languages are file based, except Ada
286 -- which is unit based.
288 type Dependency_File_Kind is (None, Makefile, ALI_File);
289 -- Type of dependency to be checked: no dependency file, Makefile fragment
290 -- or ALI file (for Ada).
292 Makefile_Dependency_Suffix : constant String := ".d";
293 ALI_Dependency_Suffix : constant String := ".ali";
295 Switches_Dependency_Suffix : constant String := ".cswi";
297 Binder_Exchange_Suffix : constant String := ".bexch";
298 -- Suffix for binder exchange files
300 Library_Exchange_Suffix : constant String := ".lexch";
301 -- Suffix for library exchange files
303 type Name_List_Index is new Nat;
304 No_Name_List : constant Name_List_Index := 0;
306 type Name_Node is record
307 Name : Name_Id := No_Name;
308 Next : Name_List_Index := No_Name_List;
311 package Name_List_Table is new GNAT.Dynamic_Tables
312 (Table_Component_Type => Name_Node,
313 Table_Index_Type => Name_List_Index,
314 Table_Low_Bound => 1,
316 Table_Increment => 100);
317 -- The table for lists of names
320 (Table : Name_List_Table.Instance;
321 List : Name_List_Index) return Natural;
322 -- Return the number of elements in specified list
324 type Number_List_Index is new Nat;
325 No_Number_List : constant Number_List_Index := 0;
327 type Number_Node is record
328 Number : Natural := 0;
329 Next : Number_List_Index := No_Number_List;
332 package Number_List_Table is new GNAT.Dynamic_Tables
333 (Table_Component_Type => Number_Node,
334 Table_Index_Type => Number_List_Index,
335 Table_Low_Bound => 1,
337 Table_Increment => 100);
338 -- The table for lists of numbers
340 package Mapping_Files_Htable is new Simple_HTable
341 (Header_Num => Header_Num,
342 Element => Path_Name_Type,
343 No_Element => No_Path,
344 Key => Path_Name_Type,
347 -- A hash table to store the mapping files that are not used
349 -- The following record ???
351 type Lang_Naming_Data is record
352 Dot_Replacement : File_Name_Type := No_File;
353 -- The string to replace '.' in the source file name (for Ada)
355 Casing : Casing_Type := All_Lower_Case;
356 -- The casing of the source file name (for Ada)
358 Separate_Suffix : File_Name_Type := No_File;
359 -- String to append to unit name for source file name of an Ada subunit
361 Spec_Suffix : File_Name_Type := No_File;
362 -- The string to append to the unit name for the
363 -- source file name of a spec.
365 Body_Suffix : File_Name_Type := No_File;
366 -- The string to append to the unit name for the
367 -- source file name of a body.
370 No_Lang_Naming_Data : constant Lang_Naming_Data :=
371 (Dot_Replacement => No_File,
372 Casing => All_Lower_Case,
373 Separate_Suffix => No_File,
374 Spec_Suffix => No_File,
375 Body_Suffix => No_File);
377 function Is_Standard_GNAT_Naming (Naming : Lang_Naming_Data) return Boolean;
378 -- True if the naming scheme is GNAT's default naming scheme. This
379 -- is to take into account shortened names like "Ada." (a-), "System." (s-)
383 type Source_Id is access all Source_Data;
385 function Is_Compilable (Source : Source_Id) return Boolean;
386 pragma Inline (Is_Compilable);
387 -- Return True if we know how to compile Source (i.e. if a compiler is
388 -- defined). This doesn't indicate whether the source should be compiled.
390 function Object_To_Global_Archive (Source : Source_Id) return Boolean;
391 pragma Inline (Object_To_Global_Archive);
392 -- Return True if the object file should be put in the global archive.
393 -- This is for Ada, when only the closure of a main needs to be
396 function Other_Part (Source : Source_Id) return Source_Id;
397 pragma Inline (Other_Part);
398 -- Source ID for the other part, if any: for a spec, indicates its body;
399 -- for a body, indicates its spec.
401 No_Source : constant Source_Id := null;
403 type Path_Syntax_Kind is
407 -- Host specific syntax, for example on VMS (the default)
409 -- The following record describes the configuration of a language
411 type Language_Config is record
412 Kind : Language_Kind := File_Based;
413 -- Kind of language. All languages are file based, except Ada which is
416 Naming_Data : Lang_Naming_Data;
417 -- The naming data for the languages (prefixes, etc.)
419 Include_Compatible_Languages : Name_List_Index := No_Name_List;
420 -- List of languages that are "include compatible" with this language. A
421 -- language B (for example "C") is "include compatible" with a language
422 -- A (for example "C++") if it is expected that sources of language A
423 -- may "include" header files from language B.
425 Compiler_Driver : File_Name_Type := No_File;
426 -- The name of the executable for the compiler of the language
428 Compiler_Driver_Path : String_Access := null;
429 -- The path name of the executable for the compiler of the language
431 Compiler_Leading_Required_Switches : Name_List_Index := No_Name_List;
432 -- The list of initial switches that are required as a minimum to invoke
433 -- the compiler driver.
435 Compiler_Trailing_Required_Switches : Name_List_Index := No_Name_List;
436 -- The list of final switches that are required as a minimum to invoke
437 -- the compiler driver.
439 Multi_Unit_Switches : Name_List_Index := No_Name_List;
440 -- The switch(es) to indicate the index of a unit in a multi-source file
442 Multi_Unit_Object_Separator : Character := ' ';
443 -- The string separating the base name of a source from the index of the
444 -- unit in a multi-source file, in the object file name.
446 Path_Syntax : Path_Syntax_Kind := Host;
447 -- Value may be Canonical (Unix style) or Host (host syntax, for example
448 -- on VMS for DEC C).
450 Object_File_Suffix : Name_Id := No_Name;
451 -- Optional alternate object file suffix
453 Object_File_Switches : Name_List_Index := No_Name_List;
454 -- Optional object file switches. When this is defined, the switches
455 -- are used to specify the object file. The object file name is appended
456 -- to the last switch in the list. Example: ("-o", "").
458 Compilation_PIC_Option : Name_List_Index := No_Name_List;
459 -- The option(s) to compile a source in Position Independent Code for
460 -- shared libraries. Specified in the configuration. When not specified,
461 -- there is no need for such switch.
463 Object_Generated : Boolean := True;
464 -- False in no object file is generated
466 Objects_Linked : Boolean := True;
467 -- False if object files are not use to link executables and build
470 Runtime_Library_Dir : Name_Id := No_Name;
471 -- Path name of the runtime library directory, if any
473 Runtime_Source_Dir : Name_Id := No_Name;
474 -- Path name of the runtime source directory, if any
476 Mapping_File_Switches : Name_List_Index := No_Name_List;
477 -- The option(s) to provide a mapping file to the compiler. Specified in
478 -- the configuration. When value is No_Name_List, there is no mapping
481 Mapping_Spec_Suffix : File_Name_Type := No_File;
482 -- Placeholder representing the spec suffix in a mapping file
484 Mapping_Body_Suffix : File_Name_Type := No_File;
485 -- Placeholder representing the body suffix in a mapping file
487 Config_File_Switches : Name_List_Index := No_Name_List;
488 -- The option(s) to provide a config file to the compiler. Specified in
489 -- the configuration. If value is No_Name_List there is no config file.
491 Dependency_Kind : Dependency_File_Kind := None;
492 -- The kind of dependency to be checked: none, Makefile fragment or
493 -- ALI file (for Ada).
495 Dependency_Option : Name_List_Index := No_Name_List;
496 -- The option(s) to be used to create the dependency file. When value is
497 -- No_Name_List, there is not such option(s).
499 Compute_Dependency : Name_List_Index := No_Name_List;
500 -- Hold the value of attribute Dependency_Driver, if declared for the
503 Include_Option : Name_List_Index := No_Name_List;
504 -- Hold the value of attribute Include_Switches, if declared for the
507 Include_Path : Name_Id := No_Name;
508 -- Name of environment variable declared by attribute Include_Path for
511 Include_Path_File : Name_Id := No_Name;
512 -- Name of environment variable declared by attribute Include_Path_File
515 Objects_Path : Name_Id := No_Name;
516 -- Name of environment variable declared by attribute Objects_Path for
519 Objects_Path_File : Name_Id := No_Name;
520 -- Name of environment variable declared by attribute Objects_Path_File
523 Config_Body : Name_Id := No_Name;
524 -- The template for a pragma Source_File_Name(_Project) for a specific
525 -- file name of a body.
527 Config_Body_Index : Name_Id := No_Name;
528 -- The template for a pragma Source_File_Name(_Project) for a specific
529 -- file name of a body in a multi-source file.
531 Config_Body_Pattern : Name_Id := No_Name;
532 -- The template for a pragma Source_File_Name(_Project) for a naming
535 Config_Spec : Name_Id := No_Name;
536 -- The template for a pragma Source_File_Name(_Project) for a specific
537 -- file name of a spec.
539 Config_Spec_Index : Name_Id := No_Name;
540 -- The template for a pragma Source_File_Name(_Project) for a specific
541 -- file name of a spec in a multi-source file.
543 Config_Spec_Pattern : Name_Id := No_Name;
544 -- The template for a pragma Source_File_Name(_Project) for a naming
547 Config_File_Unique : Boolean := False;
548 -- Indicate if the config file specified to the compiler needs to be
549 -- unique. If it is unique, then all config files are concatenated into
550 -- a temp config file.
552 Binder_Driver : File_Name_Type := No_File;
553 -- The name of the binder driver for the language, if any
555 Binder_Driver_Path : Path_Name_Type := No_Path;
556 -- The path name of the binder driver
558 Binder_Required_Switches : Name_List_Index := No_Name_List;
559 -- Hold the value of attribute Binder'Required_Switches for the language
561 Binder_Prefix : Name_Id := No_Name;
562 -- Hold the value of attribute Binder'Prefix for the language
564 Toolchain_Version : Name_Id := No_Name;
565 -- Hold the value of attribute Toolchain_Version for the language
567 Toolchain_Description : Name_Id := No_Name;
568 -- Hold the value of attribute Toolchain_Description for the language
572 No_Language_Config : constant Language_Config :=
574 Naming_Data => No_Lang_Naming_Data,
575 Include_Compatible_Languages => No_Name_List,
576 Compiler_Driver => No_File,
577 Compiler_Driver_Path => null,
578 Compiler_Leading_Required_Switches => No_Name_List,
579 Compiler_Trailing_Required_Switches => No_Name_List,
580 Multi_Unit_Switches => No_Name_List,
581 Multi_Unit_Object_Separator => ' ',
582 Path_Syntax => Canonical,
583 Object_File_Suffix => No_Name,
584 Object_File_Switches => No_Name_List,
585 Compilation_PIC_Option => No_Name_List,
586 Object_Generated => True,
587 Objects_Linked => True,
588 Runtime_Library_Dir => No_Name,
589 Runtime_Source_Dir => No_Name,
590 Mapping_File_Switches => No_Name_List,
591 Mapping_Spec_Suffix => No_File,
592 Mapping_Body_Suffix => No_File,
593 Config_File_Switches => No_Name_List,
594 Dependency_Kind => None,
595 Dependency_Option => No_Name_List,
596 Compute_Dependency => No_Name_List,
597 Include_Option => No_Name_List,
598 Include_Path => No_Name,
599 Include_Path_File => No_Name,
600 Objects_Path => No_Name,
601 Objects_Path_File => No_Name,
602 Config_Body => No_Name,
603 Config_Body_Index => No_Name,
604 Config_Body_Pattern => No_Name,
605 Config_Spec => No_Name,
606 Config_Spec_Index => No_Name,
607 Config_Spec_Pattern => No_Name,
608 Config_File_Unique => False,
609 Binder_Driver => No_File,
610 Binder_Driver_Path => No_Path,
611 Binder_Required_Switches => No_Name_List,
612 Binder_Prefix => No_Name,
613 Toolchain_Version => No_Name,
614 Toolchain_Description => No_Name);
616 -- The following record ???
618 type Language_Data is record
619 Name : Name_Id := No_Name;
620 Display_Name : Name_Id := No_Name;
621 Config : Language_Config := No_Language_Config;
622 First_Source : Source_Id := No_Source;
623 Mapping_Files : Mapping_Files_Htable.Instance :=
624 Mapping_Files_Htable.Nil;
625 Next : Language_Ptr := No_Language_Index;
628 No_Language_Data : constant Language_Data :=
630 Display_Name => No_Name,
631 Config => No_Language_Config,
632 First_Source => No_Source,
633 Mapping_Files => Mapping_Files_Htable.Nil,
634 Next => No_Language_Index);
636 type Language_List_Element;
637 type Language_List is access all Language_List_Element;
638 type Language_List_Element is record
639 Language : Language_Ptr := No_Language_Index;
640 Next : Language_List;
643 type Source_Kind is (Spec, Impl, Sep);
644 subtype Spec_Or_Body is Source_Kind range Spec .. Impl;
646 -- The following declarations declare a structure used to store the Name
647 -- and File and Path names of a unit, with a reference to its GNAT Project
648 -- File(s). Some units might have neither Spec nor Impl when they were
649 -- created for a "separate".
651 type File_Names_Data is array (Spec_Or_Body) of Source_Id;
653 type Unit_Data is record
654 Name : Name_Id := No_Name;
655 File_Names : File_Names_Data;
658 type Unit_Index is access all Unit_Data;
660 No_Unit_Index : constant Unit_Index := null;
661 -- Used to indicate a null entry for no unit
663 -- Structure to define source data
665 type Source_Data is record
666 Project : Project_Id := No_Project;
667 -- Project of the source
669 Source_Dir_Rank : Natural := 0;
670 -- The rank of the source directory in list declared with attribute
671 -- Source_Dirs. Two source files with the same name cannot appears in
672 -- different directory with the same rank. That can happen when the
673 -- recursive notation <dir>/** is used in attribute Source_Dirs.
675 Language : Language_Ptr := No_Language_Index;
676 -- Index of the language. This is an index into
677 -- Project_Tree.Languages_Data.
679 In_Interfaces : Boolean := True;
680 -- False when the source is not included in interfaces, when attribute
681 -- Interfaces is declared.
683 Declared_In_Interfaces : Boolean := False;
684 -- True when source is declared in attribute Interfaces
686 Alternate_Languages : Language_List := null;
687 -- List of languages a header file may also be, in addition of language
690 Kind : Source_Kind := Spec;
691 -- Kind of the source: spec, body or subunit
693 Unit : Unit_Index := No_Unit_Index;
694 -- Name of the unit, if language is unit based. This is only set for
695 -- those files that are part of the compilation set (for instance a
696 -- file in an extended project that is overridden will not have this
700 -- Index of the source in a multi unit source file (the same Source_Data
701 -- is duplicated several times when there are several units in the same
702 -- file). Index is 0 if there is either no unit or a single one, and
703 -- starts at 1 when there are multiple units
705 Locally_Removed : Boolean := False;
706 -- True if the source has been "excluded"
708 Replaced_By : Source_Id := No_Source;
709 -- Missing comment ???
711 File : File_Name_Type := No_File;
712 -- Canonical file name of the source
714 Display_File : File_Name_Type := No_File;
715 -- File name of the source, for display purposes
717 Path : Path_Information := No_Path_Information;
718 -- Path name of the source
720 Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
721 -- Time stamp of the source file
723 Object_Project : Project_Id := No_Project;
724 -- Project where the object file is. This might be different from
725 -- Project when using extending project files.
727 Object : File_Name_Type := No_File;
728 -- File name of the object file
730 Current_Object_Path : Path_Name_Type := No_Path;
731 -- Object path of an existing object file
733 Object_Path : Path_Name_Type := No_Path;
734 -- Object path of the real object file
736 Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
737 -- Object file time stamp
739 Dep_Name : File_Name_Type := No_File;
740 -- Dependency file simple name
742 Current_Dep_Path : Path_Name_Type := No_Path;
743 -- Path name of an existing dependency file
745 Dep_Path : Path_Name_Type := No_Path;
746 -- Path name of the real dependency file
748 Dep_TS : Time_Stamp_Type := Empty_Time_Stamp;
749 -- Dependency file time stamp
751 Switches : File_Name_Type := No_File;
752 -- File name of the switches file. For all languages, this is a file
753 -- that ends with the .cswi extension.
755 Switches_Path : Path_Name_Type := No_Path;
756 -- Path name of the switches file
758 Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
759 -- Switches file time stamp
761 Naming_Exception : Boolean := False;
762 -- True if the source has an exceptional name
764 Next_In_Lang : Source_Id := No_Source;
765 -- Link to another source of the same language in the same project
768 No_Source_Data : constant Source_Data :=
769 (Project => No_Project,
770 Source_Dir_Rank => 0,
771 Language => No_Language_Index,
772 In_Interfaces => True,
773 Declared_In_Interfaces => False,
774 Alternate_Languages => null,
776 Unit => No_Unit_Index,
778 Locally_Removed => False,
779 Replaced_By => No_Source,
781 Display_File => No_File,
782 Path => No_Path_Information,
783 Source_TS => Empty_Time_Stamp,
784 Object_Project => No_Project,
786 Current_Object_Path => No_Path,
787 Object_Path => No_Path,
788 Object_TS => Empty_Time_Stamp,
790 Current_Dep_Path => No_Path,
792 Dep_TS => Empty_Time_Stamp,
794 Switches_Path => No_Path,
795 Switches_TS => Empty_Time_Stamp,
796 Naming_Exception => False,
797 Next_In_Lang => No_Source);
799 package Source_Paths_Htable is new Simple_HTable
800 (Header_Num => Header_Num,
801 Element => Source_Id,
802 No_Element => No_Source,
803 Key => Path_Name_Type,
806 -- Mapping of source paths to source ids
808 package Unit_Sources_Htable is new Simple_HTable
809 (Header_Num => Header_Num,
810 Element => Source_Id,
811 No_Element => No_Source,
816 type Verbosity is (Default, Medium, High);
817 -- Verbosity when parsing GNAT Project Files
818 -- Default is default (very quiet, if no errors).
819 -- Medium is more verbose.
820 -- High is extremely verbose.
822 Current_Verbosity : Verbosity := Default;
823 -- The current value of the verbosity the project files are parsed with
825 type Lib_Kind is (Static, Dynamic, Relocatable);
827 type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
828 -- Type to specify the symbol policy, when symbol control is supported.
829 -- See full explanation about this type in package Symbols.
830 -- Autonomous: Create a symbol file without considering any reference
831 -- Compliant: Try to be as compatible as possible with an existing ref
832 -- Controlled: Fail if symbols are not the same as those in the reference
833 -- Restricted: Restrict the symbols to those in the symbol file
834 -- Direct: The symbol file is used as is
836 type Symbol_Record is record
837 Symbol_File : Path_Name_Type := No_Path;
838 Reference : Path_Name_Type := No_Path;
839 Symbol_Policy : Policy := Autonomous;
841 -- Type to keep the symbol data to be used when building a shared library
843 No_Symbols : constant Symbol_Record :=
844 (Symbol_File => No_Path,
845 Reference => No_Path,
846 Symbol_Policy => Autonomous);
847 -- The default value of the symbol data
849 function Image (The_Casing : Casing_Type) return String;
850 -- Similar to 'Image (but avoid use of this attribute in compiler)
852 function Value (Image : String) return Casing_Type;
853 -- Similar to 'Value (but avoid use of this attribute in compiler)
854 -- Raises Constraint_Error if not a Casing_Type image.
856 -- The following record contains data for a naming scheme
858 function Get_Object_Directory
859 (Project : Project_Id;
860 Including_Libraries : Boolean;
861 Only_If_Ada : Boolean := False) return Path_Name_Type;
862 -- Return the object directory to use for the project. This depends on
863 -- whether we have a library project or a standard project. This function
864 -- might return No_Name when no directory applies.
865 -- If we have a a library project file and Including_Libraries is True then
866 -- the library dir is returned instead of the object dir.
867 -- If Only_If_Ada is True, then No_Name will be returned when the project
868 -- doesn't Ada sources.
870 procedure Compute_All_Imported_Projects (Tree : Project_Tree_Ref);
871 -- For all projects in the tree, compute the list of the projects imported
872 -- directly or indirectly by project Project. The result is stored in
873 -- Project.All_Imported_Projects for each project
875 function Ultimate_Extending_Project_Of
876 (Proj : Project_Id) return Project_Id;
877 -- Returns the ultimate extending project of project Proj. If project Proj
878 -- is not extended, returns Proj.
880 type Project_List_Element;
881 type Project_List is access all Project_List_Element;
882 type Project_List_Element is record
883 Project : Project_Id := No_Project;
884 Next : Project_List := null;
886 -- A list of projects
889 (List : in out Project_List;
890 Free_Project : Boolean);
891 -- Free the list of projects, if Free_Project, each project is also freed
893 type Response_File_Format is
898 -- The format of the different response files
900 type Project_Configuration is record
901 Target : Name_Id := No_Name;
902 -- The target of the configuration, when specified
904 Run_Path_Option : Name_List_Index := No_Name_List;
905 -- The option to use when linking to specify the path where to look for
908 Separate_Run_Path_Options : Boolean := False;
909 -- True if each directory needs to be specified in a separate run path
912 Executable_Suffix : Name_Id := No_Name;
913 -- The suffix of executables, when specified in the configuration or in
914 -- package Builder of the main project. When this is not specified, the
915 -- executable suffix is the default for the platform.
919 Linker : Path_Name_Type := No_Path;
920 -- Path name of the linker driver. Specified in the configuration or in
921 -- the package Builder of the main project.
923 Map_File_Option : Name_Id := No_Name;
924 -- Option to use when invoking the linker to build a map file
926 Minimum_Linker_Options : Name_List_Index := No_Name_List;
927 -- The minimum options for the linker driver. Specified in the
930 Linker_Executable_Option : Name_List_Index := No_Name_List;
931 -- The option(s) to indicate the name of the executable in the linker
932 -- command. Specified in the configuration. When not specified, default
933 -- to -o <executable name>.
935 Linker_Lib_Dir_Option : Name_Id := No_Name;
936 -- The option to specify where to find a library for linking. Specified
937 -- in the configuration. When not specified, defaults to "-L".
939 Linker_Lib_Name_Option : Name_Id := No_Name;
940 -- The option to specify the name of a library for linking. Specified in
941 -- the configuration. When not specified, defaults to "-l".
943 Max_Command_Line_Length : Natural := 0;
944 -- When positive and when Resp_File_Format (see below) is not None,
945 -- if the command line for the invocation of the linker would be greater
946 -- than this value, a response file is used to invoke the linker.
948 Resp_File_Format : Response_File_Format := None;
949 -- The format of a response file, when linking with a response file is
952 Resp_File_Options : Name_List_Index := No_Name_List;
953 -- The switches, if any, that precede the path name of the response
954 -- file in the invocation of the linker.
958 Library_Builder : Path_Name_Type := No_Path;
959 -- The executable to build library (specified in the configuration)
961 Lib_Support : Library_Support := None;
962 -- The level of library support. Specified in the configuration. Support
963 -- is none, static libraries only or both static and shared libraries.
965 Archive_Builder : Name_List_Index := No_Name_List;
966 -- The name of the executable to build archives, with the minimum
967 -- switches. Specified in the configuration.
969 Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
970 -- The options to append object files to an archive
972 Archive_Indexer : Name_List_Index := No_Name_List;
973 -- The name of the executable to index archives, with the minimum
974 -- switches. Specified in the configuration.
976 Archive_Suffix : File_Name_Type := No_File;
977 -- The suffix of archives. Specified in the configuration. When not
978 -- specified, defaults to ".a".
980 Lib_Partial_Linker : Name_List_Index := No_Name_List;
984 Shared_Lib_Driver : File_Name_Type := No_File;
985 -- The driver to link shared libraries. Set with attribute Library_GCC.
988 Shared_Lib_Prefix : File_Name_Type := No_File;
989 -- Part of a shared library file name that precedes the name of the
990 -- library. Specified in the configuration. When not specified, defaults
993 Shared_Lib_Suffix : File_Name_Type := No_File;
994 -- Suffix of shared libraries, after the library name in the shared
995 -- library name. Specified in the configuration. When not specified,
998 Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
999 -- The minimum options to use when building a shared library
1001 Lib_Version_Options : Name_List_Index := No_Name_List;
1002 -- The options to use to specify a library version
1004 Symbolic_Link_Supported : Boolean := False;
1005 -- True if the platform supports symbolic link files
1007 Lib_Maj_Min_Id_Supported : Boolean := False;
1008 -- True if platform supports library major and minor options, such as
1009 -- libname.so -> libname.so.2 -> libname.so.2.4
1011 Auto_Init_Supported : Boolean := False;
1012 -- True if automatic initialisation is supported for shared stand-alone
1016 Default_Project_Config : constant Project_Configuration :=
1018 Run_Path_Option => No_Name_List,
1019 Separate_Run_Path_Options => False,
1020 Executable_Suffix => No_Name,
1022 Map_File_Option => No_Name,
1023 Minimum_Linker_Options => No_Name_List,
1024 Linker_Executable_Option => No_Name_List,
1025 Linker_Lib_Dir_Option => No_Name,
1026 Linker_Lib_Name_Option => No_Name,
1027 Library_Builder => No_Path,
1028 Max_Command_Line_Length => 0,
1029 Resp_File_Format => None,
1030 Resp_File_Options => No_Name_List,
1031 Lib_Support => None,
1032 Archive_Builder => No_Name_List,
1033 Archive_Builder_Append_Option => No_Name_List,
1034 Archive_Indexer => No_Name_List,
1035 Archive_Suffix => No_File,
1036 Lib_Partial_Linker => No_Name_List,
1037 Shared_Lib_Driver => No_File,
1038 Shared_Lib_Prefix => No_File,
1039 Shared_Lib_Suffix => No_File,
1040 Shared_Lib_Min_Options => No_Name_List,
1041 Lib_Version_Options => No_Name_List,
1042 Symbolic_Link_Supported => False,
1043 Lib_Maj_Min_Id_Supported => False,
1044 Auto_Init_Supported => False);
1046 -- The following record describes a project file representation
1048 -- Note that it is not specified if the path names of directories (source,
1049 -- object, library or exec directories) end with or without a directory
1052 type Project_Data is record
1058 Name : Name_Id := No_Name;
1059 -- The name of the project
1061 Display_Name : Name_Id := No_Name;
1062 -- The name of the project with the spelling of its declaration
1064 Qualifier : Project_Qualifier := Unspecified;
1065 -- The eventual qualifier for this project
1067 Externally_Built : Boolean := False;
1068 -- True if the project is externally built. In such case, the Project
1069 -- Manager will not modify anything in this project.
1071 Config : Project_Configuration;
1073 Path : Path_Information := No_Path_Information;
1074 -- The path name of the project file. This include base name of the
1077 Virtual : Boolean := False;
1078 -- True for virtual extending projects
1080 Location : Source_Ptr := No_Location;
1081 -- The location in the project file source of the reserved word project
1087 Languages : Language_Ptr := No_Language_Index;
1088 -- First index of the language data in the project.
1089 -- This is an index into the project_tree_data.languages_data.
1090 -- Traversing the list gives access to all the languages supported by
1097 Mains : String_List_Id := Nil_String;
1098 -- List of mains specified by attribute Main
1100 Extends : Project_Id := No_Project;
1101 -- The reference of the project file, if any, that this project file
1104 Extended_By : Project_Id := No_Project;
1105 -- The reference of the project file, if any, that extends this project
1108 Decl : Declarations := No_Declarations;
1109 -- The declarations (variables, attributes and packages) of this project
1112 Imported_Projects : Project_List;
1113 -- The list of all directly imported projects, if any
1115 All_Imported_Projects : Project_List;
1116 -- The list of all projects imported directly or indirectly, if any.
1117 -- This does not include the project itself.
1123 Directory : Path_Information := No_Path_Information;
1124 -- Path name of the directory where the project file resides
1126 Object_Directory : Path_Information := No_Path_Information;
1127 -- The path name of the object directory of this project file
1129 Exec_Directory : Path_Information := No_Path_Information;
1130 -- The path name of the exec directory of this project file. Default is
1131 -- equal to Object_Directory.
1137 Library : Boolean := False;
1138 -- True if this is a library project
1140 Library_Name : Name_Id := No_Name;
1141 -- If a library project, name of the library
1143 Library_Kind : Lib_Kind := Static;
1144 -- If a library project, kind of library
1146 Library_Dir : Path_Information := No_Path_Information;
1147 -- If a library project, path name of the directory where the library
1150 Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1151 -- The timestamp of a library file in a library project
1153 Library_Src_Dir : Path_Information := No_Path_Information;
1154 -- If a Stand-Alone Library project, path name of the directory where
1155 -- the sources of the interfaces of the library are copied. By default,
1156 -- if attribute Library_Src_Dir is not specified, sources of the
1157 -- interfaces are not copied anywhere.
1159 Library_ALI_Dir : Path_Information := No_Path_Information;
1160 -- In a library project, path name of the directory where the ALI files
1161 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1162 -- are copied in the Library_Dir.
1164 Lib_Internal_Name : Name_Id := No_Name;
1165 -- If a library project, internal name store inside the library
1167 Standalone_Library : Boolean := False;
1168 -- Indicate that this is a Standalone Library Project File
1170 Lib_Interface_ALIs : String_List_Id := Nil_String;
1171 -- For Standalone Library Project Files, indicate the list of Interface
1174 Lib_Auto_Init : Boolean := False;
1175 -- For non static Stand-Alone Library Project Files, indicate if
1176 -- the library initialisation should be automatic.
1178 Symbol_Data : Symbol_Record := No_Symbols;
1179 -- Symbol file name, reference symbol file name, symbol policy
1181 Need_To_Build_Lib : Boolean := False;
1182 -- Indicates that the library of a Library Project needs to be built or
1188 -- The sources for all languages including Ada are accessible through
1189 -- the Source_Iterator type
1191 Interfaces_Defined : Boolean := False;
1192 -- True if attribute Interfaces is declared for the project or any
1193 -- project it extends.
1195 Include_Path_File : Path_Name_Type := No_Path;
1196 -- The path name of the of the source search directory file.
1197 -- This is only used by gnatmake
1199 Source_Dirs : String_List_Id := Nil_String;
1200 -- The list of all the source directories
1202 Source_Dir_Ranks : Number_List_Index := No_Number_List;
1204 Ada_Include_Path : String_Access := null;
1205 -- The cached value of source search path for this project file. Set by
1206 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1207 -- use this field directly outside of the project manager, use
1208 -- Prj.Env.Ada_Include_Path instead.
1214 Ada_Objects_Path : String_Access := null;
1215 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1216 -- use this field directly outside of the compiler, use
1217 -- Prj.Env.Ada_Objects_Path instead.
1219 Libgnarl_Needed : Yes_No_Unknown := Unknown;
1220 -- Set to True when libgnarl is needed to link
1222 Objects_Path : String_Access := null;
1223 -- The cached value of the object dir path, used during the binding
1224 -- phase of gprbuild.
1226 Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1227 -- The cached value of the object path temp file (including library
1228 -- dirs) for this project file.
1230 Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1231 -- The cached value of the object path temp file (excluding library
1232 -- dirs) for this project file.
1234 Config_File_Name : Path_Name_Type := No_Path;
1235 -- The path name of the configuration pragmas file, if any
1237 Config_File_Temp : Boolean := False;
1238 -- An indication that the configuration pragmas file is a temporary file
1239 -- that must be deleted at the end.
1241 Config_Checked : Boolean := False;
1242 -- A flag to avoid checking repetitively the configuration pragmas file
1244 Depth : Natural := 0;
1245 -- The maximum depth of a project in the project graph. Depth of main
1248 Unkept_Comments : Boolean := False;
1249 -- True if there are comments in the project sources that cannot be kept
1250 -- in the project tree.
1254 function Empty_Project return Project_Data;
1255 -- Return the representation of an empty project
1257 function Is_Extending
1258 (Extending : Project_Id;
1259 Extended : Project_Id) return Boolean;
1260 -- Return True if Extending is extending the Extended project
1262 function Has_Ada_Sources (Data : Project_Id) return Boolean;
1263 -- Return True if the project has Ada sources
1265 Project_Error : exception;
1266 -- Raised by some subprograms in Prj.Attr
1268 package Units_Htable is new Simple_HTable
1269 (Header_Num => Header_Num,
1270 Element => Unit_Index,
1271 No_Element => No_Unit_Index,
1275 -- Mapping of unit names to indexes in the Units table
1277 ---------------------
1278 -- Source_Iterator --
1279 ---------------------
1281 type Source_Iterator is private;
1283 function For_Each_Source
1284 (In_Tree : Project_Tree_Ref;
1285 Project : Project_Id := No_Project;
1286 Language : Name_Id := No_Name) return Source_Iterator;
1287 -- Returns an iterator for all the sources of a project tree, or a specific
1288 -- project, or a specific language.
1290 function Element (Iter : Source_Iterator) return Source_Id;
1291 -- Return the current source (or No_Source if there are no more sources)
1293 procedure Next (Iter : in out Source_Iterator);
1294 -- Move on to the next source
1296 function Find_Source
1297 (In_Tree : Project_Tree_Ref;
1298 Project : Project_Id;
1299 In_Imported_Only : Boolean := False;
1300 In_Extended_Only : Boolean := False;
1301 Base_Name : File_Name_Type) return Source_Id;
1302 -- Find the first source file with the given name either in the whole tree
1303 -- (if In_Imported_Only is False) or in the projects imported or extended
1304 -- by Project otherwise. In_Extended_Only implies In_Imported_Only, and
1305 -- will only look in Project and the projects it extends
1307 -----------------------
1308 -- Project_Tree_Data --
1309 -----------------------
1311 type Private_Project_Tree_Data is private;
1312 -- Data for a project tree that is used only by the Project Manager
1314 type Project_Tree_Data is
1316 Name_Lists : Name_List_Table.Instance;
1317 Number_Lists : Number_List_Table.Instance;
1318 String_Elements : String_Element_Table.Instance;
1319 Variable_Elements : Variable_Element_Table.Instance;
1320 Array_Elements : Array_Element_Table.Instance;
1321 Arrays : Array_Table.Instance;
1322 Packages : Package_Table.Instance;
1323 Projects : Project_List;
1325 Units_HT : Units_Htable.Instance;
1326 -- Unit name to Unit_Index (and from there so Source_Id)
1328 Source_Paths_HT : Source_Paths_Htable.Instance;
1329 -- Full path to Source_Id
1331 Private_Part : Private_Project_Tree_Data;
1333 -- Data for a project tree
1335 procedure Expect (The_Token : Token_Type; Token_Image : String);
1336 -- Check that the current token is The_Token. If it is not, then output
1337 -- an error message.
1339 procedure Initialize (Tree : Project_Tree_Ref);
1340 -- This procedure must be called before using any services from the Prj
1341 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1343 procedure Reset (Tree : Project_Tree_Ref);
1344 -- This procedure resets all the tables that are used when processing a
1345 -- project file tree. Initialize must be called before the call to Reset.
1347 package Project_Boolean_Htable is new Simple_HTable
1348 (Header_Num => Header_Num,
1350 No_Element => False,
1354 -- A table that associates a project to a boolean. This is used to detect
1355 -- whether a project was already processed for instance.
1358 type State is limited private;
1359 with procedure Action
1360 (Project : Project_Id;
1361 With_State : in out State);
1362 procedure For_Every_Project_Imported
1364 With_State : in out State;
1365 Imported_First : Boolean := False);
1366 -- Call Action for each project imported directly or indirectly by project
1367 -- By, as well as extended projects.
1368 -- The order of processing depends on Imported_First:
1369 -- If False, Action is called according to the order of importation: if A
1370 -- imports B, directly or indirectly, Action will be called for A before
1371 -- it is called for B. If two projects import each other directly or
1372 -- indirectly (using at least one "limited with"), it is not specified
1373 -- for which of these two projects Action will be called first.
1374 -- The order is reversed if Imported_First is True.
1375 -- With_State may be used by Action to choose a behavior or to report some
1378 function Extend_Name
1379 (File : File_Name_Type;
1380 With_Suffix : String) return File_Name_Type;
1381 -- Replace the extension of File with With_Suffix
1383 function Object_Name
1384 (Source_File_Name : File_Name_Type;
1385 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1386 -- Returns the object file name corresponding to a source file name
1388 function Object_Name
1389 (Source_File_Name : File_Name_Type;
1391 Index_Separator : Character;
1392 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1393 -- Returns the object file name corresponding to a unit in a multi-source
1396 function Dependency_Name
1397 (Source_File_Name : File_Name_Type;
1398 Dependency : Dependency_File_Kind) return File_Name_Type;
1399 -- Returns the dependency file name corresponding to a source file name
1401 function Switches_Name
1402 (Source_File_Name : File_Name_Type) return File_Name_Type;
1403 -- Returns the switches file name corresponding to a source file name
1409 type Processing_Flags is private;
1410 -- Flags used while parsing and processing a project tree to configure the
1411 -- behavior of the parser, and indicate how to report error messages. This
1412 -- structure does not allocate memory and never needs to be freed
1414 type Error_Warning is (Silent, Warning, Error);
1415 -- Severity of some situations, such as: no Ada sources in a project where
1416 -- Ada is one of the language.
1418 -- When the situation occurs, the behaviour depends on the setting:
1420 -- - Silent: no action
1421 -- - Warning: issue a warning, does not cause the tool to fail
1422 -- - Error: issue an error, causes the tool to fail
1424 type Error_Handler is access procedure
1425 (Project : Project_Id;
1426 Is_Warning : Boolean);
1427 -- This warngs when an error was found when parsing a project. The error
1428 -- itself is handled through Prj.Err (and Prj.Err.Finalize should be called
1429 -- to actually print the error). This ensures that duplicate error messages
1430 -- are always correctly removed, that errors msgs are sorted, and that all
1431 -- tools will report the same error to the user.
1433 function Create_Flags
1434 (Report_Error : Error_Handler;
1435 When_No_Sources : Error_Warning;
1436 Require_Sources_Other_Lang : Boolean := True;
1437 Allow_Duplicate_Basenames : Boolean := True;
1438 Compiler_Driver_Mandatory : Boolean := False;
1439 Error_On_Unknown_Language : Boolean := True;
1440 Require_Obj_Dirs : Error_Warning := Error)
1441 return Processing_Flags;
1442 -- Function used to create Processing_Flags structure
1444 -- If Allow_Duplicate_Basenames, then files with the same base names are
1445 -- authorized within a project for source-based languages (never for unit
1446 -- based languages).
1448 -- If Compiler_Driver_Mandatory is true, then a Compiler.Driver attribute
1449 -- for each language must be defined, or we will not look for its source
1452 -- When_No_Sources indicates what should be done when no sources of a
1453 -- language are found in a project where this language is declared.
1454 -- If Require_Sources_Other_Lang is true, then all languages must have at
1455 -- least one source file, or an error is reported via When_No_Sources. If
1456 -- it is false, this is only required for Ada (and only if it is a language
1457 -- of the project). When this parameter is set to False, we do not check
1458 -- that a proper naming scheme is defined for languages other than Ada.
1460 -- If Report_Error is null, use the standard error reporting mechanism
1461 -- (Errout). Otherwise, report errors using Report_Error.
1463 -- If Error_On_Unknown_Language is true, an error is displayed if some of
1464 -- the source files listed in the project do not match any naming scheme
1466 -- If Require_Obj_Dirs is true, then all object directories must exist
1467 -- (possibly after they have been created automatically if the appropriate
1468 -- switches were specified), or an error is raised.
1470 Gprbuild_Flags : constant Processing_Flags;
1471 Gprclean_Flags : constant Processing_Flags;
1472 Gnatmake_Flags : constant Processing_Flags;
1473 -- Flags used by the various tools. They all display the error messages
1480 procedure Record_Temp_File
1481 (Tree : Project_Tree_Ref;
1482 Path : Path_Name_Type);
1483 -- Record the path of a newly created temporary file, so that it can be
1486 procedure Delete_All_Temp_Files (Tree : Project_Tree_Ref);
1487 -- Delete all recorded temporary files.
1488 -- Does nothing if Debug.Debug_Flag_N is set
1490 procedure Delete_Temporary_File
1491 (Tree : Project_Tree_Ref;
1492 Path : Path_Name_Type);
1493 -- Delete a temporary file from the disk. The file is also removed from the
1494 -- list of temporary files to delete at the end of the program, in case
1495 -- another program running on the same machine has recreated it.
1496 -- Does nothing if Debug.Debug_Flag_N is set
1500 All_Packages : constant String_List_Access := null;
1502 No_Project_Tree : constant Project_Tree_Ref := null;
1504 Ignored : constant Variable_Kind := Single;
1506 Nil_Variable_Value : constant Variable_Value :=
1507 (Project => No_Project,
1509 Location => No_Location,
1512 Virtual_Prefix : constant String := "v$";
1513 -- The prefix for virtual extending projects. Because of the '$', which is
1514 -- normally forbidden for project names, there cannot be any name clash.
1516 type Source_Iterator is record
1517 In_Tree : Project_Tree_Ref;
1519 Project : Project_List;
1520 All_Projects : Boolean;
1521 -- Current project and whether we should move on to the next
1523 Language : Language_Ptr;
1524 -- Current language processed
1526 Language_Name : Name_Id;
1527 -- Only sources of this language will be returned (or all if No_Name)
1529 Current : Source_Id;
1532 procedure Add_To_Buffer
1534 To : in out String_Access;
1535 Last : in out Natural);
1536 -- Append a String to the Buffer
1538 package Temp_Files_Table is new GNAT.Dynamic_Tables
1539 (Table_Component_Type => Path_Name_Type,
1540 Table_Index_Type => Integer,
1541 Table_Low_Bound => 1,
1542 Table_Initial => 10,
1543 Table_Increment => 10);
1544 -- Table to store the path name of all the created temporary files, so that
1545 -- they can be deleted at the end, or when the program is interrupted.
1547 type Private_Project_Tree_Data is record
1548 Temp_Files : Temp_Files_Table.Instance;
1549 -- Temporary files created as part of running tools (pragma files,
1550 -- mapping files,...)
1552 Current_Source_Path_File : Path_Name_Type := No_Path;
1553 -- Current value of project source path file env var. Used to avoid
1554 -- setting the env var to the same value. When different from No_Path,
1555 -- this indicates that logical names (VMS) or environment variables were
1556 -- created and should be deassigned to avoid polluting the environment
1560 Current_Object_Path_File : Path_Name_Type := No_Path;
1561 -- Current value of project object path file env var. Used to avoid
1562 -- setting the env var to the same value.
1566 -- Type to represent the part of a project tree which is private to the
1569 type Processing_Flags is record
1570 Require_Sources_Other_Lang : Boolean;
1571 Report_Error : Error_Handler;
1572 When_No_Sources : Error_Warning;
1573 Allow_Duplicate_Basenames : Boolean;
1574 Compiler_Driver_Mandatory : Boolean;
1575 Error_On_Unknown_Language : Boolean;
1576 Require_Obj_Dirs : Error_Warning;
1579 Gprbuild_Flags : constant Processing_Flags :=
1580 (Report_Error => null,
1581 When_No_Sources => Warning,
1582 Require_Sources_Other_Lang => True,
1583 Allow_Duplicate_Basenames => False,
1584 Compiler_Driver_Mandatory => True,
1585 Error_On_Unknown_Language => True,
1586 Require_Obj_Dirs => Error);
1588 Gprclean_Flags : constant Processing_Flags :=
1589 (Report_Error => null,
1590 When_No_Sources => Warning,
1591 Require_Sources_Other_Lang => True,
1592 Allow_Duplicate_Basenames => False,
1593 Compiler_Driver_Mandatory => True,
1594 Error_On_Unknown_Language => True,
1595 Require_Obj_Dirs => Warning);
1597 Gnatmake_Flags : constant Processing_Flags :=
1598 (Report_Error => null,
1599 When_No_Sources => Error,
1600 Require_Sources_Other_Lang => False,
1601 Allow_Duplicate_Basenames => False,
1602 Compiler_Driver_Mandatory => False,
1603 Error_On_Unknown_Language => False,
1604 Require_Obj_Dirs => Error);