-- --
-- S p e c --
-- --
--- Copyright (C) 2001-2006, Free Software Foundation, Inc. --
+-- Copyright (C) 2001-2009, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
--- ware Foundation; either version 2, or (at your option) any later ver- --
+-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
--- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
--- Boston, MA 02110-1301, USA. --
+-- Public License distributed with GNAT; see file COPYING3. If not, go to --
+-- http://www.gnu.org/licenses for a complete copy of the license. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- See in particular Prj.Pars and Prj.Env.
with Casing; use Casing;
+with Namet; use Namet;
+with Osint;
with Scans; use Scans;
-with Table;
with Types; use Types;
with GNAT.Dynamic_HTables; use GNAT.Dynamic_HTables;
with GNAT.Dynamic_Tables;
-with GNAT.OS_Lib; use GNAT.OS_Lib;
-
-with System.HTable;
+with GNAT.OS_Lib; use GNAT.OS_Lib;
package Prj is
+ All_Other_Names : constant Name_Id := Names_High_Bound;
+ -- Name used to replace others as an index of an associative array
+ -- attribute in situations where this is allowed.
+
+ Subdirs : String_Ptr := null;
+ -- The value after the equal sign in switch --subdirs=...
+ -- Contains the relative subdirectory.
+
+ type Library_Support is (None, Static_Only, Full);
+ -- Support for Library Project File.
+ -- - None: Library Project Files are not supported at all
+ -- - Static_Only: Library Project Files are only supported for static
+ -- libraries.
+ -- - Full: Library Project Files are supported for static and dynamic
+ -- (shared) libraries.
+
+ type Yes_No_Unknown is (Yes, No, Unknown);
+ -- Tri-state to decide if -lgnarl is needed when linking
+
+ type Project_Qualifier is
+ (Unspecified,
+ Standard,
+ Library,
+ Configuration,
+ Dry,
+ Aggregate,
+ Aggregate_Library);
+ -- Qualifiers that can prefix the reserved word "project" in a project
+ -- file:
+ -- Standard: standard project ...
+ -- Library: library project is ...
+ -- Dry: abstract project is
+ -- Aggregate: aggregate project is
+ -- Aggregate_Library: aggregate library project is ...
+ -- Configuration: configuration project is ...
+
All_Packages : constant String_List_Access;
-- Default value of parameter Packages of procedures Parse, in Prj.Pars and
-- Prj.Part, indicating that all packages should be checked.
type Project_Tree_Data;
type Project_Tree_Ref is access all Project_Tree_Data;
- -- Reference to a project tree.
- -- Several project trees may exist in memory at the same time.
+ -- Reference to a project tree. Several project trees may exist in memory
+ -- at the same time.
No_Project_Tree : constant Project_Tree_Ref;
- function Default_Ada_Spec_Suffix return Name_Id;
- pragma Inline (Default_Ada_Spec_Suffix);
- -- The Name_Id for the standard GNAT suffix for Ada spec source file
- -- name ".ads". Initialized by Prj.Initialize.
-
- function Default_Ada_Body_Suffix return Name_Id;
- pragma Inline (Default_Ada_Body_Suffix);
- -- The Name_Id for the standard GNAT suffix for Ada body source file
- -- name ".adb". Initialized by Prj.Initialize.
-
- function Slash return Name_Id;
- pragma Inline (Slash);
- -- "/", used as the path of locally removed files
+ procedure Free (Tree : in out Project_Tree_Ref);
+ -- Free memory associated with the tree
+ Config_Project_File_Extension : String := ".cgpr";
Project_File_Extension : String := ".gpr";
- -- The standard project file name extension. It is not a constant, because
- -- Canonical_Case_File_Name is called on this variable in the body of Prj.
-
- type Error_Warning is (Silent, Warning, Error);
- -- Severity of some situations, such as: no Ada sources in a project where
- -- Ada is one of the language.
- --
- -- When the situation occurs, the behaviour depends on the setting:
- --
- -- - Silent: no action
- -- - Warning: issue a warning, does not cause the tool to fail
- -- - Error: issue an error, causes the tool to fail
-
- -----------------------------------------------------
- -- Multi-language Stuff That Will be Modified Soon --
- -----------------------------------------------------
-
- -- Still should be properly commented ???
-
- type Language_Index is new Nat;
-
- No_Language_Index : constant Language_Index := 0;
- First_Language_Index : constant Language_Index := 1;
- First_Language_Indexes_Last : constant Language_Index := 5;
-
- Ada_Language_Index : constant Language_Index :=
- First_Language_Index;
- C_Language_Index : constant Language_Index :=
- Ada_Language_Index + 1;
- C_Plus_Plus_Language_Index : constant Language_Index :=
- C_Language_Index + 1;
-
- Last_Language_Index : Language_Index := No_Language_Index;
-
- subtype First_Language_Indexes is Language_Index
- range First_Language_Index .. First_Language_Indexes_Last;
-
- type Header_Num is range 0 .. 2047;
-
- function Hash is new System.HTable.Hash (Header_Num => Header_Num);
-
- function Hash (Name : Name_Id) return Header_Num;
-
- package Language_Indexes is new System.HTable.Simple_HTable
- (Header_Num => Header_Num,
- Element => Language_Index,
- No_Element => No_Language_Index,
- Key => Name_Id,
- Hash => Hash,
- Equal => "=");
- -- Mapping of language names to language indexes
-
- package Language_Names is new Table.Table
- (Table_Component_Type => Name_Id,
- Table_Index_Type => Language_Index,
- Table_Low_Bound => 1,
- Table_Initial => 4,
- Table_Increment => 100,
- Table_Name => "Prj.Language_Names");
- -- The table for the name of programming languages
-
- procedure Add_Language_Name (Name : Name_Id);
-
- procedure Display_Language_Name (Language : Language_Index);
-
- type Languages_In_Project is array (First_Language_Indexes) of Boolean;
- -- Set of supported languages used in a project
-
- No_Languages : constant Languages_In_Project := (others => False);
- -- No supported languages are used
-
- type Supp_Language_Index is new Nat;
- No_Supp_Language_Index : constant Supp_Language_Index := 0;
-
- type Supp_Language is record
- Index : Language_Index := No_Language_Index;
- Present : Boolean := False;
- Next : Supp_Language_Index := No_Supp_Language_Index;
- end record;
-
- package Present_Language_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Supp_Language,
- Table_Index_Type => Supp_Language_Index,
- Table_Low_Bound => 1,
- Table_Initial => 4,
- Table_Increment => 100);
- -- The table for the presence of languages with an index that is outside
- -- of First_Language_Indexes.
-
- type Impl_Suffix_Array is array (First_Language_Indexes) of Name_Id;
- -- Suffixes for the non spec sources of the different supported languages
- -- in a project.
+ -- The standard config and user project file name extensions. They are not
+ -- constants, because Canonical_Case_File_Name is called on these variables
+ -- in the body of Prj.
- No_Impl_Suffixes : constant Impl_Suffix_Array := (others => No_Name);
- -- A default value for the non spec source suffixes
-
- type Supp_Suffix is record
- Index : Language_Index := No_Language_Index;
- Suffix : Name_Id := No_Name;
- Next : Supp_Language_Index := No_Supp_Language_Index;
- end record;
-
- package Supp_Suffix_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Supp_Suffix,
- Table_Index_Type => Supp_Language_Index,
- Table_Low_Bound => 1,
- Table_Initial => 4,
- Table_Increment => 100);
- -- The table for the presence of languages with an index that is outside
- -- of First_Language_Indexes.
-
- type Language_Kind is (GNU, other);
-
- type Name_List_Index is new Nat;
- No_Name_List : constant Name_List_Index := 0;
-
- type Name_Node is record
- Name : Name_Id := No_Name;
- Next : Name_List_Index := No_Name_List;
- end record;
-
- package Name_List_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Name_Node,
- Table_Index_Type => Name_List_Index,
- Table_Low_Bound => 1,
- Table_Initial => 10,
- Table_Increment => 100);
- -- The table for lists of names used in package Language_Processing
-
- type Language_Processing_Data is record
- Compiler_Drivers : Name_List_Index := No_Name_List;
- Compiler_Paths : Name_Id := No_Name;
- Compiler_Kinds : Language_Kind := GNU;
- Dependency_Options : Name_List_Index := No_Name_List;
- Compute_Dependencies : Name_List_Index := No_Name_List;
- Include_Options : Name_List_Index := No_Name_List;
- Binder_Drivers : Name_Id := No_Name;
- Binder_Driver_Paths : Name_Id := No_Name;
- end record;
-
- Default_Language_Processing_Data :
- constant Language_Processing_Data :=
- (Compiler_Drivers => No_Name_List,
- Compiler_Paths => No_Name,
- Compiler_Kinds => GNU,
- Dependency_Options => No_Name_List,
- Compute_Dependencies => No_Name_List,
- Include_Options => No_Name_List,
- Binder_Drivers => No_Name,
- Binder_Driver_Paths => No_Name);
-
- type First_Language_Processing_Data is
- array (First_Language_Indexes) of Language_Processing_Data;
-
- Default_First_Language_Processing_Data :
- constant First_Language_Processing_Data :=
- (others => Default_Language_Processing_Data);
-
- type Supp_Language_Data is record
- Index : Language_Index := No_Language_Index;
- Data : Language_Processing_Data := Default_Language_Processing_Data;
- Next : Supp_Language_Index := No_Supp_Language_Index;
- end record;
-
- package Supp_Language_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Supp_Language_Data,
- Table_Index_Type => Supp_Language_Index,
- Table_Low_Bound => 1,
- Table_Initial => 4,
- Table_Increment => 100);
- -- The table for language data when there are more languages than
- -- in First_Language_Indexes.
-
- type Other_Source_Id is new Nat;
- No_Other_Source : constant Other_Source_Id := 0;
-
- type Other_Source is record
- Language : Language_Index; -- language of the source
- File_Name : Name_Id; -- source file simple name
- Path_Name : Name_Id; -- source full path name
- Source_TS : Time_Stamp_Type; -- source file time stamp
- Object_Name : Name_Id; -- object file simple name
- Object_Path : Name_Id; -- object full path name
- Object_TS : Time_Stamp_Type; -- object file time stamp
- Dep_Name : Name_Id; -- dependency file simple name
- Dep_Path : Name_Id; -- dependency full path name
- Dep_TS : Time_Stamp_Type; -- dependency file time stamp
- Naming_Exception : Boolean := False; -- True if a naming exception
- Next : Other_Source_Id := No_Other_Source;
- end record;
- -- Data for a source in a language other than Ada
-
- package Other_Source_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Other_Source,
- Table_Index_Type => Other_Source_Id,
- Table_Low_Bound => 1,
- Table_Initial => 200,
- Table_Increment => 100);
- -- The table for sources of languages other than Ada
-
- ----------------------------------
- -- End of multi-language stuff --
- ----------------------------------
-
- type Verbosity is (Default, Medium, High);
- -- Verbosity when parsing GNAT Project Files
- -- Default is default (very quiet, if no errors).
- -- Medium is more verbose.
- -- High is extremely verbose.
-
- Current_Verbosity : Verbosity := Default;
- -- The current value of the verbosity the project files are parsed with
-
- type Lib_Kind is (Static, Dynamic, Relocatable);
- type Policy is (Autonomous, Compliant, Controlled, Restricted);
- -- Type to specify the symbol policy, when symbol control is supported.
- -- See full explanation about this type in package Symbols.
- -- Autonomous: Create a symbol file without considering any reference
- -- Compliant: Try to be as compatible as possible with an existing ref
- -- Controlled: Fail if symbols are not the same as those in the reference
- -- Restricted: Restrict the symbols to those in the symbol file
+ function Empty_File return File_Name_Type;
+ function Empty_String return Name_Id;
+ -- Return the id for an empty string ""
- type Symbol_Record is record
- Symbol_File : Name_Id := No_Name;
- Reference : Name_Id := No_Name;
- Symbol_Policy : Policy := Autonomous;
+ type Path_Information is record
+ Name : Path_Name_Type := No_Path;
+ Display_Name : Path_Name_Type := No_Path;
end record;
- -- Type to keep the symbol data to be used when building a shared library
+ -- Directory names always end with a directory separator
- No_Symbols : constant Symbol_Record :=
- (Symbol_File => No_Name,
- Reference => No_Name,
- Symbol_Policy => Autonomous);
- -- The default value of the symbol data
-
- function Empty_String return Name_Id;
- -- Return the Name_Id for an empty string ""
+ No_Path_Information : constant Path_Information := (No_Path, No_Path);
- type Project_Id is new Nat;
- No_Project : constant Project_Id := 0;
+ type Project_Data;
+ type Project_Id is access all Project_Data;
+ No_Project : constant Project_Id := null;
-- Id of a Project File
type String_List_Id is new Nat;
end case;
end record;
-- Values for variables and array elements. Default is True if the
- -- current value is the default one for the variable
+ -- current value is the default one for the variable.
Nil_Variable_Value : constant Variable_Value;
-- Value of a non existing variable or array element
type Array_Id is new Nat;
No_Array : constant Array_Id := 0;
type Array_Data is record
- Name : Name_Id := No_Name;
- Value : Array_Element_Id := No_Array_Element;
- Next : Array_Id := No_Array;
+ Name : Name_Id := No_Name;
+ Location : Source_Ptr := No_Location;
+ Value : Array_Element_Id := No_Array_Element;
+ Next : Array_Id := No_Array;
end record;
-- Each Array_Data value represents an array.
-- Value is the id of the first element.
Table_Increment => 100);
-- The table that contains all packages
- function Image (Casing : Casing_Type) return String;
- -- Similar to 'Image (but avoid use of this attribute in compiler)
+ type Language_Data;
+ type Language_Ptr is access all Language_Data;
+ -- Index of language data
- function Value (Image : String) return Casing_Type;
- -- Similar to 'Value (but avoid use of this attribute in compiler)
- -- Raises Constraint_Error if not a Casing_Type image.
+ No_Language_Index : constant Language_Ptr := null;
+ -- Constant indicating that there is no language data
- -- The following record contains data for a naming scheme
+ function Get_Language_From_Name
+ (Project : Project_Id;
+ Name : String) return Language_Ptr;
+ -- Get a language from a project. This might return null if no such
+ -- language exists in the project
- type Naming_Data is record
+ Max_Header_Num : constant := 6150;
+ type Header_Num is range 0 .. Max_Header_Num;
+ -- Size for hash table below. The upper bound is an arbitrary value, the
+ -- value here was chosen after testing to determine a good compromise
+ -- between speed of access and memory usage.
- Dot_Replacement : Name_Id := No_Name;
- -- The string to replace '.' in the source file name (for Ada)
+ function Hash (Name : Name_Id) return Header_Num;
+ function Hash (Name : File_Name_Type) return Header_Num;
+ function Hash (Name : Path_Name_Type) return Header_Num;
+ function Hash (Project : Project_Id) return Header_Num;
+ -- Used for computing hash values for names put into hash tables
+
+ type Language_Kind is (File_Based, Unit_Based);
+ -- Type for the kind of language. All languages are file based, except Ada
+ -- which is unit based.
+
+ type Dependency_File_Kind is (None, Makefile, ALI_File);
+ -- Type of dependency to be checked: no dependency file, Makefile fragment
+ -- or ALI file (for Ada).
+
+ Makefile_Dependency_Suffix : constant String := ".d";
+ ALI_Dependency_Suffix : constant String := ".ali";
+
+ Switches_Dependency_Suffix : constant String := ".cswi";
- Dot_Repl_Loc : Source_Ptr := No_Location;
- -- The position in the project file source where Dot_Replacement is
- -- defined.
+ Binder_Exchange_Suffix : constant String := ".bexch";
+ -- Suffix for binder exchange files
+
+ Library_Exchange_Suffix : constant String := ".lexch";
+ -- Suffix for library exchange files
+
+ type Name_List_Index is new Nat;
+ No_Name_List : constant Name_List_Index := 0;
+
+ type Name_Node is record
+ Name : Name_Id := No_Name;
+ Next : Name_List_Index := No_Name_List;
+ end record;
+
+ package Name_List_Table is new GNAT.Dynamic_Tables
+ (Table_Component_Type => Name_Node,
+ Table_Index_Type => Name_List_Index,
+ Table_Low_Bound => 1,
+ Table_Initial => 10,
+ Table_Increment => 100);
+ -- The table for lists of names
+
+ function Length
+ (Table : Name_List_Table.Instance;
+ List : Name_List_Index) return Natural;
+ -- Return the number of elements in specified list
+
+ type Number_List_Index is new Nat;
+ No_Number_List : constant Number_List_Index := 0;
+
+ type Number_Node is record
+ Number : Natural := 0;
+ Next : Number_List_Index := No_Number_List;
+ end record;
+
+ package Number_List_Table is new GNAT.Dynamic_Tables
+ (Table_Component_Type => Number_Node,
+ Table_Index_Type => Number_List_Index,
+ Table_Low_Bound => 1,
+ Table_Initial => 10,
+ Table_Increment => 100);
+ -- The table for lists of numbers
+
+ package Mapping_Files_Htable is new Simple_HTable
+ (Header_Num => Header_Num,
+ Element => Path_Name_Type,
+ No_Element => No_Path,
+ Key => Path_Name_Type,
+ Hash => Hash,
+ Equal => "=");
+ -- A hash table to store the mapping files that are not used
+
+ -- The following record ???
+
+ type Lang_Naming_Data is record
+ Dot_Replacement : File_Name_Type := No_File;
+ -- The string to replace '.' in the source file name (for Ada)
Casing : Casing_Type := All_Lower_Case;
-- The casing of the source file name (for Ada)
- Spec_Suffix : Array_Element_Id := No_Array_Element;
+ Separate_Suffix : File_Name_Type := No_File;
+ -- String to append to unit name for source file name of an Ada subunit
+
+ Spec_Suffix : File_Name_Type := No_File;
-- The string to append to the unit name for the
-- source file name of a spec.
- -- Indexed by the programming language.
- Ada_Spec_Suffix : Name_Id := No_Name;
- -- The suffix of the Ada spec sources
+ Body_Suffix : File_Name_Type := No_File;
+ -- The string to append to the unit name for the
+ -- source file name of a body.
+ end record;
+
+ No_Lang_Naming_Data : constant Lang_Naming_Data :=
+ (Dot_Replacement => No_File,
+ Casing => All_Lower_Case,
+ Separate_Suffix => No_File,
+ Spec_Suffix => No_File,
+ Body_Suffix => No_File);
- Spec_Suffix_Loc : Source_Ptr := No_Location;
- -- The position in the project file source where
- -- Ada_Spec_Suffix is defined.
+ function Is_Standard_GNAT_Naming (Naming : Lang_Naming_Data) return Boolean;
+ -- True if the naming scheme is GNAT's default naming scheme. This
+ -- is to take into account shortened names like "Ada." (a-), "System." (s-)
+ -- and so on.
- Impl_Suffixes : Impl_Suffix_Array := No_Impl_Suffixes;
- Supp_Suffixes : Supp_Language_Index := No_Supp_Language_Index;
- -- The source suffixes of the different languages
+ type Source_Data;
+ type Source_Id is access all Source_Data;
- Body_Suffix : Array_Element_Id := No_Array_Element;
- -- The string to append to the unit name for the
- -- source file name of a body.
- -- Indexed by the programming language.
+ function Is_Compilable (Source : Source_Id) return Boolean;
+ pragma Inline (Is_Compilable);
+ -- Return True if we know how to compile Source (i.e. if a compiler is
+ -- defined). This doesn't indicate whether the source should be compiled.
- Ada_Body_Suffix : Name_Id := No_Name;
- -- The suffix of the Ada body sources
+ function Object_To_Global_Archive (Source : Source_Id) return Boolean;
+ pragma Inline (Object_To_Global_Archive);
+ -- Return True if the object file should be put in the global archive.
+ -- This is for Ada, when only the closure of a main needs to be
+ -- (re)compiled.
- Body_Suffix_Loc : Source_Ptr := No_Location;
- -- The position in the project file source where
- -- Ada_Body_Suffix is defined.
+ function Other_Part (Source : Source_Id) return Source_Id;
+ pragma Inline (Other_Part);
+ -- Source ID for the other part, if any: for a spec, indicates its body;
+ -- for a body, indicates its spec.
- Separate_Suffix : Name_Id := No_Name;
- -- String to append to unit name for source file name of an Ada subunit
+ No_Source : constant Source_Id := null;
+
+ type Path_Syntax_Kind is
+ (Canonical,
+ -- Unix style
+ Host);
+ -- Host specific syntax, for example on VMS (the default)
+
+ -- The following record describes the configuration of a language
+
+ type Language_Config is record
+ Kind : Language_Kind := File_Based;
+ -- Kind of language. All languages are file based, except Ada which is
+ -- unit based.
+
+ Naming_Data : Lang_Naming_Data;
+ -- The naming data for the languages (prefixes, etc.)
+
+ Include_Compatible_Languages : Name_List_Index := No_Name_List;
+ -- List of languages that are "include compatible" with this language. A
+ -- language B (for example "C") is "include compatible" with a language
+ -- A (for example "C++") if it is expected that sources of language A
+ -- may "include" header files from language B.
+
+ Compiler_Driver : File_Name_Type := No_File;
+ -- The name of the executable for the compiler of the language
+
+ Compiler_Driver_Path : String_Access := null;
+ -- The path name of the executable for the compiler of the language
+
+ Compiler_Leading_Required_Switches : Name_List_Index := No_Name_List;
+ -- The list of initial switches that are required as a minimum to invoke
+ -- the compiler driver.
+
+ Compiler_Trailing_Required_Switches : Name_List_Index := No_Name_List;
+ -- The list of final switches that are required as a minimum to invoke
+ -- the compiler driver.
+
+ Multi_Unit_Switches : Name_List_Index := No_Name_List;
+ -- The switch(es) to indicate the index of a unit in a multi-source file
+
+ Multi_Unit_Object_Separator : Character := ' ';
+ -- The string separating the base name of a source from the index of the
+ -- unit in a multi-source file, in the object file name.
+
+ Path_Syntax : Path_Syntax_Kind := Host;
+ -- Value may be Canonical (Unix style) or Host (host syntax, for example
+ -- on VMS for DEC C).
+
+ Object_File_Suffix : Name_Id := No_Name;
+ -- Optional alternate object file suffix
+
+ Object_File_Switches : Name_List_Index := No_Name_List;
+ -- Optional object file switches. When this is defined, the switches
+ -- are used to specify the object file. The object file name is appended
+ -- to the last switch in the list. Example: ("-o", "").
+
+ Compilation_PIC_Option : Name_List_Index := No_Name_List;
+ -- The option(s) to compile a source in Position Independent Code for
+ -- shared libraries. Specified in the configuration. When not specified,
+ -- there is no need for such switch.
+
+ Object_Generated : Boolean := True;
+ -- False in no object file is generated
+
+ Objects_Linked : Boolean := True;
+ -- False if object files are not use to link executables and build
+ -- libraries.
+
+ Runtime_Library_Dir : Name_Id := No_Name;
+ -- Path name of the runtime library directory, if any
+
+ Runtime_Source_Dir : Name_Id := No_Name;
+ -- Path name of the runtime source directory, if any
+
+ Mapping_File_Switches : Name_List_Index := No_Name_List;
+ -- The option(s) to provide a mapping file to the compiler. Specified in
+ -- the configuration. When value is No_Name_List, there is no mapping
+ -- file.
+
+ Mapping_Spec_Suffix : File_Name_Type := No_File;
+ -- Placeholder representing the spec suffix in a mapping file
+
+ Mapping_Body_Suffix : File_Name_Type := No_File;
+ -- Placeholder representing the body suffix in a mapping file
+
+ Config_File_Switches : Name_List_Index := No_Name_List;
+ -- The option(s) to provide a config file to the compiler. Specified in
+ -- the configuration. If value is No_Name_List there is no config file.
+
+ Dependency_Kind : Dependency_File_Kind := None;
+ -- The kind of dependency to be checked: none, Makefile fragment or
+ -- ALI file (for Ada).
+
+ Dependency_Option : Name_List_Index := No_Name_List;
+ -- The option(s) to be used to create the dependency file. When value is
+ -- No_Name_List, there is not such option(s).
+
+ Compute_Dependency : Name_List_Index := No_Name_List;
+ -- Hold the value of attribute Dependency_Driver, if declared for the
+ -- language.
+
+ Include_Option : Name_List_Index := No_Name_List;
+ -- Hold the value of attribute Include_Switches, if declared for the
+ -- language.
+
+ Include_Path : Name_Id := No_Name;
+ -- Name of environment variable declared by attribute Include_Path for
+ -- the language.
+
+ Include_Path_File : Name_Id := No_Name;
+ -- Name of environment variable declared by attribute Include_Path_File
+ -- for the language.
+
+ Objects_Path : Name_Id := No_Name;
+ -- Name of environment variable declared by attribute Objects_Path for
+ -- the language.
+
+ Objects_Path_File : Name_Id := No_Name;
+ -- Name of environment variable declared by attribute Objects_Path_File
+ -- for the language.
+
+ Config_Body : Name_Id := No_Name;
+ -- The template for a pragma Source_File_Name(_Project) for a specific
+ -- file name of a body.
+
+ Config_Body_Index : Name_Id := No_Name;
+ -- The template for a pragma Source_File_Name(_Project) for a specific
+ -- file name of a body in a multi-source file.
+
+ Config_Body_Pattern : Name_Id := No_Name;
+ -- The template for a pragma Source_File_Name(_Project) for a naming
+ -- body pattern.
+
+ Config_Spec : Name_Id := No_Name;
+ -- The template for a pragma Source_File_Name(_Project) for a specific
+ -- file name of a spec.
+
+ Config_Spec_Index : Name_Id := No_Name;
+ -- The template for a pragma Source_File_Name(_Project) for a specific
+ -- file name of a spec in a multi-source file.
+
+ Config_Spec_Pattern : Name_Id := No_Name;
+ -- The template for a pragma Source_File_Name(_Project) for a naming
+ -- spec pattern.
+
+ Config_File_Unique : Boolean := False;
+ -- Indicate if the config file specified to the compiler needs to be
+ -- unique. If it is unique, then all config files are concatenated into
+ -- a temp config file.
+
+ Binder_Driver : File_Name_Type := No_File;
+ -- The name of the binder driver for the language, if any
+
+ Binder_Driver_Path : Path_Name_Type := No_Path;
+ -- The path name of the binder driver
+
+ Binder_Required_Switches : Name_List_Index := No_Name_List;
+ -- Hold the value of attribute Binder'Required_Switches for the language
+
+ Binder_Prefix : Name_Id := No_Name;
+ -- Hold the value of attribute Binder'Prefix for the language
+
+ Toolchain_Version : Name_Id := No_Name;
+ -- Hold the value of attribute Toolchain_Version for the language
+
+ Toolchain_Description : Name_Id := No_Name;
+ -- Hold the value of attribute Toolchain_Description for the language
+
+ end record;
+
+ No_Language_Config : constant Language_Config :=
+ (Kind => File_Based,
+ Naming_Data => No_Lang_Naming_Data,
+ Include_Compatible_Languages => No_Name_List,
+ Compiler_Driver => No_File,
+ Compiler_Driver_Path => null,
+ Compiler_Leading_Required_Switches => No_Name_List,
+ Compiler_Trailing_Required_Switches => No_Name_List,
+ Multi_Unit_Switches => No_Name_List,
+ Multi_Unit_Object_Separator => ' ',
+ Path_Syntax => Canonical,
+ Object_File_Suffix => No_Name,
+ Object_File_Switches => No_Name_List,
+ Compilation_PIC_Option => No_Name_List,
+ Object_Generated => True,
+ Objects_Linked => True,
+ Runtime_Library_Dir => No_Name,
+ Runtime_Source_Dir => No_Name,
+ Mapping_File_Switches => No_Name_List,
+ Mapping_Spec_Suffix => No_File,
+ Mapping_Body_Suffix => No_File,
+ Config_File_Switches => No_Name_List,
+ Dependency_Kind => None,
+ Dependency_Option => No_Name_List,
+ Compute_Dependency => No_Name_List,
+ Include_Option => No_Name_List,
+ Include_Path => No_Name,
+ Include_Path_File => No_Name,
+ Objects_Path => No_Name,
+ Objects_Path_File => No_Name,
+ Config_Body => No_Name,
+ Config_Body_Index => No_Name,
+ Config_Body_Pattern => No_Name,
+ Config_Spec => No_Name,
+ Config_Spec_Index => No_Name,
+ Config_Spec_Pattern => No_Name,
+ Config_File_Unique => False,
+ Binder_Driver => No_File,
+ Binder_Driver_Path => No_Path,
+ Binder_Required_Switches => No_Name_List,
+ Binder_Prefix => No_Name,
+ Toolchain_Version => No_Name,
+ Toolchain_Description => No_Name);
+
+ -- The following record ???
+
+ type Language_Data is record
+ Name : Name_Id := No_Name;
+ Display_Name : Name_Id := No_Name;
+ Config : Language_Config := No_Language_Config;
+ First_Source : Source_Id := No_Source;
+ Mapping_Files : Mapping_Files_Htable.Instance :=
+ Mapping_Files_Htable.Nil;
+ Next : Language_Ptr := No_Language_Index;
+ end record;
+
+ No_Language_Data : constant Language_Data :=
+ (Name => No_Name,
+ Display_Name => No_Name,
+ Config => No_Language_Config,
+ First_Source => No_Source,
+ Mapping_Files => Mapping_Files_Htable.Nil,
+ Next => No_Language_Index);
+
+ type Language_List_Element;
+ type Language_List is access all Language_List_Element;
+ type Language_List_Element is record
+ Language : Language_Ptr := No_Language_Index;
+ Next : Language_List;
+ end record;
+
+ type Source_Kind is (Spec, Impl, Sep);
+ subtype Spec_Or_Body is Source_Kind range Spec .. Impl;
+
+ -- The following declarations declare a structure used to store the Name
+ -- and File and Path names of a unit, with a reference to its GNAT Project
+ -- File(s). Some units might have neither Spec nor Impl when they were
+ -- created for a "separate".
+
+ type File_Names_Data is array (Spec_Or_Body) of Source_Id;
+
+ type Unit_Data is record
+ Name : Name_Id := No_Name;
+ File_Names : File_Names_Data;
+ end record;
+
+ type Unit_Index is access all Unit_Data;
+
+ No_Unit_Index : constant Unit_Index := null;
+ -- Used to indicate a null entry for no unit
+
+ -- Structure to define source data
+
+ type Source_Data is record
+ Project : Project_Id := No_Project;
+ -- Project of the source
+
+ Source_Dir_Rank : Natural := 0;
+ -- The rank of the source directory in list declared with attribute
+ -- Source_Dirs. Two source files with the same name cannot appears in
+ -- different directory with the same rank. That can happen when the
+ -- recursive notation <dir>/** is used in attribute Source_Dirs.
+
+ Language : Language_Ptr := No_Language_Index;
+ -- Index of the language. This is an index into
+ -- Project_Tree.Languages_Data.
+
+ In_Interfaces : Boolean := True;
+ -- False when the source is not included in interfaces, when attribute
+ -- Interfaces is declared.
+
+ Declared_In_Interfaces : Boolean := False;
+ -- True when source is declared in attribute Interfaces
+
+ Alternate_Languages : Language_List := null;
+ -- List of languages a header file may also be, in addition of language
+ -- Language_Name.
+
+ Kind : Source_Kind := Spec;
+ -- Kind of the source: spec, body or subunit
+
+ Unit : Unit_Index := No_Unit_Index;
+ -- Name of the unit, if language is unit based. This is only set for
+ -- those files that are part of the compilation set (for instance a
+ -- file in an extended project that is overridden will not have this
+ -- field set).
- Sep_Suffix_Loc : Source_Ptr := No_Location;
- -- Position in the project file source where Separate_Suffix is defined
+ Index : Int := 0;
+ -- Index of the source in a multi unit source file (the same Source_Data
+ -- is duplicated several times when there are several units in the same
+ -- file). Index is 0 if there is either no unit or a single one, and
+ -- starts at 1 when there are multiple units
- Specs : Array_Element_Id := No_Array_Element;
- -- An associative array mapping individual specs to source file names
- -- This is specific to Ada.
+ Locally_Removed : Boolean := False;
+ -- True if the source has been "excluded"
- Bodies : Array_Element_Id := No_Array_Element;
- -- An associative array mapping individual bodies to source file names
- -- This is specific to Ada.
+ Replaced_By : Source_Id := No_Source;
+ -- Missing comment ???
- Specification_Exceptions : Array_Element_Id := No_Array_Element;
- -- An associative array listing spec file names that do not have the
- -- spec suffix. Not used by Ada. Indexed by programming language name.
+ File : File_Name_Type := No_File;
+ -- Canonical file name of the source
- Implementation_Exceptions : Array_Element_Id := No_Array_Element;
- -- An associative array listing body file names that do not have the
- -- body suffix. Not used by Ada. Indexed by programming language name.
+ Display_File : File_Name_Type := No_File;
+ -- File name of the source, for display purposes
+ Path : Path_Information := No_Path_Information;
+ -- Path name of the source
+
+ Source_TS : Time_Stamp_Type := Empty_Time_Stamp;
+ -- Time stamp of the source file
+
+ Object_Project : Project_Id := No_Project;
+ -- Project where the object file is. This might be different from
+ -- Project when using extending project files.
+
+ Object : File_Name_Type := No_File;
+ -- File name of the object file
+
+ Current_Object_Path : Path_Name_Type := No_Path;
+ -- Object path of an existing object file
+
+ Object_Path : Path_Name_Type := No_Path;
+ -- Object path of the real object file
+
+ Object_TS : Time_Stamp_Type := Empty_Time_Stamp;
+ -- Object file time stamp
+
+ Dep_Name : File_Name_Type := No_File;
+ -- Dependency file simple name
+
+ Current_Dep_Path : Path_Name_Type := No_Path;
+ -- Path name of an existing dependency file
+
+ Dep_Path : Path_Name_Type := No_Path;
+ -- Path name of the real dependency file
+
+ Dep_TS : aliased Osint.File_Attributes := Osint.Unknown_Attributes;
+ -- Dependency file time stamp
+
+ Switches : File_Name_Type := No_File;
+ -- File name of the switches file. For all languages, this is a file
+ -- that ends with the .cswi extension.
+
+ Switches_Path : Path_Name_Type := No_Path;
+ -- Path name of the switches file
+
+ Switches_TS : Time_Stamp_Type := Empty_Time_Stamp;
+ -- Switches file time stamp
+
+ Naming_Exception : Boolean := False;
+ -- True if the source has an exceptional name
+
+ Next_In_Lang : Source_Id := No_Source;
+ -- Link to another source of the same language in the same project
+ end record;
+
+ No_Source_Data : constant Source_Data :=
+ (Project => No_Project,
+ Source_Dir_Rank => 0,
+ Language => No_Language_Index,
+ In_Interfaces => True,
+ Declared_In_Interfaces => False,
+ Alternate_Languages => null,
+ Kind => Spec,
+ Unit => No_Unit_Index,
+ Index => 0,
+ Locally_Removed => False,
+ Replaced_By => No_Source,
+ File => No_File,
+ Display_File => No_File,
+ Path => No_Path_Information,
+ Source_TS => Empty_Time_Stamp,
+ Object_Project => No_Project,
+ Object => No_File,
+ Current_Object_Path => No_Path,
+ Object_Path => No_Path,
+ Object_TS => Empty_Time_Stamp,
+ Dep_Name => No_File,
+ Current_Dep_Path => No_Path,
+ Dep_Path => No_Path,
+ Dep_TS => Osint.Unknown_Attributes,
+ Switches => No_File,
+ Switches_Path => No_Path,
+ Switches_TS => Empty_Time_Stamp,
+ Naming_Exception => False,
+ Next_In_Lang => No_Source);
+
+ package Source_Paths_Htable is new Simple_HTable
+ (Header_Num => Header_Num,
+ Element => Source_Id,
+ No_Element => No_Source,
+ Key => Path_Name_Type,
+ Hash => Hash,
+ Equal => "=");
+ -- Mapping of source paths to source ids
+
+ package Unit_Sources_Htable is new Simple_HTable
+ (Header_Num => Header_Num,
+ Element => Source_Id,
+ No_Element => No_Source,
+ Key => Name_Id,
+ Hash => Hash,
+ Equal => "=");
+
+ type Verbosity is (Default, Medium, High);
+ -- Verbosity when parsing GNAT Project Files
+ -- Default is default (very quiet, if no errors).
+ -- Medium is more verbose.
+ -- High is extremely verbose.
+
+ Current_Verbosity : Verbosity := Default;
+ -- The current value of the verbosity the project files are parsed with
+
+ type Lib_Kind is (Static, Dynamic, Relocatable);
+
+ type Policy is (Autonomous, Compliant, Controlled, Restricted, Direct);
+ -- Type to specify the symbol policy, when symbol control is supported.
+ -- See full explanation about this type in package Symbols.
+ -- Autonomous: Create a symbol file without considering any reference
+ -- Compliant: Try to be as compatible as possible with an existing ref
+ -- Controlled: Fail if symbols are not the same as those in the reference
+ -- Restricted: Restrict the symbols to those in the symbol file
+ -- Direct: The symbol file is used as is
+
+ type Symbol_Record is record
+ Symbol_File : Path_Name_Type := No_Path;
+ Reference : Path_Name_Type := No_Path;
+ Symbol_Policy : Policy := Autonomous;
end record;
+ -- Type to keep the symbol data to be used when building a shared library
+
+ No_Symbols : constant Symbol_Record :=
+ (Symbol_File => No_Path,
+ Reference => No_Path,
+ Symbol_Policy => Autonomous);
+ -- The default value of the symbol data
- function Standard_Naming_Data
- (Tree : Project_Tree_Ref := No_Project_Tree) return Naming_Data;
- pragma Inline (Standard_Naming_Data);
- -- The standard GNAT naming scheme when Tree is No_Project_Tree.
- -- Otherwise, return the default naming scheme for the project tree Tree,
- -- which must have been Initialized.
+ function Image (The_Casing : Casing_Type) return String;
+ -- Similar to 'Image (but avoid use of this attribute in compiler)
- function Same_Naming_Scheme
- (Left, Right : Naming_Data) return Boolean;
- -- Returns True if Left and Right are the same naming scheme
- -- not considering Specs and Bodies.
+ function Value (Image : String) return Casing_Type;
+ -- Similar to 'Value (but avoid use of this attribute in compiler)
+ -- Raises Constraint_Error if not a Casing_Type image.
- type Project_List is new Nat;
- Empty_Project_List : constant Project_List := 0;
- -- A list of project files
+ -- The following record contains data for a naming scheme
- type Project_Element is record
+ function Get_Object_Directory
+ (Project : Project_Id;
+ Including_Libraries : Boolean;
+ Only_If_Ada : Boolean := False) return Path_Name_Type;
+ -- Return the object directory to use for the project. This depends on
+ -- whether we have a library project or a standard project. This function
+ -- might return No_Name when no directory applies.
+ -- If we have a a library project file and Including_Libraries is True then
+ -- the library dir is returned instead of the object dir.
+ -- If Only_If_Ada is True, then No_Name will be returned when the project
+ -- doesn't Ada sources.
+
+ procedure Compute_All_Imported_Projects (Tree : Project_Tree_Ref);
+ -- For all projects in the tree, compute the list of the projects imported
+ -- directly or indirectly by project Project. The result is stored in
+ -- Project.All_Imported_Projects for each project
+
+ function Ultimate_Extending_Project_Of
+ (Proj : Project_Id) return Project_Id;
+ -- Returns the ultimate extending project of project Proj. If project Proj
+ -- is not extended, returns Proj.
+
+ type Project_List_Element;
+ type Project_List is access all Project_List_Element;
+ type Project_List_Element is record
Project : Project_Id := No_Project;
- Next : Project_List := Empty_Project_List;
+ Next : Project_List := null;
end record;
- -- Element in a list of project files. Next is the id of the next
- -- project file in the list.
+ -- A list of projects
- package Project_List_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Project_Element,
- Table_Index_Type => Project_List,
- Table_Low_Bound => 1,
- Table_Initial => 100,
- Table_Increment => 100);
- -- The table that contains the lists of project files
+ procedure Free_List
+ (List : in out Project_List;
+ Free_Project : Boolean);
+ -- Free the list of projects, if Free_Project, each project is also freed
+
+ type Response_File_Format is
+ (None,
+ GNU,
+ Object_List,
+ Option_List);
+ -- The format of the different response files
+
+ type Project_Configuration is record
+ Target : Name_Id := No_Name;
+ -- The target of the configuration, when specified
+
+ Run_Path_Option : Name_List_Index := No_Name_List;
+ -- The option to use when linking to specify the path where to look for
+ -- libraries.
+
+ Run_Path_Origin : Name_Id := No_Name;
+ -- Specify the string (such as "$ORIGIN") to indicate paths relative to
+ -- the directory of the executable in the run path option.
+
+ Library_Install_Name_Option : Name_Id := No_Name;
+ -- When this is not an empty list, this option, followed by the single
+ -- name of the shared library file is used when linking a shared
+ -- library.
+
+ Separate_Run_Path_Options : Boolean := False;
+ -- True if each directory needs to be specified in a separate run path
+ -- option.
+
+ Executable_Suffix : Name_Id := No_Name;
+ -- The suffix of executables, when specified in the configuration or in
+ -- package Builder of the main project. When this is not specified, the
+ -- executable suffix is the default for the platform.
+
+ -- Linking
+
+ Linker : Path_Name_Type := No_Path;
+ -- Path name of the linker driver. Specified in the configuration or in
+ -- the package Builder of the main project.
+
+ Map_File_Option : Name_Id := No_Name;
+ -- Option to use when invoking the linker to build a map file
+
+ Minimum_Linker_Options : Name_List_Index := No_Name_List;
+ -- The minimum options for the linker driver. Specified in the
+ -- configuration.
+
+ Linker_Executable_Option : Name_List_Index := No_Name_List;
+ -- The option(s) to indicate the name of the executable in the linker
+ -- command. Specified in the configuration. When not specified, default
+ -- to -o <executable name>.
+
+ Linker_Lib_Dir_Option : Name_Id := No_Name;
+ -- The option to specify where to find a library for linking. Specified
+ -- in the configuration. When not specified, defaults to "-L".
+
+ Linker_Lib_Name_Option : Name_Id := No_Name;
+ -- The option to specify the name of a library for linking. Specified in
+ -- the configuration. When not specified, defaults to "-l".
+
+ Max_Command_Line_Length : Natural := 0;
+ -- When positive and when Resp_File_Format (see below) is not None,
+ -- if the command line for the invocation of the linker would be greater
+ -- than this value, a response file is used to invoke the linker.
+
+ Resp_File_Format : Response_File_Format := None;
+ -- The format of a response file, when linking with a response file is
+ -- supported.
+
+ Resp_File_Options : Name_List_Index := No_Name_List;
+ -- The switches, if any, that precede the path name of the response
+ -- file in the invocation of the linker.
+
+ -- Libraries
+
+ Library_Builder : Path_Name_Type := No_Path;
+ -- The executable to build library (specified in the configuration)
+
+ Lib_Support : Library_Support := None;
+ -- The level of library support. Specified in the configuration. Support
+ -- is none, static libraries only or both static and shared libraries.
+
+ Archive_Builder : Name_List_Index := No_Name_List;
+ -- The name of the executable to build archives, with the minimum
+ -- switches. Specified in the configuration.
+
+ Archive_Builder_Append_Option : Name_List_Index := No_Name_List;
+ -- The options to append object files to an archive
+
+ Archive_Indexer : Name_List_Index := No_Name_List;
+ -- The name of the executable to index archives, with the minimum
+ -- switches. Specified in the configuration.
+
+ Archive_Suffix : File_Name_Type := No_File;
+ -- The suffix of archives. Specified in the configuration. When not
+ -- specified, defaults to ".a".
+
+ Lib_Partial_Linker : Name_List_Index := No_Name_List;
+
+ -- Shared libraries
+
+ Shared_Lib_Driver : File_Name_Type := No_File;
+ -- The driver to link shared libraries. Set with attribute Library_GCC.
+ -- Default to gcc.
+
+ Shared_Lib_Prefix : File_Name_Type := No_File;
+ -- Part of a shared library file name that precedes the name of the
+ -- library. Specified in the configuration. When not specified, defaults
+ -- to "lib".
+
+ Shared_Lib_Suffix : File_Name_Type := No_File;
+ -- Suffix of shared libraries, after the library name in the shared
+ -- library name. Specified in the configuration. When not specified,
+ -- default to ".so".
+
+ Shared_Lib_Min_Options : Name_List_Index := No_Name_List;
+ -- The minimum options to use when building a shared library
+
+ Lib_Version_Options : Name_List_Index := No_Name_List;
+ -- The options to use to specify a library version
+
+ Symbolic_Link_Supported : Boolean := False;
+ -- True if the platform supports symbolic link files
+
+ Lib_Maj_Min_Id_Supported : Boolean := False;
+ -- True if platform supports library major and minor options, such as
+ -- libname.so -> libname.so.2 -> libname.so.2.4
+
+ Auto_Init_Supported : Boolean := False;
+ -- True if automatic initialisation is supported for shared stand-alone
+ -- libraries.
+ end record;
+
+ Default_Project_Config : constant Project_Configuration :=
+ (Target => No_Name,
+ Run_Path_Option => No_Name_List,
+ Run_Path_Origin => No_Name,
+ Library_Install_Name_Option => No_Name,
+ Separate_Run_Path_Options => False,
+ Executable_Suffix => No_Name,
+ Linker => No_Path,
+ Map_File_Option => No_Name,
+ Minimum_Linker_Options => No_Name_List,
+ Linker_Executable_Option => No_Name_List,
+ Linker_Lib_Dir_Option => No_Name,
+ Linker_Lib_Name_Option => No_Name,
+ Library_Builder => No_Path,
+ Max_Command_Line_Length => 0,
+ Resp_File_Format => None,
+ Resp_File_Options => No_Name_List,
+ Lib_Support => None,
+ Archive_Builder => No_Name_List,
+ Archive_Builder_Append_Option => No_Name_List,
+ Archive_Indexer => No_Name_List,
+ Archive_Suffix => No_File,
+ Lib_Partial_Linker => No_Name_List,
+ Shared_Lib_Driver => No_File,
+ Shared_Lib_Prefix => No_File,
+ Shared_Lib_Suffix => No_File,
+ Shared_Lib_Min_Options => No_Name_List,
+ Lib_Version_Options => No_Name_List,
+ Symbolic_Link_Supported => False,
+ Lib_Maj_Min_Id_Supported => False,
+ Auto_Init_Supported => False);
-- The following record describes a project file representation
- type Project_Data is record
- Externally_Built : Boolean := False;
+ -- Note that it is not specified if the path names of directories (source,
+ -- object, library or exec directories) end with or without a directory
+ -- separator.
- Languages : Languages_In_Project := No_Languages;
- Supp_Languages : Supp_Language_Index := No_Supp_Language_Index;
- -- Indicate the different languages of the source of this project
+ type Project_Data is record
- First_Referred_By : Project_Id := No_Project;
- -- The project, if any, that was the first to be known as importing or
- -- extending this project. Set by Prj.Proc.Process.
+ -------------
+ -- General --
+ -------------
Name : Name_Id := No_Name;
- -- The name of the project. Set by Prj.Proc.Process
+ -- The name of the project
Display_Name : Name_Id := No_Name;
- -- The name of the project with the spelling of its declaration.
- -- Set by Prj.Proc.Process.
+ -- The name of the project with the spelling of its declaration
- Path_Name : Name_Id := No_Name;
- -- The path name of the project file. Set by Prj.Proc.Process
+ Qualifier : Project_Qualifier := Unspecified;
+ -- The eventual qualifier for this project
- Display_Path_Name : Name_Id := No_Name;
- -- The path name used for display purposes. May be different from
- -- Path_Name for platforms where the file names are case-insensitive.
+ Externally_Built : Boolean := False;
+ -- True if the project is externally built. In such case, the Project
+ -- Manager will not modify anything in this project.
+
+ Config : Project_Configuration;
+
+ Path : Path_Information := No_Path_Information;
+ -- The path name of the project file. This include base name of the
+ -- project file.
Virtual : Boolean := False;
-- True for virtual extending projects
Location : Source_Ptr := No_Location;
- -- The location in the project file source of the reserved word
- -- project. Set by Prj.Proc.Process.
+ -- The location in the project file source of the reserved word project
+
+ ---------------
+ -- Languages --
+ ---------------
+
+ Languages : Language_Ptr := No_Language_Index;
+ -- First index of the language data in the project.
+ -- This is an index into the project_tree_data.languages_data.
+ -- Traversing the list gives access to all the languages supported by
+ -- the project.
+
+ --------------
+ -- Projects --
+ --------------
Mains : String_List_Id := Nil_String;
- -- List of mains specified by attribute Main. Set by Prj.Nmsc.Check
+ -- List of mains specified by attribute Main
- Directory : Name_Id := No_Name;
- -- Directory where the project file resides. Set by Prj.Proc.Process
+ Extends : Project_Id := No_Project;
+ -- The reference of the project file, if any, that this project file
+ -- extends.
- Display_Directory : Name_Id := No_Name;
- -- comment ???
+ Extended_By : Project_Id := No_Project;
+ -- The reference of the project file, if any, that extends this project
+ -- file.
- Dir_Path : String_Access;
- -- Same as Directory, but as an access to String. Set by
- -- Make.Compile_Sources.Collect_Arguments_And_Compile.
+ Decl : Declarations := No_Declarations;
+ -- The declarations (variables, attributes and packages) of this project
+ -- file.
- Library : Boolean := False;
- -- True if this is a library project. Set by
- -- Prj.Nmsc.Language_Independent_Check.
+ Imported_Projects : Project_List;
+ -- The list of all directly imported projects, if any
- Library_Dir : Name_Id := No_Name;
- -- If a library project, directory where resides the library Set by
- -- Prj.Nmsc.Language_Independent_Check.
+ All_Imported_Projects : Project_List;
+ -- The list of all projects imported directly or indirectly, if any.
+ -- This does not include the project itself.
- Display_Library_Dir : Name_Id := No_Name;
- -- The name of the library directory, for display purposes. May be
- -- different from Library_Dir for platforms where the file names are
- -- case-insensitive.
+ -----------------
+ -- Directories --
+ -----------------
- Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
- -- The timestamp of a library file in a library project.
- -- Set by MLib.Prj.Check_Library.
-
- Library_Src_Dir : Name_Id := No_Name;
- -- If a Stand-Alone Library project, directory where the sources
- -- of the interfaces of the library are copied. By default, if
- -- attribute Library_Src_Dir is not specified, sources of the interfaces
- -- are not copied anywhere. Set by Prj.Nmsc.Check_Stand_Alone_Library.
-
- Display_Library_Src_Dir : Name_Id := No_Name;
- -- The name of the library source directory, for display purposes.
- -- May be different from Library_Src_Dir for platforms where the file
- -- names are case-insensitive.
-
- Library_ALI_Dir : Name_Id := No_Name;
- -- In a library project, directory where the ALI files are copied.
- -- If attribute Library_ALI_Dir is not specified, ALI files are
- -- copied in the Library_Dir. Set by Prj.Nmsc.Check_Library_Attributes.
-
- Display_Library_ALI_Dir : Name_Id := No_Name;
- -- The name of the library ALI directory, for display purposes. May be
- -- different from Library_ALI_Dir for platforms where the file names are
- -- case-insensitive.
+ Directory : Path_Information := No_Path_Information;
+ -- Path name of the directory where the project file resides
+
+ Object_Directory : Path_Information := No_Path_Information;
+ -- The path name of the object directory of this project file
+
+ Exec_Directory : Path_Information := No_Path_Information;
+ -- The path name of the exec directory of this project file. Default is
+ -- equal to Object_Directory.
+
+ -------------
+ -- Library --
+ -------------
+
+ Library : Boolean := False;
+ -- True if this is a library project
Library_Name : Name_Id := No_Name;
-- If a library project, name of the library
- -- Set by Prj.Nmsc.Language_Independent_Check.
Library_Kind : Lib_Kind := Static;
-- If a library project, kind of library
- -- Set by Prj.Nmsc.Language_Independent_Check.
+
+ Library_Dir : Path_Information := No_Path_Information;
+ -- If a library project, path name of the directory where the library
+ -- resides.
+
+ Library_TS : Time_Stamp_Type := Empty_Time_Stamp;
+ -- The timestamp of a library file in a library project
+
+ Library_Src_Dir : Path_Information := No_Path_Information;
+ -- If a Stand-Alone Library project, path name of the directory where
+ -- the sources of the interfaces of the library are copied. By default,
+ -- if attribute Library_Src_Dir is not specified, sources of the
+ -- interfaces are not copied anywhere.
+
+ Library_ALI_Dir : Path_Information := No_Path_Information;
+ -- In a library project, path name of the directory where the ALI files
+ -- are copied. If attribute Library_ALI_Dir is not specified, ALI files
+ -- are copied in the Library_Dir.
Lib_Internal_Name : Name_Id := No_Name;
- -- If a library project, internal name store inside the library Set by
- -- Prj.Nmsc.Language_Independent_Check.
+ -- If a library project, internal name store inside the library
Standalone_Library : Boolean := False;
- -- Indicate that this is a Standalone Library Project File. Set by
- -- Prj.Nmsc.Check.
+ -- Indicate that this is a Standalone Library Project File
Lib_Interface_ALIs : String_List_Id := Nil_String;
-- For Standalone Library Project Files, indicate the list of Interface
- -- ALI files. Set by Prj.Nmsc.Check.
+ -- ALI files.
Lib_Auto_Init : Boolean := False;
- -- For non static Standalone Library Project Files, indicate if
+ -- For non static Stand-Alone Library Project Files, indicate if
-- the library initialisation should be automatic.
Symbol_Data : Symbol_Record := No_Symbols;
-- Symbol file name, reference symbol file name, symbol policy
- Ada_Sources_Present : Boolean := True;
- -- A flag that indicates if there are Ada sources in this project file.
- -- There are no sources if any of the following is true:
- -- 1) Source_Dirs is specified as an empty list
- -- 2) Source_Files is specified as an empty list
- -- 3) Ada is not in the list of the specified Languages
-
- Other_Sources_Present : Boolean := True;
- -- A flag that indicates that there are non-Ada sources in this project
-
- Sources : String_List_Id := Nil_String;
- -- The list of all the source file names.
- -- Set by Prj.Nmsc.Check_Ada_Naming_Scheme.
-
- First_Other_Source : Other_Source_Id := No_Other_Source;
- Last_Other_Source : Other_Source_Id := No_Other_Source;
- -- Head and tail of the list of sources of languages other than Ada
+ Need_To_Build_Lib : Boolean := False;
+ -- Indicates that the library of a Library Project needs to be built or
+ -- rebuilt.
- Imported_Directories_Switches : Argument_List_Access := null;
- -- List of the -I switches to be used when compiling sources of
- -- languages other than Ada.
+ -------------
+ -- Sources --
+ -------------
+ -- The sources for all languages including Ada are accessible through
+ -- the Source_Iterator type
- Include_Path : String_Access := null;
- -- Value to be used as CPATH, when using a GCC, instead of a list of
- -- -I switches.
+ Interfaces_Defined : Boolean := False;
+ -- True if attribute Interfaces is declared for the project or any
+ -- project it extends.
- Include_Data_Set : Boolean := False;
- -- Set True when Imported_Directories_Switches or Include_Path are set
+ Include_Path_File : Path_Name_Type := No_Path;
+ -- The path name of the of the source search directory file.
+ -- This is only used by gnatmake
Source_Dirs : String_List_Id := Nil_String;
- -- The list of all the source directories.
- -- Set by Prj.Nmsc.Language_Independent_Check.
-
- Known_Order_Of_Source_Dirs : Boolean := True;
- -- False, if there is any /** in the Source_Dirs, because in this case
- -- the ordering of the source subdirs depend on the OS. If True,
- -- duplicate file names in the same project file are allowed.
-
- Object_Directory : Name_Id := No_Name;
- -- The object directory of this project file.
- -- Set by Prj.Nmsc.Language_Independent_Check.
-
- Display_Object_Dir : Name_Id := No_Name;
- -- The name of the object directory, for display purposes.
- -- May be different from Object_Directory for platforms where the file
- -- names are case-insensitive.
-
- Exec_Directory : Name_Id := No_Name;
- -- The exec directory of this project file. Default is equal to
- -- Object_Directory. Set by Prj.Nmsc.Language_Independent_Check.
-
- Display_Exec_Dir : Name_Id := No_Name;
- -- The name of the exec directory, for display purposes. May be
- -- different from Exec_Directory for platforms where the file names are
- -- case-insensitive.
-
- Extends : Project_Id := No_Project;
- -- The reference of the project file, if any, that this project file
- -- extends. Set by Prj.Proc.Process.
-
- Extended_By : Project_Id := No_Project;
- -- The reference of the project file, if any, that extends this project
- -- file. Set by Prj.Proc.Process.
+ -- The list of all the source directories
- Naming : Naming_Data := Standard_Naming_Data;
- -- The naming scheme of this project file.
- -- Set by Prj.Nmsc.Check_Naming_Scheme.
+ Source_Dir_Ranks : Number_List_Index := No_Number_List;
- First_Language_Processing : First_Language_Processing_Data :=
- Default_First_Language_Processing_Data;
- -- Comment needed ???
-
- Supp_Language_Processing : Supp_Language_Index := No_Supp_Language_Index;
- -- Comment needed
-
- Default_Linker : Name_Id := No_Name;
- Default_Linker_Path : Name_Id := No_Name;
-
- Decl : Declarations := No_Declarations;
- -- The declarations (variables, attributes and packages) of this
- -- project file. Set by Prj.Proc.Process.
-
- Imported_Projects : Project_List := Empty_Project_List;
- -- The list of all directly imported projects, if any. Set by
- -- Prj.Proc.Process.
+ Ada_Include_Path : String_Access := null;
+ -- The cached value of source search path for this project file. Set by
+ -- the first call to Prj.Env.Ada_Include_Path for the project. Do not
+ -- use this field directly outside of the project manager, use
+ -- Prj.Env.Ada_Include_Path instead.
- All_Imported_Projects : Project_List := Empty_Project_List;
- -- The list of all projects imported directly or indirectly, if any.
- -- Set by Make.Initialize.
+ Has_Multi_Unit_Sources : Boolean := False;
+ -- Whether there is at least one source file containing multiple units
- Ada_Include_Path : String_Access := null;
- -- The cached value of ADA_INCLUDE_PATH for this project file. Do not
- -- use this field directly outside of the compiler, use
- -- Prj.Env.Ada_Include_Path instead. Set by Prj.Env.Ada_Include_Path.
+ -------------------
+ -- Miscellaneous --
+ -------------------
Ada_Objects_Path : String_Access := null;
-- The cached value of ADA_OBJECTS_PATH for this project file. Do not
-- use this field directly outside of the compiler, use
- -- Prj.Env.Ada_Objects_Path instead. Set by Prj.Env.Ada_Objects_Path
+ -- Prj.Env.Ada_Objects_Path instead.
- Include_Path_File : Name_Id := No_Name;
- -- The cached value of the source path temp file for this project file.
- -- Set by gnatmake (Prj.Env.Set_Ada_Paths).
+ Libgnarl_Needed : Yes_No_Unknown := Unknown;
+ -- Set to True when libgnarl is needed to link
+
+ Objects_Path : String_Access := null;
+ -- The cached value of the object dir path, used during the binding
+ -- phase of gprbuild.
- Objects_Path_File_With_Libs : Name_Id := No_Name;
+ Objects_Path_File_With_Libs : Path_Name_Type := No_Path;
-- The cached value of the object path temp file (including library
- -- dirs) for this project file. Set by gnatmake (Prj.Env.Set_Ada_Paths).
+ -- dirs) for this project file.
- Objects_Path_File_Without_Libs : Name_Id := No_Name;
+ Objects_Path_File_Without_Libs : Path_Name_Type := No_Path;
-- The cached value of the object path temp file (excluding library
- -- dirs) for this project file. Set by gnatmake (Prj.Env.Set_Ada_Paths).
+ -- dirs) for this project file.
- Config_File_Name : Name_Id := No_Name;
- -- The name of the configuration pragmas file, if any.
- -- Set by gnatmake (Prj.Env.Create_Config_Pragmas_File).
+ Config_File_Name : Path_Name_Type := No_Path;
+ -- The path name of the configuration pragmas file, if any
Config_File_Temp : Boolean := False;
- -- An indication that the configuration pragmas file is
- -- a temporary file that must be deleted at the end.
- -- Set by gnatmake (Prj.Env.Create_Config_Pragmas_File).
+ -- An indication that the configuration pragmas file is a temporary file
+ -- that must be deleted at the end.
Config_Checked : Boolean := False;
- -- A flag to avoid checking repetitively the configuration pragmas file.
- -- Set by gnatmake (Prj.Env.Create_Config_Pragmas_File).
-
- Language_Independent_Checked : Boolean := False;
- -- A flag that indicates that the project file has been checked
- -- for language independent features: Object_Directory,
- -- Source_Directories, Library, non empty Naming Suffixes.
-
- Checked : Boolean := False;
- -- A flag to avoid checking repetitively the naming scheme of
- -- this project file. Set by Prj.Nmsc.Check_Ada_Naming_Scheme.
-
- Seen : Boolean := False;
- -- A flag to mark a project as "visited" to avoid processing the same
- -- project several time.
-
- Need_To_Build_Lib : Boolean := False;
- -- Indicates that the library of a Library Project needs to be built or
- -- rebuilt.
+ -- A flag to avoid checking repetitively the configuration pragmas file
Depth : Natural := 0;
- -- The maximum depth of a project in the project graph.
- -- Depth of main project is 0.
+ -- The maximum depth of a project in the project graph. Depth of main
+ -- project is 0.
Unkept_Comments : Boolean := False;
- -- True if there are comments in the project sources that cannot
- -- be kept in the project tree.
+ -- True if there are comments in the project sources that cannot be kept
+ -- in the project tree.
end record;
- function Empty_Project (Tree : Project_Tree_Ref) return Project_Data;
- -- Return the representation of an empty project in project Tree tree.
- -- The project tree Tree must have been Initialized and/or Reset.
+ function Empty_Project return Project_Data;
+ -- Return the representation of an empty project
- Project_Error : exception;
- -- Raised by some subprograms in Prj.Attr
+ function Is_Extending
+ (Extending : Project_Id;
+ Extended : Project_Id) return Boolean;
+ -- Return True if Extending is extending the Extended project
- package Project_Table is new GNAT.Dynamic_Tables (
- Table_Component_Type => Project_Data,
- Table_Index_Type => Project_Id,
- Table_Low_Bound => 1,
- Table_Initial => 100,
- Table_Increment => 100);
- -- The set of all project files
-
- type Spec_Or_Body is
- (Specification, Body_Part);
-
- type File_Name_Data is record
- Name : Name_Id := No_Name;
- Index : Int := 0;
- Display_Name : Name_Id := No_Name;
- Path : Name_Id := No_Name;
- Display_Path : Name_Id := No_Name;
- Project : Project_Id := No_Project;
- Needs_Pragma : Boolean := False;
- end record;
- -- File and Path name of a spec or body
+ function Has_Ada_Sources (Data : Project_Id) return Boolean;
+ -- Return True if the project has Ada sources
- type File_Names_Data is array (Spec_Or_Body) of File_Name_Data;
-
- type Unit_Id is new Nat;
- No_Unit : constant Unit_Id := 0;
- type Unit_Data is record
- Name : Name_Id := No_Name;
- File_Names : File_Names_Data;
- end record;
- -- Name and File and Path names of a unit, with a reference to its
- -- GNAT Project File(s).
-
- package Unit_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Unit_Data,
- Table_Index_Type => Unit_Id,
- Table_Low_Bound => 1,
- Table_Initial => 100,
- Table_Increment => 100);
- -- Table of all units in a project tree
+ Project_Error : exception;
+ -- Raised by some subprograms in Prj.Attr
package Units_Htable is new Simple_HTable
(Header_Num => Header_Num,
- Element => Unit_Id,
- No_Element => No_Unit,
+ Element => Unit_Index,
+ No_Element => No_Unit_Index,
Key => Name_Id,
Hash => Hash,
Equal => "=");
-- Mapping of unit names to indexes in the Units table
- type Unit_Project is record
- Unit : Unit_Id := No_Unit;
- Project : Project_Id := No_Project;
- end record;
+ ---------------------
+ -- Source_Iterator --
+ ---------------------
- No_Unit_Project : constant Unit_Project := (No_Unit, No_Project);
+ type Source_Iterator is private;
- package Files_Htable is new Simple_HTable
- (Header_Num => Header_Num,
- Element => Unit_Project,
- No_Element => No_Unit_Project,
- Key => Name_Id,
- Hash => Hash,
- Equal => "=");
- -- Mapping of file names to indexes in the Units table
+ function For_Each_Source
+ (In_Tree : Project_Tree_Ref;
+ Project : Project_Id := No_Project;
+ Language : Name_Id := No_Name) return Source_Iterator;
+ -- Returns an iterator for all the sources of a project tree, or a specific
+ -- project, or a specific language.
+
+ function Element (Iter : Source_Iterator) return Source_Id;
+ -- Return the current source (or No_Source if there are no more sources)
+
+ procedure Next (Iter : in out Source_Iterator);
+ -- Move on to the next source
+
+ function Find_Source
+ (In_Tree : Project_Tree_Ref;
+ Project : Project_Id;
+ In_Imported_Only : Boolean := False;
+ In_Extended_Only : Boolean := False;
+ Base_Name : File_Name_Type) return Source_Id;
+ -- Find the first source file with the given name either in the whole tree
+ -- (if In_Imported_Only is False) or in the projects imported or extended
+ -- by Project otherwise. In_Extended_Only implies In_Imported_Only, and
+ -- will only look in Project and the projects it extends
+
+ -----------------------
+ -- Project_Tree_Data --
+ -----------------------
type Private_Project_Tree_Data is private;
-- Data for a project tree that is used only by the Project Manager
type Project_Tree_Data is
record
- Present_Languages : Present_Language_Table.Instance;
- Supp_Suffixes : Supp_Suffix_Table.Instance;
Name_Lists : Name_List_Table.Instance;
- Supp_Languages : Supp_Language_Table.Instance;
- Other_Sources : Other_Source_Table.Instance;
+ Number_Lists : Number_List_Table.Instance;
String_Elements : String_Element_Table.Instance;
Variable_Elements : Variable_Element_Table.Instance;
Array_Elements : Array_Element_Table.Instance;
Arrays : Array_Table.Instance;
Packages : Package_Table.Instance;
- Project_Lists : Project_List_Table.Instance;
- Projects : Project_Table.Instance;
- Units : Unit_Table.Instance;
+ Projects : Project_List;
+
Units_HT : Units_Htable.Instance;
- Files_HT : Files_Htable.Instance;
+ -- Unit name to Unit_Index (and from there so Source_Id)
+
+ Source_Paths_HT : Source_Paths_Htable.Instance;
+ -- Full path to Source_Id
+
Private_Part : Private_Project_Tree_Data;
end record;
-- Data for a project tree
- type Put_Line_Access is access procedure
- (Line : String;
- Project : Project_Id;
- In_Tree : Project_Tree_Ref);
- -- Use to customize error reporting in Prj.Proc and Prj.Nmsc
-
procedure Expect (The_Token : Token_Type; Token_Image : String);
- -- Check that the current token is The_Token. If it is not, then
- -- output an error message.
+ -- Check that the current token is The_Token. If it is not, then output
+ -- an error message.
procedure Initialize (Tree : Project_Tree_Ref);
-- This procedure must be called before using any services from the Prj
-- This procedure resets all the tables that are used when processing a
-- project file tree. Initialize must be called before the call to Reset.
- procedure Register_Default_Naming_Scheme
- (Language : Name_Id;
- Default_Spec_Suffix : Name_Id;
- Default_Body_Suffix : Name_Id;
- In_Tree : Project_Tree_Ref);
- -- Register the default suffixes for a given language. These extensions
- -- will be ignored if the user has specified a new naming scheme in a
- -- project file.
- --
- -- Otherwise, this information will be automatically added to Naming_Data
- -- when a project is processed, in the lists Spec_Suffix and Body_Suffix.
+ package Project_Boolean_Htable is new Simple_HTable
+ (Header_Num => Header_Num,
+ Element => Boolean,
+ No_Element => False,
+ Key => Project_Id,
+ Hash => Hash,
+ Equal => "=");
+ -- A table that associates a project to a boolean. This is used to detect
+ -- whether a project was already processed for instance.
generic
type State is limited private;
(Project : Project_Id;
With_State : in out State);
procedure For_Every_Project_Imported
- (By : Project_Id;
- In_Tree : Project_Tree_Ref;
- With_State : in out State);
+ (By : Project_Id;
+ With_State : in out State;
+ Imported_First : Boolean := False);
-- Call Action for each project imported directly or indirectly by project
- -- By. Action is called according to the order of importation: if A
+ -- By, as well as extended projects.
+ -- The order of processing depends on Imported_First:
+ -- If False, Action is called according to the order of importation: if A
-- imports B, directly or indirectly, Action will be called for A before
-- it is called for B. If two projects import each other directly or
-- indirectly (using at least one "limited with"), it is not specified
- -- for which of these two projects Action will be called first. Projects
- -- that are extended by other projects are not considered. With_State may
- -- be used by Action to choose a behavior or to report some global result.
-
- ----------------------------------------------------------
- -- Other multi-language stuff that may be modified soon --
- ----------------------------------------------------------
-
- function Is_Present
- (Language : Language_Index;
- In_Project : Project_Data;
- In_Tree : Project_Tree_Ref) return Boolean;
- -- Return True when Language is one of the languages used in
- -- project In_Project.
-
- procedure Set
- (Language : Language_Index;
- Present : Boolean;
- In_Project : in out Project_Data;
- In_Tree : Project_Tree_Ref);
- -- Indicate if Language is or not a language used in project In_Project
-
- function Language_Processing_Data_Of
- (Language : Language_Index;
- In_Project : Project_Data;
- In_Tree : Project_Tree_Ref) return Language_Processing_Data;
- -- Return the Language_Processing_Data for language Language in project
- -- In_Project. Return the default when no Language_Processing_Data are
- -- defined for the language.
-
- procedure Set
- (Language_Processing : Language_Processing_Data;
- For_Language : Language_Index;
- In_Project : in out Project_Data;
- In_Tree : Project_Tree_Ref);
- -- Set the Language_Processing_Data for language Language in project
- -- In_Project.
-
- function Suffix_Of
- (Language : Language_Index;
- In_Project : Project_Data;
- In_Tree : Project_Tree_Ref) return Name_Id;
- -- Return the suffix for language Language in project In_Project. Return
- -- No_Name when no suffix is defined for the language.
-
- procedure Set
- (Suffix : Name_Id;
- For_Language : Language_Index;
- In_Project : in out Project_Data;
- In_Tree : Project_Tree_Ref);
- -- Set the suffix for language Language in project In_Project
+ -- for which of these two projects Action will be called first.
+ -- The order is reversed if Imported_First is True.
+ -- With_State may be used by Action to choose a behavior or to report some
+ -- global result.
+
+ function Extend_Name
+ (File : File_Name_Type;
+ With_Suffix : String) return File_Name_Type;
+ -- Replace the extension of File with With_Suffix
+
+ function Object_Name
+ (Source_File_Name : File_Name_Type;
+ Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
+ -- Returns the object file name corresponding to a source file name
+
+ function Object_Name
+ (Source_File_Name : File_Name_Type;
+ Source_Index : Int;
+ Index_Separator : Character;
+ Object_File_Suffix : Name_Id := No_Name) return File_Name_Type;
+ -- Returns the object file name corresponding to a unit in a multi-source
+ -- file.
+
+ function Dependency_Name
+ (Source_File_Name : File_Name_Type;
+ Dependency : Dependency_File_Kind) return File_Name_Type;
+ -- Returns the dependency file name corresponding to a source file name
+
+ function Switches_Name
+ (Source_File_Name : File_Name_Type) return File_Name_Type;
+ -- Returns the switches file name corresponding to a source file name
+
+ -----------
+ -- Flags --
+ -----------
+
+ type Processing_Flags is private;
+ -- Flags used while parsing and processing a project tree to configure the
+ -- behavior of the parser, and indicate how to report error messages. This
+ -- structure does not allocate memory and never needs to be freed
+
+ type Error_Warning is (Silent, Warning, Error);
+ -- Severity of some situations, such as: no Ada sources in a project where
+ -- Ada is one of the language.
+ --
+ -- When the situation occurs, the behaviour depends on the setting:
+ --
+ -- - Silent: no action
+ -- - Warning: issue a warning, does not cause the tool to fail
+ -- - Error: issue an error, causes the tool to fail
+
+ type Error_Handler is access procedure
+ (Project : Project_Id;
+ Is_Warning : Boolean);
+ -- This warngs when an error was found when parsing a project. The error
+ -- itself is handled through Prj.Err (and Prj.Err.Finalize should be called
+ -- to actually print the error). This ensures that duplicate error messages
+ -- are always correctly removed, that errors msgs are sorted, and that all
+ -- tools will report the same error to the user.
+
+ function Create_Flags
+ (Report_Error : Error_Handler;
+ When_No_Sources : Error_Warning;
+ Require_Sources_Other_Lang : Boolean := True;
+ Allow_Duplicate_Basenames : Boolean := True;
+ Compiler_Driver_Mandatory : Boolean := False;
+ Error_On_Unknown_Language : Boolean := True;
+ Require_Obj_Dirs : Error_Warning := Error)
+ return Processing_Flags;
+ -- Function used to create Processing_Flags structure
+ --
+ -- If Allow_Duplicate_Basenames, then files with the same base names are
+ -- authorized within a project for source-based languages (never for unit
+ -- based languages).
+ --
+ -- If Compiler_Driver_Mandatory is true, then a Compiler.Driver attribute
+ -- for each language must be defined, or we will not look for its source
+ -- files.
+ --
+ -- When_No_Sources indicates what should be done when no sources of a
+ -- language are found in a project where this language is declared.
+ -- If Require_Sources_Other_Lang is true, then all languages must have at
+ -- least one source file, or an error is reported via When_No_Sources. If
+ -- it is false, this is only required for Ada (and only if it is a language
+ -- of the project). When this parameter is set to False, we do not check
+ -- that a proper naming scheme is defined for languages other than Ada.
+ --
+ -- If Report_Error is null, use the standard error reporting mechanism
+ -- (Errout). Otherwise, report errors using Report_Error.
+ --
+ -- If Error_On_Unknown_Language is true, an error is displayed if some of
+ -- the source files listed in the project do not match any naming scheme
+ --
+ -- If Require_Obj_Dirs is true, then all object directories must exist
+ -- (possibly after they have been created automatically if the appropriate
+ -- switches were specified), or an error is raised.
+
+ Gprbuild_Flags : constant Processing_Flags;
+ Gprclean_Flags : constant Processing_Flags;
+ Gnatmake_Flags : constant Processing_Flags;
+ -- Flags used by the various tools. They all display the error messages
+ -- through Prj.Err.
+
+ ----------------
+ -- Temp Files --
+ ----------------
+
+ procedure Record_Temp_File
+ (Tree : Project_Tree_Ref;
+ Path : Path_Name_Type);
+ -- Record the path of a newly created temporary file, so that it can be
+ -- deleted later.
+
+ procedure Delete_All_Temp_Files (Tree : Project_Tree_Ref);
+ -- Delete all recorded temporary files.
+ -- Does nothing if Debug.Debug_Flag_N is set
+
+ procedure Delete_Temporary_File
+ (Tree : Project_Tree_Ref;
+ Path : Path_Name_Type);
+ -- Delete a temporary file from the disk. The file is also removed from the
+ -- list of temporary files to delete at the end of the program, in case
+ -- another program running on the same machine has recreated it.
+ -- Does nothing if Debug.Debug_Flag_N is set
private
Ignored : constant Variable_Kind := Single;
Nil_Variable_Value : constant Variable_Value :=
- (Project => No_Project,
- Kind => Undefined,
- Location => No_Location,
- Default => False);
+ (Project => No_Project,
+ Kind => Undefined,
+ Location => No_Location,
+ Default => False);
Virtual_Prefix : constant String := "v$";
-- The prefix for virtual extending projects. Because of the '$', which is
-- normally forbidden for project names, there cannot be any name clash.
- Empty_Name : Name_Id;
- -- Name_Id for an empty name (no characters). Initialized by the call
- -- to procedure Initialize.
+ type Source_Iterator is record
+ In_Tree : Project_Tree_Ref;
+
+ Project : Project_List;
+ All_Projects : Boolean;
+ -- Current project and whether we should move on to the next
+
+ Language : Language_Ptr;
+ -- Current language processed
+
+ Language_Name : Name_Id;
+ -- Only sources of this language will be returned (or all if No_Name)
+
+ Current : Source_Id;
+ end record;
procedure Add_To_Buffer
(S : String;
Last : in out Natural);
-- Append a String to the Buffer
- type Naming_Id is new Nat;
-
- package Naming_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Naming_Data,
- Table_Index_Type => Naming_Id,
+ package Temp_Files_Table is new GNAT.Dynamic_Tables
+ (Table_Component_Type => Path_Name_Type,
+ Table_Index_Type => Integer,
Table_Low_Bound => 1,
- Table_Initial => 5,
- Table_Increment => 100);
- -- Comment ???
+ Table_Initial => 10,
+ Table_Increment => 10);
+ -- Table to store the path name of all the created temporary files, so that
+ -- they can be deleted at the end, or when the program is interrupted.
- package Path_File_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Name_Id,
- Table_Index_Type => Natural,
- Table_Low_Bound => 1,
- Table_Initial => 50,
- Table_Increment => 100);
- -- Table storing all the temp path file names.
- -- Used by Delete_All_Path_Files.
+ type Private_Project_Tree_Data is record
+ Temp_Files : Temp_Files_Table.Instance;
+ -- Temporary files created as part of running tools (pragma files,
+ -- mapping files,...)
+
+ Current_Source_Path_File : Path_Name_Type := No_Path;
+ -- Current value of project source path file env var. Used to avoid
+ -- setting the env var to the same value. When different from No_Path,
+ -- this indicates that logical names (VMS) or environment variables were
+ -- created and should be deassigned to avoid polluting the environment
+ -- on VMS.
+ -- gnatmake only
+
+ Current_Object_Path_File : Path_Name_Type := No_Path;
+ -- Current value of project object path file env var. Used to avoid
+ -- setting the env var to the same value.
+ -- gnatmake only
- package Source_Path_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Name_Id,
- Table_Index_Type => Natural,
- Table_Low_Bound => 1,
- Table_Initial => 50,
- Table_Increment => 100);
- -- A table to store the source dirs before creating the source path file
+ end record;
+ -- Type to represent the part of a project tree which is private to the
+ -- Project Manager.
+
+ type Processing_Flags is record
+ Require_Sources_Other_Lang : Boolean;
+ Report_Error : Error_Handler;
+ When_No_Sources : Error_Warning;
+ Allow_Duplicate_Basenames : Boolean;
+ Compiler_Driver_Mandatory : Boolean;
+ Error_On_Unknown_Language : Boolean;
+ Require_Obj_Dirs : Error_Warning;
+ end record;
- package Object_Path_Table is new GNAT.Dynamic_Tables
- (Table_Component_Type => Name_Id,
- Table_Index_Type => Natural,
- Table_Low_Bound => 1,
- Table_Initial => 50,
- Table_Increment => 100);
- -- A table to store the object dirs, before creating the object path file
+ Gprbuild_Flags : constant Processing_Flags :=
+ (Report_Error => null,
+ When_No_Sources => Warning,
+ Require_Sources_Other_Lang => True,
+ Allow_Duplicate_Basenames => False,
+ Compiler_Driver_Mandatory => True,
+ Error_On_Unknown_Language => True,
+ Require_Obj_Dirs => Error);
+
+ Gprclean_Flags : constant Processing_Flags :=
+ (Report_Error => null,
+ When_No_Sources => Warning,
+ Require_Sources_Other_Lang => True,
+ Allow_Duplicate_Basenames => False,
+ Compiler_Driver_Mandatory => True,
+ Error_On_Unknown_Language => True,
+ Require_Obj_Dirs => Warning);
+
+ Gnatmake_Flags : constant Processing_Flags :=
+ (Report_Error => null,
+ When_No_Sources => Error,
+ Require_Sources_Other_Lang => False,
+ Allow_Duplicate_Basenames => False,
+ Compiler_Driver_Mandatory => False,
+ Error_On_Unknown_Language => False,
+ Require_Obj_Dirs => Error);
- type Private_Project_Tree_Data is record
- Namings : Naming_Table.Instance;
- Path_Files : Path_File_Table.Instance;
- Source_Paths : Source_Path_Table.Instance;
- Object_Paths : Object_Path_Table.Instance;
- Default_Naming : Naming_Data;
- end record;
- -- Comment ???
end Prj;