1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2010, 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;
35 with Scans; use Scans;
36 with Types; use Types;
38 with GNAT.Dynamic_HTables; use GNAT.Dynamic_HTables;
39 with GNAT.Dynamic_Tables;
40 with GNAT.OS_Lib; use GNAT.OS_Lib;
44 All_Other_Names : constant Name_Id := Names_High_Bound;
45 -- Name used to replace others as an index of an associative array
46 -- attribute in situations where this is allowed.
48 Subdirs : String_Ptr := null;
49 -- The value after the equal sign in switch --subdirs=...
50 -- Contains the relative subdirectory.
52 type Library_Support is (None, Static_Only, Full);
53 -- Support for Library Project File.
54 -- - None: Library Project Files are not supported at all
55 -- - Static_Only: Library Project Files are only supported for static
57 -- - Full: Library Project Files are supported for static and dynamic
58 -- (shared) libraries.
60 type Yes_No_Unknown is (Yes, No, Unknown);
61 -- Tri-state to decide if -lgnarl is needed when linking
63 type Project_Qualifier is
71 -- Qualifiers that can prefix the reserved word "project" in a project
73 -- Standard: standard project ...
74 -- Library: library project is ...
75 -- Dry: abstract project is
76 -- Aggregate: aggregate project is
77 -- Aggregate_Library: aggregate library project is ...
78 -- Configuration: configuration project is ...
80 All_Packages : constant String_List_Access;
81 -- Default value of parameter Packages of procedures Parse, in Prj.Pars and
82 -- Prj.Part, indicating that all packages should be checked.
84 type Project_Tree_Data;
85 type Project_Tree_Ref is access all Project_Tree_Data;
86 -- Reference to a project tree. Several project trees may exist in memory
89 No_Project_Tree : constant Project_Tree_Ref;
91 procedure Free (Tree : in out Project_Tree_Ref);
92 -- Free memory associated with the tree
94 Config_Project_File_Extension : String := ".cgpr";
95 Project_File_Extension : String := ".gpr";
96 -- The standard config and user project file name extensions. They are not
97 -- constants, because Canonical_Case_File_Name is called on these variables
98 -- in the body of Prj.
100 function Empty_File return File_Name_Type;
101 function Empty_String return Name_Id;
102 -- Return the id for an empty string ""
104 type Path_Information is record
105 Name : Path_Name_Type := No_Path;
106 Display_Name : Path_Name_Type := No_Path;
108 -- Directory names always end with a directory separator
110 No_Path_Information : constant Path_Information := (No_Path, No_Path);
113 type Project_Id is access all Project_Data;
114 No_Project : constant Project_Id := null;
115 -- Id of a Project File
117 type String_List_Id is new Nat;
118 Nil_String : constant String_List_Id := 0;
119 type String_Element is record
120 Value : Name_Id := No_Name;
122 Display_Value : Name_Id := No_Name;
123 Location : Source_Ptr := No_Location;
124 Flag : Boolean := False;
125 Next : String_List_Id := Nil_String;
127 -- To hold values for string list variables and array elements.
128 -- Component Flag may be used for various purposes. For source
129 -- directories, it indicates if the directory contains Ada source(s).
131 package String_Element_Table is new GNAT.Dynamic_Tables
132 (Table_Component_Type => String_Element,
133 Table_Index_Type => String_List_Id,
134 Table_Low_Bound => 1,
135 Table_Initial => 200,
136 Table_Increment => 100);
137 -- The table for string elements in string lists
139 type Variable_Kind is (Undefined, List, Single);
140 -- Different kinds of variables
142 subtype Defined_Variable_Kind is Variable_Kind range List .. Single;
143 -- The defined kinds of variables
145 Ignored : constant Variable_Kind;
146 -- Used to indicate that a package declaration must be ignored
147 -- while processing the project tree (unknown package name).
149 type Variable_Value (Kind : Variable_Kind := Undefined) is record
150 Project : Project_Id := No_Project;
151 Location : Source_Ptr := No_Location;
152 Default : Boolean := False;
157 Values : String_List_Id := Nil_String;
159 Value : Name_Id := No_Name;
163 -- Values for variables and array elements. Default is True if the
164 -- current value is the default one for the variable.
166 Nil_Variable_Value : constant Variable_Value;
167 -- Value of a non existing variable or array element
169 type Variable_Id is new Nat;
170 No_Variable : constant Variable_Id := 0;
171 type Variable is record
172 Next : Variable_Id := No_Variable;
174 Value : Variable_Value;
176 -- To hold the list of variables in a project file and in packages
178 package Variable_Element_Table is new GNAT.Dynamic_Tables
179 (Table_Component_Type => Variable,
180 Table_Index_Type => Variable_Id,
181 Table_Low_Bound => 1,
182 Table_Initial => 200,
183 Table_Increment => 100);
184 -- The table of variable in list of variables
186 type Array_Element_Id is new Nat;
187 No_Array_Element : constant Array_Element_Id := 0;
188 type Array_Element is record
190 Src_Index : Int := 0;
191 Index_Case_Sensitive : Boolean := True;
192 Value : Variable_Value;
193 Next : Array_Element_Id := No_Array_Element;
195 -- Each Array_Element represents an array element and is linked (Next)
196 -- to the next array element, if any, in the array.
198 package Array_Element_Table is new GNAT.Dynamic_Tables
199 (Table_Component_Type => Array_Element,
200 Table_Index_Type => Array_Element_Id,
201 Table_Low_Bound => 1,
202 Table_Initial => 200,
203 Table_Increment => 100);
204 -- The table that contains all array elements
206 type Array_Id is new Nat;
207 No_Array : constant Array_Id := 0;
208 type Array_Data is record
209 Name : Name_Id := No_Name;
210 Location : Source_Ptr := No_Location;
211 Value : Array_Element_Id := No_Array_Element;
212 Next : Array_Id := No_Array;
214 -- Each Array_Data value represents an array.
215 -- Value is the id of the first element.
216 -- Next is the id of the next array in the project file or package.
218 package Array_Table is new GNAT.Dynamic_Tables
219 (Table_Component_Type => Array_Data,
220 Table_Index_Type => Array_Id,
221 Table_Low_Bound => 1,
222 Table_Initial => 200,
223 Table_Increment => 100);
224 -- The table that contains all arrays
226 type Package_Id is new Nat;
227 No_Package : constant Package_Id := 0;
228 type Declarations is record
229 Variables : Variable_Id := No_Variable;
230 Attributes : Variable_Id := No_Variable;
231 Arrays : Array_Id := No_Array;
232 Packages : Package_Id := No_Package;
234 -- Contains the declarations (variables, single and array attributes,
235 -- packages) for a project or a package in a project.
237 No_Declarations : constant Declarations :=
238 (Variables => No_Variable,
239 Attributes => No_Variable,
241 Packages => No_Package);
242 -- Default value of Declarations: indicates that there is no declarations
244 type Package_Element is record
245 Name : Name_Id := No_Name;
246 Decl : Declarations := No_Declarations;
247 Parent : Package_Id := No_Package;
248 Next : Package_Id := No_Package;
250 -- A package (includes declarations that may include other packages)
252 package Package_Table is new GNAT.Dynamic_Tables
253 (Table_Component_Type => Package_Element,
254 Table_Index_Type => Package_Id,
255 Table_Low_Bound => 1,
256 Table_Initial => 100,
257 Table_Increment => 100);
258 -- The table that contains all packages
261 type Language_Ptr is access all Language_Data;
262 -- Index of language data
264 No_Language_Index : constant Language_Ptr := null;
265 -- Constant indicating that there is no language data
267 function Get_Language_From_Name
268 (Project : Project_Id;
269 Name : String) return Language_Ptr;
270 -- Get a language from a project. This might return null if no such
271 -- language exists in the project
273 Max_Header_Num : constant := 6150;
274 type Header_Num is range 0 .. Max_Header_Num;
275 -- Size for hash table below. The upper bound is an arbitrary value, the
276 -- value here was chosen after testing to determine a good compromise
277 -- between speed of access and memory usage.
279 function Hash (Name : Name_Id) return Header_Num;
280 function Hash (Name : File_Name_Type) return Header_Num;
281 function Hash (Name : Path_Name_Type) return Header_Num;
282 function Hash (Project : Project_Id) return Header_Num;
283 -- Used for computing hash values for names put into hash tables
285 type Language_Kind is (File_Based, Unit_Based);
286 -- Type for the kind of language. All languages are file based, except Ada
287 -- which is unit based.
289 type Dependency_File_Kind is (None, Makefile, ALI_File);
290 -- Type of dependency to be checked: no dependency file, Makefile fragment
291 -- or ALI file (for Ada).
293 Makefile_Dependency_Suffix : constant String := ".d";
294 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 Location : Source_Ptr := No_Location;
670 -- Location in the project file of the declaration of the source in
673 Source_Dir_Rank : Natural := 0;
674 -- The rank of the source directory in list declared with attribute
675 -- Source_Dirs. Two source files with the same name cannot appears in
676 -- different directory with the same rank. That can happen when the
677 -- recursive notation <dir>/** is used in attribute Source_Dirs.
679 Language : Language_Ptr := No_Language_Index;
680 -- Index of the language. This is an index into
681 -- Project_Tree.Languages_Data.
683 In_Interfaces : Boolean := True;
684 -- False when the source is not included in interfaces, when attribute
685 -- Interfaces is declared.
687 Declared_In_Interfaces : Boolean := False;
688 -- True when source is declared in attribute Interfaces
690 Alternate_Languages : Language_List := null;
691 -- List of languages a header file may also be, in addition of language
694 Kind : Source_Kind := Spec;
695 -- Kind of the source: spec, body or subunit
697 Unit : Unit_Index := No_Unit_Index;
698 -- Name of the unit, if language is unit based. This is only set for
699 -- those files that are part of the compilation set (for instance a
700 -- file in an extended project that is overridden will not have this
704 -- Index of the source in a multi unit source file (the same Source_Data
705 -- is duplicated several times when there are several units in the same
706 -- file). Index is 0 if there is either no unit or a single one, and
707 -- starts at 1 when there are multiple units
709 Locally_Removed : Boolean := False;
710 -- True if the source has been "excluded"
712 Replaced_By : Source_Id := No_Source;
713 -- Missing comment ???
715 File : File_Name_Type := No_File;
716 -- Canonical file name of the source
718 Display_File : File_Name_Type := No_File;
719 -- File name of the source, for display purposes
721 Path : Path_Information := No_Path_Information;
722 -- Path name of the source
724 Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
725 -- Time stamp of the source file
727 Object_Project : Project_Id := No_Project;
728 -- Project where the object file is. This might be different from
729 -- Project when using extending project files.
731 Object : File_Name_Type := No_File;
732 -- File name of the object file
734 Current_Object_Path : Path_Name_Type := No_Path;
735 -- Object path of an existing object file
737 Object_Path : Path_Name_Type := No_Path;
738 -- Object path of the real object file
740 Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
741 -- Object file time stamp
743 Dep_Name : File_Name_Type := No_File;
744 -- Dependency file simple name
746 Current_Dep_Path : Path_Name_Type := No_Path;
747 -- Path name of an existing dependency file
749 Dep_Path : Path_Name_Type := No_Path;
750 -- Path name of the real dependency file
752 Dep_TS : aliased Osint.File_Attributes := Osint.Unknown_Attributes;
753 -- Dependency file time stamp
755 Switches : File_Name_Type := No_File;
756 -- File name of the switches file. For all languages, this is a file
757 -- that ends with the .cswi extension.
759 Switches_Path : Path_Name_Type := No_Path;
760 -- Path name of the switches file
762 Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
763 -- Switches file time stamp
765 Naming_Exception : Boolean := False;
766 -- True if the source has an exceptional name
768 Duplicate_Unit : Boolean := False;
769 -- True when a duplicate unit has been reported for this source
771 Next_In_Lang : Source_Id := No_Source;
772 -- Link to another source of the same language in the same project
775 No_Source_Data : constant Source_Data :=
776 (Project => No_Project,
777 Location => No_Location,
778 Source_Dir_Rank => 0,
779 Language => No_Language_Index,
780 In_Interfaces => True,
781 Declared_In_Interfaces => False,
782 Alternate_Languages => null,
784 Unit => No_Unit_Index,
786 Locally_Removed => False,
787 Replaced_By => No_Source,
789 Display_File => No_File,
790 Path => No_Path_Information,
791 Source_TS => Empty_Time_Stamp,
792 Object_Project => No_Project,
794 Current_Object_Path => No_Path,
795 Object_Path => No_Path,
796 Object_TS => Empty_Time_Stamp,
798 Current_Dep_Path => No_Path,
800 Dep_TS => Osint.Unknown_Attributes,
802 Switches_Path => No_Path,
803 Switches_TS => Empty_Time_Stamp,
804 Naming_Exception => False,
805 Duplicate_Unit => False,
806 Next_In_Lang => No_Source);
808 package Source_Paths_Htable is new Simple_HTable
809 (Header_Num => Header_Num,
810 Element => Source_Id,
811 No_Element => No_Source,
812 Key => Path_Name_Type,
815 -- Mapping of source paths to source ids
817 package Unit_Sources_Htable is new Simple_HTable
818 (Header_Num => Header_Num,
819 Element => Source_Id,
820 No_Element => No_Source,
825 type Verbosity is (Default, Medium, High);
826 pragma Ordered (Verbosity);
827 -- Verbosity when parsing GNAT Project Files
828 -- Default is default (very quiet, if no errors).
829 -- Medium is more verbose.
830 -- High is extremely verbose.
832 Current_Verbosity : Verbosity := Default;
833 -- The current value of the verbosity the project files are parsed with
835 type Lib_Kind is (Static, Dynamic, Relocatable);
837 type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
838 -- Type to specify the symbol policy, when symbol control is supported.
839 -- See full explanation about this type in package Symbols.
840 -- Autonomous: Create a symbol file without considering any reference
841 -- Compliant: Try to be as compatible as possible with an existing ref
842 -- Controlled: Fail if symbols are not the same as those in the reference
843 -- Restricted: Restrict the symbols to those in the symbol file
844 -- Direct: The symbol file is used as is
846 type Symbol_Record is record
847 Symbol_File : Path_Name_Type := No_Path;
848 Reference : Path_Name_Type := No_Path;
849 Symbol_Policy : Policy := Autonomous;
851 -- Type to keep the symbol data to be used when building a shared library
853 No_Symbols : constant Symbol_Record :=
854 (Symbol_File => No_Path,
855 Reference => No_Path,
856 Symbol_Policy => Autonomous);
857 -- The default value of the symbol data
859 function Image (The_Casing : Casing_Type) return String;
860 -- Similar to 'Image (but avoid use of this attribute in compiler)
862 function Value (Image : String) return Casing_Type;
863 -- Similar to 'Value (but avoid use of this attribute in compiler)
864 -- Raises Constraint_Error if not a Casing_Type image.
866 -- The following record contains data for a naming scheme
868 function Get_Object_Directory
869 (Project : Project_Id;
870 Including_Libraries : Boolean;
871 Only_If_Ada : Boolean := False) return Path_Name_Type;
872 -- Return the object directory to use for the project. This depends on
873 -- whether we have a library project or a standard project. This function
874 -- might return No_Name when no directory applies.
875 -- If we have a a library project file and Including_Libraries is True then
876 -- the library dir is returned instead of the object dir.
877 -- If Only_If_Ada is True, then No_Name will be returned when the project
878 -- doesn't Ada sources.
880 procedure Compute_All_Imported_Projects (Tree : Project_Tree_Ref);
881 -- For all projects in the tree, compute the list of the projects imported
882 -- directly or indirectly by project Project. The result is stored in
883 -- Project.All_Imported_Projects for each project
885 function Ultimate_Extending_Project_Of
886 (Proj : Project_Id) return Project_Id;
887 -- Returns the ultimate extending project of project Proj. If project Proj
888 -- is not extended, returns Proj.
890 type Project_List_Element;
891 type Project_List is access all Project_List_Element;
892 type Project_List_Element is record
893 Project : Project_Id := No_Project;
894 Next : Project_List := null;
896 -- A list of projects
899 (List : in out Project_List;
900 Free_Project : Boolean);
901 -- Free the list of projects, if Free_Project, each project is also freed
903 type Response_File_Format is
912 -- The format of the different response files
914 type Project_Configuration is record
915 Target : Name_Id := No_Name;
916 -- The target of the configuration, when specified
918 Run_Path_Option : Name_List_Index := No_Name_List;
919 -- The option to use when linking to specify the path where to look for
922 Run_Path_Origin : Name_Id := No_Name;
923 -- Specify the string (such as "$ORIGIN") to indicate paths relative to
924 -- the directory of the executable in the run path option.
926 Library_Install_Name_Option : Name_Id := No_Name;
927 -- When this is not an empty list, this option, followed by the single
928 -- name of the shared library file is used when linking a shared
931 Separate_Run_Path_Options : Boolean := False;
932 -- True if each directory needs to be specified in a separate run path
935 Executable_Suffix : Name_Id := No_Name;
936 -- The suffix of executables, when specified in the configuration or in
937 -- package Builder of the main project. When this is not specified, the
938 -- executable suffix is the default for the platform.
942 Linker : Path_Name_Type := No_Path;
943 -- Path name of the linker driver. Specified in the configuration or in
944 -- the package Builder of the main project.
946 Map_File_Option : Name_Id := No_Name;
947 -- Option to use when invoking the linker to build a map file
949 Trailing_Linker_Required_Switches : Name_List_Index := No_Name_List;
950 -- The minimum options for the linker driver. Specified in the
953 Linker_Executable_Option : Name_List_Index := No_Name_List;
954 -- The option(s) to indicate the name of the executable in the linker
955 -- command. Specified in the configuration. When not specified, default
956 -- to -o <executable name>.
958 Linker_Lib_Dir_Option : Name_Id := No_Name;
959 -- The option to specify where to find a library for linking. Specified
960 -- in the configuration. When not specified, defaults to "-L".
962 Linker_Lib_Name_Option : Name_Id := No_Name;
963 -- The option to specify the name of a library for linking. Specified in
964 -- the configuration. When not specified, defaults to "-l".
966 Max_Command_Line_Length : Natural := 0;
967 -- When positive and when Resp_File_Format (see below) is not None,
968 -- if the command line for the invocation of the linker would be greater
969 -- than this value, a response file is used to invoke the linker.
971 Resp_File_Format : Response_File_Format := None;
972 -- The format of a response file, when linking with a response file is
975 Resp_File_Options : Name_List_Index := No_Name_List;
976 -- The switches, if any, that precede the path name of the response
977 -- file in the invocation of the linker.
981 Library_Builder : Path_Name_Type := No_Path;
982 -- The executable to build library (specified in the configuration)
984 Lib_Support : Library_Support := None;
985 -- The level of library support. Specified in the configuration. Support
986 -- is none, static libraries only or both static and shared libraries.
988 Archive_Builder : Name_List_Index := No_Name_List;
989 -- The name of the executable to build archives, with the minimum
990 -- switches. Specified in the configuration.
992 Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
993 -- The options to append object files to an archive
995 Archive_Indexer : Name_List_Index := No_Name_List;
996 -- The name of the executable to index archives, with the minimum
997 -- switches. Specified in the configuration.
999 Archive_Suffix : File_Name_Type := No_File;
1000 -- The suffix of archives. Specified in the configuration. When not
1001 -- specified, defaults to ".a".
1003 Lib_Partial_Linker : Name_List_Index := No_Name_List;
1007 Shared_Lib_Driver : File_Name_Type := No_File;
1008 -- The driver to link shared libraries. Set with attribute Library_GCC.
1011 Shared_Lib_Prefix : File_Name_Type := No_File;
1012 -- Part of a shared library file name that precedes the name of the
1013 -- library. Specified in the configuration. When not specified, defaults
1016 Shared_Lib_Suffix : File_Name_Type := No_File;
1017 -- Suffix of shared libraries, after the library name in the shared
1018 -- library name. Specified in the configuration. When not specified,
1019 -- default to ".so".
1021 Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1022 -- The minimum options to use when building a shared library
1024 Lib_Version_Options : Name_List_Index := No_Name_List;
1025 -- The options to use to specify a library version
1027 Symbolic_Link_Supported : Boolean := False;
1028 -- True if the platform supports symbolic link files
1030 Lib_Maj_Min_Id_Supported : Boolean := False;
1031 -- True if platform supports library major and minor options, such as
1032 -- libname.so -> libname.so.2 -> libname.so.2.4
1034 Auto_Init_Supported : Boolean := False;
1035 -- True if automatic initialisation is supported for shared stand-alone
1039 Default_Project_Config : constant Project_Configuration :=
1041 Run_Path_Option => No_Name_List,
1042 Run_Path_Origin => No_Name,
1043 Library_Install_Name_Option => No_Name,
1044 Separate_Run_Path_Options => False,
1045 Executable_Suffix => No_Name,
1047 Map_File_Option => No_Name,
1048 Trailing_Linker_Required_Switches =>
1050 Linker_Executable_Option => No_Name_List,
1051 Linker_Lib_Dir_Option => No_Name,
1052 Linker_Lib_Name_Option => No_Name,
1053 Library_Builder => No_Path,
1054 Max_Command_Line_Length => 0,
1055 Resp_File_Format => None,
1056 Resp_File_Options => No_Name_List,
1057 Lib_Support => None,
1058 Archive_Builder => No_Name_List,
1059 Archive_Builder_Append_Option => No_Name_List,
1060 Archive_Indexer => No_Name_List,
1061 Archive_Suffix => No_File,
1062 Lib_Partial_Linker => No_Name_List,
1063 Shared_Lib_Driver => No_File,
1064 Shared_Lib_Prefix => No_File,
1065 Shared_Lib_Suffix => No_File,
1066 Shared_Lib_Min_Options => No_Name_List,
1067 Lib_Version_Options => No_Name_List,
1068 Symbolic_Link_Supported => False,
1069 Lib_Maj_Min_Id_Supported => False,
1070 Auto_Init_Supported => False);
1072 -- The following record describes a project file representation
1074 -- Note that it is not specified if the path names of directories (source,
1075 -- object, library or exec directories) end with or without a directory
1078 type Project_Data is record
1084 Name : Name_Id := No_Name;
1085 -- The name of the project
1087 Display_Name : Name_Id := No_Name;
1088 -- The name of the project with the spelling of its declaration
1090 Qualifier : Project_Qualifier := Unspecified;
1091 -- The eventual qualifier for this project
1093 Externally_Built : Boolean := False;
1094 -- True if the project is externally built. In such case, the Project
1095 -- Manager will not modify anything in this project.
1097 Config : Project_Configuration;
1099 Path : Path_Information := No_Path_Information;
1100 -- The path name of the project file. This include base name of the
1103 Virtual : Boolean := False;
1104 -- True for virtual extending projects
1106 Location : Source_Ptr := No_Location;
1107 -- The location in the project file source of the reserved word project
1113 Languages : Language_Ptr := No_Language_Index;
1114 -- First index of the language data in the project.
1115 -- This is an index into the project_tree_data.languages_data.
1116 -- Traversing the list gives access to all the languages supported by
1123 Mains : String_List_Id := Nil_String;
1124 -- List of mains specified by attribute Main
1126 Extends : Project_Id := No_Project;
1127 -- The reference of the project file, if any, that this project file
1130 Extended_By : Project_Id := No_Project;
1131 -- The reference of the project file, if any, that extends this project
1134 Decl : Declarations := No_Declarations;
1135 -- The declarations (variables, attributes and packages) of this project
1138 Imported_Projects : Project_List;
1139 -- The list of all directly imported projects, if any
1141 All_Imported_Projects : Project_List;
1142 -- The list of all projects imported directly or indirectly, if any.
1143 -- This does not include the project itself.
1149 Directory : Path_Information := No_Path_Information;
1150 -- Path name of the directory where the project file resides
1152 Object_Directory : Path_Information := No_Path_Information;
1153 -- The path name of the object directory of this project file
1155 Exec_Directory : Path_Information := No_Path_Information;
1156 -- The path name of the exec directory of this project file. Default is
1157 -- equal to Object_Directory.
1163 Library : Boolean := False;
1164 -- True if this is a library project
1166 Library_Name : Name_Id := No_Name;
1167 -- If a library project, name of the library
1169 Library_Kind : Lib_Kind := Static;
1170 -- If a library project, kind of library
1172 Library_Dir : Path_Information := No_Path_Information;
1173 -- If a library project, path name of the directory where the library
1176 Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1177 -- The timestamp of a library file in a library project
1179 Library_Src_Dir : Path_Information := No_Path_Information;
1180 -- If a Stand-Alone Library project, path name of the directory where
1181 -- the sources of the interfaces of the library are copied. By default,
1182 -- if attribute Library_Src_Dir is not specified, sources of the
1183 -- interfaces are not copied anywhere.
1185 Library_ALI_Dir : Path_Information := No_Path_Information;
1186 -- In a library project, path name of the directory where the ALI files
1187 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1188 -- are copied in the Library_Dir.
1190 Lib_Internal_Name : Name_Id := No_Name;
1191 -- If a library project, internal name store inside the library
1193 Standalone_Library : Boolean := False;
1194 -- Indicate that this is a Standalone Library Project File
1196 Lib_Interface_ALIs : String_List_Id := Nil_String;
1197 -- For Standalone Library Project Files, indicate the list of Interface
1200 Lib_Auto_Init : Boolean := False;
1201 -- For non static Stand-Alone Library Project Files, indicate if
1202 -- the library initialisation should be automatic.
1204 Symbol_Data : Symbol_Record := No_Symbols;
1205 -- Symbol file name, reference symbol file name, symbol policy
1207 Need_To_Build_Lib : Boolean := False;
1208 -- Indicates that the library of a Library Project needs to be built or
1214 -- The sources for all languages including Ada are accessible through
1215 -- the Source_Iterator type
1217 Interfaces_Defined : Boolean := False;
1218 -- True if attribute Interfaces is declared for the project or any
1219 -- project it extends.
1221 Include_Path_File : Path_Name_Type := No_Path;
1222 -- The path name of the of the source search directory file.
1223 -- This is only used by gnatmake
1225 Source_Dirs : String_List_Id := Nil_String;
1226 -- The list of all the source directories
1228 Source_Dir_Ranks : Number_List_Index := No_Number_List;
1230 Ada_Include_Path : String_Access := null;
1231 -- The cached value of source search path for this project file. Set by
1232 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1233 -- use this field directly outside of the project manager, use
1234 -- Prj.Env.Ada_Include_Path instead.
1236 Has_Multi_Unit_Sources : Boolean := False;
1237 -- Whether there is at least one source file containing multiple units
1243 Ada_Objects_Path : String_Access := null;
1244 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1245 -- use this field directly outside of the compiler, use
1246 -- Prj.Env.Ada_Objects_Path instead.
1248 Libgnarl_Needed : Yes_No_Unknown := Unknown;
1249 -- Set to True when libgnarl is needed to link
1251 Objects_Path : String_Access := null;
1252 -- The cached value of the object dir path, used during the binding
1253 -- phase of gprbuild.
1255 Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1256 -- The cached value of the object path temp file (including library
1257 -- dirs) for this project file.
1259 Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1260 -- The cached value of the object path temp file (excluding library
1261 -- dirs) for this project file.
1263 Config_File_Name : Path_Name_Type := No_Path;
1264 -- The path name of the configuration pragmas file, if any
1266 Config_File_Temp : Boolean := False;
1267 -- An indication that the configuration pragmas file is a temporary file
1268 -- that must be deleted at the end.
1270 Config_Checked : Boolean := False;
1271 -- A flag to avoid checking repetitively the configuration pragmas file
1273 Depth : Natural := 0;
1274 -- The maximum depth of a project in the project graph. Depth of main
1277 Unkept_Comments : Boolean := False;
1278 -- True if there are comments in the project sources that cannot be kept
1279 -- in the project tree.
1283 function Empty_Project return Project_Data;
1284 -- Return the representation of an empty project
1286 function Is_Extending
1287 (Extending : Project_Id;
1288 Extended : Project_Id) return Boolean;
1289 -- Return True if Extending is extending the Extended project
1291 function Has_Ada_Sources (Data : Project_Id) return Boolean;
1292 -- Return True if the project has Ada sources
1294 Project_Error : exception;
1295 -- Raised by some subprograms in Prj.Attr
1297 package Units_Htable is new Simple_HTable
1298 (Header_Num => Header_Num,
1299 Element => Unit_Index,
1300 No_Element => No_Unit_Index,
1304 -- Mapping of unit names to indexes in the Units table
1306 ---------------------
1307 -- Source_Iterator --
1308 ---------------------
1310 type Source_Iterator is private;
1312 function For_Each_Source
1313 (In_Tree : Project_Tree_Ref;
1314 Project : Project_Id := No_Project;
1315 Language : Name_Id := No_Name) return Source_Iterator;
1316 -- Returns an iterator for all the sources of a project tree, or a specific
1317 -- project, or a specific language.
1319 function Element (Iter : Source_Iterator) return Source_Id;
1320 -- Return the current source (or No_Source if there are no more sources)
1322 procedure Next (Iter : in out Source_Iterator);
1323 -- Move on to the next source
1325 function Find_Source
1326 (In_Tree : Project_Tree_Ref;
1327 Project : Project_Id;
1328 In_Imported_Only : Boolean := False;
1329 In_Extended_Only : Boolean := False;
1330 Base_Name : File_Name_Type) return Source_Id;
1331 -- Find the first source file with the given name either in the whole tree
1332 -- (if In_Imported_Only is False) or in the projects imported or extended
1333 -- by Project otherwise. In_Extended_Only implies In_Imported_Only, and
1334 -- will only look in Project and the projects it extends
1336 -----------------------
1337 -- Project_Tree_Data --
1338 -----------------------
1340 package Replaced_Source_HTable is new Simple_HTable
1341 (Header_Num => Header_Num,
1342 Element => File_Name_Type,
1343 No_Element => No_File,
1344 Key => File_Name_Type,
1348 type Private_Project_Tree_Data is private;
1349 -- Data for a project tree that is used only by the Project Manager
1351 type Project_Tree_Data is
1353 Name_Lists : Name_List_Table.Instance;
1354 Number_Lists : Number_List_Table.Instance;
1355 String_Elements : String_Element_Table.Instance;
1356 Variable_Elements : Variable_Element_Table.Instance;
1357 Array_Elements : Array_Element_Table.Instance;
1358 Arrays : Array_Table.Instance;
1359 Packages : Package_Table.Instance;
1360 Projects : Project_List;
1362 Replaced_Sources : Replaced_Source_HTable.Instance;
1363 -- The list of sources that have been replaced by sources with
1364 -- different file names.
1366 Replaced_Source_Number : Natural := 0;
1367 -- The number of entries in Replaced_Sources
1369 Units_HT : Units_Htable.Instance;
1370 -- Unit name to Unit_Index (and from there so Source_Id)
1372 Source_Paths_HT : Source_Paths_Htable.Instance;
1373 -- Full path to Source_Id
1375 Source_Info_File_Name : String_Access := null;
1376 -- The name of the source info file, if specified by the builder
1378 Source_Info_File_Exists : Boolean := False;
1379 -- True when a source info file has been successfully read
1381 Private_Part : Private_Project_Tree_Data;
1383 -- Data for a project tree
1385 procedure Expect (The_Token : Token_Type; Token_Image : String);
1386 -- Check that the current token is The_Token. If it is not, then output
1387 -- an error message.
1389 procedure Initialize (Tree : Project_Tree_Ref);
1390 -- This procedure must be called before using any services from the Prj
1391 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1393 procedure Reset (Tree : Project_Tree_Ref);
1394 -- This procedure resets all the tables that are used when processing a
1395 -- project file tree. Initialize must be called before the call to Reset.
1397 package Project_Boolean_Htable is new Simple_HTable
1398 (Header_Num => Header_Num,
1400 No_Element => False,
1404 -- A table that associates a project to a boolean. This is used to detect
1405 -- whether a project was already processed for instance.
1408 type State is limited private;
1409 with procedure Action
1410 (Project : Project_Id;
1411 With_State : in out State);
1412 procedure For_Every_Project_Imported
1414 With_State : in out State;
1415 Imported_First : Boolean := False);
1416 -- Call Action for each project imported directly or indirectly by project
1417 -- By, as well as extended projects.
1418 -- The order of processing depends on Imported_First:
1419 -- If False, Action is called according to the order of importation: if A
1420 -- imports B, directly or indirectly, Action will be called for A before
1421 -- it is called for B. If two projects import each other directly or
1422 -- indirectly (using at least one "limited with"), it is not specified
1423 -- for which of these two projects Action will be called first.
1424 -- The order is reversed if Imported_First is True.
1425 -- With_State may be used by Action to choose a behavior or to report some
1428 function Extend_Name
1429 (File : File_Name_Type;
1430 With_Suffix : String) return File_Name_Type;
1431 -- Replace the extension of File with With_Suffix
1433 function Object_Name
1434 (Source_File_Name : File_Name_Type;
1435 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1436 -- Returns the object file name corresponding to a source file name
1438 function Object_Name
1439 (Source_File_Name : File_Name_Type;
1441 Index_Separator : Character;
1442 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1443 -- Returns the object file name corresponding to a unit in a multi-source
1446 function Dependency_Name
1447 (Source_File_Name : File_Name_Type;
1448 Dependency : Dependency_File_Kind) return File_Name_Type;
1449 -- Returns the dependency file name corresponding to a source file name
1451 function Switches_Name
1452 (Source_File_Name : File_Name_Type) return File_Name_Type;
1453 -- Returns the switches file name corresponding to a source file name
1459 type Processing_Flags is private;
1460 -- Flags used while parsing and processing a project tree to configure the
1461 -- behavior of the parser, and indicate how to report error messages. This
1462 -- structure does not allocate memory and never needs to be freed
1464 type Error_Warning is (Silent, Warning, Error);
1465 -- Severity of some situations, such as: no Ada sources in a project where
1466 -- Ada is one of the language.
1468 -- When the situation occurs, the behaviour depends on the setting:
1470 -- - Silent: no action
1471 -- - Warning: issue a warning, does not cause the tool to fail
1472 -- - Error: issue an error, causes the tool to fail
1474 type Error_Handler is access procedure
1475 (Project : Project_Id;
1476 Is_Warning : Boolean);
1477 -- This warngs when an error was found when parsing a project. The error
1478 -- itself is handled through Prj.Err (and Prj.Err.Finalize should be called
1479 -- to actually print the error). This ensures that duplicate error messages
1480 -- are always correctly removed, that errors msgs are sorted, and that all
1481 -- tools will report the same error to the user.
1483 function Create_Flags
1484 (Report_Error : Error_Handler;
1485 When_No_Sources : Error_Warning;
1486 Require_Sources_Other_Lang : Boolean := True;
1487 Allow_Duplicate_Basenames : Boolean := True;
1488 Compiler_Driver_Mandatory : Boolean := False;
1489 Error_On_Unknown_Language : Boolean := True;
1490 Require_Obj_Dirs : Error_Warning := Error;
1491 Allow_Invalid_External : Error_Warning := Error;
1492 Missing_Source_Files : Error_Warning := Error)
1493 return Processing_Flags;
1494 -- Function used to create Processing_Flags structure
1496 -- If Allow_Duplicate_Basenames, then files with the same base names are
1497 -- authorized within a project for source-based languages (never for unit
1498 -- based languages).
1500 -- If Compiler_Driver_Mandatory is true, then a Compiler.Driver attribute
1501 -- for each language must be defined, or we will not look for its source
1504 -- When_No_Sources indicates what should be done when no sources of a
1505 -- language are found in a project where this language is declared.
1506 -- If Require_Sources_Other_Lang is true, then all languages must have at
1507 -- least one source file, or an error is reported via When_No_Sources. If
1508 -- it is false, this is only required for Ada (and only if it is a language
1509 -- of the project). When this parameter is set to False, we do not check
1510 -- that a proper naming scheme is defined for languages other than Ada.
1512 -- If Report_Error is null, use the standard error reporting mechanism
1513 -- (Errout). Otherwise, report errors using Report_Error.
1515 -- If Error_On_Unknown_Language is true, an error is displayed if some of
1516 -- the source files listed in the project do not match any naming scheme
1518 -- If Require_Obj_Dirs is true, then all object directories must exist
1519 -- (possibly after they have been created automatically if the appropriate
1520 -- switches were specified), or an error is raised.
1522 -- If Allow_Invalid_External is Silent, then no error is reported when an
1523 -- invalid value is used for an external variable (and it doesn't match its
1524 -- type). Instead, the first possible value is used.
1526 -- Missing_Source_Files indicates whether it is an error or a warning that
1527 -- a source file mentioned in the Source_Files attributes is not actually
1528 -- found in the source directories. This also impacts errors for missing
1529 -- source directories.
1531 Gprbuild_Flags : constant Processing_Flags;
1532 Gprclean_Flags : constant Processing_Flags;
1533 Gnatmake_Flags : constant Processing_Flags;
1534 -- Flags used by the various tools. They all display the error messages
1541 procedure Record_Temp_File
1542 (Tree : Project_Tree_Ref;
1543 Path : Path_Name_Type);
1544 -- Record the path of a newly created temporary file, so that it can be
1547 procedure Delete_All_Temp_Files (Tree : Project_Tree_Ref);
1548 -- Delete all recorded temporary files.
1549 -- Does nothing if Debug.Debug_Flag_N is set
1551 procedure Delete_Temporary_File
1552 (Tree : Project_Tree_Ref;
1553 Path : Path_Name_Type);
1554 -- Delete a temporary file from the disk. The file is also removed from the
1555 -- list of temporary files to delete at the end of the program, in case
1556 -- another program running on the same machine has recreated it.
1557 -- Does nothing if Debug.Debug_Flag_N is set
1559 Virtual_Prefix : constant String := "v$";
1560 -- The prefix for virtual extending projects. Because of the '$', which is
1561 -- normally forbidden for project names, there cannot be any name clash.
1565 All_Packages : constant String_List_Access := null;
1567 No_Project_Tree : constant Project_Tree_Ref := null;
1569 Ignored : constant Variable_Kind := Single;
1571 Nil_Variable_Value : constant Variable_Value :=
1572 (Project => No_Project,
1574 Location => No_Location,
1577 type Source_Iterator is record
1578 In_Tree : Project_Tree_Ref;
1580 Project : Project_List;
1581 All_Projects : Boolean;
1582 -- Current project and whether we should move on to the next
1584 Language : Language_Ptr;
1585 -- Current language processed
1587 Language_Name : Name_Id;
1588 -- Only sources of this language will be returned (or all if No_Name)
1590 Current : Source_Id;
1593 procedure Add_To_Buffer
1595 To : in out String_Access;
1596 Last : in out Natural);
1597 -- Append a String to the Buffer
1599 package Temp_Files_Table is new GNAT.Dynamic_Tables
1600 (Table_Component_Type => Path_Name_Type,
1601 Table_Index_Type => Integer,
1602 Table_Low_Bound => 1,
1603 Table_Initial => 10,
1604 Table_Increment => 10);
1605 -- Table to store the path name of all the created temporary files, so that
1606 -- they can be deleted at the end, or when the program is interrupted.
1608 type Private_Project_Tree_Data is record
1609 Temp_Files : Temp_Files_Table.Instance;
1610 -- Temporary files created as part of running tools (pragma files,
1611 -- mapping files,...)
1613 Current_Source_Path_File : Path_Name_Type := No_Path;
1614 -- Current value of project source path file env var. Used to avoid
1615 -- setting the env var to the same value. When different from No_Path,
1616 -- this indicates that logical names (VMS) or environment variables were
1617 -- created and should be deassigned to avoid polluting the environment
1621 Current_Object_Path_File : Path_Name_Type := No_Path;
1622 -- Current value of project object path file env var. Used to avoid
1623 -- setting the env var to the same value.
1627 -- Type to represent the part of a project tree which is private to the
1630 type Processing_Flags is record
1631 Require_Sources_Other_Lang : Boolean;
1632 Report_Error : Error_Handler;
1633 When_No_Sources : Error_Warning;
1634 Allow_Duplicate_Basenames : Boolean;
1635 Compiler_Driver_Mandatory : Boolean;
1636 Error_On_Unknown_Language : Boolean;
1637 Require_Obj_Dirs : Error_Warning;
1638 Allow_Invalid_External : Error_Warning;
1639 Missing_Source_Files : Error_Warning;
1642 Gprbuild_Flags : constant Processing_Flags :=
1643 (Report_Error => null,
1644 When_No_Sources => Warning,
1645 Require_Sources_Other_Lang => True,
1646 Allow_Duplicate_Basenames => False,
1647 Compiler_Driver_Mandatory => True,
1648 Error_On_Unknown_Language => True,
1649 Require_Obj_Dirs => Error,
1650 Allow_Invalid_External => Error,
1651 Missing_Source_Files => Error);
1653 Gprclean_Flags : constant Processing_Flags :=
1654 (Report_Error => null,
1655 When_No_Sources => Warning,
1656 Require_Sources_Other_Lang => True,
1657 Allow_Duplicate_Basenames => False,
1658 Compiler_Driver_Mandatory => True,
1659 Error_On_Unknown_Language => True,
1660 Require_Obj_Dirs => Warning,
1661 Allow_Invalid_External => Error,
1662 Missing_Source_Files => Error);
1664 Gnatmake_Flags : constant Processing_Flags :=
1665 (Report_Error => null,
1666 When_No_Sources => Error,
1667 Require_Sources_Other_Lang => False,
1668 Allow_Duplicate_Basenames => False,
1669 Compiler_Driver_Mandatory => False,
1670 Error_On_Unknown_Language => False,
1671 Require_Obj_Dirs => Error,
1672 Allow_Invalid_External => Error,
1673 Missing_Source_Files => Error);
OSDN Git Service
