1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
------------------------------------------------------------------------------
-- --
-- COMMON ASIS TOOLS COMPONENTS LIBRARY --
-- --
-- A S I S _ U L . E N V I R O N M E N T --
-- --
-- S p e c --
-- --
-- Copyright (C) 2004-2014, AdaCore --
-- --
-- Asis Utility Library (ASIS UL) is free software; you can redistribute it --
-- and/or modify it under terms of the GNU General Public License as --
-- published by the Free Software Foundation; either version 3, or (at your --
-- option) any later version. ASIS UL is distributed in the hope that it --
-- will be useful, but WITHOUT 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 --
-- COPYING3. If not, go to http://www.gnu.org/licenses for a complete copy --
-- of the license. --
-- --
-- ASIS UL is maintained by AdaCore (http://www.adacore.com). --
-- --
------------------------------------------------------------------------------
pragma Ada_2012;
-- This package contains routines for creating, maintaining and cleaning up
-- the working environment for an ASIS tool
with GNAT.Directory_Operations; use GNAT.Directory_Operations;
with GNAT.OS_Lib; use GNAT.OS_Lib;
with GNAT.Command_Line; use GNAT.Command_Line;
with ASIS_UL.Projects;
with ASIS_UL.String_Utilities; use ASIS_UL.String_Utilities;
use ASIS_UL.String_Utilities.String_Vectors;
package ASIS_UL.Environment is
-- ???procedure Initialize;
-- No longer used; need to update doc below.
--
-- This procedure is supposed to perform the common initialization
-- actions, such as scanning the tool parameters, checking that the
-- parameter values are compatible, creating the temporary directory and
-- moving into it. Parameter scanning and checking are tool-specific,
-- so the corresponding bodies should be provided (see the body for the
-- details).
--
-- When this procedure is completed, ASIS_UL.Compiler_Options.Arg_List
-- should contain the full list of options needed to call the compiler to
-- create the tree, and all the source files that will have to be processed
-- by the tool. That is, if the tool is based on ASIS_UL.One_Arg_Driver
-- driver, then ASIS_UL.Common.Arg_File should be a full normalized name of
-- some existing file (given in absolute form). If the tool is based on
-- ASIS_UL.Several_Files_Driver??? driver, the source file table should
-- contain full normalized names of some existing files (also given in
-- absolute form). And in any case ASIS_UL.Compiler_Options.Arg_List should
-- contain the full list of options needed to call the compiler to create
-- the tree.
--
-- This procedure should raise Parameter_Error in case if anything is wrong
-- with tool parameters or/and options. In particular, Parameter_Error
-- should be raised if no existing source file is set.
procedure Initialize_New
(Prj : in out ASIS_UL.Projects.Arg_Project_Type'Class);
-- Same as above but some tool-specific parts of the processing should be
-- defined as the primitive operations of the tool project type.
-- ??? More docs needed.
procedure Scan_Parameters_New
(Prj : in out ASIS_UL.Projects.Arg_Project_Type'Class);
-- Scans the tools parameters and initializes the corresponding data
-- structures representing the tool options, and also stores in the
-- temporary database the argument sources. This procedure first scans the
-- tool command line and extracts and stores only the following
-- information
--
-- * project-specific options (-Pprj, -Xref=value, -vPn, -U [main]);
--
-- * argument sources (both specified directly and passed through
-- '-files=list_of_arg_files' option;
-- * '--version' and '--help' options;
--
-- If either '--help' or '--version' option is detected, this procedure
-- prints out the corresponding information and exits to OS.
--
-- If a project file is specified as a tool argument, the corresponding
-- project file is loaded and processed: the tool-specific options are
-- extracted and stored, and if no argument source is specified in a
-- command line parameters, the project sources are extracted from the
-- project and stored as argument sources (a set of sources extracted from
-- the project depends on the fact if '-U' option is given in the command
-- line, and if it contains the name of the main unit.
--
-- Then, the command line parameters are scanned again, but this time
-- neither the project-specific options nor the argument sources are
-- extracted and stored in the tool environment.
--
-- The procedure that actually scans the parameters (either given in the
-- command-line or specified in the project file) and the procedure that
-- prints out the usage information for '--help' option should be defined
-- as primitive operations of the tool project type.
procedure Go_To_Temp_Dir (With_Dir_For_Comp_Output : Boolean := False);
-- Creates the temporary directory for all the compilations performed by
-- the tool and changes the tool working directory to this temporary
-- directory. Raises Fatal_Error if creating of the temporary directory
-- failed because of any reason. If With_Dir_For_Comp_Output is set ON,
-- creates in this temporary directory another temporary directory to place
-- the compiler diagnostic output in.
-- Sets ASIS_UL.Environment.Tool_Temp_Dir and
-- ASIS_UL.Common.Compiler_Output_File_Name.
procedure Context_Clean_Up;
-- Closes and dissociates the context, if needed
procedure Clean_Up;
-- Performs the general final clean-up actions, including closing and
-- deleting of all files in the temporary directory and deleting this
-- temporary directory itself.
procedure Prepare_Context (Success : out Boolean);
-- This procedure performs all the steps needed to prepare the ASIS Context
-- (represented by ASIS_UL.Common.The_Context and to make it ready for all
-- the ASIS-based processing. It assumes that ASIS_UL.Common.Arg_File
-- points to the full normalized name of some existing source, and
-- ASIS_UL.Compiler_Options.Arg_List contains all the options needed to
-- compile this source. This procedure compiles this source to get the tree
-- file, if the tree is successfully created, it opens the 'C1' Context
-- based on this tree, and sets ASIS_UL.Common.The_CU to point to the main
-- unit in this tree. ASIS_UL.Common.Tree_File is set to the short name of
-- the tree file that has been created. If all these actions are
-- successfully performed, Success is set ON, otherwise it is set OFF.
function More_Arguments
(Store_Arguments : Boolean := True;
In_Switches : Boolean := False;
Parser : Opt_Parser := Command_Line_Parser)
return Boolean;
-- Is supposed to be used as a common part of Scan_Parameters in the
-- loop that iterates through the command line. Is supposed to be called
-- when Getop returns ASCII.NUL. Tries to read arguments and store them (if
-- any). Returns True if at least one argument is found and False
-- otherwise.
-- In case if '-U' option is specified, this procedure stores the first
-- argument file into ASIS_UL.Projects.Main_Unit, but if
-- ASIS_UL.Projects.Main_Unit is already set or if it processes more then
-- one argument, it generates an error message that says that only one main
-- unit can be specified for '-U' and raises Parameter_Error.
type Common_Arg_Status is (Arg_Processed, Arg_Not_Processed, Quit);
function Scan_Common_Arg
(My_Project : in out ASIS_UL.Projects.Arg_Project_Type'Class;
First_Pass : Boolean;
Parser : Opt_Parser;
In_Switches : Boolean;
In_Project_File : Boolean;
Initial_Char : Character)
return Common_Arg_Status;
-- This is used to scan a command-line argument that is common to more than
-- one ASIS tool, or might be in the future. If the current argument is a
-- common one, this processes it. Otherwise, it does nothing. Initial_Char
-- is the character returned by Getopt, and First_Pass indicates which pass
-- we are in.
--
-- If the argument is processed by Scan_Common_Arg, it returns
-- Arg_Processed, unless the switch indicates that we should quit
-- (e.g. "--help" or "--version"), in which case it returns Quit. If the
-- argument is not processed by Scan_Common_Arg, it returns
-- Arg_Not_Processed, in which case the caller is expected to deal with
-- the argument.
--
-- If this function can handle a particular argument (say, "--my-switch"),
-- that doesn't mean --my-switch is meaningful for every ASIS tool that
-- calls Scan_Common_Arg. It will be meaningful only if "-my-switch" is
-- included in the string passed to Getopt.
procedure Call_Builder;
-- Used by the outer invocation in incremental mode to call the
-- builder. Raises Fatal_Error on failure.
Extra_Inner_Pre_Args, Extra_Inner_Post_Args : String_Vector;
-- In Incremental_Mode, these may be used by the outer invocation of the
-- tool to pass information to the inner invocations. The Pre ones go
-- first; the Post ones go last.
Tool_Temp_Dir : String_Access;
-- Contains the name of the temporary directory created by the ASIS tools
-- for the tree files
Tool_Current_Dir : constant String := Normalize_Pathname (Get_Current_Dir);
procedure Print_Command_Line;
-- Prints the command line to standard output for debugging
end ASIS_UL.Environment;
|
