1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1991-2012, 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 ------------------------------------------------------------------------------
26 with Atree
; use Atree
;
27 with Err_Vars
; use Err_Vars
;
28 with Erroutc
; use Erroutc
;
29 with Namet
; use Namet
;
31 with Output
; use Output
;
32 with Scans
; use Scans
;
33 with Sinput
; use Sinput
;
34 with Stylesw
; use Stylesw
;
36 package body Errutil
is
38 Errors_Must_Be_Ignored
: Boolean := False;
39 -- Set to True by procedure Set_Ignore_Errors (True), when calls to
40 -- error message procedures should be ignored (when parsing irrelevant
41 -- text in sources being preprocessed).
43 -----------------------
44 -- Local Subprograms --
45 -----------------------
47 procedure Error_Msg_AP
(Msg
: String);
48 -- Output a message just after the previous token
50 procedure Output_Source_Line
51 (L
: Physical_Line_Number
;
52 Sfile
: Source_File_Index
;
54 Source_Type
: String);
55 -- Outputs text of source line L, in file S, together with preceding line
56 -- number, as described above for Output_Line_Number. The Errs parameter
57 -- indicates if there are errors attached to the line, which forces
58 -- listing on, even in the presence of pragma List (Off).
60 procedure Set_Msg_Insertion_Column
;
61 -- Handle column number insertion (@ insertion character)
63 procedure Set_Msg_Text
(Text
: String; Flag
: Source_Ptr
);
64 -- Add a sequence of characters to the current message. The characters may
65 -- be one of the special insertion characters (see documentation in spec).
66 -- Flag is the location at which the error is to be posted, which is used
67 -- to determine whether or not the # insertion needs a file name. The
68 -- variables Msg_Buffer, Msglen, Is_Style_Msg, Is_Warning_Msg, and
69 -- Is_Unconditional_Msg are set on return.
75 procedure Error_Msg_AP
(Msg
: String) is
80 -- If we had saved the Scan_Ptr value after scanning the previous
81 -- token, then we would have exactly the right place for putting
82 -- the flag immediately at hand. However, that would add at least
83 -- two instructions to a Scan call *just* to service the possibility
84 -- of an Error_Msg_AP call. So instead we reconstruct that value.
86 -- We have two possibilities, start with Prev_Token_Ptr and skip over
87 -- the current token, which is made harder by the possibility that this
88 -- token may be in error, or start with Token_Ptr and work backwards.
89 -- We used to take the second approach, but it's hard because of
90 -- comments, and harder still because things that look like comments
91 -- can appear inside strings. So now we take the first approach.
93 -- Note: in the case where there is no previous token, Prev_Token_Ptr
94 -- is set to Source_First, which is a reasonable position for the
95 -- error flag in this situation.
100 -- If the previous token is a string literal, we need a special approach
101 -- since there may be white space inside the literal and we don't want
102 -- to stop on that white space.
104 -- Note that it is not worth worrying about special UTF_32 line
105 -- terminator characters in this context, since this is only about
106 -- error recovery anyway.
108 if Prev_Token
= Tok_String_Literal
then
112 if Source
(S1
) = C
then
114 exit when Source
(S1
) /= C
;
115 elsif Source
(S1
) in Line_Terminator
then
120 -- Character literal also needs special handling
122 elsif Prev_Token
= Tok_Char_Literal
then
125 -- Otherwise we search forward for the end of the current token, marked
126 -- by a line terminator, white space, a comment symbol or if we bump
127 -- into the following token (i.e. the current token)
129 -- Note that it is not worth worrying about special UTF_32 line
130 -- terminator characters in this context, since this is only about
131 -- error recovery anyway.
134 while Source
(S1
) not in Line_Terminator
135 and then Source
(S1
) /= ' '
136 and then Source
(S1
) /= ASCII
.HT
137 and then (Source
(S1
) /= '-' or else Source
(S1
+ 1) /= '-')
138 and then S1
/= Token_Ptr
144 -- S1 is now set to the location for the flag
154 procedure Error_Msg
(Msg
: String; Flag_Location
: Source_Ptr
) is
156 Next_Msg
: Error_Msg_Id
;
157 -- Pointer to next message at insertion point
159 Prev_Msg
: Error_Msg_Id
;
160 -- Pointer to previous message at insertion point
162 Sptr
: Source_Ptr
renames Flag_Location
;
163 -- Corresponds to the Sptr value in the error message object
165 Optr
: Source_Ptr
renames Flag_Location
;
166 -- Corresponds to the Optr value in the error message object. Note
167 -- that for this usage, Sptr and Optr always have the same value,
168 -- since we do not have to worry about generic instantiations.
171 if Errors_Must_Be_Ignored
then
175 if Raise_Exception_On_Error
/= 0 then
176 raise Error_Msg_Exception
;
179 Test_Style_Warning_Serious_Msg
(Msg
);
180 Set_Msg_Text
(Msg
, Sptr
);
182 -- Kill continuation if parent message killed
184 if Continuation
and Last_Killed
then
188 -- Return without doing anything if message is killed and this is not
189 -- the first error message. The philosophy is that if we get a weird
190 -- error message and we already have had a message, then we hope the
191 -- weird message is a junk cascaded message
193 -- Immediate return if warning message and warnings are suppressed.
194 -- Note that style messages are not warnings for this purpose.
196 if Is_Warning_Msg
and then Warnings_Suppressed
(Sptr
) then
197 Cur_Msg
:= No_Error_Msg
;
201 -- Otherwise build error message object for new message
203 Errors
.Increment_Last
;
204 Cur_Msg
:= Errors
.Last
;
205 Errors
.Table
(Cur_Msg
).Text
:= new String'(Msg_Buffer (1 .. Msglen));
206 Errors.Table (Cur_Msg).Next := No_Error_Msg;
207 Errors.Table (Cur_Msg).Sptr := Sptr;
208 Errors.Table (Cur_Msg).Optr := Optr;
209 Errors.Table (Cur_Msg).Sfile := Get_Source_File_Index (Sptr);
210 Errors.Table (Cur_Msg).Line := Get_Physical_Line_Number (Sptr);
211 Errors.Table (Cur_Msg).Col := Get_Column_Number (Sptr);
212 Errors.Table (Cur_Msg).Style := Is_Style_Msg;
213 Errors.Table (Cur_Msg).Warn := Is_Warning_Msg;
214 Errors.Table (Cur_Msg).Serious := Is_Serious_Error;
215 Errors.Table (Cur_Msg).Uncond := Is_Unconditional_Msg;
216 Errors.Table (Cur_Msg).Msg_Cont := Continuation;
217 Errors.Table (Cur_Msg).Deleted := False;
219 Prev_Msg := No_Error_Msg;
220 Next_Msg := First_Error_Msg;
222 while Next_Msg /= No_Error_Msg loop
224 Errors.Table (Cur_Msg).Sfile < Errors.Table (Next_Msg).Sfile;
226 if Errors.Table (Cur_Msg).Sfile = Errors.Table (Next_Msg).Sfile then
227 exit when Sptr < Errors.Table (Next_Msg).Sptr;
230 Prev_Msg := Next_Msg;
231 Next_Msg := Errors.Table (Next_Msg).Next;
234 -- Now we insert the new message in the error chain. The insertion
235 -- point for the message is after Prev_Msg and before Next_Msg.
237 -- The possible insertion point for the new message is after Prev_Msg
238 -- and before Next_Msg. However, this is where we do a special check
239 -- for redundant parsing messages, defined as messages posted on the
240 -- same line. The idea here is that probably such messages are junk
241 -- from the parser recovering. In full errors mode, we don't do this
242 -- deletion, but otherwise such messages are discarded at this stage.
244 if Prev_Msg /= No_Error_Msg
245 and then Errors.Table (Prev_Msg).Line =
246 Errors.Table (Cur_Msg).Line
247 and then Errors.Table (Prev_Msg).Sfile =
248 Errors.Table (Cur_Msg).Sfile
250 -- Don't delete unconditional messages and at this stage, don't
251 -- delete continuation lines (we attempted to delete those earlier
252 -- if the parent message was deleted.
254 if not Errors.Table (Cur_Msg).Uncond
255 and then not Continuation
258 -- Don't delete if prev msg is warning and new msg is an error.
259 -- This is because we don't want a real error masked by a warning.
260 -- In all other cases (that is parse errors for the same line that
261 -- are not unconditional) we do delete the message. This helps to
262 -- avoid junk extra messages from cascaded parsing errors
264 if not (Errors.Table (Prev_Msg).Warn
266 Errors.Table (Prev_Msg).Style)
268 (Errors.Table (Cur_Msg).Warn
270 Errors.Table (Cur_Msg).Style)
272 -- All tests passed, delete the message by simply returning
273 -- without any further processing.
275 if not Continuation then
284 -- Come here if message is to be inserted in the error chain
286 if not Continuation then
287 Last_Killed := False;
290 if Prev_Msg = No_Error_Msg then
291 First_Error_Msg := Cur_Msg;
293 Errors.Table (Prev_Msg).Next := Cur_Msg;
296 Errors.Table (Cur_Msg).Next := Next_Msg;
298 -- Bump appropriate statistics count
300 if Errors.Table (Cur_Msg).Warn
302 Errors.Table (Cur_Msg).Style
304 Warnings_Detected := Warnings_Detected + 1;
307 Total_Errors_Detected := Total_Errors_Detected + 1;
309 if Errors.Table (Cur_Msg).Serious then
310 Serious_Errors_Detected := Serious_Errors_Detected + 1;
320 procedure Error_Msg_S (Msg : String) is
322 Error_Msg (Msg, Scan_Ptr);
329 procedure Error_Msg_SC (Msg : String) is
331 -- If we are at end of file, post the flag after the previous token
333 if Token = Tok_EOF then
336 -- For all other cases the message is posted at the current token
340 Error_Msg (Msg, Token_Ptr);
348 procedure Error_Msg_SP (Msg : String) is
350 -- Note: in the case where there is no previous token, Prev_Token_Ptr
351 -- is set to Source_First, which is a reasonable position for the
352 -- error flag in this situation
354 Error_Msg (Msg, Prev_Token_Ptr);
361 procedure Finalize (Source_Type : String := "project") is
368 -- Eliminate any duplicated error messages from the list. This is
369 -- done after the fact to avoid problems with Change_Error_Text.
371 Cur := First_Error_Msg;
372 while Cur /= No_Error_Msg loop
373 Nxt := Errors.Table (Cur).Next;
376 while F /= No_Error_Msg
377 and then Errors.Table (F).Sptr = Errors.Table (Cur).Sptr
379 Check_Duplicate_Message (Cur, F);
380 F := Errors.Table (F).Next;
388 if Brief_Output or (not Full_List and not Verbose_Mode) then
389 E := First_Error_Msg;
392 while E /= No_Error_Msg loop
393 if not Errors.Table (E).Deleted then
394 if Full_Path_Name_For_Brief_Errors then
395 Write_Name (Full_Ref_Name (Errors.Table (E).Sfile));
397 Write_Name (Reference_Name (Errors.Table (E).Sfile));
401 Write_Int (Int (Physical_To_Logical
402 (Errors.Table (E).Line,
403 Errors.Table (E).Sfile)));
406 if Errors.Table (E).Col < 10 then
410 Write_Int (Int (Errors.Table (E).Col));
416 E := Errors.Table (E).Next;
422 -- Full source listing case
425 List_Pragmas_Index := 1;
426 List_Pragmas_Mode := True;
427 E := First_Error_Msg;
430 -- First list initial main source file with its error messages
432 for N in 1 .. Last_Source_Line (Main_Source_File) loop
435 and then Errors.Table (E).Line = N
436 and then Errors.Table (E).Sfile = Main_Source_File;
438 Output_Source_Line (N, Main_Source_File, Err_Flag, Source_Type);
441 Output_Error_Msgs (E);
447 -- Then output errors, if any, for subsidiary units
449 while E /= No_Error_Msg
450 and then Errors.Table (E).Sfile /= Main_Source_File
454 (Errors.Table (E).Line,
455 Errors.Table (E).Sfile,
458 Output_Error_Msgs (E);
462 -- Verbose mode (error lines only with error flags)
465 E := First_Error_Msg;
467 -- Loop through error lines
469 while E /= No_Error_Msg loop
472 (Errors.Table (E).Line,
473 Errors.Table (E).Sfile,
476 Output_Error_Msgs (E);
480 -- Output error summary if verbose or full list mode
482 if Verbose_Mode or else Full_List then
484 -- Extra blank line if error messages or source listing were output
486 if Total_Errors_Detected + Warnings_Detected > 0
492 -- Message giving number of lines read and number of errors detected.
493 -- This normally goes to Standard_Output. The exception is when brief
494 -- mode is not set, verbose mode (or full list mode) is set, and
495 -- there are errors. In this case we send the message to standard
496 -- error to make sure that *something* appears on standard error in
497 -- an error situation.
499 -- Formerly, only the "# errors" suffix was sent to stderr, whereas
500 -- "# lines:" appeared on stdout. This caused problems on VMS when
501 -- the stdout buffer was flushed, giving an extra line feed after
504 if Total_Errors_Detected + Warnings_Detected /= 0
505 and then not Brief_Output
506 and then (Verbose_Mode or Full_List)
511 -- Message giving total number of lines
514 Write_Int (Num_Source_Lines (Main_Source_File));
516 if Num_Source_Lines (Main_Source_File) = 1 then
517 Write_Str (" line: ");
519 Write_Str (" lines: ");
522 if Total_Errors_Detected = 0 then
523 Write_Str ("No errors");
525 elsif Total_Errors_Detected = 1 then
526 Write_Str ("1 error");
529 Write_Int (Total_Errors_Detected);
530 Write_Str (" errors");
533 if Warnings_Detected /= 0 then
535 Write_Int (Warnings_Detected);
536 Write_Str (" warning");
538 if Warnings_Detected /= 1 then
542 if Warning_Mode = Treat_As_Error then
543 Write_Str (" (treated as error");
545 if Warnings_Detected /= 1 then
557 if Maximum_Messages /= 0 then
558 if Warnings_Detected >= Maximum_Messages then
560 Write_Line ("maximum number of warnings detected");
561 Warning_Mode := Suppress;
564 if Total_Errors_Detected >= Maximum_Messages then
566 Write_Line ("fatal error: maximum errors reached");
571 if Warning_Mode = Treat_As_Error then
572 Total_Errors_Detected := Total_Errors_Detected + Warnings_Detected;
573 Warnings_Detected := 0;
576 -- Prevent displaying the same messages again in the future
578 First_Error_Msg := No_Error_Msg;
585 procedure Initialize is
588 First_Error_Msg := No_Error_Msg;
589 Last_Error_Msg := No_Error_Msg;
590 Serious_Errors_Detected := 0;
591 Total_Errors_Detected := 0;
592 Warnings_Detected := 0;
593 Cur_Msg := No_Error_Msg;
595 -- Initialize warnings table, if all warnings are suppressed, supply
596 -- an initial dummy entry covering all possible source locations.
600 if Warning_Mode = Suppress then
601 Warnings.Increment_Last;
602 Warnings.Table (Warnings.Last).Start := Source_Ptr'First;
603 Warnings.Table (Warnings.Last).Stop := Source_Ptr'Last;
607 ------------------------
608 -- Output_Source_Line --
609 ------------------------
611 procedure Output_Source_Line
612 (L : Physical_Line_Number;
613 Sfile : Source_File_Index;
615 Source_Type : String)
620 Line_Number_Output : Boolean := False;
621 -- Set True once line number is output
624 if Sfile /= Current_Error_Source_File then
625 Write_Str ("==============Error messages for ");
626 Write_Str (Source_Type);
627 Write_Str (" file: ");
628 Write_Name (Full_File_Name (Sfile));
630 Current_Error_Source_File := Sfile;
634 Output_Line_Number (Physical_To_Logical (L, Sfile));
635 Line_Number_Output := True;
638 S := Line_Start (L, Sfile);
641 C := Source_Text (Sfile) (S);
642 exit when C = ASCII.LF or else C = ASCII.CR or else C = EOF;
651 if Line_Number_Output then
654 end Output_Source_Line;
656 -----------------------
657 -- Set_Ignore_Errors --
658 -----------------------
660 procedure Set_Ignore_Errors (To : Boolean) is
662 Errors_Must_Be_Ignored := To;
663 end Set_Ignore_Errors;
665 ------------------------------
666 -- Set_Msg_Insertion_Column --
667 ------------------------------
669 procedure Set_Msg_Insertion_Column is
671 if RM_Column_Check then
672 Set_Msg_Str (" in column ");
673 Set_Msg_Int (Int (Error_Msg_Col) + 1);
675 end Set_Msg_Insertion_Column;
681 procedure Set_Msg_Text (Text : String; Flag : Source_Ptr) is
682 C : Character; -- Current character
683 P : Natural; -- Current index;
686 Manual_Quote_Mode := False;
688 Flag_Source := Get_Source_File_Index (Flag);
691 while P <= Text'Last loop
695 -- Check for insertion character
698 if P <= Text'Last and then Text (P) = '%' then
700 Set_Msg_Insertion_Name_Literal;
702 Set_Msg_Insertion_Name;
712 Set_Msg_Insertion_File_Name;
721 Set_Msg_Insertion_Reserved_Name;
730 Set_Msg_Insertion_Line_Number (Error_Msg_Sloc, Flag);
733 Continuation := True;
736 Set_Msg_Insertion_Column;
739 Set_Msg_Insertion_Uint;
742 Manual_Quote_Mode := not Manual_Quote_Mode;
746 Is_Unconditional_Msg := True;
758 Set_Msg_Char (Text (P));
761 -- Upper case letter (start of reserved word if 2 or more)
763 elsif C in 'A' .. 'Z'
764 and then P <= Text'Last
765 and then Text (P) in 'A' .. 'Z'
768 Set_Msg_Insertion_Reserved_Word (Text, P);
770 -- Normal character with no special treatment