-- --
-- S p e c --
-- --
--- Copyright (C) 2001-2005 Free Software Foundation, Inc. --
+-- Copyright (C) 2001-2010, 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, 59 Temple Place - Suite 330, Boston, --
--- MA 02111-1307, 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. --
-- Utilities for use in processing project files
-with Types; use Types;
-
-with GNAT.OS_Lib; use GNAT.OS_Lib;
-
package Prj.Util is
function Executable_Of
- (Project : Project_Id;
- In_Tree : Project_Tree_Ref;
- Main : Name_Id;
- Index : Int;
- Ada_Main : Boolean := True) return Name_Id;
+ (Project : Project_Id;
+ In_Tree : Project_Tree_Ref;
+ Main : File_Name_Type;
+ Index : Int;
+ Ada_Main : Boolean := True;
+ Language : String := "";
+ Include_Suffix : Boolean := True) return File_Name_Type;
-- Return the value of the attribute Builder'Executable for file Main in
-- the project Project, if it exists. If there is no attribute Executable
-- for Main, remove the suffix from Main; then, if the attribute
-- Executable_Suffix is specified, add this suffix, otherwise add the
-- standard executable suffix for the platform.
+ --
+ -- If Include_Suffix is true, then the ".exe" suffix (or any suffix defined
+ -- in the config) will be added. The suffix defined by the user in his own
+ -- project file is always taken into account. Otherwise, such a suffix is
+ -- not added. In particular, the prefix should not be added if you are
+ -- potentially testing for cross-platforms, since the suffix might not be
+ -- known (its default value comes from the ...-gnatmake prefix).
+ --
+ -- What is Ada_Main???
+ -- What is Language???
+
+ procedure Put
+ (Into_List : in out Name_List_Index;
+ From_List : String_List_Id;
+ In_Tree : Project_Tree_Ref;
+ Lower_Case : Boolean := False);
+ -- Append a name list to a string list
+ -- Describe parameters???
+
+ procedure Duplicate
+ (This : in out Name_List_Index;
+ In_Tree : Project_Tree_Ref);
+ -- Duplicate a name list
function Value_Of
(Variable : Variable_Value;
Default : String) return String;
- -- Get the value of a single string variable. If Variable is
- -- Nil_Variable_Value, is a string list or is defaulted, return Default.
+ -- Get the value of a single string variable. If Variable is a string list,
+ -- is Nil_Variable_Value,or is defaulted, return Default.
function Value_Of
(Index : Name_Id;
-- associative array.
function Value_Of
- (Index : Name_Id;
- Src_Index : Int := 0;
- In_Array : Array_Element_Id;
- In_Tree : Project_Tree_Ref) return Variable_Value;
- -- Get a string array component (single String or String list).
- -- Returns Nil_Variable_Value if there is no component Index
- -- or if In_Array is null.
+ (Index : Name_Id;
+ Src_Index : Int := 0;
+ In_Array : Array_Element_Id;
+ In_Tree : Project_Tree_Ref;
+ Force_Lower_Case_Index : Boolean := False;
+ Allow_Wildcards : Boolean := False) return Variable_Value;
+ -- Get a string array component (single String or String list). Returns
+ -- Nil_Variable_Value if no component Index or if In_Array is null.
--
-- Depending on the attribute (only attributes may be associative arrays)
- -- the index may or may not be case sensitive. If the index is not
- -- case sensitive, it is first set to lower case before the search
- -- in the associative array.
+ -- the index may or may not be case sensitive. If the index is not case
+ -- sensitive, it is first set to lower case before the search in the
+ -- associative array.
function Value_Of
(Name : Name_Id;
Index : Int := 0;
Attribute_Or_Array_Name : Name_Id;
In_Package : Package_Id;
- In_Tree : Project_Tree_Ref) return Variable_Value;
- -- In a specific package,
- -- - if there exists an array Attribute_Or_Array_Name with an index
- -- Name, returns the corresponding component (depending on the
- -- attribute, the index may or may not be case sensitive, see previous
- -- function),
+ In_Tree : Project_Tree_Ref;
+ Force_Lower_Case_Index : Boolean := False;
+ Allow_Wildcards : Boolean := False) return Variable_Value;
+ -- In a specific package:
+ -- - if there exists an array Attribute_Or_Array_Name with an index Name,
+ -- returns the corresponding component (depending on the attribute, the
+ -- index may or may not be case sensitive, see previous function),
-- - otherwise if there is a single attribute Attribute_Or_Array_Name,
-- returns this attribute,
-- - otherwise, returns Nil_Variable_Value.
In_Array : Name_Id;
In_Arrays : Array_Id;
In_Tree : Project_Tree_Ref) return Name_Id;
- -- Get a string array component in an array of an array list.
- -- Returns No_Name if there is no component Index, if In_Arrays is null, if
+ -- Get a string array component in an array of an array list. Returns
+ -- No_Name if there is no component Index, if In_Arrays is null, if
-- In_Array is not found in In_Arrays or if the component is a String list.
function Value_Of
(S : String;
Max_Length : Positive;
Separator : Character);
- -- Output string S using Output.Write_Str. If S is too long to fit in
- -- one line of Max_Length, cut it in several lines, using Separator as
- -- the last character of each line, if possible.
+ -- Output string S using Output.Write_Str. If S is too long to fit in one
+ -- line of Max_Length, cut it in several lines, using Separator as the last
+ -- character of each line, if possible.
type Text_File is limited private;
- -- Represents a text file. Default is invalid text file.
+ -- Represents a text file (default is invalid text file)
function Is_Valid (File : Text_File) return Boolean;
- -- Returns True if File designates an open text file that
- -- has not yet been closed.
+ -- Returns True if File designates an open text file that has not yet been
+ -- closed.
procedure Open (File : out Text_File; Name : String);
- -- Open a text file. If this procedure fails, File is invalid.
+ -- Open a text file to read (File is invalid if text file cannot be opened)
+
+ procedure Create (File : out Text_File; Name : String);
+ -- Create a text file to write (File is invaid if text file cannot be
+ -- created).
function End_Of_File (File : Text_File) return Boolean;
- -- Returns True if the end of the text file File has been
- -- reached. Fails if File is invalid.
+ -- Returns True if the end of the text file File has been reached. Fails if
+ -- File is invalid. Return True if File is an out file.
procedure Get_Line
(File : Text_File;
Line : out String;
Last : out Natural);
- -- Reads a line from an open text file. Fails if File is invalid.
+ -- Reads a line from an open text file (fails if File is invalid or in an
+ -- out file).
+
+ procedure Put (File : Text_File; S : String);
+ procedure Put_Line (File : Text_File; Line : String);
+ -- Output a string or a line to an out text file (fails if File is invalid
+ -- or in an in file).
procedure Close (File : in out Text_File);
- -- Close an open text file. File becomes invalid.
- -- Fails if File is already invalid.
+ -- Close an open text file. File becomes invalid. Fails if File is already
+ -- invalid or if an out file cannot be closed successfully.
+
+ -----------------------
+ -- Source info files --
+ -----------------------
+
+ procedure Write_Source_Info_File (Tree : Project_Tree_Ref);
+ -- Create a new source info file, with the path name specified in the
+ -- project tree data. Issue a warning if it is not possible to create
+ -- the new file.
+
+ procedure Read_Source_Info_File (Tree : Project_Tree_Ref);
+ -- Check if there is a source info file specified for the project Tree. If
+ -- so, attempt to read it. If the file exists and is successfully read, set
+ -- the flag Source_Info_File_Exists to True for the tree.
+
+ type Source_Info_Data is record
+ Project : Name_Id;
+ Language : Name_Id;
+ Kind : Source_Kind;
+ Display_Path_Name : Name_Id;
+ Path_Name : Name_Id;
+ Unit_Name : Name_Id := No_Name;
+ Index : Int := 0;
+ Naming_Exception : Boolean := False;
+ end record;
+ -- Data read from a source info file for a single source
-private
+ type Source_Info is access all Source_Info_Data;
+ No_Source_Info : constant Source_Info := null;
+
+ type Source_Info_Iterator is private;
+ -- Iterator to get the sources for a single project
+
+ procedure Initialize
+ (Iter : out Source_Info_Iterator;
+ For_Project : Name_Id);
+ -- Initiaize Iter for the project
+
+ function Source_Info_Of (Iter : Source_Info_Iterator) return Source_Info;
+ -- Get the source info for the source corresponding to the current value of
+ -- the iterator. Returns No_Source_Info if there is no source corresponding
+ -- to the iterator.
+ procedure Next (Iter : in out Source_Info_Iterator);
+ -- Advance the iterator to the next source in the project
+
+private
type Text_File_Data is record
FD : File_Descriptor := Invalid_FD;
+ Out_File : Boolean := False;
Buffer : String (1 .. 1_000);
- Buffer_Len : Natural;
+ Buffer_Len : Natural := 0;
Cursor : Natural := 0;
End_Of_File_Reached : Boolean := False;
end record;
type Text_File is access Text_File_Data;
+ type Source_Info_Iterator is record
+ Info : Source_Info;
+ Next : Natural;
+ end record;
+
end Prj.Util;
OSDN Git Service
