1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2007, 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 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 --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 -- This packages contains global variables and routines common to error
28 -- reporting packages, including Errout and Prj.Err.
31 with Types; use Types;
35 Class_Flag : Boolean := False;
36 -- This flag is set True when outputting a reference to a class-wide
37 -- type, and is used by Add_Class to insert 'Class at the proper point
39 Continuation : Boolean := False;
40 -- Indicates if current message is a continuation. Intialized from the
41 -- Msg_Cont parameter in Error_Msg_Internal and then set True if a \
42 -- insertion character is encountered.
44 Continuation_New_Line : Boolean := False;
45 -- Indicates if current message was a continuation line marked with \\ to
46 -- force a new line. Set True if \\ encountered.
48 Flag_Source : Source_File_Index;
49 -- Source file index for source file where error is being posted
51 Is_Warning_Msg : Boolean := False;
52 -- Set True to indicate if current message is warning message
54 Is_Style_Msg : Boolean := False;
55 -- Set True to indicate if the current message is a style message
57 Is_Serious_Error : Boolean := False;
58 -- Set by Set_Msg_Text to indicate if current message is serious error
60 Is_Unconditional_Msg : Boolean := False;
61 -- Set by Set_Msg_Text to indicate if current message is unconditional
63 Kill_Message : Boolean := False;
64 -- A flag used to kill weird messages (e.g. those containing uninterpreted
65 -- implicit type references) if we have already seen at least one message
66 -- already. The idea is that we hope the weird message is a junk cascaded
67 -- message that should be suppressed.
69 Last_Killed : Boolean := False;
70 -- Set True if the most recently posted non-continuation message was
71 -- killed. This is used to determine the processing of any continuation
72 -- messages that follow.
74 List_Pragmas_Index : Int := 0;
75 -- Index into List_Pragmas table
77 List_Pragmas_Mode : Boolean := False;
78 -- Starts True, gets set False by pragma List (Off), True by List (On)
80 Manual_Quote_Mode : Boolean := False;
81 -- Set True in manual quotation mode
83 Max_Msg_Length : constant := 1024 + 2 * Int (Column_Number'Last);
84 -- Maximum length of error message. The addition of 2 * Column_Number'Last
85 -- ensures that two insertion tokens of maximum length can be accomodated.
86 -- The value of 1024 is an arbitrary value that should be more than long
87 -- enough to accomodate any reasonable message (and for that matter, some
88 -- pretty unreasonable messages!)
90 Msg_Buffer : String (1 .. Max_Msg_Length);
91 -- Buffer used to prepare error messages
93 Msglen : Integer := 0;
94 -- Number of characters currently stored in the message buffer
96 Suppress_Message : Boolean;
97 -- A flag used to suppress certain obviously redundant messages (i.e.
98 -- those referring to a node whose type is Any_Type). This suppression
99 -- is effective only if All_Errors_Mode is off.
101 Suppress_Instance_Location : Boolean := False;
102 -- Normally, if a # location in a message references a location within
103 -- a generic template, then a note is added giving the location of the
104 -- instantiation. If this variable is set True, then this note is not
105 -- output. This is used for internal processing for the case of an
106 -- illegal instantiation. See Error_Msg routine for further details.
108 ----------------------------
109 -- Message ID Definitions --
110 ----------------------------
112 type Error_Msg_Id is new Int;
113 -- A type used to represent specific error messages. Used by the clients
114 -- of this package only in the context of the Get_Error_Id and
115 -- Change_Error_Text subprograms.
117 No_Error_Msg : constant Error_Msg_Id := 0;
118 -- A constant which is different from any value returned by Get_Error_Id.
119 -- Typically used by a client to indicate absense of a saved Id value.
121 Cur_Msg : Error_Msg_Id := No_Error_Msg;
122 -- Id of most recently posted error message
124 function Get_Msg_Id return Error_Msg_Id;
125 -- Returns the Id of the message most recently posted using one of the
126 -- Error_Msg routines.
128 function Get_Location (E : Error_Msg_Id) return Source_Ptr;
129 -- Returns the flag location of the error message with the given id E
131 -----------------------------------
132 -- Error Message Data Structures --
133 -----------------------------------
135 -- The error messages are stored as a linked list of error message objects
136 -- sorted into ascending order by the source location (Sloc). Each object
137 -- records the text of the message and its source location.
139 -- The following record type and table are used to represent error
140 -- messages, with one entry in the table being allocated for each message.
142 type Error_Msg_Object is record
144 -- Text of error message, fully expanded with all insertions
147 -- Pointer to next message in error chain. A value of No_Error_Msg
148 -- indicates the end of the chain.
150 Sfile : Source_File_Index;
151 -- Source table index of source file. In the case of an error that
152 -- refers to a template, always references the original template
153 -- not an instantiation copy.
156 -- Flag pointer. In the case of an error that refers to a template,
157 -- always references the original template, not an instantiation copy.
158 -- This value is the actual place in the source that the error message
159 -- will be posted. Note that an error placed on an instantiation will
160 -- have Sptr pointing to the instantiation point.
163 -- Flag location used in the call to post the error. This is normally
164 -- the same as Sptr, except when an error is posted on a particular
165 -- instantiation of a generic. In such a case, Sptr will point to
166 -- the original source location of the instantiation itself, but
167 -- Optr will point to the template location (more accurately to the
168 -- template copy in the instantiation copy corresponding to the
169 -- instantiation referenced by Sptr).
171 Line : Physical_Line_Number;
172 -- Line number for error message
175 -- Column number for error message
178 -- True if warning message (i.e. insertion character ? appeared)
181 -- True if style message (starts with "(style)")
184 -- True if serious error message (not a warning and no | character)
187 -- True if unconditional message (i.e. insertion character ! appeared)
190 -- This is used for logical messages that are composed of multiple
191 -- individual messages. For messages that are not part of such a
192 -- group, or that are the first message in such a group. Msg_Cont
193 -- is set to False. For subsequent messages in a group, Msg_Cont
194 -- is set to True. This is used to make sure that such a group of
195 -- messages is either suppressed or retained as a group (e.g. in
196 -- the circuit that deletes identical messages).
199 -- If this flag is set, the message is not printed. This is used
200 -- in the circuit for deleting duplicate/redundant error messages.
203 package Errors is new Table.Table (
204 Table_Component_Type => Error_Msg_Object,
205 Table_Index_Type => Error_Msg_Id,
206 Table_Low_Bound => 1,
207 Table_Initial => 200,
208 Table_Increment => 200,
209 Table_Name => "Error");
211 First_Error_Msg : Error_Msg_Id;
212 -- The list of error messages, i.e. the first entry on the list of error
213 -- messages. This is not the same as the physically first entry in the
214 -- error message table, since messages are not always inserted in sequence.
216 Last_Error_Msg : Error_Msg_Id;
217 -- The last entry on the list of error messages. Note that this is not
218 -- the same as the physically last entry in the error message table, since
219 -- messages are not always inserted in sequence.
221 --------------------------
222 -- Warning Mode Control --
223 --------------------------
225 -- Pragma Warnings allows warnings to be turned off for a specified
226 -- region of code, and the following tables are the data structure used
227 -- to keep track of these regions.
229 -- The first table is used for the basic command line control, and for
230 -- the forms of Warning with a single ON or OFF parameter
232 -- It contains pairs of source locations, the first being the start
233 -- location for a warnings off region, and the second being the end
234 -- location. When a pragma Warnings (Off) is encountered, a new entry
235 -- is established extending from the location of the pragma to the
236 -- end of the current source file. A subsequent pragma Warnings (On)
237 -- adjusts the end point of this entry appropriately.
239 -- If all warnings are suppressed by comamnd switch, then there is a
240 -- dummy entry (put there by Errout.Initialize) at the start of the
241 -- table which covers all possible Source_Ptr values. Note that the
242 -- source pointer values in this table always reference the original
243 -- template, not an instantiation copy, in the generic case.
245 type Warnings_Entry is record
250 package Warnings is new Table.Table (
251 Table_Component_Type => Warnings_Entry,
252 Table_Index_Type => Natural,
253 Table_Low_Bound => 1,
254 Table_Initial => 100,
255 Table_Increment => 200,
256 Table_Name => "Warnings");
258 -- The second table is used for the specific forms of the pragma, where
259 -- the first argument is ON or OFF, and the second parameter is a string
260 -- which is the entire message to suppress, or a prefix of it.
262 type Specific_Warning_Entry is record
265 -- Starting and ending source pointers for the range. These are always
266 -- from the same source file.
269 -- Message from pragma Warnings (Off, string)
271 Pattern : String_Ptr;
272 -- Same as Msg, excluding initial and final asterisks if present. The
273 -- lower bound of this string is always one.
276 -- Length of pattern string (excluding initial/final asterisks)
279 -- Set to True if OFF has been encountered with no matching ON
282 -- Set to True if entry has been used to suppress a warning
284 Star_Start : Boolean;
285 -- True if given pattern had * at start
288 -- True if given pattern had * at end
291 -- True if pragma is configuration pragma (in which case no matching
292 -- Off pragma is required, and it is not required that a specific
293 -- warning be suppressed).
296 package Specific_Warnings is new Table.Table (
297 Table_Component_Type => Specific_Warning_Entry,
298 Table_Index_Type => Natural,
299 Table_Low_Bound => 1,
300 Table_Initial => 100,
301 Table_Increment => 200,
302 Table_Name => "Specific_Warnings");
304 -- Note on handling configuration case versus specific case. A complication
305 -- arises from this example:
307 -- pragma Warnings (Off, "not referenced*");
308 -- procedure Mumble (X : Integer) is
309 -- pragma Warnings (On, "not referenced*");
314 -- The trouble is that the first pragma is technically a configuration
315 -- pragma, and yet it is clearly being used in the context of thinking
316 -- of it as a specific case. To deal with this, what we do is that the
317 -- On entry can match a configuration pragma from the same file, and if
318 -- we find such an On entry, we cancel the indication of it being the
319 -- configuration case. This seems to handle all cases we run into ok.
326 -- Add 'Class to buffer for class wide type case (Class_Flag set)
328 function Buffer_Ends_With (S : String) return Boolean;
329 -- Tests if message buffer ends with given string preceded by a space
331 procedure Buffer_Remove (S : String);
332 -- Removes given string from end of buffer if it is present
333 -- at end of buffer, and preceded by a space.
335 function Compilation_Errors return Boolean;
336 -- Returns true if errors have been detected, or warnings in -gnatwe
337 -- (treat warnings as errors) mode.
339 procedure dmsg (Id : Error_Msg_Id);
340 -- Debugging routine to dump an error message
342 procedure Debug_Output (N : Node_Id);
343 -- Called from Error_Msg_N and Error_Msg_NE to generate line of debug
344 -- output giving node number (of node N) if the debug X switch is set.
346 procedure Check_Duplicate_Message (M1, M2 : Error_Msg_Id);
347 -- This function is passed the Id values of two error messages. If
348 -- either M1 or M2 is a continuation message, or is already deleted,
349 -- the call is ignored. Otherwise a check is made to see if M1 and M2
350 -- are duplicated or redundant. If so, the message to be deleted and
351 -- all its continuations are marked with the Deleted flag set to True.
353 procedure Output_Error_Msgs (E : in out Error_Msg_Id);
354 -- Output source line, error flag, and text of stored error message and
355 -- all subsequent messages for the same line and unit. On return E is
356 -- set to be one higher than the last message output.
358 procedure Output_Line_Number (L : Logical_Line_Number);
359 -- Output a line number as six digits (with leading zeroes suppressed),
360 -- followed by a period and a blank (note that this is 8 characters which
361 -- means that tabs in the source line will not get messed up). Line numbers
362 -- that match or are less than the last Source_Reference pragma are listed
363 -- as all blanks, avoiding output of junk line numbers.
365 procedure Output_Msg_Text (E : Error_Msg_Id);
366 -- Outputs characters of text in the text of the error message E. Note that
367 -- no end of line is output, the caller is responsible for adding the end
368 -- of line. If Error_Msg_Line_Length is non-zero, this is the routine that
369 -- splits the line generating multiple lines of output, and in this case
370 -- the last line has no terminating end of line character.
372 procedure Purge_Messages (From : Source_Ptr; To : Source_Ptr);
373 -- All error messages whose location is in the range From .. To (not
374 -- including the end points) will be deleted from the error listing.
376 function Same_Error (M1, M2 : Error_Msg_Id) return Boolean;
377 -- See if two messages have the same text. Returns true if the text
378 -- of the two messages is identical, or if one of them is the same
379 -- as the other with an appended "instance at xxx" tag.
381 procedure Set_Msg_Blank;
382 -- Sets a single blank in the message if the preceding character is a
383 -- non-blank character other than a left parenthesis or minus. Has no
384 -- effect if manual quote mode is turned on.
386 procedure Set_Msg_Blank_Conditional;
387 -- Sets a single blank in the message if the preceding character is a
388 -- non-blank character other than a left parenthesis or quote. Has no
389 -- effect if manual quote mode is turned on.
391 procedure Set_Msg_Char (C : Character);
392 -- Add a single character to the current message. This routine does not
393 -- check for special insertion characters (they are just treated as text
394 -- characters if they occur).
396 procedure Set_Msg_Insertion_File_Name;
397 -- Handle file name insertion (left brace insertion character)
399 procedure Set_Msg_Insertion_Line_Number (Loc, Flag : Source_Ptr);
400 -- Handle line number insertion (# insertion character). Loc is the
401 -- location to be referenced, and Flag is the location at which the
402 -- flag is posted (used to determine whether to add "in file xxx")
404 procedure Set_Msg_Insertion_Name_Literal;
406 procedure Set_Msg_Insertion_Name;
407 -- Handle name insertion (% insertion character)
409 procedure Set_Msg_Insertion_Reserved_Name;
410 -- Handle insertion of reserved word name (* insertion character)
412 procedure Set_Msg_Insertion_Reserved_Word
415 -- Handle reserved word insertion (upper case letters). The Text argument
416 -- is the current error message input text, and J is an index which on
417 -- entry points to the first character of the reserved word, and on exit
418 -- points past the last character of the reserved word.
420 procedure Set_Msg_Insertion_Run_Time_Name;
421 -- If package System contains a definition for Run_Time_Name (see package
422 -- Targparm for details), then this procedure will insert a message of
423 -- the form (name) into the current error message, with name set in mixed
424 -- case (upper case after any spaces). If no run time name is defined,
425 -- then this routine has no effect).
427 procedure Set_Msg_Insertion_Uint;
428 -- Handle Uint insertion (^ insertion character)
430 procedure Set_Msg_Int (Line : Int);
431 -- Set the decimal representation of the argument in the error message
432 -- buffer with no leading zeroes output.
434 procedure Set_Msg_Name_Buffer;
435 -- Output name from Name_Buffer, with surrounding quotes unless manual
436 -- quotation mode is in effect.
438 procedure Set_Msg_Quote;
439 -- Set quote if in normal quote mode, nothing if in manual quote mode
441 procedure Set_Msg_Str (Text : String);
442 -- Add a sequence of characters to the current message. This routine does
443 -- not check for special insertion characters (they are just treated as
444 -- text characters if they occur).
446 procedure Set_Next_Non_Deleted_Msg (E : in out Error_Msg_Id);
447 -- Given a message id, move to next message id, but skip any deleted
448 -- messages, so that this results in E on output being the first non-
449 -- deleted message following the input value of E, or No_Error_Msg if
450 -- the input value of E was either already No_Error_Msg, or was the
451 -- last non-deleted message.
453 procedure Set_Specific_Warning_Off
457 -- This is called in response to the two argument form of pragma Warnings
458 -- where the first argument is OFF, and the second argument is a string
459 -- which identifies a specific warning to be suppressed. The first argument
460 -- is the start of the suppression range, and the second argument is the
461 -- string from the pragma. Loc is the location of the pragma (which is the
462 -- start of the range to suppress). Config is True for the configuration
463 -- pragma case (where there is no requirement for a matching OFF pragma).
465 procedure Set_Specific_Warning_On
469 -- This is called in response to the two argument form of pragma Warnings
470 -- where the first argument is ON, and the second argument is a string
471 -- which identifies a specific warning to be suppressed. The first argument
472 -- is the end of the suppression range, and the second argument is the
473 -- string from the pragma. Err is set to True on return to report the error
474 -- of no matching Warnings Off pragma preceding this one.
476 procedure Set_Warnings_Mode_Off (Loc : Source_Ptr);
477 -- Called in response to a pragma Warnings (Off) to record the source
478 -- location from which warnings are to be turned off.
480 procedure Set_Warnings_Mode_On (Loc : Source_Ptr);
481 -- Called in response to a pragma Warnings (On) to record the source
482 -- location from which warnings are to be turned back on.
484 procedure Test_Style_Warning_Serious_Msg (Msg : String);
485 -- Sets Is_Warning_Msg true if Msg is a warning message (contains a
486 -- question mark character), and False otherwise. Sets Is_Style_Msg
487 -- true if Msg is a style message (starts with "(style)"). Sets
488 -- Is_Serious_Error True unless the message is a warning or style
489 -- message or contains the character | indicating a non-serious
490 -- error message. Note that the call has no effect for continuation
491 -- messages (those whose first character is \).
493 function Warnings_Suppressed (Loc : Source_Ptr) return Boolean;
494 -- Determines if given location is covered by a warnings off suppression
495 -- range in the warnings table (or is suppressed by compilation option,
496 -- which generates a warning range for the whole source file). This routine
497 -- only deals with the general ON/OFF case, not specific warnings
499 function Warning_Specifically_Suppressed
501 Msg : String_Ptr) return Boolean;
502 -- Determines if given message to be posted at given location is suppressed
503 -- by specific ON/OFF Warnings pragmas specifying this particular message.
505 type Error_Msg_Proc is
506 access procedure (Msg : String; Flag_Location : Source_Ptr);
507 procedure Validate_Specific_Warnings (Eproc : Error_Msg_Proc);
508 -- Checks that specific warnings are consistent (for non-configuration
509 -- case, properly closed, and used). The argument is a pointer to the
510 -- Error_Msg procedure to be called if any inconsistencies are detected.