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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
------------------------------------------------------------------------------
-- --
-- ASIS UTILITY LIBRARY COMPONENTS --
-- --
-- A S I S _ U L . O U T P U T --
-- --
-- S p e c --
-- --
-- Copyright (C) 2004-2018, 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 various output routines.
with Asis; use Asis;
with Ada.Exceptions; use Ada.Exceptions;
package ASIS_UL.Output is
Text_Report_ON : Boolean := True;
XML_Report_ON : Boolean := False;
-- Indicate if the tool should generate a global report file in text or XML
-- format;
procedure Print_Version_Info (Released_At : Positive);
-- Prints into Stderr the tool version information in the following format:
--
-- <toolname>
-- Copyright <Released_At>-<current year>, AdaCore.
--
-- Released_At is supposed to be the year when the tool is first released.
procedure Print_Tool_Version (Released_At : Positive);
-- Similar to Print_Version_Info, but sends the output into Stdout and
-- the format of the information printed is similar to what is printed
-- for '--version' option by all the other GNAT tools.
procedure Report_Unhandled_ASIS_Exception (Ex : Exception_Occurrence);
-- Reports an unhandled ASIS exception into Standard_Error
procedure Report_Unhandled_Exception (Ex : Exception_Occurrence);
-- Reports an unhandled non-ASIS exception into Standard_Error
procedure Error (Message : String);
-- Sends into Stderr the error message in the form 'Tool_Name: Message'
procedure Error_No_Tool_Name (Message : String);
-- Sends into Stderr the error message with no tool name prefix
procedure SLOC_Error
(Message : String;
Elem : Asis.Element);
procedure SLOC_Error
(Message : String;
SLOC : String);
-- Sends to Stderr the error message in the following format:
-- 'SLOC:Tool_Name:Message', where SLOC is the GNAT-style sourse location.
-- For the first procedure, SLOC is computed for argument Elem and the
-- caller is responsible for providing actual Elements for that SLOC can
-- successfully be computed. For the second procedure SLOC should be
-- provided by the caller.
--
-- This procedure should be used in case when the generated message is
-- supposed to be parsed by GPS.
procedure Warning (Message : String);
-- Same as Error, but do nothing if Warning_Mode = Quiet.
procedure Warning_No_Tool_Name (Message : String);
-- Same as Warning, but no tool name prefix
procedure Info
(Message : String;
Line_Len : Natural := 0;
Spacing : Natural := 0);
-- Sends Message as a separate line(s) into Stderr (with no tool name
-- prefix). If Line_Len is set to some positive value, it is treated as a
-- maximal length of the text to be placed into one output line, and if the
-- length of Message exceeds Line_Len, this procedure tries to split
-- Message treating spaces as word separators and prints the rest of the
-- Message on the next line(s). Each continuation line starts from Spacing
-- number of space characters. Message can be split only on borders of
-- words.
procedure Info_No_EOL
(Message : String;
Line_Len : Natural := 0;
Spacing : Natural := 0);
-- The same as Info, but does not "close" the last line being printed out,
-- that is, the last line does not contain a (platform-specific) EOL
-- character(s).
Ident_String : constant String := " ";
-- Used as indentation element in the debug output
----------------------
-- Tool report file --
----------------------
type Out_File_Formats is (
Default,
CRLF,
LF);
Out_File_Format : Out_File_Formats := Default;
-- Format of the tool report file(s)
function Get_Out_File_Format (Val : String) return Out_File_Formats;
-- This function is supposed to be used as a part of tool parameters
-- processing. It tries to convert its parameter into the corresponding
-- value of Out_File_Formats type using the following conventions:
--
-- "dos" -> CRLF
-- "crlf" -> CRLF
-- "unix" -> LF
-- "lf" -> LF
--
-- Generates the error message and raises Parameter_Error if such a
-- conversion is not possible.
procedure Set_Report_File_Name (Fname : String);
procedure Set_XML_Report_File_Name (Fname : String);
-- Sets the name of the tool (XML) report file. If this procedure has not
-- been called before creating the output file, the default name of the
-- form 'tool_name.out' ('tool_name.xml') is used.
function Get_Report_File_Name return String;
function Get_XML_Report_File_Name return String;
-- Returns the full normalized name of the tool (XML) report file in
-- absolute form. Return empty string if the tool report file name is
-- not set.
function Get_Number return String;
-- Gets numeric index from the report file name.
procedure Set_Pipe_Mode (On : Boolean := True);
-- Turns ON (if On => True) or OFF (otherwise) the pipe mode. In the pipe
-- mode the tool report should be sent into Stdout. Raises Parameter_Error
-- if both text and XML outout are specified for the tool
procedure Set_Report_Files;
-- Creates and/or opens the tool report files, according to the values of
-- Text_Report_ON and XML_Report_ON. If the file with the same name as the
-- name of the report file already exists, it is silently and
-- unconditionally overridden. In Mimic_gcc mode, the file should have
-- already been created by the outer invocation, and we don't overwrite it,
-- we APPEND to it. We also lock the file in this mode in case there are
-- parallel inner invocations.
-- Note, that this procedure is supposed to be called *before* the tool
-- creates the temporary directory and gets into it.
procedure Close_Report_Files;
-- Closes the report files (according to the values of Text_Report_ON and
-- XML_Report_ON). In Mimic_gcc mode, also unlock them.
-- The following routines should be called only after the call to
-- Set_Report_File. They should not be called after the call to
-- Close_Report_File
procedure Report
(Message : String;
Indent_Level : Natural := 0);
procedure XML_Report
(Message : String;
Indent_Level : Natural := 0);
-- Sends the Message into the tool (XML) report file. The line is then
-- closed (by appending the EOL character(s)). If Indent_Level is not zero,
-- Message is prepended by Indent_Level indentation string (currently the
-- indentation string consists of three space characters).
procedure Report_No_EOL
(Message : String;
Indent_Level : Natural := 0);
procedure XML_Report_No_EOL
(Message : String;
Indent_Level : Natural := 0);
-- Similar to the previous routine, but it does not close the output line.
procedure Report_EOL;
procedure XML_Report_EOL;
-- Closes the line in the (XML) output file.
function Get_Indent_String return String;
-- Returns the strung constant consisting on space characters and used to
-- indicate one level of indentation
-------------------
-- Tool log file --
-------------------
-- The log file is the file to copy all the information sent into Stderr.
procedure Set_Log_File_Name (Fname : String);
-- Sets the name of the tool log file. If this procedure has not been
-- called before creating the log file, the default name of the form
-- 'tool_name.log' is used.
procedure Set_Log_File;
-- Creates and/or opens the tool log file. If the file with the same name
-- as the name of the log file already exists, it is silently and
-- unconditionally overridden.
-- Note, that this procedure is supposed to be called *before* the tool
-- creates the temporary directory and gets into it.
--
-- At the moment there is no possibility to specify the name for the log
-- file, the name used for it is always tool_name.log
--
-- As soon as the procedure is called, all the messages that are sent by
-- the routines defined in this package into Stderr, are copied into the
-- log file.
procedure Close_Log_File;
-- Closes the report file (and stops copying the messages into it)
end ASIS_UL.Output;
|
