1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2004-2010, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
27 with Namet
; use Namet
;
32 with Types
; use Types
;
34 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
38 type Fail_Proc
is access procedure (S
: String);
39 Do_Fail
: Fail_Proc
:= Osint
.Fail
'Access;
40 -- Failing procedure called from procedure Test_If_Relative_Path below. May
43 Project_Tree
: constant Project_Tree_Ref
:= new Project_Tree_Data
;
46 Subdirs_Option
: constant String := "--subdirs=";
47 -- Switch used to indicate that the real directories (object, exec,
48 -- library, ...) are subdirectories of those in the project file.
50 Unchecked_Shared_Lib_Imports
: constant String :=
51 "--unchecked-shared-lib-imports";
52 -- Command line switch to allow shared library projects to import projects
53 -- that are not shared library projects.
55 Single_Compile_Per_Obj_Dir_Switch
: constant String :=
56 "--single-compile-per-obj-dir";
57 -- Switch to forbid simultaneous compilations for the same object directory
58 -- when project files are used.
60 Create_Map_File_Switch
: constant String := "--create-map-file";
61 -- Switch to create a map file when an executable is linked
64 (Option
: String_Access
;
65 To
: in out String_List_Access
;
66 Last
: in out Natural);
69 To
: in out String_List_Access
;
70 Last
: in out Natural);
71 -- Add a string to a list of strings
73 function Create_Binder_Mapping_File
return Path_Name_Type
;
74 -- Create a binder mapping file and returns its path name
76 function Create_Name
(Name
: String) return File_Name_Type
;
77 function Create_Name
(Name
: String) return Name_Id
;
78 function Create_Name
(Name
: String) return Path_Name_Type
;
79 -- Get an id for a name
81 function Base_Name_Index_For
84 Index_Separator
: Character) return File_Name_Type
;
85 -- Returns the base name of Main, without the extension, followed by the
86 -- Index_Separator followed by the Main_Index if it is non-zero.
88 function Executable_Prefix_Path
return String;
89 -- Return the absolute path parent directory of the directory where the
90 -- current executable resides, if its directory is named "bin", otherwise
91 -- return an empty string. When a directory is returned, it is guaranteed
92 -- to end with a directory separator.
94 procedure Inform
(N
: Name_Id
:= No_Name
; Msg
: String);
95 procedure Inform
(N
: File_Name_Type
; Msg
: String);
96 -- Prints out the program name followed by a colon, N and S
98 function File_Not_A_Source_Of
100 Sfile
: File_Name_Type
) return Boolean;
101 -- Check that file name Sfile is one of the source of unit Uname. Returns
102 -- True if the unit is in one of the project file, but the file name is not
103 -- one of its source. Returns False otherwise.
105 function Check_Source_Info_In_ALI
(The_ALI
: ALI
.ALI_Id
) return Boolean;
106 -- Check whether all file references in ALI are still valid (i.e. the
107 -- source files are still associated with the same units). Return True
108 -- if everything is still valid.
110 function Is_External_Assignment
111 (Tree
: Prj
.Tree
.Project_Node_Tree_Ref
;
112 Argv
: String) return Boolean;
113 -- Verify that an external assignment switch is syntactically correct
115 -- Correct forms are:
118 -- -X"name=other value"
120 -- Assumptions: 'First = 1, Argv (1 .. 2) = "-X"
122 -- When this function returns True, the external assignment has been
123 -- entered by a call to Prj.Ext.Add, so that in a project file, External
124 -- ("name") will return "value".
126 procedure Verbose_Msg
129 N2
: Name_Id
:= No_Name
;
131 Prefix
: String := " -> ";
132 Minimum_Verbosity
: Opt
.Verbosity_Level_Type
:= Opt
.Low
);
133 procedure Verbose_Msg
134 (N1
: File_Name_Type
;
136 N2
: File_Name_Type
:= No_File
;
138 Prefix
: String := " -> ";
139 Minimum_Verbosity
: Opt
.Verbosity_Level_Type
:= Opt
.Low
);
140 -- If the verbose flag (Verbose_Mode) is set and the verbosity level is at
141 -- least equal to Minimum_Verbosity, then print Prefix to standard output
142 -- followed by N1 and S1. If N2 /= No_Name then N2 is printed after S1. S2
143 -- is printed last. Both N1 and N2 are printed in quotation marks. The two
144 -- forms differ only in taking Name_Id or File_name_Type arguments.
146 function Linker_Options_Switches
147 (Project
: Project_Id
;
148 In_Tree
: Project_Tree_Ref
) return String_List
;
149 -- Collect the options specified in the Linker'Linker_Options attributes
150 -- of project Project, in project tree In_Tree, and in the projects that
151 -- it imports directly or indirectly, and returns the result.
153 -- Package Mains is used to store the mains specified on the command line
154 -- and to retrieve them when a project file is used, to verify that the
155 -- files exist and that they belong to a project file.
157 function Unit_Index_Of
(ALI_File
: File_Name_Type
) return Int
;
158 -- Find the index of a unit in a source file. Return zero if the file is
159 -- not a multi-unit source file.
161 procedure Test_If_Relative_Path
162 (Switch
: in out String_Access
;
164 Including_L_Switch
: Boolean := True;
165 Including_Non_Switch
: Boolean := True;
166 Including_RTS
: Boolean := False);
167 -- Test if Switch is a relative search path switch. If it is, fail if
168 -- Parent is the empty string, otherwise prepend the path with Parent.
169 -- This subprogram is only called when using project files. For gnatbind
170 -- switches, Including_L_Switch is False, because the argument of the -L
171 -- switch is not a path. If Including_RTS is True, process also switches
174 function Path_Or_File_Name
(Path
: Path_Name_Type
) return String;
175 -- Returns a file name if -df is used, otherwise return a path name
181 -- Mains are stored in a table. An index is used to retrieve the mains
186 procedure Add_Main
(Name
: String);
187 -- Add one main to the table
189 procedure Set_Index
(Index
: Int
);
191 procedure Set_Location
(Location
: Source_Ptr
);
192 -- Set the location of the last main added. By default, the location is
199 -- Reset the index to the beginning of the table
201 function Next_Main
return String;
202 -- Increase the index and return the next main. If table is exhausted,
203 -- return an empty string.
205 function Get_Index
return Int
;
207 function Get_Location
return Source_Ptr
;
208 -- Get the location of the current main
210 procedure Update_Main
(Name
: String);
211 -- Update the file name of the current main
213 function Number_Of_Mains
return Natural;
214 -- Returns the number of mains added with Add_Main since the last call
219 ----------------------
220 -- Marking Routines --
221 ----------------------
223 procedure Mark
(Source_File
: File_Name_Type
; Index
: Int
:= 0);
224 -- Mark a unit, identified by its source file and, when Index is not 0, the
225 -- index of the unit in the source file. Marking is used to signal that the
226 -- unit has already been inserted in the Q.
229 (Source_File
: File_Name_Type
;
230 Index
: Int
:= 0) return Boolean;
231 -- Returns True if the unit was previously marked
233 procedure Delete_All_Marks
;
234 -- Remove all file/index couples marked