1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2008, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- The following package declares the data types for GNAT project.
27 -- These data types may be used by GNAT Project-aware tools.
29 -- Children of these package implements various services on these data types.
30 -- See in particular Prj.Pars and Prj.Env.
32 with Casing
; use Casing
;
33 with Namet
; use Namet
;
34 with Scans
; use Scans
;
35 with Types
; use Types
;
37 with GNAT
.Dynamic_HTables
; use GNAT
.Dynamic_HTables
;
38 with GNAT
.Dynamic_Tables
;
39 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
43 All_Other_Names
: constant Name_Id
:= Names_High_Bound
;
44 -- Name used to replace others as an index of an associative array
45 -- attribute in situations where this is allowed.
47 Subdirs_Option
: constant String := "--subdirs=";
48 -- Switch used to indicate that the real directories (object, exec,
49 -- library, ...) are subdirectories of those in the project file.
51 Subdirs
: String_Ptr
:= null;
52 -- The value after the equal sign in switch --subdirs=...
53 -- Contains the relative subdirectory.
55 type Library_Support
is (None
, Static_Only
, Full
);
56 -- Support for Library Project File.
57 -- - None: Library Project Files are not supported at all
58 -- - Static_Only: Library Project Files are only supported for static
60 -- - Full: Library Project Files are supported for static and dynamic
61 -- (shared) libraries.
63 type Yes_No_Unknown
is (Yes
, No
, Unknown
);
64 -- Tri-state to decide if -lgnarl is needed when linking
66 type Mode
is (Multi_Language
, Ada_Only
);
67 -- Ada_Only: mode for gnatmake, gnatclean, gnatname, the GNAT driver
68 -- Multi_Language: mode for gprbuild, gprclean
70 type Project_Qualifier
is
77 -- Qualifiers that can prefix the reserved word "project" in a project
79 -- Standard: standard project ...
80 -- Library: library project is ...
81 -- Dry: abstract project is
82 -- Aggregate: aggregate project is
83 -- Aggregate_Library: aggregate library project is ...
85 function Get_Mode
return Mode
;
86 pragma Inline
(Get_Mode
);
88 procedure Set_Mode
(New_Mode
: Mode
);
89 pragma Inline
(Set_Mode
);
91 Default_Language_Is_Ada
: Boolean := True;
92 -- If no language was defined in the project or the configuration file, it
93 -- is an error, unless this variable is True, in which case it defaults to
94 -- Ada. Calling Set_Mode will reset this variable, default is for Ada_Only.
96 Must_Check_Configuration
: Boolean := False;
97 -- True when the contents of the configuration file must be checked. This
98 -- is in general only needed by gprbuild itself, since other applications
99 -- can ignore such errors when they don't need to build directly. Calling
100 -- Set_Mode will reset this variable, default is for Ada_Only.
102 function In_Configuration
return Boolean;
103 pragma Inline
(In_Configuration
);
105 procedure Set_In_Configuration
(Value
: Boolean);
106 pragma Inline
(Set_In_Configuration
);
108 All_Packages
: constant String_List_Access
;
109 -- Default value of parameter Packages of procedures Parse, in Prj.Pars and
110 -- Prj.Part, indicating that all packages should be checked.
112 type Project_Tree_Data
;
113 type Project_Tree_Ref
is access all Project_Tree_Data
;
114 -- Reference to a project tree. Several project trees may exist in memory
117 No_Project_Tree
: constant Project_Tree_Ref
;
119 function Default_Ada_Spec_Suffix
return File_Name_Type
;
120 pragma Inline
(Default_Ada_Spec_Suffix
);
121 -- The name for the standard GNAT suffix for Ada spec source file name
122 -- ".ads". Initialized by Prj.Initialize.
124 function Default_Ada_Body_Suffix
return File_Name_Type
;
125 pragma Inline
(Default_Ada_Body_Suffix
);
126 -- The name for the standard GNAT suffix for Ada body source file name
127 -- ".adb". Initialized by Prj.Initialize.
129 function Slash
return Path_Name_Type
;
130 pragma Inline
(Slash
);
131 -- "/", used as the path of locally removed files
133 Config_Project_File_Extension
: String := ".cgpr";
134 Project_File_Extension
: String := ".gpr";
135 -- The standard config and user project file name extensions. They are not
136 -- constants, because Canonical_Case_File_Name is called on these variables
137 -- in the body of Prj.
139 type Error_Warning
is (Silent
, Warning
, Error
);
140 -- Severity of some situations, such as: no Ada sources in a project where
141 -- Ada is one of the language.
143 -- When the situation occurs, the behaviour depends on the setting:
145 -- - Silent: no action
146 -- - Warning: issue a warning, does not cause the tool to fail
147 -- - Error: issue an error, causes the tool to fail
149 function Empty_File
return File_Name_Type
;
150 function Empty_String
return Name_Id
;
151 -- Return the id for an empty string ""
153 type Path_Information
is record
154 Name
: Path_Name_Type
:= No_Path
;
155 Display_Name
: Path_Name_Type
:= No_Path
;
158 No_Path_Information
: constant Path_Information
:= (No_Path
, No_Path
);
160 type Project_Id
is new Nat
;
161 No_Project
: constant Project_Id
:= 0;
162 -- Id of a Project File
164 type String_List_Id
is new Nat
;
165 Nil_String
: constant String_List_Id
:= 0;
166 type String_Element
is record
167 Value
: Name_Id
:= No_Name
;
169 Display_Value
: Name_Id
:= No_Name
;
170 Location
: Source_Ptr
:= No_Location
;
171 Flag
: Boolean := False;
172 Next
: String_List_Id
:= Nil_String
;
174 -- To hold values for string list variables and array elements.
175 -- Component Flag may be used for various purposes. For source
176 -- directories, it indicates if the directory contains Ada source(s).
178 package String_Element_Table
is new GNAT
.Dynamic_Tables
179 (Table_Component_Type
=> String_Element
,
180 Table_Index_Type
=> String_List_Id
,
181 Table_Low_Bound
=> 1,
182 Table_Initial
=> 200,
183 Table_Increment
=> 100);
184 -- The table for string elements in string lists
186 type Variable_Kind
is (Undefined
, List
, Single
);
187 -- Different kinds of variables
189 subtype Defined_Variable_Kind
is Variable_Kind
range List
.. Single
;
190 -- The defined kinds of variables
192 Ignored
: constant Variable_Kind
;
193 -- Used to indicate that a package declaration must be ignored
194 -- while processing the project tree (unknown package name).
196 type Variable_Value
(Kind
: Variable_Kind
:= Undefined
) is record
197 Project
: Project_Id
:= No_Project
;
198 Location
: Source_Ptr
:= No_Location
;
199 Default
: Boolean := False;
204 Values
: String_List_Id
:= Nil_String
;
206 Value
: Name_Id
:= No_Name
;
210 -- Values for variables and array elements. Default is True if the
211 -- current value is the default one for the variable
213 Nil_Variable_Value
: constant Variable_Value
;
214 -- Value of a non existing variable or array element
216 type Variable_Id
is new Nat
;
217 No_Variable
: constant Variable_Id
:= 0;
218 type Variable
is record
219 Next
: Variable_Id
:= No_Variable
;
221 Value
: Variable_Value
;
223 -- To hold the list of variables in a project file and in packages
225 package Variable_Element_Table
is new GNAT
.Dynamic_Tables
226 (Table_Component_Type
=> Variable
,
227 Table_Index_Type
=> Variable_Id
,
228 Table_Low_Bound
=> 1,
229 Table_Initial
=> 200,
230 Table_Increment
=> 100);
231 -- The table of variable in list of variables
233 type Array_Element_Id
is new Nat
;
234 No_Array_Element
: constant Array_Element_Id
:= 0;
235 type Array_Element
is record
237 Src_Index
: Int
:= 0;
238 Index_Case_Sensitive
: Boolean := True;
239 Value
: Variable_Value
;
240 Next
: Array_Element_Id
:= No_Array_Element
;
242 -- Each Array_Element represents an array element and is linked (Next)
243 -- to the next array element, if any, in the array.
245 package Array_Element_Table
is new GNAT
.Dynamic_Tables
246 (Table_Component_Type
=> Array_Element
,
247 Table_Index_Type
=> Array_Element_Id
,
248 Table_Low_Bound
=> 1,
249 Table_Initial
=> 200,
250 Table_Increment
=> 100);
251 -- The table that contains all array elements
253 type Array_Id
is new Nat
;
254 No_Array
: constant Array_Id
:= 0;
255 type Array_Data
is record
256 Name
: Name_Id
:= No_Name
;
257 Location
: Source_Ptr
:= No_Location
;
258 Value
: Array_Element_Id
:= No_Array_Element
;
259 Next
: Array_Id
:= No_Array
;
261 -- Each Array_Data value represents an array.
262 -- Value is the id of the first element.
263 -- Next is the id of the next array in the project file or package.
265 package Array_Table
is new GNAT
.Dynamic_Tables
266 (Table_Component_Type
=> Array_Data
,
267 Table_Index_Type
=> Array_Id
,
268 Table_Low_Bound
=> 1,
269 Table_Initial
=> 200,
270 Table_Increment
=> 100);
271 -- The table that contains all arrays
273 type Package_Id
is new Nat
;
274 No_Package
: constant Package_Id
:= 0;
275 type Declarations
is record
276 Variables
: Variable_Id
:= No_Variable
;
277 Attributes
: Variable_Id
:= No_Variable
;
278 Arrays
: Array_Id
:= No_Array
;
279 Packages
: Package_Id
:= No_Package
;
281 -- Contains the declarations (variables, single and array attributes,
282 -- packages) for a project or a package in a project.
284 No_Declarations
: constant Declarations
:=
285 (Variables
=> No_Variable
,
286 Attributes
=> No_Variable
,
288 Packages
=> No_Package
);
289 -- Default value of Declarations: indicates that there is no declarations
291 type Package_Element
is record
292 Name
: Name_Id
:= No_Name
;
293 Decl
: Declarations
:= No_Declarations
;
294 Parent
: Package_Id
:= No_Package
;
295 Next
: Package_Id
:= No_Package
;
297 -- A package (includes declarations that may include other packages)
299 package Package_Table
is new GNAT
.Dynamic_Tables
300 (Table_Component_Type
=> Package_Element
,
301 Table_Index_Type
=> Package_Id
,
302 Table_Low_Bound
=> 1,
303 Table_Initial
=> 100,
304 Table_Increment
=> 100);
305 -- The table that contains all packages
307 type Language_Index
is new Nat
;
308 -- Index of language data
310 No_Language_Index
: constant Language_Index
:= 0;
311 -- Constant indicating that there is no language data
313 procedure Display_Language_Name
314 (In_Tree
: Project_Tree_Ref
;
315 Language
: Language_Index
);
316 -- Output the name of a language
318 Max_Header_Num
: constant := 6150;
319 type Header_Num
is range 0 .. Max_Header_Num
;
320 -- Size for hash table below. The upper bound is an arbitrary value, the
321 -- value here was chosen after testing to determine a good compromise
322 -- between speed of access and memory usage.
324 function Hash
(Name
: Name_Id
) return Header_Num
;
325 function Hash
(Name
: File_Name_Type
) return Header_Num
;
326 function Hash
(Name
: Path_Name_Type
) return Header_Num
;
327 -- Used for computing hash values for names put into above hash table
329 function Hash
(Project
: Project_Id
) return Header_Num
;
330 -- Used for hash tables where Project_Id is the Key
332 type Language_Kind
is (File_Based
, Unit_Based
);
333 -- Type for the kind of language. All languages are file based, except Ada
334 -- which is unit based.
336 type Dependency_File_Kind
is (None
, Makefile
, ALI_File
);
337 -- Type of dependency to be checked: no dependency file, Makefile fragment
338 -- or ALI file (for Ada).
340 Makefile_Dependency_Suffix
: constant String := ".d";
341 ALI_Dependency_Suffix
: constant String := ".ali";
343 Switches_Dependency_Suffix
: constant String := ".cswi";
345 Binder_Exchange_Suffix
: constant String := ".bexch";
346 -- Suffix for binder exchange files
348 Library_Exchange_Suffix
: constant String := ".lexch";
349 -- Suffix for library exchange files
351 type Name_List_Index
is new Nat
;
352 No_Name_List
: constant Name_List_Index
:= 0;
354 type Name_Node
is record
355 Name
: Name_Id
:= No_Name
;
356 Next
: Name_List_Index
:= No_Name_List
;
359 package Name_List_Table
is new GNAT
.Dynamic_Tables
360 (Table_Component_Type
=> Name_Node
,
361 Table_Index_Type
=> Name_List_Index
,
362 Table_Low_Bound
=> 1,
364 Table_Increment
=> 100);
365 -- The table for lists of names used in package Language_Processing
367 package Mapping_Files_Htable
is new Simple_HTable
368 (Header_Num
=> Header_Num
,
369 Element
=> Path_Name_Type
,
370 No_Element
=> No_Path
,
371 Key
=> Path_Name_Type
,
374 -- A hash table to store the mapping files that are not used
376 type Lang_Naming_Data
is record
377 Dot_Replacement
: File_Name_Type
:= No_File
;
378 -- The string to replace '.' in the source file name (for Ada)
380 Casing
: Casing_Type
:= All_Lower_Case
;
381 -- The casing of the source file name (for Ada)
383 Separate_Suffix
: File_Name_Type
:= No_File
;
384 -- String to append to unit name for source file name of an Ada subunit
386 Spec_Suffix
: File_Name_Type
:= No_File
;
387 -- The string to append to the unit name for the
388 -- source file name of a spec.
390 Body_Suffix
: File_Name_Type
:= No_File
;
391 -- The string to append to the unit name for the
392 -- source file name of a body.
395 No_Lang_Naming_Data
: constant Lang_Naming_Data
:=
396 (Dot_Replacement
=> No_File
,
397 Casing
=> All_Lower_Case
,
398 Separate_Suffix
=> No_File
,
399 Spec_Suffix
=> No_File
,
400 Body_Suffix
=> No_File
);
402 type Source_Id
is new Nat
;
404 No_Source
: constant Source_Id
:= 0;
406 type Path_Syntax_Kind
is
411 -- Host specific syntax, for example on VMS (the default)
413 type Language_Config
is record
414 Kind
: Language_Kind
:= File_Based
;
415 -- Kind of language. All languages are file based, except Ada which is
418 Naming_Data
: Lang_Naming_Data
;
419 -- The naming data for the languages (prefixes, etc.)
421 Include_Compatible_Languages
: Name_List_Index
:= No_Name_List
;
422 -- The list of languages that are "include compatible" with this
423 -- language. A language B (for example "C") is "include compatible" with
424 -- a language A (for example "C++") if it is expected that sources of
425 -- language A may "include" header files from language B.
427 Compiler_Driver
: File_Name_Type
:= No_File
;
428 -- The name of the executable for the compiler of the language
430 Compiler_Driver_Path
: String_Access
:= null;
431 -- The path name of the executable for the compiler of the language
433 Compiler_Required_Switches
: Name_List_Index
:= No_Name_List
;
434 -- The list of switches that are required as a minimum to invoke the
437 Path_Syntax
: Path_Syntax_Kind
:= Host
;
438 -- Value may be Canonical (Unix style) or Host (host syntax, for example
439 -- on VMS for DEC C).
441 Compilation_PIC_Option
: Name_List_Index
:= No_Name_List
;
442 -- The option(s) to compile a source in Position Independent Code for
443 -- shared libraries. Specified in the configuration. When not specified,
444 -- there is no need for such switch.
446 Object_Generated
: Boolean := True;
447 -- False in no object file is generated
449 Objects_Linked
: Boolean := True;
450 -- False if object files are not use to link executables and build
453 Runtime_Library_Dir
: Name_Id
:= No_Name
;
454 -- Path name of the runtime library directory, if any
456 Mapping_File_Switches
: Name_List_Index
:= No_Name_List
;
457 -- The option(s) to provide a mapping file to the compiler. Specified in
458 -- the configuration. When value is No_Name_List, there is no mapping
461 Mapping_Spec_Suffix
: File_Name_Type
:= No_File
;
462 -- Placeholder representing the spec suffix in a mapping file
464 Mapping_Body_Suffix
: File_Name_Type
:= No_File
;
465 -- Placeholder representing the body suffix in a mapping file
467 Config_File_Switches
: Name_List_Index
:= No_Name_List
;
468 -- The option(s) to provide a config file to the compiler. Specified in
469 -- the configuration. When value is No_Name_List, there is no config
472 Dependency_Kind
: Dependency_File_Kind
:= None
;
473 -- The kind of dependency to be checked: none, Makefile fragment or
474 -- ALI file (for Ada).
476 Dependency_Option
: Name_List_Index
:= No_Name_List
;
477 -- The option(s) to be used to create the dependency file. When value is
478 -- No_Name_List, there is not such option(s).
480 Compute_Dependency
: Name_List_Index
:= No_Name_List
;
481 -- Hold the value of attribute Dependency_Driver, if declared for the
484 Include_Option
: Name_List_Index
:= No_Name_List
;
485 -- Hold the value of attribute Include_Switches, if declared for the
488 Include_Path
: Name_Id
:= No_Name
;
489 -- Name of environment variable declared by attribute Include_Path for
492 Include_Path_File
: Name_Id
:= No_Name
;
493 -- Name of environment variable declared by attribute Include_Path_File
496 Objects_Path
: Name_Id
:= No_Name
;
497 -- Name of environment variable declared by attribute Objects_Path for
500 Objects_Path_File
: Name_Id
:= No_Name
;
501 -- Name of environment variable declared by attribute Objects_Path_File
504 Config_Body
: Name_Id
:= No_Name
;
505 -- The template for a pragma Source_File_Name(_Project) for a specific
506 -- file name of a body.
508 Config_Spec
: Name_Id
:= No_Name
;
509 -- The template for a pragma Source_File_Name(_Project) for a specific
510 -- file name of a spec.
512 Config_Body_Pattern
: Name_Id
:= No_Name
;
513 -- The template for a pragma Source_File_Name(_Project) for a naming
516 Config_Spec_Pattern
: Name_Id
:= No_Name
;
517 -- The template for a pragma Source_File_Name(_Project) for a naming
520 Config_File_Unique
: Boolean := False;
521 -- Indicate if the config file specified to the compiler needs to be
522 -- unique. If it is unique, then all config files are concatenated into
523 -- a temp config file.
525 Binder_Driver
: File_Name_Type
:= No_File
;
526 -- The name of the binder driver for the language, if any
528 Binder_Driver_Path
: Path_Name_Type
:= No_Path
;
529 -- The path name of the binder driver
531 Binder_Required_Switches
: Name_List_Index
:= No_Name_List
;
532 -- Hold the value of attribute Binder'Required_Switches for the language
534 Binder_Prefix
: Name_Id
:= No_Name
;
535 -- Hold the value of attribute Binder'Prefix for the language
537 Toolchain_Version
: Name_Id
:= No_Name
;
538 -- Hold the value of attribute Toolchain_Version for the language
540 Toolchain_Description
: Name_Id
:= No_Name
;
541 -- Hold the value of attribute Toolchain_Description for the language
544 -- Record describing the configuration of a language
546 No_Language_Config
: constant Language_Config
:=
548 Naming_Data
=> No_Lang_Naming_Data
,
549 Include_Compatible_Languages
=> No_Name_List
,
550 Compiler_Driver
=> No_File
,
551 Compiler_Driver_Path
=> null,
552 Compiler_Required_Switches
=> No_Name_List
,
553 Path_Syntax
=> Canonical
,
554 Compilation_PIC_Option
=> No_Name_List
,
555 Object_Generated
=> True,
556 Objects_Linked
=> True,
557 Runtime_Library_Dir
=> No_Name
,
558 Mapping_File_Switches
=> No_Name_List
,
559 Mapping_Spec_Suffix
=> No_File
,
560 Mapping_Body_Suffix
=> No_File
,
561 Config_File_Switches
=> No_Name_List
,
562 Dependency_Kind
=> Makefile
,
563 Dependency_Option
=> No_Name_List
,
564 Compute_Dependency
=> No_Name_List
,
565 Include_Option
=> No_Name_List
,
566 Include_Path
=> No_Name
,
567 Include_Path_File
=> No_Name
,
568 Objects_Path
=> No_Name
,
569 Objects_Path_File
=> No_Name
,
570 Config_Body
=> No_Name
,
571 Config_Spec
=> No_Name
,
572 Config_Body_Pattern
=> No_Name
,
573 Config_Spec_Pattern
=> No_Name
,
574 Config_File_Unique
=> False,
575 Binder_Driver
=> No_File
,
576 Binder_Driver_Path
=> No_Path
,
577 Binder_Required_Switches
=> No_Name_List
,
578 Binder_Prefix
=> No_Name
,
579 Toolchain_Version
=> No_Name
,
580 Toolchain_Description
=> No_Name
);
582 type Language_Data
is record
583 Name
: Name_Id
:= No_Name
;
584 Display_Name
: Name_Id
:= No_Name
;
585 Config
: Language_Config
:= No_Language_Config
;
586 First_Source
: Source_Id
:= No_Source
;
587 Mapping_Files
: Mapping_Files_Htable
.Instance
:=
588 Mapping_Files_Htable
.Nil
;
589 Next
: Language_Index
:= No_Language_Index
;
592 No_Language_Data
: constant Language_Data
:=
594 Display_Name
=> No_Name
,
595 Config
=> No_Language_Config
,
596 First_Source
=> No_Source
,
597 Mapping_Files
=> Mapping_Files_Htable
.Nil
,
598 Next
=> No_Language_Index
);
600 package Language_Data_Table
is new GNAT
.Dynamic_Tables
601 (Table_Component_Type
=> Language_Data
,
602 Table_Index_Type
=> Language_Index
,
603 Table_Low_Bound
=> 1,
605 Table_Increment
=> 100);
606 -- The table for lists of names used in package Language_Processing
608 type Alternate_Language_Id
is new Nat
;
610 No_Alternate_Language
: constant Alternate_Language_Id
:= 0;
612 type Alternate_Language_Data
is record
613 Language
: Language_Index
:= No_Language_Index
;
614 Next
: Alternate_Language_Id
:= No_Alternate_Language
;
617 package Alternate_Language_Table
is new GNAT
.Dynamic_Tables
618 (Table_Component_Type
=> Alternate_Language_Data
,
619 Table_Index_Type
=> Alternate_Language_Id
,
620 Table_Low_Bound
=> 1,
622 Table_Increment
=> 100);
623 -- The table for storing the alternate languages of a header file that
624 -- is used for several languages.
626 type Source_Kind
is (Spec
, Impl
, Sep
);
628 type Source_Data
is record
629 Project
: Project_Id
:= No_Project
;
630 -- Project of the source
632 Language_Name
: Name_Id
:= No_Name
;
633 -- Name of the language of the source
635 Language
: Language_Index
:= No_Language_Index
;
636 -- Index of the language
638 Lang_Kind
: Language_Kind
:= File_Based
;
639 -- Kind of the language
641 Compiled
: Boolean := True;
642 -- False when there is no compiler for the language
644 In_Interfaces
: Boolean := True;
645 -- False when the source is not included in interfaces, when attribute
646 -- Interfaces is declared.
648 Declared_In_Interfaces
: Boolean := False;
649 -- True when source is declared in attribute Interfaces
651 Alternate_Languages
: Alternate_Language_Id
:= No_Alternate_Language
;
652 -- List of languages a header file may also be, in addition of
653 -- language Language_Name.
655 Kind
: Source_Kind
:= Spec
;
656 -- Kind of the source: spec, body or subunit
658 Dependency
: Dependency_File_Kind
:= None
;
659 -- Kind of dependency: none, Makefile fragment or ALI file
661 Other_Part
: Source_Id
:= No_Source
;
662 -- Source ID for the other part, if any: for a spec, indicates its body;
663 -- for a body, indicates its spec.
665 Unit
: Name_Id
:= No_Name
;
666 -- Name of the unit, if language is unit based
669 -- Index of the source in a multi unit source file
671 Locally_Removed
: Boolean := False;
672 -- True if the source has been "excluded"
674 Get_Object
: Boolean := False;
675 -- Indicates that the object of the source should be put in the global
676 -- archive. This is for Ada, when only the closure of a main needs to
677 -- be compiled/recompiled.
679 Replaced_By
: Source_Id
:= No_Source
;
681 File
: File_Name_Type
:= No_File
;
682 -- Canonical file name of the source
684 Display_File
: File_Name_Type
:= No_File
;
685 -- File name of the source, for display purposes
687 Path
: Path_Information
:= No_Path_Information
;
688 -- Path name of the source
690 Source_TS
: Time_Stamp_Type
:= Empty_Time_Stamp
;
691 -- Time stamp of the source file
693 Object_Project
: Project_Id
:= No_Project
;
694 -- Project where the object file is
696 Object_Exists
: Boolean := True;
697 -- True if an object file exists
699 Object_Linked
: Boolean := True;
700 -- False if the object file is not use to link executables or included
703 Object
: File_Name_Type
:= No_File
;
704 -- File name of the object file
706 Current_Object_Path
: Path_Name_Type
:= No_Path
;
707 -- Object path of an existing object file
709 Object_Path
: Path_Name_Type
:= No_Path
;
710 -- Object path of the real object file
712 Object_TS
: Time_Stamp_Type
:= Empty_Time_Stamp
;
713 -- Object file time stamp
715 Dep_Name
: File_Name_Type
:= No_File
;
716 -- Dependency file simple name
718 Current_Dep_Path
: Path_Name_Type
:= No_Path
;
719 -- Path name of an existing dependency file
721 Dep_Path
: Path_Name_Type
:= No_Path
;
722 -- Path name of the real dependency file
724 Dep_TS
: Time_Stamp_Type
:= Empty_Time_Stamp
;
725 -- Dependency file time stamp
727 Switches
: File_Name_Type
:= No_File
;
728 -- File name of the switches file
730 Switches_Path
: Path_Name_Type
:= No_Path
;
731 -- Path name of the switches file
733 Switches_TS
: Time_Stamp_Type
:= Empty_Time_Stamp
;
734 -- Switches file time stamp
736 Naming_Exception
: Boolean := False;
737 -- True if the source has an exceptional name
739 Next_In_Sources
: Source_Id
:= No_Source
;
740 -- Link to another source in the project tree
742 Next_In_Project
: Source_Id
:= No_Source
;
743 -- Link to another source in the project
745 Next_In_Lang
: Source_Id
:= No_Source
;
746 -- Link to another source of the same language
749 No_Source_Data
: constant Source_Data
:=
750 (Project
=> No_Project
,
751 Language_Name
=> No_Name
,
752 Language
=> No_Language_Index
,
753 Lang_Kind
=> File_Based
,
755 In_Interfaces
=> True,
756 Declared_In_Interfaces
=> False,
757 Alternate_Languages
=> No_Alternate_Language
,
760 Other_Part
=> No_Source
,
763 Locally_Removed
=> False,
765 Replaced_By
=> No_Source
,
767 Display_File
=> No_File
,
768 Path
=> No_Path_Information
,
769 Source_TS
=> Empty_Time_Stamp
,
770 Object_Project
=> No_Project
,
771 Object_Exists
=> True,
772 Object_Linked
=> True,
774 Current_Object_Path
=> No_Path
,
775 Object_Path
=> No_Path
,
776 Object_TS
=> Empty_Time_Stamp
,
778 Current_Dep_Path
=> No_Path
,
780 Dep_TS
=> Empty_Time_Stamp
,
782 Switches_Path
=> No_Path
,
783 Switches_TS
=> Empty_Time_Stamp
,
784 Naming_Exception
=> False,
785 Next_In_Sources
=> No_Source
,
786 Next_In_Project
=> No_Source
,
787 Next_In_Lang
=> No_Source
);
789 package Source_Data_Table
is new GNAT
.Dynamic_Tables
790 (Table_Component_Type
=> Source_Data
,
791 Table_Index_Type
=> Source_Id
,
792 Table_Low_Bound
=> 1,
793 Table_Initial
=> 1000,
794 Table_Increment
=> 100);
795 -- The table for the sources
797 package Source_Paths_Htable
is new Simple_HTable
798 (Header_Num
=> Header_Num
,
799 Element
=> Source_Id
,
800 No_Element
=> No_Source
,
801 Key
=> Path_Name_Type
,
804 -- Mapping of source paths to source ids
806 type Verbosity
is (Default
, Medium
, High
);
807 -- Verbosity when parsing GNAT Project Files
808 -- Default is default (very quiet, if no errors).
809 -- Medium is more verbose.
810 -- High is extremely verbose.
812 Current_Verbosity
: Verbosity
:= Default
;
813 -- The current value of the verbosity the project files are parsed with
815 type Lib_Kind
is (Static
, Dynamic
, Relocatable
);
817 type Policy
is (Autonomous
, Compliant
, Controlled
, Restricted
, Direct
);
818 -- Type to specify the symbol policy, when symbol control is supported.
819 -- See full explanation about this type in package Symbols.
820 -- Autonomous: Create a symbol file without considering any reference
821 -- Compliant: Try to be as compatible as possible with an existing ref
822 -- Controlled: Fail if symbols are not the same as those in the reference
823 -- Restricted: Restrict the symbols to those in the symbol file
824 -- Direct: The symbol file is used as is
826 type Symbol_Record
is record
827 Symbol_File
: Path_Name_Type
:= No_Path
;
828 Reference
: Path_Name_Type
:= No_Path
;
829 Symbol_Policy
: Policy
:= Autonomous
;
831 -- Type to keep the symbol data to be used when building a shared library
833 No_Symbols
: constant Symbol_Record
:=
834 (Symbol_File
=> No_Path
,
835 Reference
=> No_Path
,
836 Symbol_Policy
=> Autonomous
);
837 -- The default value of the symbol data
839 function Image
(Casing
: Casing_Type
) return String;
840 -- Similar to 'Image (but avoid use of this attribute in compiler)
842 function Value
(Image
: String) return Casing_Type
;
843 -- Similar to 'Value (but avoid use of this attribute in compiler)
844 -- Raises Constraint_Error if not a Casing_Type image.
846 -- The following record contains data for a naming scheme
848 type Naming_Data
is record
850 Dot_Replacement
: File_Name_Type
:= No_File
;
851 -- The string to replace '.' in the source file name (for Ada)
853 Dot_Repl_Loc
: Source_Ptr
:= No_Location
;
855 Casing
: Casing_Type
:= All_Lower_Case
;
856 -- The casing of the source file name (for Ada)
858 Spec_Suffix
: Array_Element_Id
:= No_Array_Element
;
859 -- The string to append to the unit name for the
860 -- source file name of a spec.
861 -- Indexed by the programming language.
863 Ada_Spec_Suffix_Loc
: Source_Ptr
:= No_Location
;
865 Body_Suffix
: Array_Element_Id
:= No_Array_Element
;
866 -- The string to append to the unit name for the
867 -- source file name of a body.
868 -- Indexed by the programming language.
870 Ada_Body_Suffix_Loc
: Source_Ptr
:= No_Location
;
872 Separate_Suffix
: File_Name_Type
:= No_File
;
873 -- String to append to unit name for source file name of an Ada subunit
875 Sep_Suffix_Loc
: Source_Ptr
:= No_Location
;
876 -- Position in the project file source where Separate_Suffix is defined
878 Specs
: Array_Element_Id
:= No_Array_Element
;
879 -- An associative array mapping individual specs to source file names
880 -- This is specific to Ada.
882 Bodies
: Array_Element_Id
:= No_Array_Element
;
883 -- An associative array mapping individual bodies to source file names
884 -- This is specific to Ada.
886 Specification_Exceptions
: Array_Element_Id
:= No_Array_Element
;
887 -- An associative array listing spec file names that do not have the
888 -- spec suffix. Not used by Ada. Indexed by programming language name.
890 Implementation_Exceptions
: Array_Element_Id
:= No_Array_Element
;
891 -- An associative array listing body file names that do not have the
892 -- body suffix. Not used by Ada. Indexed by programming language name.
896 function Spec_Suffix_Of
897 (In_Tree
: Project_Tree_Ref
;
899 Naming
: Naming_Data
) return String;
901 function Spec_Suffix_Id_Of
902 (In_Tree
: Project_Tree_Ref
;
904 Naming
: Naming_Data
) return File_Name_Type
;
906 function Spec_Suffix_Id_Of
907 (In_Tree
: Project_Tree_Ref
;
908 Language_Id
: Name_Id
;
909 Naming
: Naming_Data
) return File_Name_Type
;
911 procedure Set_Spec_Suffix
912 (In_Tree
: Project_Tree_Ref
;
914 Naming
: in out Naming_Data
;
915 Suffix
: File_Name_Type
);
917 function Body_Suffix_Id_Of
918 (In_Tree
: Project_Tree_Ref
;
920 Naming
: Naming_Data
) return File_Name_Type
;
922 function Body_Suffix_Id_Of
923 (In_Tree
: Project_Tree_Ref
;
924 Language_Id
: Name_Id
;
925 Naming
: Naming_Data
) return File_Name_Type
;
927 function Body_Suffix_Of
928 (In_Tree
: Project_Tree_Ref
;
930 Naming
: Naming_Data
) return String;
932 procedure Set_Body_Suffix
933 (In_Tree
: Project_Tree_Ref
;
935 Naming
: in out Naming_Data
;
936 Suffix
: File_Name_Type
);
938 function Objects_Exist_For
940 In_Tree
: Project_Tree_Ref
) return Boolean;
942 function Standard_Naming_Data
943 (Tree
: Project_Tree_Ref
:= No_Project_Tree
) return Naming_Data
;
944 pragma Inline
(Standard_Naming_Data
);
945 -- The standard GNAT naming scheme when Tree is No_Project_Tree.
946 -- Otherwise, return the default naming scheme for the project tree Tree,
947 -- which must have been Initialized.
949 function Same_Naming_Scheme
950 (Left
, Right
: Naming_Data
) return Boolean;
951 -- Returns True if Left and Right are the same naming scheme
952 -- not considering Specs and Bodies.
954 type Project_List
is new Nat
;
955 Empty_Project_List
: constant Project_List
:= 0;
956 -- A list of project files
958 type Project_Element
is record
959 Project
: Project_Id
:= No_Project
;
960 Next
: Project_List
:= Empty_Project_List
;
962 -- Element in a list of project files. Next is the id of the next
963 -- project file in the list.
965 package Project_List_Table
is new GNAT
.Dynamic_Tables
966 (Table_Component_Type
=> Project_Element
,
967 Table_Index_Type
=> Project_List
,
968 Table_Low_Bound
=> 1,
969 Table_Initial
=> 100,
970 Table_Increment
=> 100);
971 -- The table that contains the lists of project files
973 type Project_Configuration
is record
974 Run_Path_Option
: Name_List_Index
:= No_Name_List
;
975 -- The option to use when linking to specify the path where to look for
978 Executable_Suffix
: Name_Id
:= No_Name
;
979 -- The suffix of executables, when specified in the configuration or in
980 -- package Builder of the main project. When this is not specified, the
981 -- executable suffix is the default for the platform.
985 Linker
: Path_Name_Type
:= No_Path
;
986 -- Path name of the linker driver. Specified in the configuration or in
987 -- the package Builder of the main project.
989 Map_File_Option
: Name_Id
:= No_Name
;
990 -- Option to use when invoking the linker to build a map file
992 Minimum_Linker_Options
: Name_List_Index
:= No_Name_List
;
993 -- The minimum options for the linker driver. Specified in the
996 Linker_Executable_Option
: Name_List_Index
:= No_Name_List
;
997 -- The option(s) to indicate the name of the executable in the linker
998 -- command. Specified in the configuration. When not specified, default
999 -- to -o <executable name>.
1001 Linker_Lib_Dir_Option
: Name_Id
:= No_Name
;
1002 -- The option to specify where to find a library for linking. Specified
1003 -- in the configuration. When not specified, defaults to "-L".
1005 Linker_Lib_Name_Option
: Name_Id
:= No_Name
;
1006 -- The option to specify the name of a library for linking. Specified in
1007 -- the configuration. When not specified, defaults to "-l".
1011 Library_Builder
: Path_Name_Type
:= No_Path
;
1012 -- The executable to build library (specified in the configuration)
1014 Lib_Support
: Library_Support
:= None
;
1015 -- The level of library support. Specified in the configuration. Support
1016 -- is none, static libraries only or both static and shared libraries.
1018 Archive_Builder
: Name_List_Index
:= No_Name_List
;
1019 -- The name of the executable to build archives, with the minimum
1020 -- switches. Specified in the configuration.
1022 Archive_Builder_Append_Option
: Name_List_Index
:= No_Name_List
;
1023 -- The options to append object files to an archive
1025 Archive_Indexer
: Name_List_Index
:= No_Name_List
;
1026 -- The name of the executable to index archives, with the minimum
1027 -- switches. Specified in the configuration.
1029 Archive_Suffix
: File_Name_Type
:= No_File
;
1030 -- The suffix of archives. Specified in the configuration. When not
1031 -- specified, defaults to ".a".
1033 Lib_Partial_Linker
: Name_List_Index
:= No_Name_List
;
1037 Shared_Lib_Driver
: File_Name_Type
:= No_File
;
1038 -- The driver to link shared libraries. Set with attribute Library_GCC.
1041 Shared_Lib_Prefix
: File_Name_Type
:= No_File
;
1042 -- Part of a shared library file name that precedes the name of the
1043 -- library. Specified in the configuration. When not specified, defaults
1046 Shared_Lib_Suffix
: File_Name_Type
:= No_File
;
1047 -- Suffix of shared libraries, after the library name in the shared
1048 -- library name. Specified in the configuration. When not specified,
1049 -- default to ".so".
1051 Shared_Lib_Min_Options
: Name_List_Index
:= No_Name_List
;
1052 -- The minimum options to use when building a shared library
1054 Lib_Version_Options
: Name_List_Index
:= No_Name_List
;
1055 -- The options to use to specify a library version
1057 Symbolic_Link_Supported
: Boolean := False;
1058 -- True if the platform supports symbolic link files
1060 Lib_Maj_Min_Id_Supported
: Boolean := False;
1061 -- True if platform supports library major and minor options, such as
1062 -- libname.so -> libname.so.2 -> libname.so.2.4
1064 Auto_Init_Supported
: Boolean := False;
1065 -- True if automatic initialisation is supported for shared stand-alone
1069 Default_Project_Config
: constant Project_Configuration
:=
1070 (Run_Path_Option
=> No_Name_List
,
1071 Executable_Suffix
=> No_Name
,
1073 Map_File_Option
=> No_Name
,
1074 Minimum_Linker_Options
=> No_Name_List
,
1075 Linker_Executable_Option
=> No_Name_List
,
1076 Linker_Lib_Dir_Option
=> No_Name
,
1077 Linker_Lib_Name_Option
=> No_Name
,
1078 Library_Builder
=> No_Path
,
1079 Lib_Support
=> None
,
1080 Archive_Builder
=> No_Name_List
,
1081 Archive_Builder_Append_Option
=> No_Name_List
,
1082 Archive_Indexer
=> No_Name_List
,
1083 Archive_Suffix
=> No_File
,
1084 Lib_Partial_Linker
=> No_Name_List
,
1085 Shared_Lib_Driver
=> No_File
,
1086 Shared_Lib_Prefix
=> No_File
,
1087 Shared_Lib_Suffix
=> No_File
,
1088 Shared_Lib_Min_Options
=> No_Name_List
,
1089 Lib_Version_Options
=> No_Name_List
,
1090 Symbolic_Link_Supported
=> False,
1091 Lib_Maj_Min_Id_Supported
=> False,
1092 Auto_Init_Supported
=> False);
1094 -- The following record describes a project file representation
1096 -- Note that it is not specified if the path names of directories (source,
1097 -- object, library or exec directories) end with or without a directory
1100 type Project_Data
is record
1106 Name
: Name_Id
:= No_Name
;
1107 -- The name of the project
1109 Display_Name
: Name_Id
:= No_Name
;
1110 -- The name of the project with the spelling of its declaration
1112 Qualifier
: Project_Qualifier
:= Unspecified
;
1113 -- The eventual qualifier for this project
1115 Externally_Built
: Boolean := False;
1116 -- True if the project is externally built. In such case, the Project
1117 -- Manager will not modify anything in this project.
1119 Config
: Project_Configuration
;
1121 Path
: Path_Information
:= No_Path_Information
;
1122 -- The path name of the project file
1124 Virtual
: Boolean := False;
1125 -- True for virtual extending projects
1127 Location
: Source_Ptr
:= No_Location
;
1128 -- The location in the project file source of the reserved word project
1130 Naming
: Naming_Data
:= Standard_Naming_Data
;
1131 -- The naming scheme of this project file
1137 Languages
: Name_List_Index
:= No_Name_List
;
1138 -- The list of languages of the sources of this project
1140 Include_Language
: Language_Index
:= No_Language_Index
;
1142 First_Language_Processing
: Language_Index
:= No_Language_Index
;
1143 -- First index of the language data in the project
1145 Unit_Based_Language_Name
: Name_Id
:= No_Name
;
1146 Unit_Based_Language_Index
: Language_Index
:= No_Language_Index
;
1147 -- The name and index, if any, of the unit-based language of some
1148 -- sources of the project. There may be only one unit-based language
1155 First_Referred_By
: Project_Id
:= No_Project
;
1156 -- The project, if any, that was the first to be known as importing or
1157 -- extending this project
1159 Mains
: String_List_Id
:= Nil_String
;
1160 -- List of mains specified by attribute Main
1162 Extends
: Project_Id
:= No_Project
;
1163 -- The reference of the project file, if any, that this project file
1166 Extended_By
: Project_Id
:= No_Project
;
1167 -- The reference of the project file, if any, that extends this project
1170 Decl
: Declarations
:= No_Declarations
;
1171 -- The declarations (variables, attributes and packages) of this project
1174 Imported_Projects
: Project_List
:= Empty_Project_List
;
1175 -- The list of all directly imported projects, if any
1177 All_Imported_Projects
: Project_List
:= Empty_Project_List
;
1178 -- The list of all projects imported directly or indirectly, if any
1184 Directory
: Path_Information
:= No_Path_Information
;
1185 -- Path name of the directory where the project file resides
1187 Dir_Path
: String_Access
;
1188 -- Same as Directory.Name, but as an access to String
1190 Object_Directory
: Path_Information
:= No_Path_Information
;
1191 -- The path name of the object directory of this project file
1193 Exec_Directory
: Path_Information
:= No_Path_Information
;
1194 -- The path name of the exec directory of this project file. Default is
1195 -- equal to Object_Directory.
1201 Library
: Boolean := False;
1202 -- True if this is a library project
1204 Library_Name
: Name_Id
:= No_Name
;
1205 -- If a library project, name of the library
1207 Library_Kind
: Lib_Kind
:= Static
;
1208 -- If a library project, kind of library
1210 Library_Dir
: Path_Information
:= No_Path_Information
;
1211 -- If a library project, path name of the directory where the library
1214 Library_TS
: Time_Stamp_Type
:= Empty_Time_Stamp
;
1215 -- The timestamp of a library file in a library project
1217 Library_Src_Dir
: Path_Information
:= No_Path_Information
;
1218 -- If a Stand-Alone Library project, path name of the directory where
1219 -- the sources of the interfaces of the library are copied. By default,
1220 -- if attribute Library_Src_Dir is not specified, sources of the
1221 -- interfaces are not copied anywhere.
1223 Library_ALI_Dir
: Path_Information
:= No_Path_Information
;
1224 -- In a library project, path name of the directory where the ALI files
1225 -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
1226 -- are copied in the Library_Dir.
1228 Lib_Internal_Name
: Name_Id
:= No_Name
;
1229 -- If a library project, internal name store inside the library
1231 Standalone_Library
: Boolean := False;
1232 -- Indicate that this is a Standalone Library Project File
1234 Lib_Interface_ALIs
: String_List_Id
:= Nil_String
;
1235 -- For Standalone Library Project Files, indicate the list of Interface
1238 Lib_Auto_Init
: Boolean := False;
1239 -- For non static Stand-Alone Library Project Files, indicate if
1240 -- the library initialisation should be automatic.
1242 Symbol_Data
: Symbol_Record
:= No_Symbols
;
1243 -- Symbol file name, reference symbol file name, symbol policy
1245 Need_To_Build_Lib
: Boolean := False;
1246 -- Indicates that the library of a Library Project needs to be built or
1253 Ada_Sources_Present
: Boolean := True;
1254 -- True if there are Ada sources in the project
1256 Other_Sources_Present
: Boolean := True;
1257 -- True if there are non-Ada sources in the project
1259 Ada_Sources
: String_List_Id
:= Nil_String
;
1260 -- The list of all the Ada source file names (gnatmake only)
1262 First_Source
: Source_Id
:= No_Source
;
1263 Last_Source
: Source_Id
:= No_Source
;
1264 -- Head and tail of the list of sources
1266 Interfaces_Defined
: Boolean := False;
1267 -- True if attribute Interfaces is declared for the project or any
1268 -- project it extends.
1270 Imported_Directories_Switches
: Argument_List_Access
:= null;
1271 -- List of the source search switches (-I<source dir>) to be used when
1274 Include_Path
: String_Access
:= null;
1275 -- The search source path for the project. Used as the value for an
1276 -- environment variable, specified by attribute Include_Path
1277 -- (<language>). The names of the environment variables are in component
1278 -- Include_Path of the records Language_Config.
1280 Include_Path_File
: Path_Name_Type
:= No_Path
;
1281 -- The path name of the of the source search directory file
1283 Include_Data_Set
: Boolean := False;
1284 -- Set True when Imported_Directories_Switches or Include_Path are set
1286 Source_Dirs
: String_List_Id
:= Nil_String
;
1287 -- The list of all the source directories
1289 Known_Order_Of_Source_Dirs
: Boolean := True;
1290 -- False, if there is any /** in the Source_Dirs, because in this case
1291 -- the ordering of the source subdirs depend on the OS. If True,
1292 -- duplicate file names in the same project file are allowed.
1294 Ada_Include_Path
: String_Access
:= null;
1295 -- The cached value of source search path for this project file. Set by
1296 -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
1297 -- use this field directly outside of the project manager, use
1298 -- Prj.Env.Ada_Include_Path instead.
1304 Ada_Objects_Path
: String_Access
:= null;
1305 -- The cached value of ADA_OBJECTS_PATH for this project file. Do not
1306 -- use this field directly outside of the compiler, use
1307 -- Prj.Env.Ada_Objects_Path instead.
1309 Libgnarl_Needed
: Yes_No_Unknown
:= Unknown
;
1310 -- Set to True when libgnarl is needed to link
1312 Objects_Path
: String_Access
:= null;
1313 -- The cached value of the object dir path, used during the binding
1314 -- phase of gprbuild.
1316 Objects_Path_File_With_Libs
: Path_Name_Type
:= No_Path
;
1317 -- The cached value of the object path temp file (including library
1318 -- dirs) for this project file.
1320 Objects_Path_File_Without_Libs
: Path_Name_Type
:= No_Path
;
1321 -- The cached value of the object path temp file (excluding library
1322 -- dirs) for this project file.
1324 Config_File_Name
: Path_Name_Type
:= No_Path
;
1325 -- The path name of the configuration pragmas file, if any
1327 Config_File_Temp
: Boolean := False;
1328 -- An indication that the configuration pragmas file is a temporary file
1329 -- that must be deleted at the end.
1331 Config_Checked
: Boolean := False;
1332 -- A flag to avoid checking repetitively the configuration pragmas file
1334 Checked
: Boolean := False;
1335 -- A flag to avoid checking repetitively the naming scheme of this
1338 Seen
: Boolean := False;
1339 -- A flag to mark a project as "visited" to avoid processing the same
1340 -- project several time.
1342 Depth
: Natural := 0;
1343 -- The maximum depth of a project in the project graph. Depth of main
1346 Unkept_Comments
: Boolean := False;
1347 -- True if there are comments in the project sources that cannot be kept
1348 -- in the project tree.
1352 function Empty_Project
(Tree
: Project_Tree_Ref
) return Project_Data
;
1353 -- Return the representation of an empty project in project Tree tree.
1354 -- The project tree Tree must have been Initialized and/or Reset.
1356 function Is_Extending
1357 (Extending
: Project_Id
;
1358 Extended
: Project_Id
;
1359 In_Tree
: Project_Tree_Ref
) return Boolean;
1360 -- ??? needs comment
1362 function Is_A_Language
1363 (Tree
: Project_Tree_Ref
;
1364 Data
: Project_Data
;
1365 Language_Name
: Name_Id
) return Boolean;
1366 -- Return True when Language_Name (which must be lower case) is one of the
1367 -- languages used for the project.
1369 Project_Error
: exception;
1370 -- Raised by some subprograms in Prj.Attr
1372 package Project_Table
is new GNAT
.Dynamic_Tables
(
1373 Table_Component_Type
=> Project_Data
,
1374 Table_Index_Type
=> Project_Id
,
1375 Table_Low_Bound
=> 1,
1376 Table_Initial
=> 100,
1377 Table_Increment
=> 100);
1378 -- The set of all project files
1380 type Spec_Or_Body
is (Specification
, Body_Part
);
1382 type File_Name_Data
is record
1383 Name
: File_Name_Type
:= No_File
;
1385 Display_Name
: File_Name_Type
:= No_File
;
1386 Path
: Path_Information
:= No_Path_Information
;
1387 Project
: Project_Id
:= No_Project
;
1388 Needs_Pragma
: Boolean := False;
1390 -- File and Path name of a spec or body
1392 type File_Names_Data
is array (Spec_Or_Body
) of File_Name_Data
;
1394 type Unit_Index
is new Nat
;
1395 No_Unit_Index
: constant Unit_Index
:= 0;
1396 type Unit_Data
is record
1397 Name
: Name_Id
:= No_Name
;
1398 File_Names
: File_Names_Data
;
1400 -- Name and File and Path names of a unit, with a reference to its
1401 -- GNAT Project File(s).
1403 package Unit_Table
is new GNAT
.Dynamic_Tables
1404 (Table_Component_Type
=> Unit_Data
,
1405 Table_Index_Type
=> Unit_Index
,
1406 Table_Low_Bound
=> 1,
1407 Table_Initial
=> 100,
1408 Table_Increment
=> 100);
1409 -- Table of all units in a project tree
1411 package Units_Htable
is new Simple_HTable
1412 (Header_Num
=> Header_Num
,
1413 Element
=> Unit_Index
,
1414 No_Element
=> No_Unit_Index
,
1418 -- Mapping of unit names to indexes in the Units table
1420 type Unit_Project
is record
1421 Unit
: Unit_Index
:= No_Unit_Index
;
1422 Project
: Project_Id
:= No_Project
;
1425 No_Unit_Project
: constant Unit_Project
:= (No_Unit_Index
, No_Project
);
1427 package Files_Htable
is new Simple_HTable
1428 (Header_Num
=> Header_Num
,
1429 Element
=> Unit_Project
,
1430 No_Element
=> No_Unit_Project
,
1431 Key
=> File_Name_Type
,
1434 -- Mapping of file names to indexes in the Units table
1436 type Private_Project_Tree_Data
is private;
1437 -- Data for a project tree that is used only by the Project Manager
1439 type Project_Tree_Data
is
1441 -- Languages and sources of the project
1443 First_Language
: Language_Index
:= No_Language_Index
;
1446 First_Source
: Source_Id
:= No_Source
;
1451 Languages_Data
: Language_Data_Table
.Instance
;
1452 Name_Lists
: Name_List_Table
.Instance
;
1453 String_Elements
: String_Element_Table
.Instance
;
1454 Variable_Elements
: Variable_Element_Table
.Instance
;
1455 Array_Elements
: Array_Element_Table
.Instance
;
1456 Arrays
: Array_Table
.Instance
;
1457 Packages
: Package_Table
.Instance
;
1458 Project_Lists
: Project_List_Table
.Instance
;
1459 Projects
: Project_Table
.Instance
;
1460 Sources
: Source_Data_Table
.Instance
;
1461 Alt_Langs
: Alternate_Language_Table
.Instance
;
1462 Units
: Unit_Table
.Instance
;
1463 Units_HT
: Units_Htable
.Instance
;
1464 Files_HT
: Files_Htable
.Instance
;
1465 Source_Paths_HT
: Source_Paths_Htable
.Instance
;
1469 Private_Part
: Private_Project_Tree_Data
;
1471 -- Data for a project tree
1473 type Put_Line_Access
is access procedure
1475 Project
: Project_Id
;
1476 In_Tree
: Project_Tree_Ref
);
1477 -- Use to customize error reporting in Prj.Proc and Prj.Nmsc
1479 procedure Expect
(The_Token
: Token_Type
; Token_Image
: String);
1480 -- Check that the current token is The_Token. If it is not, then output
1481 -- an error message.
1483 procedure Initialize
(Tree
: Project_Tree_Ref
);
1484 -- This procedure must be called before using any services from the Prj
1485 -- hierarchy. Namet.Initialize must be called before Prj.Initialize.
1487 procedure Reset
(Tree
: Project_Tree_Ref
);
1488 -- This procedure resets all the tables that are used when processing a
1489 -- project file tree. Initialize must be called before the call to Reset.
1491 procedure Register_Default_Naming_Scheme
1492 (Language
: Name_Id
;
1493 Default_Spec_Suffix
: File_Name_Type
;
1494 Default_Body_Suffix
: File_Name_Type
;
1495 In_Tree
: Project_Tree_Ref
);
1496 -- Register the default suffixes for a given language. These extensions
1497 -- will be ignored if the user has specified a new naming scheme in a
1500 -- Otherwise, this information will be automatically added to Naming_Data
1501 -- when a project is processed, in the lists Spec_Suffix and Body_Suffix.
1504 type State
is limited private;
1505 with procedure Action
1506 (Project
: Project_Id
;
1507 With_State
: in out State
);
1508 procedure For_Every_Project_Imported
1510 In_Tree
: Project_Tree_Ref
;
1511 With_State
: in out State
);
1512 -- Call Action for each project imported directly or indirectly by project
1513 -- By. Action is called according to the order of importation: if A
1514 -- imports B, directly or indirectly, Action will be called for A before
1515 -- it is called for B. If two projects import each other directly or
1516 -- indirectly (using at least one "limited with"), it is not specified
1517 -- for which of these two projects Action will be called first. Projects
1518 -- that are extended by other projects are not considered. With_State may
1519 -- be used by Action to choose a behavior or to report some global result.
1521 function Extend_Name
1522 (File
: File_Name_Type
;
1523 With_Suffix
: String) return File_Name_Type
;
1524 -- Replace the extension of File with With_Suffix
1526 function Object_Name
1527 (Source_File_Name
: File_Name_Type
) return File_Name_Type
;
1528 -- Returns the object file name corresponding to a source file name
1530 function Dependency_Name
1531 (Source_File_Name
: File_Name_Type
;
1532 Dependency
: Dependency_File_Kind
) return File_Name_Type
;
1533 -- Returns the dependency file name corresponding to a source file name
1535 function Switches_Name
1536 (Source_File_Name
: File_Name_Type
) return File_Name_Type
;
1537 -- Returns the switches file name corresponding to a source file name
1543 procedure Record_Temp_File
(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
;
1548 -- Delete all recorded temporary files
1552 All_Packages
: constant String_List_Access
:= null;
1554 No_Project_Tree
: constant Project_Tree_Ref
:= null;
1556 Ignored
: constant Variable_Kind
:= Single
;
1558 Nil_Variable_Value
: constant Variable_Value
:=
1559 (Project
=> No_Project
,
1561 Location
=> No_Location
,
1564 Virtual_Prefix
: constant String := "v$";
1565 -- The prefix for virtual extending projects. Because of the '$', which is
1566 -- normally forbidden for project names, there cannot be any name clash.
1568 Empty_Name
: Name_Id
;
1569 -- Name_Id for an empty name (no characters). Initialized in procedure
1572 Empty_File_Name
: File_Name_Type
;
1573 -- Empty File_Name_Type (no characters). Initialized in procedure
1576 procedure Add_To_Buffer
1578 To
: in out String_Access
;
1579 Last
: in out Natural);
1580 -- Append a String to the Buffer
1582 type Naming_Id
is new Nat
;
1584 package Naming_Table
is new GNAT
.Dynamic_Tables
1585 (Table_Component_Type
=> Naming_Data
,
1586 Table_Index_Type
=> Naming_Id
,
1587 Table_Low_Bound
=> 1,
1589 Table_Increment
=> 100);
1590 -- Table storing the naming data for gnatmake/gprmake
1592 package Path_File_Table
is new GNAT
.Dynamic_Tables
1593 (Table_Component_Type
=> Path_Name_Type
,
1594 Table_Index_Type
=> Natural,
1595 Table_Low_Bound
=> 1,
1596 Table_Initial
=> 50,
1597 Table_Increment
=> 100);
1598 -- Table storing all the temp path file names.
1599 -- Used by Delete_All_Path_Files.
1601 package Source_Path_Table
is new GNAT
.Dynamic_Tables
1602 (Table_Component_Type
=> Name_Id
,
1603 Table_Index_Type
=> Natural,
1604 Table_Low_Bound
=> 1,
1605 Table_Initial
=> 50,
1606 Table_Increment
=> 100);
1607 -- A table to store the source dirs before creating the source path file
1609 package Object_Path_Table
is new GNAT
.Dynamic_Tables
1610 (Table_Component_Type
=> Path_Name_Type
,
1611 Table_Index_Type
=> Natural,
1612 Table_Low_Bound
=> 1,
1613 Table_Initial
=> 50,
1614 Table_Increment
=> 100);
1615 -- A table to store the object dirs, before creating the object path file
1617 type Private_Project_Tree_Data
is record
1618 Namings
: Naming_Table
.Instance
;
1619 Path_Files
: Path_File_Table
.Instance
;
1620 Source_Paths
: Source_Path_Table
.Instance
;
1621 Object_Paths
: Object_Path_Table
.Instance
;
1622 Default_Naming
: Naming_Data
;
1624 -- Type to represent the part of a project tree which is private to the