]>
Commit | Line | Data |
---|---|---|
70482933 RK |
1 | ------------------------------------------------------------------------------ |
2 | -- -- | |
3 | -- GNAT COMPILER COMPONENTS -- | |
4 | -- -- | |
5 | -- E R R O U T -- | |
6 | -- -- | |
7 | -- S p e c -- | |
8 | -- -- | |
3a0462b3 | 9 | -- Copyright (C) 1992-2006, Free Software Foundation, Inc. -- |
70482933 RK |
10 | -- -- |
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 2, 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 COPYING. If not, write -- | |
cb5fee25 KC |
19 | -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, -- |
20 | -- Boston, MA 02110-1301, USA. -- | |
70482933 RK |
21 | -- -- |
22 | -- GNAT was originally developed by the GNAT team at New York University. -- | |
71ff80dc | 23 | -- Extensive contributions were provided by Ada Core Technologies Inc. -- |
70482933 RK |
24 | -- -- |
25 | ------------------------------------------------------------------------------ | |
26 | ||
87b3f81f AC |
27 | -- This package contains the routines to output error messages. They are |
28 | -- basically system independent, however in some environments, e.g. when the | |
29 | -- parser is embedded into an editor, it may be appropriate to replace the | |
30 | -- implementation of this package. | |
70482933 | 31 | |
fbf5a39b AC |
32 | with Err_Vars; |
33 | with Erroutc; | |
70482933 RK |
34 | with Table; |
35 | with Types; use Types; | |
36 | with Uintp; use Uintp; | |
37 | ||
fbf5a39b AC |
38 | with System; |
39 | ||
70482933 RK |
40 | package Errout is |
41 | ||
fbf5a39b | 42 | Serious_Errors_Detected : Nat renames Err_Vars.Serious_Errors_Detected; |
07fc65c4 | 43 | -- This is a count of errors that are serious enough to stop expansion, |
87b3f81f AC |
44 | -- and hence to prevent generation of an object file even if the switch |
45 | -- -gnatQ is set. | |
07fc65c4 | 46 | |
fbf5a39b | 47 | Total_Errors_Detected : Nat renames Err_Vars.Total_Errors_Detected; |
87b3f81f AC |
48 | -- Number of errors detected so far. Includes count of serious errors and |
49 | -- non-serious errors, so this value is always greater than or equal to | |
50 | -- the Serious_Errors_Detected value. | |
70482933 | 51 | |
fbf5a39b | 52 | Warnings_Detected : Nat renames Err_Vars.Warnings_Detected; |
70482933 RK |
53 | -- Number of warnings detected |
54 | ||
fbf5a39b AC |
55 | Configurable_Run_Time_Violations : Nat := 0; |
56 | -- Count of configurable run time violations so far. This is used to | |
57 | -- suppress certain cascaded error messages when we know that we may not | |
58 | -- have fully expanded some items, due to high integrity violations (i.e. | |
87b3f81f AC |
59 | -- the use of constructs not permitted by the library in use, or improper |
60 | -- constructs in No_Run_Time mode). | |
fbf5a39b | 61 | |
70482933 RK |
62 | type Compiler_State_Type is (Parsing, Analyzing); |
63 | Compiler_State : Compiler_State_Type; | |
87b3f81f AC |
64 | -- Indicates current state of compilation. This is put in the Errout spec |
65 | -- because it affects the action of the error message handling. In | |
66 | -- particular, an attempt is made by Errout to suppress cascaded error | |
67 | -- messages in Parsing mode, but not in the other modes. | |
70482933 | 68 | |
fbf5a39b AC |
69 | Current_Error_Source_File : Source_File_Index |
70 | renames Err_Vars.Current_Error_Source_File; | |
70482933 RK |
71 | -- Id of current messages. Used to post file name when unit changes. This |
72 | -- is initialized to Main_Source_File at the start of a compilation, which | |
87b3f81f AC |
73 | -- means that no file names will be output unless there are errors in |
74 | -- units other than the main unit. However, if the main unit has a pragma | |
75 | -- Source_Reference line, then this is initialized to No_Source_File, to | |
76 | -- force an initial reference to the real source file name. | |
70482933 | 77 | |
fbf5a39b | 78 | Raise_Exception_On_Error : Nat renames Err_Vars.Raise_Exception_On_Error; |
70482933 | 79 | -- If this value is non-zero, then any attempt to generate an error |
87b3f81f AC |
80 | -- message raises the exception Error_Msg_Exception, and the error message |
81 | -- is not output. This is used for defending against junk resulting from | |
82 | -- illegalities, and also for substitution of more appropriate error | |
83 | -- messages from higher semantic levels. It is a counter so that the | |
84 | -- increment/decrement protocol nests neatly. | |
70482933 | 85 | |
fbf5a39b | 86 | Error_Msg_Exception : exception renames Err_Vars.Error_Msg_Exception; |
70482933 RK |
87 | -- Exception raised if Raise_Exception_On_Error is true |
88 | ||
89 | ----------------------------------- | |
90 | -- Suppression of Error Messages -- | |
91 | ----------------------------------- | |
92 | ||
93 | -- In an effort to reduce the impact of redundant error messages, the | |
94 | -- error output routines in this package normally suppress certain | |
95 | -- classes of messages as follows: | |
96 | ||
97 | -- 1. Identical messages placed at the same point in the text. Such | |
98 | -- duplicate error message result for example from rescanning | |
99 | -- sections of the text that contain lexical errors. Only one of | |
100 | -- such a set of duplicate messages is output, and the rest are | |
101 | -- suppressed. | |
102 | ||
103 | -- 2. If more than one parser message is generated for a single source | |
104 | -- line, then only the first message is output, the remaining | |
105 | -- messages on the same line are suppressed. | |
106 | ||
107 | -- 3. If a message is posted on a node for which a message has been | |
108 | -- previously posted, then only the first message is retained. The | |
109 | -- Error_Posted flag is used to detect such multiple postings. Note | |
110 | -- that this only applies to semantic messages, since otherwise | |
111 | -- for parser messages, this would be a special case of case 2. | |
112 | ||
113 | -- 4. If a message is posted on a node whose Etype or Entity | |
114 | -- fields reference entities on which an error message has | |
115 | -- already been placed, as indicated by the Error_Posted flag | |
116 | -- being set on these entities, then the message is suppressed. | |
117 | ||
118 | -- 5. If a message attempts to insert an Error node, or a direct | |
119 | -- reference to the Any_Type node, then the message is suppressed. | |
120 | ||
3a0462b3 RD |
121 | -- 6. Note that cases 2-5 only apply to error messages, not warning |
122 | -- messages. Warning messages are only suppressed for case 1. | |
123 | ||
70482933 RK |
124 | -- This normal suppression action may be overridden in cases 2-5 (but not |
125 | -- in case 1) by setting All_Errors mode, or by setting the special | |
126 | -- unconditional message insertion character (!) at the end of the message | |
127 | -- text as described below. | |
128 | ||
129 | --------------------------------------------------------- | |
130 | -- Error Message Text and Message Insertion Characters -- | |
131 | --------------------------------------------------------- | |
132 | ||
133 | -- Error message text strings are composed of lower case letters, digits | |
134 | -- and the special characters space, comma, period, colon and semicolon, | |
135 | -- apostrophe and parentheses. Special insertion characters can also | |
136 | -- appear which cause the error message circuit to modify the given | |
137 | -- string as follows: | |
138 | ||
139 | -- Insertion character % (Percent: insert name from Names table) | |
140 | -- The character % is replaced by the text for the name specified by | |
87b3f81f AC |
141 | -- the Name_Id value stored in Error_Msg_Name_1. A blank precedes the |
142 | -- name if it is preceded by a non-blank character other than left | |
143 | -- parenthesis. The name is enclosed in quotes unless manual quotation | |
144 | -- mode is set. If the Name_Id is set to No_Name, then no insertion | |
145 | -- occurs; if the Name_Id is set to Error_Name, then the string | |
146 | -- <error> is inserted. A second and third % may appear in a single | |
147 | -- message, similarly replaced by the names which are specified by the | |
148 | -- Name_Id values stored in Error_Msg_Name_2 and Error_Msg_Name_3. The | |
149 | -- names are decoded and cased according to the current identifier | |
150 | -- casing mode. | |
70482933 RK |
151 | |
152 | -- Insertion character $ (Dollar: insert unit name from Names table) | |
87b3f81f AC |
153 | -- The character $ is treated similarly to %, except that the name is |
154 | -- obtained from the Unit_Name_Type value in Error_Msg_Unit_1 and | |
155 | -- Error_Msg_Unit_2, as provided by Get_Unit_Name_String in package | |
156 | -- Uname. Note that this name includes the postfix (spec) or (body) | |
157 | -- strings. If this postfix is not required, use the normal % | |
158 | -- insertion for the unit name. | |
70482933 RK |
159 | |
160 | -- Insertion character { (Left brace: insert literally from names table) | |
87b3f81f AC |
161 | -- The character { is treated similarly to %, except that the name is |
162 | -- output literally as stored in the names table without adjusting the | |
163 | -- casing. This can be used for file names and in other situations | |
164 | -- where the name string is to be output unchanged. | |
70482933 RK |
165 | |
166 | -- Insertion character * (Asterisk, insert reserved word name) | |
87b3f81f AC |
167 | -- The insertion character * is treated exactly like % except that the |
168 | -- resulting name is cased according to the default conventions for | |
169 | -- reserved words (see package Scans). | |
70482933 RK |
170 | |
171 | -- Insertion character & (Ampersand: insert name from node) | |
172 | -- The insertion character & is treated similarly to %, except that | |
173 | -- the name is taken from the Chars field of the given node, and may | |
87b3f81f AC |
174 | -- refer to a child unit name, or a selected component. The casing is, |
175 | -- if possible, taken from the original source reference, which is | |
176 | -- obtained from the Sloc field of the given node or nodes. If no Sloc | |
177 | -- is available (happens e.g. for nodes in package Standard), then the | |
178 | -- default case (see Scans spec) is used. The nodes to be used are | |
179 | -- stored in Error_Msg_Node_1, Error_Msg_Node_2. No insertion occurs | |
180 | -- for the Empty node, and the Error node results in the insertion of | |
181 | -- the characters <error>. In addition, if the special global variable | |
182 | -- Error_Msg_Qual_Level is non-zero, then the reference will include | |
183 | -- up to the given number of levels of qualification, using the scope | |
184 | -- chain. | |
70482933 RK |
185 | |
186 | -- Insertion character # (Pound: insert line number reference) | |
187 | -- The character # is replaced by the string indicating the source | |
188 | -- position stored in Error_Msg_Sloc. There are three cases: | |
189 | -- | |
190 | -- for package Standard: in package Standard | |
191 | -- for locations in current file: at line nnn:ccc | |
192 | -- for locations in other files: at filename:nnn:ccc | |
193 | -- | |
87b3f81f AC |
194 | -- By convention, the # insertion character is only used at the end of |
195 | -- an error message, so the above strings only appear as the last | |
70482933 RK |
196 | -- characters of an error message. |
197 | ||
198 | -- Insertion character } (Right brace: insert type reference) | |
199 | -- The character } is replaced by a string describing the type | |
200 | -- referenced by the entity whose Id is stored in Error_Msg_Node_1. | |
201 | -- the string gives the name or description of the type, and also | |
87b3f81f AC |
202 | -- where appropriate the location of its declaration. Special cases |
203 | -- like "some integer type" are handled appropriately. Only one } is | |
204 | -- allowed in a message, since there is not enough room for two (the | |
205 | -- insertion can be quite long, including a file name) In addition, if | |
206 | -- the special global variable Error_Msg_Qual_Level is non-zero, then | |
207 | -- the reference will include up to the given number of levels of | |
208 | -- qualification, using the scope chain. | |
70482933 RK |
209 | |
210 | -- Insertion character @ (At: insert column number reference) | |
211 | -- The character @ is replaced by null if the RM_Column_Check mode is | |
212 | -- off (False). If the switch is on (True), then @ is replaced by the | |
87b3f81f AC |
213 | -- text string " in column nnn" where nnn is the decimal |
214 | -- representation of the column number stored in Error_Msg_Col plus | |
215 | -- one (the plus one is because the number is stored 0-origin and | |
216 | -- displayed 1-origin). | |
70482933 RK |
217 | |
218 | -- Insertion character ^ (Carret: insert integer value) | |
219 | -- The character ^ is replaced by the decimal conversion of the Uint | |
220 | -- value stored in Error_Msg_Uint_1, with a possible leading minus. | |
221 | -- A second ^ may occur in the message, in which case it is replaced | |
222 | -- by the decimal conversion of the Uint value in Error_Msg_Uint_2. | |
223 | ||
fbf5a39b AC |
224 | -- Insertion character > (Right bracket, run time name) |
225 | -- The character > is replaced by a string of the form (name) if | |
226 | -- Targparm scanned out a Run_Time_Name (see package Targparm for | |
227 | -- details). The name is enclosed in parentheses and output in mixed | |
228 | -- case mode (upper case after any space in the name). If no run time | |
229 | -- name is defined, this insertion character has no effect. | |
230 | ||
70482933 RK |
231 | -- Insertion character ! (Exclamation: unconditional message) |
232 | -- The character ! appearing as the last character of a message makes | |
233 | -- the message unconditional which means that it is output even if it | |
234 | -- would normally be suppressed. See section above for a description | |
3a0462b3 RD |
235 | -- of the cases in which messages are normally suppressed. Note that |
236 | -- warnings are never suppressed, so the use of the ! character in a | |
237 | -- warning message is never useful. | |
70482933 RK |
238 | |
239 | -- Insertion character ? (Question: warning message) | |
3a0462b3 RD |
240 | -- The character ? appearing anywhere in a message makes the message a |
241 | -- warning instead of a normal error message, and the text of the | |
242 | -- message will be preceded by "Warning:" instead of "Error:" in the | |
243 | -- normal case. The handling of warnings if further controlled by the | |
244 | -- Warning_Mode option (-w switch), see package Opt for further | |
245 | -- details, and also by the current setting from pragma Warnings. This | |
246 | -- pragma applies only to warnings issued from the semantic phase (not | |
247 | -- the parser), but currently all relevant warnings are posted by the | |
248 | -- semantic phase anyway. Messages starting with (style) are also | |
249 | -- treated as warning messages. | |
70482933 | 250 | |
3711d646 RD |
251 | -- Insertion character < (Less Than: conditional warning message) |
252 | -- The character < appearing anywhere in a message is used for a | |
253 | -- conditional error message. If Error_Msg_Warn is True, then the | |
254 | -- effect is the same as ? described above. If Error_Msg_Warn is | |
255 | -- False, then there is no effect. | |
256 | ||
70482933 RK |
257 | -- Insertion character A-Z (Upper case letter: Ada reserved word) |
258 | -- If two or more upper case letters appear in the message, they are | |
259 | -- taken as an Ada reserved word, and are converted to the default | |
260 | -- case for reserved words (see Scans package spec). Surrounding | |
261 | -- quotes are added unless manual quotation mode is currently set. | |
262 | ||
263 | -- Insertion character ` (Backquote: set manual quotation mode) | |
87b3f81f AC |
264 | -- The backquote character always appears in pairs. Each backquote of |
265 | -- the pair is replaced by a double quote character. In addition, Any | |
266 | -- reserved keywords, or name insertions between these backquotes are | |
267 | -- not surrounded by the usual automatic double quotes. See the | |
70482933 RK |
268 | -- section below on manual quotation mode for further details. |
269 | ||
270 | -- Insertion character ' (Quote: literal character) | |
271 | -- Precedes a character which is placed literally into the message. | |
272 | -- Used to insert characters into messages that are one of the | |
fbf5a39b AC |
273 | -- insertion characters defined here. Also useful in inserting |
274 | -- sequences of upper case letters (e.g. RM) which are not to be | |
275 | -- treated as keywords. | |
70482933 RK |
276 | |
277 | -- Insertion character \ (Backslash: continuation message) | |
278 | -- Indicates that the message is a continuation of a message | |
87b3f81f AC |
279 | -- previously posted. This is used to ensure that such groups of |
280 | -- messages are treated as a unit. The \ character must be the first | |
281 | -- character of the message text. | |
70482933 | 282 | |
07fc65c4 GB |
283 | -- Insertion character | (vertical bar, non-serious error) |
284 | -- By default, error messages (other than warning messages) are | |
87b3f81f AC |
285 | -- considered to be fatal error messages which prevent expansion or |
286 | -- generation of code in the presence of the -gnatQ switch. If the | |
287 | -- insertion character | appears, the message is considered to be | |
288 | -- non-serious, and does not cause Serious_Errors_Detected to be | |
289 | -- incremented (so expansion is not prevented by such a msg). | |
07fc65c4 | 290 | |
555360a5 AC |
291 | ---------------------------------------- |
292 | -- Specialization of Messages for VMS -- | |
293 | ---------------------------------------- | |
294 | ||
295 | -- Some messages mention gcc-style switch names. When using an OpenVMS | |
296 | -- host, such switch names must be converted to their corresponding VMS | |
297 | -- qualifer. The following table controls this translation. In each case | |
298 | -- the original message must contain the string "-xxx switch", where xxx | |
299 | -- is the Gname? entry from below, and this string will be replaced by | |
300 | -- "/yyy qualifier", where yyy is the corresponding Vname? entry. | |
301 | ||
302 | Gname1 : aliased constant String := "fno-strict-aliasing"; | |
8a6a52dc | 303 | Vname1 : aliased constant String := "OPTIMIZE=NO_STRICT_ALIASING"; |
555360a5 AC |
304 | |
305 | Gname2 : aliased constant String := "gnatX"; | |
306 | Vname2 : aliased constant String := "EXTENSIONS_ALLOWED"; | |
307 | ||
308 | Gname3 : aliased constant String := "gnatW"; | |
309 | Vname3 : aliased constant String := "WIDE_CHARACTER_ENCODING"; | |
310 | ||
311 | Gname4 : aliased constant String := "gnatf"; | |
312 | Vname4 : aliased constant String := "REPORT_ERRORS=FULL"; | |
313 | ||
0ab80019 AC |
314 | Gname5 : aliased constant String := "gnat05"; |
315 | Vname5 : aliased constant String := "05"; | |
316 | ||
555360a5 AC |
317 | type Cstring_Ptr is access constant String; |
318 | ||
319 | Gnames : array (Nat range <>) of Cstring_Ptr := | |
320 | (Gname1'Access, | |
321 | Gname2'Access, | |
322 | Gname3'Access, | |
0ab80019 AC |
323 | Gname4'Access, |
324 | Gname5'Access); | |
555360a5 AC |
325 | |
326 | Vnames : array (Nat range <>) of Cstring_Ptr := | |
327 | (Vname1'Access, | |
328 | Vname2'Access, | |
329 | Vname3'Access, | |
0ab80019 AC |
330 | Vname4'Access, |
331 | Vname5'Access); | |
555360a5 | 332 | |
70482933 RK |
333 | ----------------------------------------------------- |
334 | -- Global Values Used for Error Message Insertions -- | |
335 | ----------------------------------------------------- | |
336 | ||
337 | -- The following global variables are essentially additional parameters | |
338 | -- passed to the error message routine for insertion sequences described | |
339 | -- above. The reason these are passed globally is that the insertion | |
340 | -- mechanism is essentially an untyped one in which the appropriate | |
9de61fcb RD |
341 | -- variables are set depending on the specific insertion characters used. |
342 | ||
343 | -- Note that is mandatory that the caller ensure that global variables | |
344 | -- are set before the Error_Msg call, otherwise the result is undefined. | |
70482933 | 345 | |
fbf5a39b | 346 | Error_Msg_Col : Column_Number renames Err_Vars.Error_Msg_Col; |
70482933 RK |
347 | -- Column for @ insertion character in message |
348 | ||
fbf5a39b AC |
349 | Error_Msg_Uint_1 : Uint renames Err_Vars.Error_Msg_Uint_1; |
350 | Error_Msg_Uint_2 : Uint renames Err_Vars.Error_Msg_Uint_2; | |
70482933 RK |
351 | -- Uint values for ^ insertion characters in message |
352 | ||
fbf5a39b | 353 | Error_Msg_Sloc : Source_Ptr renames Err_Vars.Error_Msg_Sloc; |
70482933 RK |
354 | -- Source location for # insertion character in message |
355 | ||
fbf5a39b AC |
356 | Error_Msg_Name_1 : Name_Id renames Err_Vars.Error_Msg_Name_1; |
357 | Error_Msg_Name_2 : Name_Id renames Err_Vars.Error_Msg_Name_2; | |
358 | Error_Msg_Name_3 : Name_Id renames Err_Vars.Error_Msg_Name_3; | |
70482933 RK |
359 | -- Name_Id values for % insertion characters in message |
360 | ||
fbf5a39b AC |
361 | Error_Msg_Unit_1 : Name_Id renames Err_Vars.Error_Msg_Unit_1; |
362 | Error_Msg_Unit_2 : Name_Id renames Err_Vars.Error_Msg_Unit_2; | |
70482933 RK |
363 | -- Name_Id values for $ insertion characters in message |
364 | ||
fbf5a39b AC |
365 | Error_Msg_Node_1 : Node_Id renames Err_Vars.Error_Msg_Node_1; |
366 | Error_Msg_Node_2 : Node_Id renames Err_Vars.Error_Msg_Node_2; | |
70482933 RK |
367 | -- Node_Id values for & insertion characters in message |
368 | ||
fbf5a39b | 369 | Error_Msg_Qual_Level : Int renames Err_Vars.Error_Msg_Qual_Level; |
70482933 RK |
370 | -- Number of levels of qualification required for type name (see the |
371 | -- description of the } insertion character. Note that this value does | |
372 | -- note get reset by any Error_Msg call, so the caller is responsible | |
373 | -- for resetting it. | |
374 | ||
3711d646 RD |
375 | Error_Msg_Warn : Boolean renames Err_Vars.Error_Msg_Warn; |
376 | -- Used if current message contains a < insertion character to indicate | |
377 | -- if the current message is a warning message. | |
378 | ||
70482933 RK |
379 | ----------------------------------------------------- |
380 | -- Format of Messages and Manual Quotation Control -- | |
381 | ----------------------------------------------------- | |
382 | ||
383 | -- Messages are generally all in lower case, except for inserted names | |
384 | -- and appear in one of the following three forms: | |
385 | ||
386 | -- error: text | |
387 | -- warning: text | |
388 | ||
389 | -- The prefixes error and warning are supplied automatically (depending | |
390 | -- on the use of the ? insertion character), and the call to the error | |
391 | -- message routine supplies the text. The "error: " prefix is omitted | |
392 | -- in brief error message formats. | |
393 | ||
394 | -- Reserved Ada keywords in the message are in the default keyword case | |
395 | -- (determined from the given source program), surrounded by quotation | |
396 | -- marks. This is achieved by spelling the reserved word in upper case | |
397 | -- letters, which is recognized as a request for insertion of quotation | |
398 | -- marks by the error text processor. Thus for example: | |
399 | ||
400 | -- Error_Msg_AP ("IS expected"); | |
401 | ||
402 | -- would result in the output of one of the following: | |
403 | ||
404 | -- error: "is" expected | |
405 | -- error: "IS" expected | |
406 | -- error: "Is" expected | |
407 | ||
408 | -- the choice between these being made by looking at the casing convention | |
409 | -- used for keywords (actually the first compilation unit keyword) in the | |
410 | -- source file. | |
411 | ||
412 | -- In the case of names, the default mode for the error text processor | |
413 | -- is to surround the name by quotation marks automatically. The case | |
414 | -- used for the identifier names is taken from the source program where | |
415 | -- possible, and otherwise is the default casing convention taken from | |
416 | -- the source file usage. | |
417 | ||
418 | -- In some cases, better control over the placement of quote marks is | |
419 | -- required. This is achieved using manual quotation mode. In this mode, | |
420 | -- one or more insertion sequences is surrounded by backquote characters. | |
421 | -- The backquote characters are output as double quote marks, and normal | |
422 | -- automatic insertion of quotes is suppressed between the double quotes. | |
423 | -- For example: | |
424 | ||
425 | -- Error_Msg_AP ("`END &;` expected"); | |
426 | ||
427 | -- generates a message like | |
428 | ||
429 | -- error: "end Open_Scope;" expected | |
430 | ||
431 | -- where the node specifying the name Open_Scope has been stored in | |
432 | -- Error_Msg_Node_1 prior to the call. The great majority of error | |
433 | -- messages operates in normal quotation mode. | |
434 | ||
435 | -- Note: the normal automatic insertion of spaces before insertion | |
436 | -- sequences (such as those that come from & and %) is suppressed in | |
437 | -- manual quotation mode, so blanks, if needed as in the above example, | |
438 | -- must be explicitly present. | |
439 | ||
440 | ---------------------------- | |
441 | -- Message ID Definitions -- | |
442 | ---------------------------- | |
443 | ||
fbf5a39b AC |
444 | subtype Error_Msg_Id is Erroutc.Error_Msg_Id; |
445 | function "=" (Left, Right : Error_Msg_Id) return Boolean | |
446 | renames Erroutc."="; | |
70482933 RK |
447 | -- A type used to represent specific error messages. Used by the clients |
448 | -- of this package only in the context of the Get_Error_Id and | |
449 | -- Change_Error_Text subprograms. | |
450 | ||
fbf5a39b | 451 | No_Error_Msg : constant Error_Msg_Id := Erroutc.No_Error_Msg; |
70482933 RK |
452 | -- A constant which is different from any value returned by Get_Error_Id. |
453 | -- Typically used by a client to indicate absense of a saved Id value. | |
454 | ||
fbf5a39b | 455 | function Get_Msg_Id return Error_Msg_Id renames Erroutc.Get_Msg_Id; |
70482933 RK |
456 | -- Returns the Id of the message most recently posted using one of the |
457 | -- Error_Msg routines. | |
458 | ||
fbf5a39b AC |
459 | function Get_Location (E : Error_Msg_Id) return Source_Ptr |
460 | renames Erroutc.Get_Location; | |
3711d646 | 461 | -- Returns the flag location of the error message with the given id E |
70482933 RK |
462 | |
463 | ------------------------ | |
464 | -- List Pragmas Table -- | |
465 | ------------------------ | |
466 | ||
467 | -- When a pragma Page or pragma List is encountered by the parser, an | |
468 | -- entry is made in the following table. This table is then used to | |
469 | -- control the full listing if one is being generated. Note that the | |
470 | -- reason we do the processing in the parser is so that we get proper | |
471 | -- listing control even in syntax check only mode. | |
472 | ||
473 | type List_Pragma_Type is (List_On, List_Off, Page); | |
474 | ||
475 | type List_Pragma_Record is record | |
476 | Ptyp : List_Pragma_Type; | |
477 | Ploc : Source_Ptr; | |
478 | end record; | |
479 | ||
87b3f81f AC |
480 | -- Note: Ploc points to the terminating semicolon in the List_Off and Page |
481 | -- cases, and to the pragma keyword for List_On. In the case of a pragma | |
482 | -- List_Off, a List_On entry is also made in the table, pointing to the | |
483 | -- pragma keyword. This ensures that, as required, a List (Off) pragma is | |
484 | -- listed even in list off mode. | |
70482933 RK |
485 | |
486 | package List_Pragmas is new Table.Table ( | |
487 | Table_Component_Type => List_Pragma_Record, | |
488 | Table_Index_Type => Int, | |
489 | Table_Low_Bound => 1, | |
490 | Table_Initial => 50, | |
491 | Table_Increment => 200, | |
492 | Table_Name => "List_Pragmas"); | |
493 | ||
494 | --------------------------- | |
495 | -- Ignore_Errors Feature -- | |
496 | --------------------------- | |
497 | ||
498 | -- In certain cases, notably for optional subunits, the compiler operates | |
499 | -- in a mode where errors are to be ignored, and the whole unit is to be | |
500 | -- considered as not present. To implement this we provide the following | |
501 | -- flag to enable special handling, where error messages are suppressed, | |
502 | -- but the Fatal_Error flag will still be set in the normal manner. | |
503 | ||
504 | Ignore_Errors_Enable : Nat := 0; | |
505 | -- Triggering switch. If non-zero, then ignore errors mode is activated. | |
506 | -- This is a counter to allow convenient nesting of enable/disable. | |
507 | ||
508 | ------------------------------ | |
509 | -- Error Output Subprograms -- | |
510 | ------------------------------ | |
511 | ||
512 | procedure Initialize; | |
513 | -- Initializes for output of error messages. Must be called for each | |
514 | -- source file before using any of the other routines in the package. | |
515 | ||
516 | procedure Finalize; | |
517 | -- Finalize processing of error messages for one file and output message | |
518 | -- indicating the number of detected errors. | |
519 | ||
520 | procedure Error_Msg (Msg : String; Flag_Location : Source_Ptr); | |
521 | -- Output a message at specified location. Can be called from the parser | |
522 | -- or the semantic analyzer. | |
523 | ||
524 | procedure Error_Msg_S (Msg : String); | |
525 | -- Output a message at current scan pointer location. This routine can be | |
526 | -- called only from the parser, since it references Scan_Ptr. | |
527 | ||
528 | procedure Error_Msg_AP (Msg : String); | |
529 | -- Output a message just after the previous token. This routine can be | |
530 | -- called only from the parser, since it references Prev_Token_Ptr. | |
531 | ||
532 | procedure Error_Msg_BC (Msg : String); | |
533 | -- Output a message just before the current token. Note that the important | |
534 | -- difference between this and the previous routine is that the BC case | |
535 | -- posts a flag on the current line, whereas AP can post a flag at the | |
536 | -- end of the preceding line. This routine can be called only from the | |
537 | -- parser, since it references Token_Ptr. | |
538 | ||
539 | procedure Error_Msg_SC (Msg : String); | |
540 | -- Output a message at the start of the current token, unless we are at | |
541 | -- the end of file, in which case we always output the message after the | |
542 | -- last real token in the file. This routine can be called only from the | |
543 | -- parser, since it references Token_Ptr. | |
544 | ||
545 | procedure Error_Msg_SP (Msg : String); | |
546 | -- Output a message at the start of the previous token. This routine can | |
547 | -- be called only from the parser, since it references Prev_Token_Ptr. | |
548 | ||
549 | procedure Error_Msg_N (Msg : String; N : Node_Or_Entity_Id); | |
550 | -- Output a message at the Sloc of the given node. This routine can be | |
87b3f81f AC |
551 | -- called from the parser or the semantic analyzer, although the call from |
552 | -- the latter is much more common (and is the most usual way of generating | |
553 | -- error messages from the analyzer). The message text may contain a | |
554 | -- single & insertion, which will reference the given node. The message is | |
555 | -- suppressed if the node N already has a message posted, or if it is a | |
556 | -- warning and warnings and N is an entity node for which warnings are | |
557 | -- suppressed. | |
70482933 | 558 | |
fbf5a39b AC |
559 | procedure Error_Msg_F (Msg : String; N : Node_Id); |
560 | -- Similar to Error_Msg_N except that the message is placed on the | |
561 | -- first node of the construct N (First_Node (N)). | |
562 | ||
70482933 RK |
563 | procedure Error_Msg_NE |
564 | (Msg : String; | |
565 | N : Node_Or_Entity_Id; | |
566 | E : Node_Or_Entity_Id); | |
07fc65c4 GB |
567 | -- Output a message at the Sloc of the given node N, with an insertion of |
568 | -- the name from the given entity node E. This is used by the semantic | |
87b3f81f AC |
569 | -- routines, where this is a common error message situation. The Msg text |
570 | -- will contain a & or } as usual to mark the insertion point. This | |
571 | -- routine can be called from the parser or the analyzer. | |
70482933 | 572 | |
fbf5a39b AC |
573 | procedure Error_Msg_FE |
574 | (Msg : String; | |
575 | N : Node_Id; | |
576 | E : Node_Or_Entity_Id); | |
577 | -- Same as Error_Msg_NE, except that the message is placed on the first | |
578 | -- node of the construct N (First_Node (N)). | |
579 | ||
07fc65c4 GB |
580 | procedure Error_Msg_NEL |
581 | (Msg : String; | |
582 | N : Node_Or_Entity_Id; | |
583 | E : Node_Or_Entity_Id; | |
584 | Flag_Location : Source_Ptr); | |
585 | -- Exactly the same as Error_Msg_NE, except that the flag is placed at | |
586 | -- the specified Flag_Location instead of at Sloc (N). | |
587 | ||
fbf5a39b AC |
588 | procedure Error_Msg_NW |
589 | (Eflag : Boolean; | |
590 | Msg : String; | |
591 | N : Node_Or_Entity_Id); | |
592 | -- This routine is used for posting a message conditionally. The message | |
593 | -- is posted (with the same effect as Error_Msg_N (Msg, N) if and only | |
594 | -- if Eflag is True and if the node N is within the main extended source | |
2aab5fd5 | 595 | -- unit and comes from source. Typically this is a warning mode flag. |
fbf5a39b | 596 | |
70482933 RK |
597 | procedure Change_Error_Text (Error_Id : Error_Msg_Id; New_Msg : String); |
598 | -- The error message text of the message identified by Id is replaced by | |
599 | -- the given text. This text may contain insertion characters in the | |
600 | -- usual manner, and need not be the same length as the original text. | |
601 | ||
fbf5a39b AC |
602 | function First_Node (C : Node_Id) return Node_Id; |
603 | -- Given a construct C, finds the first node in the construct, i.e. the | |
604 | -- one with the lowest Sloc value. This is useful in placing error msgs. | |
605 | ||
bc202b70 AC |
606 | function First_Sloc (N : Node_Id) return Source_Ptr; |
607 | -- Given the node for an expression, return a source pointer value that | |
608 | -- points to the start of the first token in the expression. In the case | |
609 | -- where the expression is parenthesized, an attempt is made to include | |
610 | -- the parentheses (i.e. to return the location of the initial paren). | |
611 | ||
fbf5a39b AC |
612 | procedure Purge_Messages (From : Source_Ptr; To : Source_Ptr) |
613 | renames Erroutc.Purge_Messages; | |
70482933 RK |
614 | -- All error messages whose location is in the range From .. To (not |
615 | -- including the end points) will be deleted from the error listing. | |
616 | ||
617 | procedure Remove_Warning_Messages (N : Node_Id); | |
618 | -- Remove any warning messages corresponding to the Sloc of N or any | |
619 | -- of its descendent nodes. No effect if no such warnings. | |
620 | ||
fbf5a39b | 621 | procedure Remove_Warning_Messages (L : List_Id); |
3711d646 | 622 | -- Remove warnings on all elements of a list |
fbf5a39b AC |
623 | |
624 | procedure Set_Ignore_Errors (To : Boolean); | |
625 | -- Following a call to this procedure with To=True, all error calls are | |
626 | -- ignored. A call with To=False restores the default treatment in which | |
627 | -- error calls are treated as usual (and as described in this spec). | |
628 | ||
629 | procedure Set_Warnings_Mode_Off (Loc : Source_Ptr) | |
630 | renames Erroutc.Set_Warnings_Mode_Off; | |
70482933 RK |
631 | -- Called in response to a pragma Warnings (Off) to record the source |
632 | -- location from which warnings are to be turned off. | |
633 | ||
fbf5a39b AC |
634 | procedure Set_Warnings_Mode_On (Loc : Source_Ptr) |
635 | renames Erroutc.Set_Warnings_Mode_On; | |
70482933 RK |
636 | -- Called in response to a pragma Warnings (On) to record the source |
637 | -- location from which warnings are to be turned back on. | |
638 | ||
fbf5a39b AC |
639 | function Compilation_Errors return Boolean |
640 | renames Erroutc.Compilation_Errors; | |
70482933 RK |
641 | -- Returns true if errors have been detected, or warnings in -gnatwe |
642 | -- (treat warnings as errors) mode. | |
643 | ||
fbf5a39b | 644 | procedure Error_Msg_CRT (Feature : String; N : Node_Id); |
87b3f81f AC |
645 | -- Posts a non-fatal message on node N saying that the feature identified |
646 | -- by the Feature argument is not supported in either configurable | |
647 | -- run-time mode or no run-time mode (as appropriate). In the former case, | |
648 | -- the name of the library is output if available. | |
fbf5a39b AC |
649 | |
650 | procedure dmsg (Id : Error_Msg_Id) renames Erroutc.dmsg; | |
70482933 RK |
651 | -- Debugging routine to dump an error message |
652 | ||
fbf5a39b AC |
653 | ------------------------------------ |
654 | -- Utility Interface for Back End -- | |
655 | ------------------------------------ | |
656 | ||
657 | -- The following subprograms can be used by the back end for the purposes | |
658 | -- of concocting error messages that are not output via Errout, e.g. the | |
659 | -- messages generated by the gcc back end. | |
660 | ||
661 | procedure Set_Identifier_Casing | |
662 | (Identifier_Name : System.Address; | |
663 | File_Name : System.Address); | |
87b3f81f AC |
664 | -- The identifier is a null terminated string that represents the name of |
665 | -- an identifier appearing in the source program. File_Name is a null | |
fbf5a39b AC |
666 | -- terminated string giving the corresponding file name for the identifier |
667 | -- as obtained from the front end by the use of Full_Debug_Name to the | |
87b3f81f AC |
668 | -- source file referenced by the corresponding source location value. On |
669 | -- return, the name is in Name_Buffer, null terminated with Name_Len set. | |
670 | -- This name is the identifier name as passed, cased according to the | |
671 | -- default identifier casing for the given file. | |
fbf5a39b | 672 | |
70482933 | 673 | end Errout; |