| ------------------------------------------------------------------------------ |
| -- -- |
| -- GNAT COMPILER COMPONENTS -- |
| -- -- |
| -- P R J -- |
| -- -- |
| -- S p e c -- |
| -- -- |
| -- Copyright (C) 2001-2003 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- -- |
| -- 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, 59 Temple Place - Suite 330, Boston, -- |
| -- MA 02111-1307, USA. -- |
| -- -- |
| -- GNAT was originally developed by the GNAT team at New York University. -- |
| -- Extensive contributions were provided by Ada Core Technologies Inc. -- |
| -- -- |
| ------------------------------------------------------------------------------ |
| |
| -- The following package declares the data types for GNAT project. |
| -- These data types may be used by GNAT Project-aware tools. |
| |
| -- Children of these package implements various services on these data types. |
| -- See in particular Prj.Pars and Prj.Env. |
| |
| with Casing; use Casing; |
| with Scans; use Scans; |
| with Table; |
| with Types; use Types; |
| |
| with GNAT.OS_Lib; use GNAT.OS_Lib; |
| |
| package Prj is |
| |
| Empty_Name : Name_Id; |
| -- Name_Id for an empty name (no characters). |
| -- Initialized by procedure Initialize. |
| |
| All_Packages : constant String_List_Access := null; |
| -- Default value of parameter Packages of procedures Parse, in Prj.Pars and |
| -- Prj.Part, indicating that all packages should be checked. |
| |
| 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. |
| |
| 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. |
| |
| Default_Ada_Spec_Suffix : Name_Id; |
| -- The Name_Id for the standard GNAT suffix for Ada spec source file |
| -- name ".ads". Initialized by Prj.Initialize. |
| |
| Default_Ada_Body_Suffix : Name_Id; |
| -- The Name_Id for the standard GNAT suffix for Ada body source file |
| -- name ".adb". Initialized by Prj.Initialize. |
| |
| Slash : Name_Id; |
| -- "/", used as the path of locally removed files |
| |
| 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. |
| |
| type Lib_Kind is (Static, Dynamic, Relocatable); |
| |
| type Policy is (Autonomous, Compliant, Controlled); |
| -- See explaination about this type in package Symbol |
| |
| type Symbol_Record is record |
| Symbol_File : Name_Id := No_Name; |
| Reference : Name_Id := No_Name; |
| Symbol_Policy : Policy := Autonomous; |
| end record; |
| -- Type to keep the symbol data to be used when building a shared library |
| |
| No_Symbols : Symbol_Record := |
| (Symbol_File => No_Name, |
| Reference => No_Name, |
| Symbol_Policy => Autonomous); |
| |
| function Empty_String return Name_Id; |
| |
| type Project_Id is new Nat; |
| No_Project : constant Project_Id := 0; |
| -- Id of a Project File |
| |
| type String_List_Id is new Nat; |
| Nil_String : constant String_List_Id := 0; |
| type String_Element is record |
| Value : Name_Id := No_Name; |
| Display_Value : Name_Id := No_Name; |
| Location : Source_Ptr := No_Location; |
| Flag : Boolean := False; |
| Next : String_List_Id := Nil_String; |
| end record; |
| -- To hold values for string list variables and array elements. |
| -- Component Flag may be used for various purposes. For source |
| -- directories, it indicates if the directory contains Ada source(s). |
| |
| package String_Elements is new Table.Table |
| (Table_Component_Type => String_Element, |
| Table_Index_Type => String_List_Id, |
| Table_Low_Bound => 1, |
| Table_Initial => 200, |
| Table_Increment => 100, |
| Table_Name => "Prj.String_Elements"); |
| -- The table for string elements in string lists |
| |
| type Variable_Kind is (Undefined, List, Single); |
| -- Different kinds of variables |
| |
| Ignored : constant Variable_Kind := Single; |
| -- Used to indicate that a package declaration must be ignored |
| -- while processing the project tree (unknown package name). |
| |
| type Variable_Value (Kind : Variable_Kind := Undefined) is record |
| Project : Project_Id := No_Project; |
| Location : Source_Ptr := No_Location; |
| Default : Boolean := False; |
| case Kind is |
| when Undefined => |
| null; |
| when List => |
| Values : String_List_Id := Nil_String; |
| when Single => |
| Value : Name_Id := No_Name; |
| end case; |
| end record; |
| -- Values for variables and array elements. |
| -- Default is True if the current value is the default one for the variable |
| |
| Nil_Variable_Value : constant Variable_Value := |
| (Project => No_Project, |
| Kind => Undefined, |
| Location => No_Location, |
| Default => False); |
| -- Value of a non existing variable or array element |
| |
| type Variable_Id is new Nat; |
| No_Variable : constant Variable_Id := 0; |
| type Variable is record |
| Next : Variable_Id := No_Variable; |
| Name : Name_Id; |
| Value : Variable_Value; |
| end record; |
| -- To hold the list of variables in a project file and in packages |
| |
| package Variable_Elements is new Table.Table |
| (Table_Component_Type => Variable, |
| Table_Index_Type => Variable_Id, |
| Table_Low_Bound => 1, |
| Table_Initial => 200, |
| Table_Increment => 100, |
| Table_Name => "Prj.Variable_Elements"); |
| -- The table of variable in list of variables |
| |
| type Array_Element_Id is new Nat; |
| No_Array_Element : constant Array_Element_Id := 0; |
| type Array_Element is record |
| Index : Name_Id; |
| Index_Case_Sensitive : Boolean := True; |
| Value : Variable_Value; |
| Next : Array_Element_Id := No_Array_Element; |
| end record; |
| -- Each Array_Element represents an array element and is linked (Next) |
| -- to the next array element, if any, in the array. |
| |
| package Array_Elements is new Table.Table |
| (Table_Component_Type => Array_Element, |
| Table_Index_Type => Array_Element_Id, |
| Table_Low_Bound => 1, |
| Table_Initial => 200, |
| Table_Increment => 100, |
| Table_Name => "Prj.Array_Elements"); |
| -- The table that contains all array elements |
| |
| 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; |
| end record; |
| -- Each Array_Data value represents an array. |
| -- Value is the id of the first element. |
| -- Next is the id of the next array in the project file or package. |
| |
| package Arrays is new Table.Table |
| (Table_Component_Type => Array_Data, |
| Table_Index_Type => Array_Id, |
| Table_Low_Bound => 1, |
| Table_Initial => 200, |
| Table_Increment => 100, |
| Table_Name => "Prj.Arrays"); |
| -- The table that contains all arrays |
| |
| type Package_Id is new Nat; |
| No_Package : constant Package_Id := 0; |
| type Declarations is record |
| Variables : Variable_Id := No_Variable; |
| Attributes : Variable_Id := No_Variable; |
| Arrays : Array_Id := No_Array; |
| Packages : Package_Id := No_Package; |
| end record; |
| |
| No_Declarations : constant Declarations := |
| (Variables => No_Variable, |
| Attributes => No_Variable, |
| Arrays => No_Array, |
| Packages => No_Package); |
| -- Declarations. Used in project structures and packages (what for???) |
| |
| type Package_Element is record |
| Name : Name_Id := No_Name; |
| Decl : Declarations := No_Declarations; |
| Parent : Package_Id := No_Package; |
| Next : Package_Id := No_Package; |
| end record; |
| -- A package. Includes declarations that may include other packages. |
| |
| package Packages is new Table.Table |
| (Table_Component_Type => Package_Element, |
| Table_Index_Type => Package_Id, |
| Table_Low_Bound => 1, |
| Table_Initial => 100, |
| Table_Increment => 100, |
| Table_Name => "Prj.Packages"); |
| -- The table that contains all packages. |
| |
| function Image (Casing : Casing_Type) return String; |
| -- Similar to 'Image (but avoid use of this attribute in compiler) |
| |
| 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. |
| |
| -- The following record contains data for a naming scheme |
| |
| type Naming_Data is record |
| Current_Language : Name_Id := No_Name; |
| -- The programming language being currently considered |
| |
| Dot_Replacement : Name_Id := No_Name; |
| -- The string to replace '.' in the source file name (for Ada). |
| |
| Dot_Repl_Loc : Source_Ptr := No_Location; |
| -- The position in the project file source where |
| -- Dot_Replacement is defined. |
| |
| Casing : Casing_Type := All_Lower_Case; |
| -- The casing of the source file name (for Ada). |
| |
| Spec_Suffix : Array_Element_Id := No_Array_Element; |
| -- The string to append to the unit name for the |
| -- source file name of a spec. |
| -- Indexed by the programming language. |
| |
| Current_Spec_Suffix : Name_Id := No_Name; |
| -- The "spec" suffix of the current programming language |
| |
| Spec_Suffix_Loc : Source_Ptr := No_Location; |
| -- The position in the project file source where |
| -- Current_Spec_Suffix is defined. |
| |
| 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. |
| |
| Current_Body_Suffix : Name_Id := No_Name; |
| -- The "body" suffix of the current programming language |
| |
| Body_Suffix_Loc : Source_Ptr := No_Location; |
| -- The position in the project file source where |
| -- Current_Body_Suffix is defined. |
| |
| Separate_Suffix : Name_Id := No_Name; |
| -- The string to append to the unit name for the |
| -- source file name of an Ada subunit. |
| |
| Sep_Suffix_Loc : Source_Ptr := No_Location; |
| -- The position in the project file source where |
| -- Separate_Suffix is defined. |
| |
| Specs : Array_Element_Id := No_Array_Element; |
| -- An associative array mapping individual specs |
| -- to source file names. Specific to Ada. |
| |
| Bodies : Array_Element_Id := No_Array_Element; |
| -- An associative array mapping individual bodies |
| -- to source file names. Specific to Ada. |
| |
| Specification_Exceptions : Array_Element_Id := No_Array_Element; |
| -- An associative array listing spec file names that don't have the |
| -- spec suffix. Not used by Ada. Indexed by the programming language |
| -- name. |
| |
| Implementation_Exceptions : Array_Element_Id := No_Array_Element; |
| -- An associative array listing body file names that don't have the |
| -- body suffix. Not used by Ada. Indexed by the programming language |
| -- name. |
| |
| end record; |
| |
| function Standard_Naming_Data return Naming_Data; |
| pragma Inline (Standard_Naming_Data); |
| -- The standard GNAT naming scheme. |
| |
| 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. |
| |
| type Project_List is new Nat; |
| Empty_Project_List : constant Project_List := 0; |
| -- A list of project files. |
| |
| type Project_Element is record |
| Project : Project_Id := No_Project; |
| Next : Project_List := Empty_Project_List; |
| end record; |
| -- Element in a list of project file. |
| -- Next is the id of the next project file in the list. |
| |
| package Project_Lists is new Table.Table |
| (Table_Component_Type => Project_Element, |
| Table_Index_Type => Project_List, |
| Table_Low_Bound => 1, |
| Table_Initial => 100, |
| Table_Increment => 100, |
| Table_Name => "Prj.Project_Lists"); |
| -- The table that contains the lists of project files. |
| |
| -- The following record describes a project file representation |
| |
| 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. |
| |
| Name : Name_Id := No_Name; |
| -- The name of the project. |
| -- Set by Prj.Proc.Process. |
| |
| Path_Name : Name_Id := No_Name; |
| -- The path name of the project file. |
| -- Set by Prj.Proc.Process. |
| |
| Virtual : Boolean := False; |
| -- True for virtual extending projects |
| |
| Display_Path_Name : Name_Id := No_Name; |
| |
| Location : Source_Ptr := No_Location; |
| -- The location in the project file source of the |
| -- reserved word project. |
| -- Set by Prj.Proc.Process. |
| |
| Mains : String_List_Id := Nil_String; |
| -- The list of mains as specified by attribute Main. |
| -- Set by Prj.Nmsc.Ada_Check. |
| |
| Directory : Name_Id := No_Name; |
| -- The directory where the project file resides. |
| -- Set by Prj.Proc.Process. |
| |
| Display_Directory : Name_Id := No_Name; |
| |
| Dir_Path : String_Access; |
| -- Same as Directory, but as an access to String. |
| -- Set by Make.Compile_Sources.Collect_Arguments_And_Compile. |
| |
| Library : Boolean := False; |
| -- True if this is a library project. |
| -- Set by Prj.Nmsc.Language_Independent_Check. |
| |
| Library_Dir : Name_Id := No_Name; |
| -- If a library project, directory where resides the library |
| -- Set by Prj.Nmsc.Language_Independent_Check. |
| |
| Display_Library_Dir : Name_Id := No_Name; |
| |
| Library_Src_Dir : Name_Id := No_Name; |
| -- If a library project, directory where the sources and the ALI files |
| -- of the library are copied. By default, if attribute Library_Src_Dir |
| -- is not specified, sources are not copied anywhere and ALI files are |
| -- copied in the Library Directory. |
| -- Set by Prj.Nmsc.Language_Independent_Check. |
| |
| Display_Library_Src_Dir : Name_Id := No_Name; |
| |
| 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. |
| |
| Lib_Internal_Name : Name_Id := No_Name; |
| -- If a library project, internal name store inside the library |
| -- Set by Prj.Nmsc.Language_Independent_Check. |
| |
| Lib_Elaboration : Boolean := False; |
| -- If a library project, indicate if <lib>init and <lib>final |
| -- procedures need to be defined. |
| -- Set by Prj.Nmsc.Language_Independent_Check. |
| |
| Standalone_Library : Boolean := False; |
| -- Indicate that this is a Standalone Library Project File. |
| -- Set by Prj.Nmsc.Ada_Check. |
| |
| Lib_Interface_ALIs : String_List_Id := Nil_String; |
| -- For Standalone Library Project Files, indicate the list |
| -- of Interface ALI files. |
| -- Set by Prj.Nmsc.Ada_Check. |
| |
| Lib_Auto_Init : Boolean := False; |
| -- For non static Standalone 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 |
| |
| Sources_Present : Boolean := True; |
| -- A flag that indicates if there are sources in this project file. |
| -- There are no sources if 1) Source_Dirs is specified as an |
| -- empty list, 2) Source_Files is specified as an empty list, or |
| -- 3) the current language is not in the list of the specified |
| -- Languages. |
| |
| Sources : String_List_Id := Nil_String; |
| -- The list of all the source file names. |
| -- Set by Prj.Nmsc.Check_Naming_Scheme. |
| |
| Source_Dirs : String_List_Id := Nil_String; |
| -- The list of all the source directories. |
| -- Set by Prj.Nmsc.Check_Naming_Scheme. |
| |
| 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.Check_Naming_Scheme. |
| |
| Display_Object_Dir : Name_Id := No_Name; |
| |
| Exec_Directory : Name_Id := No_Name; |
| -- The exec directory of this project file. |
| -- Default is equal to Object_Directory. |
| -- Set by Prj.Nmsc.Check_Naming_Scheme. |
| |
| Display_Exec_Dir : Name_Id := No_Name; |
| |
| 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. |
| |
| Naming : Naming_Data := Standard_Naming_Data; |
| -- The naming scheme of this project file. |
| -- Set by Prj.Nmsc.Check_Naming_Scheme. |
| |
| 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 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. |
| |
| 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 |
| |
| 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). |
| |
| Objects_Path_File_With_Libs : Name_Id := No_Name; |
| -- The cached value of the object path temp file (including library |
| -- dirs) for this project file. |
| -- Set by gnatmake (Prj.Env.Set_Ada_Paths). |
| |
| Objects_Path_File_Without_Libs : Name_Id := No_Name; |
| -- The cached value of the object path temp file (excluding library |
| -- dirs) for this project file. |
| -- Set by gnatmake (Prj.Env.Set_Ada_Paths). |
| |
| 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_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). |
| |
| 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 Suffixs. |
| |
| Checked : Boolean := False; |
| -- A flag to avoid checking repetitively the naming scheme of |
| -- this project file. |
| -- Set by Prj.Nmsc.Check_Naming_Scheme. |
| |
| Seen : Boolean := False; |
| Flag1 : Boolean := False; |
| Flag2 : Boolean := False; |
| -- Various flags that are used in an ad hoc manner |
| -- That's really not a good enough comment ??? we need to know what |
| -- these flags are used for, and give them proper names. If Flag1 |
| -- and Flag2 have multiple uses, then either we use multiple fields |
| -- or a renaming scheme. |
| |
| Depth : Natural := 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. |
| |
| end record; |
| |
| function Empty_Project return Project_Data; |
| -- Return the representation of an empty project. |
| |
| package Projects is new Table.Table ( |
| Table_Component_Type => Project_Data, |
| Table_Index_Type => Project_Id, |
| Table_Low_Bound => 1, |
| Table_Initial => 100, |
| Table_Increment => 100, |
| Table_Name => "Prj.Projects"); |
| -- The set of all project files. |
| |
| type Put_Line_Access is access procedure |
| (Line : String; |
| Project : Project_Id); |
| -- 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. |
| |
| procedure Initialize; |
| -- This procedure must be called before using any services from the Prj |
| -- hierarchy. Namet.Initialize must be called before Prj.Initialize. |
| |
| procedure Reset; |
| -- 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); |
| -- Register the default suffixs 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. |
| |
| generic |
| type State is limited private; |
| with procedure Action |
| (Project : Project_Id; |
| With_State : in out State); |
| procedure For_Every_Project_Imported |
| (By : Project_Id; |
| With_State : in out State); |
| -- Call Action for each project imported directly or indirectly by project |
| -- By. 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. With_State may be used by Action to choose a |
| -- behavior or to report some global result. |
| |
| private |
| |
| Initial_Buffer_Size : constant := 100; |
| |
| Buffer : String_Access := new String (1 .. Initial_Buffer_Size); |
| -- An extensible character buffer to store names. Used in Prj.Part and |
| -- Prj.Strt. |
| |
| Buffer_Last : Natural := 0; |
| -- The index of the last character in the Buffer |
| |
| Current_Packages_To_Check : String_List_Access := All_Packages; |
| -- Global variable, set by Prj.Part.Parse, used by Prj.Dect. |
| |
| procedure Add_To_Buffer (S : String); |
| -- Append a String to the Buffer |
| |
| end Prj; |
