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";
296 Switches_Dependency_Suffix : constant String := ".cswi";
298 Binder_Exchange_Suffix : constant String := ".bexch";
299 -- Suffix for binder exchange files
301 Library_Exchange_Suffix : constant String := ".lexch";
302 -- Suffix for library exchange files
304 type Name_List_Index is new Nat;
305 No_Name_List : constant Name_List_Index := 0;
307 type Name_Node is record
308 Name : Name_Id := No_Name;
309 Next : Name_List_Index := No_Name_List;
312 package Name_List_Table is new GNAT.Dynamic_Tables
313 (Table_Component_Type => Name_Node,
314 Table_Index_Type => Name_List_Index,
315 Table_Low_Bound => 1,
317 Table_Increment => 100);
318 -- The table for lists of names
321 (Table : Name_List_Table.Instance;
322 List : Name_List_Index) return Natural;
323 -- Return the number of elements in specified list
325 type Number_List_Index is new Nat;
326 No_Number_List : constant Number_List_Index := 0;
328 type Number_Node is record
329 Number : Natural := 0;
330 Next : Number_List_Index := No_Number_List;
333 package Number_List_Table is new GNAT.Dynamic_Tables
334 (Table_Component_Type => Number_Node,
335 Table_Index_Type => Number_List_Index,
336 Table_Low_Bound => 1,
338 Table_Increment => 100);
339 -- The table for lists of numbers
341 package Mapping_Files_Htable is new Simple_HTable
342 (Header_Num => Header_Num,
343 Element => Path_Name_Type,
344 No_Element => No_Path,
345 Key => Path_Name_Type,
348 -- A hash table to store the mapping files that are not used
350 -- The following record ???
352 type Lang_Naming_Data is record
353 Dot_Replacement : File_Name_Type := No_File;
354 -- The string to replace '.' in the source file name (for Ada)
356 Casing : Casing_Type := All_Lower_Case;
357 -- The casing of the source file name (for Ada)
359 Separate_Suffix : File_Name_Type := No_File;
360 -- String to append to unit name for source file name of an Ada subunit
362 Spec_Suffix : File_Name_Type := No_File;
363 -- The string to append to the unit name for the
364 -- source file name of a spec.
366 Body_Suffix : File_Name_Type := No_File;
367 -- The string to append to the unit name for the
368 -- source file name of a body.
371 No_Lang_Naming_Data : constant Lang_Naming_Data :=
372 (Dot_Replacement => No_File,
373 Casing => All_Lower_Case,
374 Separate_Suffix => No_File,
375 Spec_Suffix => No_File,
376 Body_Suffix => No_File);
378 function Is_Standard_GNAT_Naming (Naming : Lang_Naming_Data) return Boolean;
379 -- True if the naming scheme is GNAT's default naming scheme. This
380 -- is to take into account shortened names like "Ada." (a-), "System." (s-)
384 type Source_Id is access all Source_Data;
386 function Is_Compilable (Source : Source_Id) return Boolean;
387 pragma Inline (Is_Compilable);
388 -- Return True if we know how to compile Source (i.e. if a compiler is
389 -- defined). This doesn't indicate whether the source should be compiled.
391 function Object_To_Global_Archive (Source : Source_Id) return Boolean;
392 pragma Inline (Object_To_Global_Archive);
393 -- Return True if the object file should be put in the global archive.
394 -- This is for Ada, when only the closure of a main needs to be
397 function Other_Part (Source : Source_Id) return Source_Id;
398 pragma Inline (Other_Part);
399 -- Source ID for the other part, if any: for a spec, indicates its body;
400 -- for a body, indicates its spec.
402 No_Source : constant Source_Id := null;
404 type Path_Syntax_Kind is
408 -- Host specific syntax, for example on VMS (the default)
410 -- The following record describes the configuration of a language
412 type Language_Config is record
413 Kind : Language_Kind := File_Based;
414 -- Kind of language. All languages are file based, except Ada which is
417 Naming_Data : Lang_Naming_Data;
418 -- The naming data for the languages (prefixes, etc.)
420 Include_Compatible_Languages : Name_List_Index := No_Name_List;
421 -- List of languages that are "include compatible" with this language. A
422 -- language B (for example "C") is "include compatible" with a language
423 -- A (for example "C++") if it is expected that sources of language A
424 -- may "include" header files from language B.
426 Compiler_Driver : File_Name_Type := No_File;
427 -- The name of the executable for the compiler of the language
429 Compiler_Driver_Path : String_Access := null;
430 -- The path name of the executable for the compiler of the language
432 Compiler_Leading_Required_Switches : Name_List_Index := No_Name_List;
433 -- The list of initial switches that are required as a minimum to invoke
434 -- the compiler driver.
436 Compiler_Trailing_Required_Switches : Name_List_Index := No_Name_List;
437 -- The list of final switches that are required as a minimum to invoke
438 -- the compiler driver.
440 Multi_Unit_Switches : Name_List_Index := No_Name_List;
441 -- The switch(es) to indicate the index of a unit in a multi-source file
443 Multi_Unit_Object_Separator : Character := ' ';
444 -- The string separating the base name of a source from the index of the
445 -- unit in a multi-source file, in the object file name.
447 Path_Syntax : Path_Syntax_Kind := Host;
448 -- Value may be Canonical (Unix style) or Host (host syntax, for example
449 -- on VMS for DEC C).
451 Object_File_Suffix : Name_Id := No_Name;
452 -- Optional alternate object file suffix
454 Object_File_Switches : Name_List_Index := No_Name_List;
455 -- Optional object file switches. When this is defined, the switches
456 -- are used to specify the object file. The object file name is appended
457 -- to the last switch in the list. Example: ("-o", "").
459 Compilation_PIC_Option : Name_List_Index := No_Name_List;
460 -- The option(s) to compile a source in Position Independent Code for
461 -- shared libraries. Specified in the configuration. When not specified,
462 -- there is no need for such switch.
464 Object_Generated : Boolean := True;
465 -- False in no object file is generated
467 Objects_Linked : Boolean := True;
468 -- False if object files are not use to link executables and build
471 Runtime_Library_Dir : Name_Id := No_Name;
472 -- Path name of the runtime library directory, if any
474 Runtime_Source_Dir : Name_Id := No_Name;
475 -- Path name of the runtime source directory, if any
477 Mapping_File_Switches : Name_List_Index := No_Name_List;
478 -- The option(s) to provide a mapping file to the compiler. Specified in
479 -- the configuration. When value is No_Name_List, there is no mapping
482 Mapping_Spec_Suffix : File_Name_Type := No_File;
483 -- Placeholder representing the spec suffix in a mapping file
485 Mapping_Body_Suffix : File_Name_Type := No_File;
486 -- Placeholder representing the body suffix in a mapping file
488 Config_File_Switches : Name_List_Index := No_Name_List;
489 -- The option(s) to provide a config file to the compiler. Specified in
490 -- the configuration. If value is No_Name_List there is no config file.
492 Dependency_Kind : Dependency_File_Kind := None;
493 -- The kind of dependency to be checked: none, Makefile fragment or
494 -- ALI file (for Ada).
496 Dependency_Option : Name_List_Index := No_Name_List;
497 -- The option(s) to be used to create the dependency file. When value is
498 -- No_Name_List, there is not such option(s).
500 Compute_Dependency : Name_List_Index := No_Name_List;
501 -- Hold the value of attribute Dependency_Driver, if declared for the
504 Include_Option : Name_List_Index := No_Name_List;
505 -- Hold the value of attribute Include_Switches, if declared for the
508 Include_Path : Name_Id := No_Name;
509 -- Name of environment variable declared by attribute Include_Path for
512 Include_Path_File : Name_Id := No_Name;
513 -- Name of environment variable declared by attribute Include_Path_File
516 Objects_Path : Name_Id := No_Name;
517 -- Name of environment variable declared by attribute Objects_Path for
520 Objects_Path_File : Name_Id := No_Name;
521 -- Name of environment variable declared by attribute Objects_Path_File
524 Config_Body : Name_Id := No_Name;
525 -- The template for a pragma Source_File_Name(_Project) for a specific
526 -- file name of a body.
528 Config_Body_Index : Name_Id := No_Name;
529 -- The template for a pragma Source_File_Name(_Project) for a specific
530 -- file name of a body in a multi-source file.
532 Config_Body_Pattern : Name_Id := No_Name;
533 -- The template for a pragma Source_File_Name(_Project) for a naming
536 Config_Spec : Name_Id := No_Name;
537 -- The template for a pragma Source_File_Name(_Project) for a specific
538 -- file name of a spec.
540 Config_Spec_Index : Name_Id := No_Name;
541 -- The template for a pragma Source_File_Name(_Project) for a specific
542 -- file name of a spec in a multi-source file.
544 Config_Spec_Pattern : Name_Id := No_Name;
545 -- The template for a pragma Source_File_Name(_Project) for a naming
548 Config_File_Unique : Boolean := False;
549 -- Indicate if the config file specified to the compiler needs to be
550 -- unique. If it is unique, then all config files are concatenated into
551 -- a temp config file.
553 Binder_Driver : File_Name_Type := No_File;
554 -- The name of the binder driver for the language, if any
556 Binder_Driver_Path : Path_Name_Type := No_Path;
557 -- The path name of the binder driver
559 Binder_Required_Switches : Name_List_Index := No_Name_List;
560 -- Hold the value of attribute Binder'Required_Switches for the language
562 Binder_Prefix : Name_Id := No_Name;
563 -- Hold the value of attribute Binder'Prefix for the language
565 Toolchain_Version : Name_Id := No_Name;
566 -- Hold the value of attribute Toolchain_Version for the language
568 Toolchain_Description : Name_Id := No_Name;
569 -- Hold the value of attribute Toolchain_Description for the language
573 No_Language_Config : constant Language_Config :=
575 Naming_Data => No_Lang_Naming_Data,
576 Include_Compatible_Languages => No_Name_List,
577 Compiler_Driver => No_File,
578 Compiler_Driver_Path => null,
579 Compiler_Leading_Required_Switches => No_Name_List,
580 Compiler_Trailing_Required_Switches => No_Name_List,
581 Multi_Unit_Switches => No_Name_List,
582 Multi_Unit_Object_Separator => ' ',
583 Path_Syntax => Canonical,
584 Object_File_Suffix => No_Name,
585 Object_File_Switches => No_Name_List,
586 Compilation_PIC_Option => No_Name_List,
587 Object_Generated => True,
588 Objects_Linked => True,
589 Runtime_Library_Dir => No_Name,
590 Runtime_Source_Dir => No_Name,
591 Mapping_File_Switches => No_Name_List,
592 Mapping_Spec_Suffix => No_File,
593 Mapping_Body_Suffix => No_File,
594 Config_File_Switches => No_Name_List,
595 Dependency_Kind => None,
596 Dependency_Option => No_Name_List,
597 Compute_Dependency => No_Name_List,
598 Include_Option => No_Name_List,
599 Include_Path => No_Name,
600 Include_Path_File => No_Name,
601 Objects_Path => No_Name,
602 Objects_Path_File => No_Name,
603 Config_Body => No_Name,
604 Config_Body_Index => No_Name,
605 Config_Body_Pattern => No_Name,
606 Config_Spec => No_Name,
607 Config_Spec_Index => No_Name,
608 Config_Spec_Pattern => No_Name,
609 Config_File_Unique => False,
610 Binder_Driver => No_File,
611 Binder_Driver_Path => No_Path,
612 Binder_Required_Switches => No_Name_List,
613 Binder_Prefix => No_Name,
614 Toolchain_Version => No_Name,
615 Toolchain_Description => No_Name);
617 -- The following record ???
619 type Language_Data is record
620 Name : Name_Id := No_Name;
621 Display_Name : Name_Id := No_Name;
622 Config : Language_Config := No_Language_Config;
623 First_Source : Source_Id := No_Source;
624 Mapping_Files : Mapping_Files_Htable.Instance :=
625 Mapping_Files_Htable.Nil;
626 Next : Language_Ptr := No_Language_Index;
629 No_Language_Data : constant Language_Data :=
631 Display_Name => No_Name,
632 Config => No_Language_Config,
633 First_Source => No_Source,
634 Mapping_Files => Mapping_Files_Htable.Nil,
635 Next => No_Language_Index);
637 type Language_List_Element;
638 type Language_List is access all Language_List_Element;
639 type Language_List_Element is record
640 Language : Language_Ptr := No_Language_Index;
641 Next : Language_List;
644 type Source_Kind is (Spec, Impl, Sep);
645 subtype Spec_Or_Body is Source_Kind range Spec .. Impl;
647 -- The following declarations declare a structure used to store the Name
648 -- and File and Path names of a unit, with a reference to its GNAT Project
649 -- File(s). Some units might have neither Spec nor Impl when they were
650 -- created for a "separate".
652 type File_Names_Data is array (Spec_Or_Body) of Source_Id;
654 type Unit_Data is record
655 Name : Name_Id := No_Name;
656 File_Names : File_Names_Data;
659 type Unit_Index is access all Unit_Data;
661 No_Unit_Index : constant Unit_Index := null;
662 -- Used to indicate a null entry for no unit
664 -- Structure to define source data
666 type Source_Data is record
667 Project : Project_Id := No_Project;
668 -- Project of the source
670 Location : Source_Ptr := No_Location;
671 -- Location in the project file of the declaration of the source in
674 Source_Dir_Rank : Natural := 0;
675 -- The rank of the source directory in list declared with attribute
676 -- Source_Dirs. Two source files with the same name cannot appears in
677 -- different directory with the same rank. That can happen when the
678 -- recursive notation <dir>/** is used in attribute Source_Dirs.
680 Language : Language_Ptr := No_Language_Index;
681 -- Index of the language. This is an index into
682 -- Project_Tree.Languages_Data.
684 In_Interfaces : Boolean := True;
685 -- False when the source is not included in interfaces, when attribute
686 -- Interfaces is declared.
688 Declared_In_Interfaces : Boolean := False;
689 -- True when source is declared in attribute Interfaces
691 Alternate_Languages : Language_List := null;
692 -- List of languages a header file may also be, in addition of language
695 Kind : Source_Kind := Spec;
696 -- Kind of the source: spec, body or subunit
698 Unit : Unit_Index := No_Unit_Index;
699 -- Name of the unit, if language is unit based. This is only set for
700 -- those files that are part of the compilation set (for instance a
701 -- file in an extended project that is overridden will not have this
705 -- Index of the source in a multi unit source file (the same Source_Data
706 -- is duplicated several times when there are several units in the same
707 -- file). Index is 0 if there is either no unit or a single one, and
708 -- starts at 1 when there are multiple units
710 Locally_Removed : Boolean := False;
711 -- True if the source has been "excluded"
713 Replaced_By : Source_Id := No_Source;
714 -- Missing comment ???
716 File : File_Name_Type := No_File;
717 -- Canonical file name of the source
719 Display_File : File_Name_Type := No_File;
720 -- File name of the source, for display purposes
722 Path : Path_Information := No_Path_Information;
723 -- Path name of the source
725 Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
726 -- Time stamp of the source file
728 Object_Project : Project_Id := No_Project;
729 -- Project where the object file is. This might be different from
730 -- Project when using extending project files.
732 Object : File_Name_Type := No_File;
733 -- File name of the object file
735 Current_Object_Path : Path_Name_Type := No_Path;
736 -- Object path of an existing object file
738 Object_Path : Path_Name_Type := No_Path;
739 -- Object path of the real object file
741 Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
742 -- Object file time stamp
744 Dep_Name : File_Name_Type := No_File;
745 -- Dependency file simple name
747 Current_Dep_Path : Path_Name_Type := No_Path;
748 -- Path name of an existing dependency file
750 Dep_Path : Path_Name_Type := No_Path;
751 -- Path name of the real dependency file
753 Dep_TS : aliased Osint.File_Attributes := Osint.Unknown_Attributes;
754 -- Dependency file time stamp
756 Switches : File_Name_Type := No_File;
757 -- File name of the switches file. For all languages, this is a file
758 -- that ends with the .cswi extension.
760 Switches_Path : Path_Name_Type := No_Path;
761 -- Path name of the switches file
763 Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
764 -- Switches file time stamp
766 Naming_Exception : Boolean := False;
767 -- True if the source has an exceptional name
769 Next_In_Lang : Source_Id := No_Source;
770 -- Link to another source of the same language in the same project
773 No_Source_Data : constant Source_Data :=
774 (Project => No_Project,
775 Location => No_Location,
776 Source_Dir_Rank => 0,
777 Language => No_Language_Index,
778 In_Interfaces => True,
779 Declared_In_Interfaces => False,
780 Alternate_Languages => null,
782 Unit => No_Unit_Index,
784 Locally_Removed => False,
785 Replaced_By => No_Source,
787 Display_File => No_File,
788 Path => No_Path_Information,
789 Source_TS => Empty_Time_Stamp,
790 Object_Project => No_Project,
792 Current_Object_Path => No_Path,
793 Object_Path => No_Path,
794 Object_TS => Empty_Time_Stamp,
796 Current_Dep_Path => No_Path,
798 Dep_TS => Osint.Unknown_Attributes,
800 Switches_Path => No_Path,
801 Switches_TS => Empty_Time_Stamp,
802 Naming_Exception => False,
803 Next_In_Lang => No_Source);
805 package Source_Paths_Htable is new Simple_HTable
806 (Header_Num => Header_Num,
807 Element => Source_Id,
808 No_Element => No_Source,
809 Key => Path_Name_Type,
812 -- Mapping of source paths to source ids
814 package Unit_Sources_Htable is new Simple_HTable
815 (Header_Num => Header_Num,
816 Element => Source_Id,
817 No_Element => No_Source,
822 type Verbosity is (Default, Medium, High);
823 -- Verbosity when parsing GNAT Project Files
824 -- Default is default (very quiet, if no errors).
825 -- Medium is more verbose.
826 -- High is extremely verbose.
828 Current_Verbosity : Verbosity := Default;
829 -- The current value of the verbosity the project files are parsed with
831 type Lib_Kind is (Static, Dynamic, Relocatable);
833 type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
834 -- Type to specify the symbol policy, when symbol control is supported.
835 -- See full explanation about this type in package Symbols.
836 -- Autonomous: Create a symbol file without considering any reference
837 -- Compliant: Try to be as compatible as possible with an existing ref
838 -- Controlled: Fail if symbols are not the same as those in the reference
839 -- Restricted: Restrict the symbols to those in the symbol file
840 -- Direct: The symbol file is used as is
842 type Symbol_Record is record
843 Symbol_File : Path_Name_Type := No_Path;
844 Reference : Path_Name_Type := No_Path;
845 Symbol_Policy : Policy := Autonomous;
847 -- Type to keep the symbol data to be used when building a shared library
849 No_Symbols : constant Symbol_Record :=
850 (Symbol_File => No_Path,
851 Reference => No_Path,
852 Symbol_Policy => Autonomous);
853 -- The default value of the symbol data
855 function Image (The_Casing : Casing_Type) return String;
856 -- Similar to 'Image (but avoid use of this attribute in compiler)
858 function Value (Image : String) return Casing_Type;
859 -- Similar to 'Value (but avoid use of this attribute in compiler)
860 -- Raises Constraint_Error if not a Casing_Type image.
862 -- The following record contains data for a naming scheme
864 function Get_Object_Directory
865 (Project : Project_Id;
866 Including_Libraries : Boolean;
867 Only_If_Ada : Boolean := False) return Path_Name_Type;
868 -- Return the object directory to use for the project. This depends on
869 -- whether we have a library project or a standard project. This function
870 -- might return No_Name when no directory applies.
871 -- If we have a a library project file and Including_Libraries is True then
872 -- the library dir is returned instead of the object dir.
873 -- If Only_If_Ada is True, then No_Name will be returned when the project
874 -- doesn't Ada sources.
876 procedure Compute_All_Imported_Projects (Tree : Project_Tree_Ref);
877 -- For all projects in the tree, compute the list of the projects imported
878 -- directly or indirectly by project Project. The result is stored in
879 -- Project.All_Imported_Projects for each project
881 function Ultimate_Extending_Project_Of
882 (Proj : Project_Id) return Project_Id;
883 -- Returns the ultimate extending project of project Proj. If project Proj
884 -- is not extended, returns Proj.
886 type Project_List_Element;
887 type Project_List is access all Project_List_Element;
888 type Project_List_Element is record
889 Project : Project_Id := No_Project;
890 Next : Project_List := null;
892 -- A list of projects
895 (List : in out Project_List;
896 Free_Project : Boolean);
897 -- Free the list of projects, if Free_Project, each project is also freed
899 type Response_File_Format is
905 -- The format of the different response files
907 type Project_Configuration is record
908 Target : Name_Id := No_Name;
909 -- The target of the configuration, when specified
911 Run_Path_Option : Name_List_Index := No_Name_List;
912 -- The option to use when linking to specify the path where to look for
915 Run_Path_Origin : Name_Id := No_Name;
916 -- Specify the string (such as "$ORIGIN") to indicate paths relative to
917 -- the directory of the executable in the run path option.
919 Library_Install_Name_Option : Name_Id := No_Name;
920 -- When this is not an empty list, this option, followed by the single
921 -- name of the shared library file is used when linking a shared
924 Separate_Run_Path_Options : Boolean := False;
925 -- True if each directory needs to be specified in a separate run path
928 Executable_Suffix : Name_Id := No_Name;
929 -- The suffix of executables, when specified in the configuration or in
930 -- package Builder of the main project. When this is not specified, the
931 -- executable suffix is the default for the platform.
935 Linker : Path_Name_Type := No_Path;
936 -- Path name of the linker driver. Specified in the configuration or in
937 -- the package Builder of the main project.
939 Map_File_Option : Name_Id := No_Name;
940 -- Option to use when invoking the linker to build a map file
942 Minimum_Linker_Options : Name_List_Index := No_Name_List;
943 -- The minimum options for the linker driver. Specified in the
946 Linker_Executable_Option : Name_List_Index := No_Name_List;
947 -- The option(s) to indicate the name of the executable in the linker
948 -- command. Specified in the configuration. When not specified, default
949 -- to -o <executable name>.
951 Linker_Lib_Dir_Option : Name_Id := No_Name;
952 -- The option to specify where to find a library for linking. Specified
953 -- in the configuration. When not specified, defaults to "-L".
955 Linker_Lib_Name_Option : Name_Id := No_Name;
956 -- The option to specify the name of a library for linking. Specified in
957 -- the configuration. When not specified, defaults to "-l".
959 Max_Command_Line_Length : Natural := 0;
960 -- When positive and when Resp_File_Format (see below) is not None,
961 -- if the command line for the invocation of the linker would be greater
962 -- than this value, a response file is used to invoke the linker.
964 Resp_File_Format : Response_File_Format := None;
965 -- The format of a response file, when linking with a response file is
968 Resp_File_Options : Name_List_Index := No_Name_List;
969 -- The switches, if any, that precede the path name of the response
970 -- file in the invocation of the linker.
974 Library_Builder : Path_Name_Type := No_Path;
975 -- The executable to build library (specified in the configuration)
977 Lib_Support : Library_Support := None;
978 -- The level of library support. Specified in the configuration. Support
979 -- is none, static libraries only or both static and shared libraries.
981 Archive_Builder : Name_List_Index := No_Name_List;
982 -- The name of the executable to build archives, with the minimum
983 -- switches. Specified in the configuration.
985 Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
986 -- The options to append object files to an archive
988 Archive_Indexer : Name_List_Index := No_Name_List;
989 -- The name of the executable to index archives, with the minimum
990 -- switches. Specified in the configuration.
992 Archive_Suffix : File_Name_Type := No_File;
993 -- The suffix of archives. Specified in the configuration. When not
994 -- specified, defaults to ".a".
996 Lib_Partial_Linker : Name_List_Index := No_Name_List;
1000 Shared_Lib_Driver : File_Name_Type := No_File;
1001 -- The driver to link shared libraries. Set with attribute Library_GCC.
1004 Shared_Lib_Prefix : File_Name_Type := No_File;
1005 -- Part of a shared library file name that precedes the name of the
1006 -- library. Specified in the configuration. When not specified, defaults
1009 Shared_Lib_Suffix : File_Name_Type := No_File;
1010 -- Suffix of shared libraries, after the library name in the shared
1011 -- library name. Specified in the configuration. When not specified,
1012 -- default to ".so".
1014 Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
1015 -- The minimum options to use when building a shared library
1017 Lib_Version_Options : Name_List_Index := No_Name_List;
1018 -- The options to use to specify a library version
1020 Symbolic_Link_Supported : Boolean := False;
1021 -- True if the platform supports symbolic link files
1023 Lib_Maj_Min_Id_Supported : Boolean := False;
1024 -- True if platform supports library major and minor options, such as
1025 -- libname.so -> libname.so.2 -> libname.so.2.4
1027 Auto_Init_Supported : Boolean := False;
1028 -- True if automatic initialisation is supported for shared stand-alone
1032 Default_Project_Config : constant Project_Configuration :=
1034 Run_Path_Option => No_Name_List,
1035 Run_Path_Origin => No_Name,
1036 Library_Install_Name_Option => No_Name,
1037 Separate_Run_Path_Options => False,
1038 Executable_Suffix => No_Name,
1040 Map_File_Option => No_Name,
1041 Minimum_Linker_Options => No_Name_List,
1042 Linker_Executable_Option => No_Name_List,
1043 Linker_Lib_Dir_Option => No_Name,
1044 Linker_Lib_Name_Option => No_Name,
1045 Library_Builder => No_Path,
1046 Max_Command_Line_Length => 0,
1047 Resp_File_Format => None,
1048 Resp_File_Options => No_Name_List,
1049 Lib_Support => None,
1050 Archive_Builder => No_Name_List,
1051 Archive_Builder_Append_Option => No_Name_List,
1052 Archive_Indexer => No_Name_List,
1053 Archive_Suffix => No_File,
1054 Lib_Partial_Linker => No_Name_List,
1055 Shared_Lib_Driver => No_File,
1056 Shared_Lib_Prefix => No_File,
1057 Shared_Lib_Suffix => No_File,
1058 Shared_Lib_Min_Options => No_Name_List,
1059 Lib_Version_Options => No_Name_List,
1060 Symbolic_Link_Supported => False,
1061 Lib_Maj_Min_Id_Supported => False,
1062 Auto_Init_Supported => False);
1064 -- The following record describes a project file representation
1066 -- Note that it is not specified if the path names of directories (source,
1067 -- object, library or exec directories) end with or without a directory
1070 type Project_Data is record
1076 Name : Name_Id := No_Name;
1077 -- The name of the project
1079 Display_Name : Name_Id := No_Name;
1080 -- The name of the project with the spelling of its declaration
1082 Qualifier : Project_Qualifier := Unspecified;
1083 -- The eventual qualifier for this project
1085 Externally_Built : Boolean := False;
1086 -- True if the project is externally built. In such case, the Project
1087 -- Manager will not modify anything in this project.
1089 Config : Project_Configuration;
1091 Path : Path_Information := No_Path_Information;
1092 -- The path name of the project file. This include base name of the
1095 Virtual : Boolean := False;
1096 -- True for virtual extending projects
1098 Location : Source_Ptr := No_Location;
1099 -- The location in the project file source of the reserved word project
1105 Languages : Language_Ptr := No_Language_Index;
1106 -- First index of the language data in the project.
1107 -- This is an index into the project_tree_data.languages_data.
1108 -- Traversing the list gives access to all the languages supported by
1115 Mains : String_List_Id := Nil_String;
1116 -- List of mains specified by attribute Main
1118 Extends : Project_Id := No_Project;
1119 -- The reference of the project file, if any, that this project file
1122 Extended_By : Project_Id := No_Project;
1123 -- The reference of the project file, if any, that extends this project
1126 Decl : Declarations := No_Declarations;
1127 -- The declarations (variables, attributes and packages) of this project
1130 Imported_Projects : Project_List;
1131 -- The list of all directly imported projects, if any
1133 All_Imported_Projects : Project_List;
1134 -- The list of all projects imported directly or indirectly, if any.
1135 -- This does not include the project itself.
1141 Directory : Path_Information := No_Path_Information;
1142 -- Path name of the directory where the project file resides
1144 Object_Directory : Path_Information := No_Path_Information;
1145 -- The path name of the object directory of this project file
1147 Exec_Directory : Path_Information := No_Path_Information;
1148 -- The path name of the exec directory of this project file. Default is
1149 -- equal to Object_Directory.
1155 Library : Boolean := False;
1156 -- True if this is a library project
1158 Library_Name : Name_Id := No_Name;
1159 -- If a library project, name of the library
1161 Library_Kind : Lib_Kind := Static;
1162 -- If a library project, kind of library
1164 Library_Dir : Path_Information := No_Path_Information;
1165 -- If a library project, path name of the directory where the library
1168 Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
1169 -- The timestamp of a library file in a library project
1171 Library_Src_Dir : Path_Information := No_Path_Information;
1172 -- If a Stand-Alone Library project, path name of the directory where
1173 -- the sources of the interfaces of the library are copied. By default,
1174 -- if attribute Library_Src_Dir is not specified, sources of the
1175 -- interfaces are not copied anywhere.
1177 Library_ALI_Dir : Path_Information := No_Path_Information;
1178 -- In a library project, path name of the directory where the ALI files
1179 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1180 -- are copied in the Library_Dir.
1182 Lib_Internal_Name : Name_Id := No_Name;
1183 -- If a library project, internal name store inside the library
1185 Standalone_Library : Boolean := False;
1186 -- Indicate that this is a Standalone Library Project File
1188 Lib_Interface_ALIs : String_List_Id := Nil_String;
1189 -- For Standalone Library Project Files, indicate the list of Interface
1192 Lib_Auto_Init : Boolean := False;
1193 -- For non static Stand-Alone Library Project Files, indicate if
1194 -- the library initialisation should be automatic.
1196 Symbol_Data : Symbol_Record := No_Symbols;
1197 -- Symbol file name, reference symbol file name, symbol policy
1199 Need_To_Build_Lib : Boolean := False;
1200 -- Indicates that the library of a Library Project needs to be built or
1206 -- The sources for all languages including Ada are accessible through
1207 -- the Source_Iterator type
1209 Interfaces_Defined : Boolean := False;
1210 -- True if attribute Interfaces is declared for the project or any
1211 -- project it extends.
1213 Include_Path_File : Path_Name_Type := No_Path;
1214 -- The path name of the of the source search directory file.
1215 -- This is only used by gnatmake
1217 Source_Dirs : String_List_Id := Nil_String;
1218 -- The list of all the source directories
1220 Source_Dir_Ranks : Number_List_Index := No_Number_List;
1222 Ada_Include_Path : String_Access := null;
1223 -- The cached value of source search path for this project file. Set by
1224 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1225 -- use this field directly outside of the project manager, use
1226 -- Prj.Env.Ada_Include_Path instead.
1228 Has_Multi_Unit_Sources : Boolean := False;
1229 -- Whether there is at least one source file containing multiple units
1235 Ada_Objects_Path : String_Access := null;
1236 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1237 -- use this field directly outside of the compiler, use
1238 -- Prj.Env.Ada_Objects_Path instead.
1240 Libgnarl_Needed : Yes_No_Unknown := Unknown;
1241 -- Set to True when libgnarl is needed to link
1243 Objects_Path : String_Access := null;
1244 -- The cached value of the object dir path, used during the binding
1245 -- phase of gprbuild.
1247 Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
1248 -- The cached value of the object path temp file (including library
1249 -- dirs) for this project file.
1251 Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
1252 -- The cached value of the object path temp file (excluding library
1253 -- dirs) for this project file.
1255 Config_File_Name : Path_Name_Type := No_Path;
1256 -- The path name of the configuration pragmas file, if any
1258 Config_File_Temp : Boolean := False;
1259 -- An indication that the configuration pragmas file is a temporary file
1260 -- that must be deleted at the end.
1262 Config_Checked : Boolean := False;
1263 -- A flag to avoid checking repetitively the configuration pragmas file
1265 Depth : Natural := 0;
1266 -- The maximum depth of a project in the project graph. Depth of main
1269 Unkept_Comments : Boolean := False;
1270 -- True if there are comments in the project sources that cannot be kept
1271 -- in the project tree.
1275 function Empty_Project return Project_Data;
1276 -- Return the representation of an empty project
1278 function Is_Extending
1279 (Extending : Project_Id;
1280 Extended : Project_Id) return Boolean;
1281 -- Return True if Extending is extending the Extended project
1283 function Has_Ada_Sources (Data : Project_Id) return Boolean;
1284 -- Return True if the project has Ada sources
1286 Project_Error : exception;
1287 -- Raised by some subprograms in Prj.Attr
1289 package Units_Htable is new Simple_HTable
1290 (Header_Num => Header_Num,
1291 Element => Unit_Index,
1292 No_Element => No_Unit_Index,
1296 -- Mapping of unit names to indexes in the Units table
1298 ---------------------
1299 -- Source_Iterator --
1300 ---------------------
1302 type Source_Iterator is private;
1304 function For_Each_Source
1305 (In_Tree : Project_Tree_Ref;
1306 Project : Project_Id := No_Project;
1307 Language : Name_Id := No_Name) return Source_Iterator;
1308 -- Returns an iterator for all the sources of a project tree, or a specific
1309 -- project, or a specific language.
1311 function Element (Iter : Source_Iterator) return Source_Id;
1312 -- Return the current source (or No_Source if there are no more sources)
1314 procedure Next (Iter : in out Source_Iterator);
1315 -- Move on to the next source
1317 function Find_Source
1318 (In_Tree : Project_Tree_Ref;
1319 Project : Project_Id;
1320 In_Imported_Only : Boolean := False;
1321 In_Extended_Only : Boolean := False;
1322 Base_Name : File_Name_Type) return Source_Id;
1323 -- Find the first source file with the given name either in the whole tree
1324 -- (if In_Imported_Only is False) or in the projects imported or extended
1325 -- by Project otherwise. In_Extended_Only implies In_Imported_Only, and
1326 -- will only look in Project and the projects it extends
1328 -----------------------
1329 -- Project_Tree_Data --
1330 -----------------------
1332 type Private_Project_Tree_Data is private;
1333 -- Data for a project tree that is used only by the Project Manager
1335 type Project_Tree_Data is
1337 Name_Lists : Name_List_Table.Instance;
1338 Number_Lists : Number_List_Table.Instance;
1339 String_Elements : String_Element_Table.Instance;
1340 Variable_Elements : Variable_Element_Table.Instance;
1341 Array_Elements : Array_Element_Table.Instance;
1342 Arrays : Array_Table.Instance;
1343 Packages : Package_Table.Instance;
1344 Projects : Project_List;
1346 Units_HT : Units_Htable.Instance;
1347 -- Unit name to Unit_Index (and from there so Source_Id)
1349 Source_Paths_HT : Source_Paths_Htable.Instance;
1350 -- Full path to Source_Id
1352 Private_Part : Private_Project_Tree_Data;
1354 -- Data for a project tree
1356 procedure Expect (The_Token : Token_Type; Token_Image : String);
1357 -- Check that the current token is The_Token. If it is not, then output
1358 -- an error message.
1360 procedure Initialize (Tree : Project_Tree_Ref);
1361 -- This procedure must be called before using any services from the Prj
1362 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1364 procedure Reset (Tree : Project_Tree_Ref);
1365 -- This procedure resets all the tables that are used when processing a
1366 -- project file tree. Initialize must be called before the call to Reset.
1368 package Project_Boolean_Htable is new Simple_HTable
1369 (Header_Num => Header_Num,
1371 No_Element => False,
1375 -- A table that associates a project to a boolean. This is used to detect
1376 -- whether a project was already processed for instance.
1379 type State is limited private;
1380 with procedure Action
1381 (Project : Project_Id;
1382 With_State : in out State);
1383 procedure For_Every_Project_Imported
1385 With_State : in out State;
1386 Imported_First : Boolean := False);
1387 -- Call Action for each project imported directly or indirectly by project
1388 -- By, as well as extended projects.
1389 -- The order of processing depends on Imported_First:
1390 -- If False, Action is called according to the order of importation: if A
1391 -- imports B, directly or indirectly, Action will be called for A before
1392 -- it is called for B. If two projects import each other directly or
1393 -- indirectly (using at least one "limited with"), it is not specified
1394 -- for which of these two projects Action will be called first.
1395 -- The order is reversed if Imported_First is True.
1396 -- With_State may be used by Action to choose a behavior or to report some
1399 function Extend_Name
1400 (File : File_Name_Type;
1401 With_Suffix : String) return File_Name_Type;
1402 -- Replace the extension of File with With_Suffix
1404 function Object_Name
1405 (Source_File_Name : File_Name_Type;
1406 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1407 -- Returns the object file name corresponding to a source file name
1409 function Object_Name
1410 (Source_File_Name : File_Name_Type;
1412 Index_Separator : Character;
1413 Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
1414 -- Returns the object file name corresponding to a unit in a multi-source
1417 function Dependency_Name
1418 (Source_File_Name : File_Name_Type;
1419 Dependency : Dependency_File_Kind) return File_Name_Type;
1420 -- Returns the dependency file name corresponding to a source file name
1422 function Switches_Name
1423 (Source_File_Name : File_Name_Type) return File_Name_Type;
1424 -- Returns the switches file name corresponding to a source file name
1430 type Processing_Flags is private;
1431 -- Flags used while parsing and processing a project tree to configure the
1432 -- behavior of the parser, and indicate how to report error messages. This
1433 -- structure does not allocate memory and never needs to be freed
1435 type Error_Warning is (Silent, Warning, Error);
1436 -- Severity of some situations, such as: no Ada sources in a project where
1437 -- Ada is one of the language.
1439 -- When the situation occurs, the behaviour depends on the setting:
1441 -- - Silent: no action
1442 -- - Warning: issue a warning, does not cause the tool to fail
1443 -- - Error: issue an error, causes the tool to fail
1445 type Error_Handler is access procedure
1446 (Project : Project_Id;
1447 Is_Warning : Boolean);
1448 -- This warngs when an error was found when parsing a project. The error
1449 -- itself is handled through Prj.Err (and Prj.Err.Finalize should be called
1450 -- to actually print the error). This ensures that duplicate error messages
1451 -- are always correctly removed, that errors msgs are sorted, and that all
1452 -- tools will report the same error to the user.
1454 function Create_Flags
1455 (Report_Error : Error_Handler;
1456 When_No_Sources : Error_Warning;
1457 Require_Sources_Other_Lang : Boolean := True;
1458 Allow_Duplicate_Basenames : Boolean := True;
1459 Compiler_Driver_Mandatory : Boolean := False;
1460 Error_On_Unknown_Language : Boolean := True;
1461 Require_Obj_Dirs : Error_Warning := Error;
1462 Allow_Invalid_External : Error_Warning := Error)
1463 return Processing_Flags;
1464 -- Function used to create Processing_Flags structure
1466 -- If Allow_Duplicate_Basenames, then files with the same base names are
1467 -- authorized within a project for source-based languages (never for unit
1468 -- based languages).
1470 -- If Compiler_Driver_Mandatory is true, then a Compiler.Driver attribute
1471 -- for each language must be defined, or we will not look for its source
1474 -- When_No_Sources indicates what should be done when no sources of a
1475 -- language are found in a project where this language is declared.
1476 -- If Require_Sources_Other_Lang is true, then all languages must have at
1477 -- least one source file, or an error is reported via When_No_Sources. If
1478 -- it is false, this is only required for Ada (and only if it is a language
1479 -- of the project). When this parameter is set to False, we do not check
1480 -- that a proper naming scheme is defined for languages other than Ada.
1482 -- If Report_Error is null, use the standard error reporting mechanism
1483 -- (Errout). Otherwise, report errors using Report_Error.
1485 -- If Error_On_Unknown_Language is true, an error is displayed if some of
1486 -- the source files listed in the project do not match any naming scheme
1488 -- If Require_Obj_Dirs is true, then all object directories must exist
1489 -- (possibly after they have been created automatically if the appropriate
1490 -- switches were specified), or an error is raised.
1492 -- If Allow_Invalid_External is Silent, then no error is reported when an
1493 -- invalid value is used for an external variable (and it doesn't match its
1494 -- type). Instead, the first possible value is used.
1496 Gprbuild_Flags : constant Processing_Flags;
1497 Gprclean_Flags : constant Processing_Flags;
1498 Gnatmake_Flags : constant Processing_Flags;
1499 -- Flags used by the various tools. They all display the error messages
1506 procedure Record_Temp_File
1507 (Tree : Project_Tree_Ref;
1508 Path : Path_Name_Type);
1509 -- Record the path of a newly created temporary file, so that it can be
1512 procedure Delete_All_Temp_Files (Tree : Project_Tree_Ref);
1513 -- Delete all recorded temporary files.
1514 -- Does nothing if Debug.Debug_Flag_N is set
1516 procedure Delete_Temporary_File
1517 (Tree : Project_Tree_Ref;
1518 Path : Path_Name_Type);
1519 -- Delete a temporary file from the disk. The file is also removed from the
1520 -- list of temporary files to delete at the end of the program, in case
1521 -- another program running on the same machine has recreated it.
1522 -- Does nothing if Debug.Debug_Flag_N is set
1526 All_Packages : constant String_List_Access := null;
1528 No_Project_Tree : constant Project_Tree_Ref := null;
1530 Ignored : constant Variable_Kind := Single;
1532 Nil_Variable_Value : constant Variable_Value :=
1533 (Project => No_Project,
1535 Location => No_Location,
1538 Virtual_Prefix : constant String := "v$";
1539 -- The prefix for virtual extending projects. Because of the '$', which is
1540 -- normally forbidden for project names, there cannot be any name clash.
1542 type Source_Iterator is record
1543 In_Tree : Project_Tree_Ref;
1545 Project : Project_List;
1546 All_Projects : Boolean;
1547 -- Current project and whether we should move on to the next
1549 Language : Language_Ptr;
1550 -- Current language processed
1552 Language_Name : Name_Id;
1553 -- Only sources of this language will be returned (or all if No_Name)
1555 Current : Source_Id;
1558 procedure Add_To_Buffer
1560 To : in out String_Access;
1561 Last : in out Natural);
1562 -- Append a String to the Buffer
1564 package Temp_Files_Table is new GNAT.Dynamic_Tables
1565 (Table_Component_Type => Path_Name_Type,
1566 Table_Index_Type => Integer,
1567 Table_Low_Bound => 1,
1568 Table_Initial => 10,
1569 Table_Increment => 10);
1570 -- Table to store the path name of all the created temporary files, so that
1571 -- they can be deleted at the end, or when the program is interrupted.
1573 type Private_Project_Tree_Data is record
1574 Temp_Files : Temp_Files_Table.Instance;
1575 -- Temporary files created as part of running tools (pragma files,
1576 -- mapping files,...)
1578 Current_Source_Path_File : Path_Name_Type := No_Path;
1579 -- Current value of project source path file env var. Used to avoid
1580 -- setting the env var to the same value. When different from No_Path,
1581 -- this indicates that logical names (VMS) or environment variables were
1582 -- created and should be deassigned to avoid polluting the environment
1586 Current_Object_Path_File : Path_Name_Type := No_Path;
1587 -- Current value of project object path file env var. Used to avoid
1588 -- setting the env var to the same value.
1592 -- Type to represent the part of a project tree which is private to the
1595 type Processing_Flags is record
1596 Require_Sources_Other_Lang : Boolean;
1597 Report_Error : Error_Handler;
1598 When_No_Sources : Error_Warning;
1599 Allow_Duplicate_Basenames : Boolean;
1600 Compiler_Driver_Mandatory : Boolean;
1601 Error_On_Unknown_Language : Boolean;
1602 Require_Obj_Dirs : Error_Warning;
1603 Allow_Invalid_External : Error_Warning;
1606 Gprbuild_Flags : constant Processing_Flags :=
1607 (Report_Error => null,
1608 When_No_Sources => Warning,
1609 Require_Sources_Other_Lang => True,
1610 Allow_Duplicate_Basenames => False,
1611 Compiler_Driver_Mandatory => True,
1612 Error_On_Unknown_Language => True,
1613 Require_Obj_Dirs => Error,
1614 Allow_Invalid_External => Error);
1616 Gprclean_Flags : constant Processing_Flags :=
1617 (Report_Error => null,
1618 When_No_Sources => Warning,
1619 Require_Sources_Other_Lang => True,
1620 Allow_Duplicate_Basenames => False,
1621 Compiler_Driver_Mandatory => True,
1622 Error_On_Unknown_Language => True,
1623 Require_Obj_Dirs => Warning,
1624 Allow_Invalid_External => Error);
1626 Gnatmake_Flags : constant Processing_Flags :=
1627 (Report_Error => null,
1628 When_No_Sources => Error,
1629 Require_Sources_Other_Lang => False,
1630 Allow_Duplicate_Basenames => False,
1631 Compiler_Driver_Mandatory => False,
1632 Error_On_Unknown_Language => False,
1633 Require_Obj_Dirs => Error,
1634 Allow_Invalid_External => Error);
OSDN Git Service
