1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1991-2011, 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 Err_Vars
; use Err_Vars
;
27 with Erroutc
; use Erroutc
;
28 with Namet
; use Namet
;
30 with Output
; use Output
;
31 with Scans
; use Scans
;
32 with Sinput
; use Sinput
;
33 with Stylesw
; use Stylesw
;
35 package body Errutil
is
37 Errors_Must_Be_Ignored
: Boolean := False;
38 -- Set to True by procedure Set_Ignore_Errors (True), when calls to
39 -- error message procedures should be ignored (when parsing irrelevant
40 -- text in sources being preprocessed).
42 -----------------------
43 -- Local Subprograms --
44 -----------------------
46 procedure Error_Msg_AP
(Msg
: String);
47 -- Output a message just after the previous token
49 procedure Output_Source_Line
50 (L
: Physical_Line_Number
;
51 Sfile
: Source_File_Index
;
53 Source_Type
: String);
54 -- Outputs text of source line L, in file S, together with preceding line
55 -- number, as described above for Output_Line_Number. The Errs parameter
56 -- indicates if there are errors attached to the line, which forces
57 -- listing on, even in the presence of pragma List (Off).
59 procedure Set_Msg_Insertion_Column
;
60 -- Handle column number insertion (@ insertion character)
62 procedure Set_Msg_Text
(Text
: String; Flag
: Source_Ptr
);
63 -- Add a sequence of characters to the current message. The characters may
64 -- be one of the special insertion characters (see documentation in spec).
65 -- Flag is the location at which the error is to be posted, which is used
66 -- to determine whether or not the # insertion needs a file name. The
67 -- variables Msg_Buffer, Msglen, Is_Style_Msg, Is_Warning_Msg, and
68 -- Is_Unconditional_Msg are set on return.
74 procedure Error_Msg_AP
(Msg
: String) is
79 -- If we had saved the Scan_Ptr value after scanning the previous
80 -- token, then we would have exactly the right place for putting
81 -- the flag immediately at hand. However, that would add at least
82 -- two instructions to a Scan call *just* to service the possibility
83 -- of an Error_Msg_AP call. So instead we reconstruct that value.
85 -- We have two possibilities, start with Prev_Token_Ptr and skip over
86 -- the current token, which is made harder by the possibility that this
87 -- token may be in error, or start with Token_Ptr and work backwards.
88 -- We used to take the second approach, but it's hard because of
89 -- comments, and harder still because things that look like comments
90 -- can appear inside strings. So now we take the first approach.
92 -- Note: in the case where there is no previous token, Prev_Token_Ptr
93 -- is set to Source_First, which is a reasonable position for the
94 -- error flag in this situation.
99 -- If the previous token is a string literal, we need a special approach
100 -- since there may be white space inside the literal and we don't want
101 -- to stop on that white space.
103 -- Note that it is not worth worrying about special UTF_32 line
104 -- terminator characters in this context, since this is only about
105 -- error recovery anyway.
107 if Prev_Token
= Tok_String_Literal
then
111 if Source
(S1
) = C
then
113 exit when Source
(S1
) /= C
;
114 elsif Source
(S1
) in Line_Terminator
then
119 -- Character literal also needs special handling
121 elsif Prev_Token
= Tok_Char_Literal
then
124 -- Otherwise we search forward for the end of the current token, marked
125 -- by a line terminator, white space, a comment symbol or if we bump
126 -- into the following token (i.e. the current token)
128 -- Note that it is not worth worrying about special UTF_32 line
129 -- terminator characters in this context, since this is only about
130 -- error recovery anyway.
133 while Source
(S1
) not in Line_Terminator
134 and then Source
(S1
) /= ' '
135 and then Source
(S1
) /= ASCII
.HT
136 and then (Source
(S1
) /= '-' or else Source
(S1
+ 1) /= '-')
137 and then S1
/= Token_Ptr
143 -- S1 is now set to the location for the flag
153 procedure Error_Msg
(Msg
: String; Flag_Location
: Source_Ptr
) is
155 Next_Msg
: Error_Msg_Id
;
156 -- Pointer to next message at insertion point
158 Prev_Msg
: Error_Msg_Id
;
159 -- Pointer to previous message at insertion point
161 Sptr
: Source_Ptr
renames Flag_Location
;
162 -- Corresponds to the Sptr value in the error message object
164 Optr
: Source_Ptr
renames Flag_Location
;
165 -- Corresponds to the Optr value in the error message object. Note
166 -- that for this usage, Sptr and Optr always have the same value,
167 -- since we do not have to worry about generic instantiations.
170 if Errors_Must_Be_Ignored
then
174 if Raise_Exception_On_Error
/= 0 then
175 raise Error_Msg_Exception
;
178 Test_Style_Warning_Serious_Msg
(Msg
);
179 Set_Msg_Text
(Msg
, Sptr
);
181 -- Kill continuation if parent message killed
183 if Continuation
and Last_Killed
then
187 -- Return without doing anything if message is killed and this is not
188 -- the first error message. The philosophy is that if we get a weird
189 -- error message and we already have had a message, then we hope the
190 -- weird message is a junk cascaded message
192 -- Immediate return if warning message and warnings are suppressed.
193 -- Note that style messages are not warnings for this purpose.
195 if Is_Warning_Msg
and then Warnings_Suppressed
(Sptr
) then
196 Cur_Msg
:= No_Error_Msg
;
200 -- Otherwise build error message object for new message
202 Errors
.Increment_Last
;
203 Cur_Msg
:= Errors
.Last
;
204 Errors
.Table
(Cur_Msg
).Text
:= new String'(Msg_Buffer (1 .. Msglen));
205 Errors.Table (Cur_Msg).Next := No_Error_Msg;
206 Errors.Table (Cur_Msg).Sptr := Sptr;
207 Errors.Table (Cur_Msg).Optr := Optr;
208 Errors.Table (Cur_Msg).Sfile := Get_Source_File_Index (Sptr);
209 Errors.Table (Cur_Msg).Line := Get_Physical_Line_Number (Sptr);
210 Errors.Table (Cur_Msg).Col := Get_Column_Number (Sptr);
211 Errors.Table (Cur_Msg).Style := Is_Style_Msg;
212 Errors.Table (Cur_Msg).Warn := Is_Warning_Msg;
213 Errors.Table (Cur_Msg).Serious := Is_Serious_Error;
214 Errors.Table (Cur_Msg).Uncond := Is_Unconditional_Msg;
215 Errors.Table (Cur_Msg).Msg_Cont := Continuation;
216 Errors.Table (Cur_Msg).Deleted := False;
218 Prev_Msg := No_Error_Msg;
219 Next_Msg := First_Error_Msg;
221 while Next_Msg /= No_Error_Msg loop
223 Errors.Table (Cur_Msg).Sfile < Errors.Table (Next_Msg).Sfile;
225 if Errors.Table (Cur_Msg).Sfile = Errors.Table (Next_Msg).Sfile then
226 exit when Sptr < Errors.Table (Next_Msg).Sptr;
229 Prev_Msg := Next_Msg;
230 Next_Msg := Errors.Table (Next_Msg).Next;
233 -- Now we insert the new message in the error chain. The insertion
234 -- point for the message is after Prev_Msg and before Next_Msg.
236 -- The possible insertion point for the new message is after Prev_Msg
237 -- and before Next_Msg. However, this is where we do a special check
238 -- for redundant parsing messages, defined as messages posted on the
239 -- same line. The idea here is that probably such messages are junk
240 -- from the parser recovering. In full errors mode, we don't do this
241 -- deletion, but otherwise such messages are discarded at this stage.
243 if Prev_Msg /= No_Error_Msg
244 and then Errors.Table (Prev_Msg).Line =
245 Errors.Table (Cur_Msg).Line
246 and then Errors.Table (Prev_Msg).Sfile =
247 Errors.Table (Cur_Msg).Sfile
249 -- Don't delete unconditional messages and at this stage, don't
250 -- delete continuation lines (we attempted to delete those earlier
251 -- if the parent message was deleted.
253 if not Errors.Table (Cur_Msg).Uncond
254 and then not Continuation
257 -- Don't delete if prev msg is warning and new msg is an error.
258 -- This is because we don't want a real error masked by a warning.
259 -- In all other cases (that is parse errors for the same line that
260 -- are not unconditional) we do delete the message. This helps to
261 -- avoid junk extra messages from cascaded parsing errors
263 if not (Errors.Table (Prev_Msg).Warn
265 Errors.Table (Prev_Msg).Style)
267 (Errors.Table (Cur_Msg).Warn
269 Errors.Table (Cur_Msg).Style)
271 -- All tests passed, delete the message by simply returning
272 -- without any further processing.
274 if not Continuation then
283 -- Come here if message is to be inserted in the error chain
285 if not Continuation then
286 Last_Killed := False;
289 if Prev_Msg = No_Error_Msg then
290 First_Error_Msg := Cur_Msg;
292 Errors.Table (Prev_Msg).Next := Cur_Msg;
295 Errors.Table (Cur_Msg).Next := Next_Msg;
297 -- Bump appropriate statistics count
299 if Errors.Table (Cur_Msg).Warn
301 Errors.Table (Cur_Msg).Style
303 Warnings_Detected := Warnings_Detected + 1;
306 Total_Errors_Detected := Total_Errors_Detected + 1;
308 if Errors.Table (Cur_Msg).Serious then
309 Serious_Errors_Detected := Serious_Errors_Detected + 1;
319 procedure Error_Msg_S (Msg : String) is
321 Error_Msg (Msg, Scan_Ptr);
328 procedure Error_Msg_SC (Msg : String) is
330 -- If we are at end of file, post the flag after the previous token
332 if Token = Tok_EOF then
335 -- For all other cases the message is posted at the current token
339 Error_Msg (Msg, Token_Ptr);
347 procedure Error_Msg_SP (Msg : String) is
349 -- Note: in the case where there is no previous token, Prev_Token_Ptr
350 -- is set to Source_First, which is a reasonable position for the
351 -- error flag in this situation
353 Error_Msg (Msg, Prev_Token_Ptr);
360 procedure Finalize (Source_Type : String := "project") is
367 -- Eliminate any duplicated error messages from the list. This is
368 -- done after the fact to avoid problems with Change_Error_Text.
370 Cur := First_Error_Msg;
371 while Cur /= No_Error_Msg loop
372 Nxt := Errors.Table (Cur).Next;
375 while F /= No_Error_Msg
376 and then Errors.Table (F).Sptr = Errors.Table (Cur).Sptr
378 Check_Duplicate_Message (Cur, F);
379 F := Errors.Table (F).Next;
387 if Brief_Output or (not Full_List and not Verbose_Mode) then
388 E := First_Error_Msg;
391 while E /= No_Error_Msg loop
392 if not Errors.Table (E).Deleted then
393 if Full_Path_Name_For_Brief_Errors then
394 Write_Name (Full_Ref_Name (Errors.Table (E).Sfile));
396 Write_Name (Reference_Name (Errors.Table (E).Sfile));
400 Write_Int (Int (Physical_To_Logical
401 (Errors.Table (E).Line,
402 Errors.Table (E).Sfile)));
405 if Errors.Table (E).Col < 10 then
409 Write_Int (Int (Errors.Table (E).Col));
415 E := Errors.Table (E).Next;
421 -- Full source listing case
424 List_Pragmas_Index := 1;
425 List_Pragmas_Mode := True;
426 E := First_Error_Msg;
429 -- First list initial main source file with its error messages
431 for N in 1 .. Last_Source_Line (Main_Source_File) loop
434 and then Errors.Table (E).Line = N
435 and then Errors.Table (E).Sfile = Main_Source_File;
437 Output_Source_Line (N, Main_Source_File, Err_Flag, Source_Type);
440 Output_Error_Msgs (E);
446 -- Then output errors, if any, for subsidiary units
448 while E /= No_Error_Msg
449 and then Errors.Table (E).Sfile /= Main_Source_File
453 (Errors.Table (E).Line,
454 Errors.Table (E).Sfile,
457 Output_Error_Msgs (E);
461 -- Verbose mode (error lines only with error flags)
464 E := First_Error_Msg;
466 -- Loop through error lines
468 while E /= No_Error_Msg loop
471 (Errors.Table (E).Line,
472 Errors.Table (E).Sfile,
475 Output_Error_Msgs (E);
479 -- Output error summary if verbose or full list mode
481 if Verbose_Mode or else Full_List then
483 -- Extra blank line if error messages or source listing were output
485 if Total_Errors_Detected + Warnings_Detected > 0
491 -- Message giving number of lines read and number of errors detected.
492 -- This normally goes to Standard_Output. The exception is when brief
493 -- mode is not set, verbose mode (or full list mode) is set, and
494 -- there are errors. In this case we send the message to standard
495 -- error to make sure that *something* appears on standard error in
496 -- an error situation.
498 -- Formerly, only the "# errors" suffix was sent to stderr, whereas
499 -- "# lines:" appeared on stdout. This caused problems on VMS when
500 -- the stdout buffer was flushed, giving an extra line feed after
503 if Total_Errors_Detected + Warnings_Detected /= 0
504 and then not Brief_Output
505 and then (Verbose_Mode or Full_List)
510 -- Message giving total number of lines
513 Write_Int (Num_Source_Lines (Main_Source_File));
515 if Num_Source_Lines (Main_Source_File) = 1 then
516 Write_Str (" line: ");
518 Write_Str (" lines: ");
521 if Total_Errors_Detected = 0 then
522 Write_Str ("No errors");
524 elsif Total_Errors_Detected = 1 then
525 Write_Str ("1 error");
528 Write_Int (Total_Errors_Detected);
529 Write_Str (" errors");
532 if Warnings_Detected /= 0 then
534 Write_Int (Warnings_Detected);
535 Write_Str (" warning");
537 if Warnings_Detected /= 1 then
541 if Warning_Mode = Treat_As_Error then
542 Write_Str (" (treated as error");
544 if Warnings_Detected /= 1 then
556 if Maximum_Messages /= 0 then
557 if Warnings_Detected >= Maximum_Messages then
559 Write_Line ("maximum number of warnings detected");
560 Warning_Mode := Suppress;
563 if Total_Errors_Detected >= Maximum_Messages then
565 Write_Line ("fatal error: maximum errors reached");
570 if Warning_Mode = Treat_As_Error then
571 Total_Errors_Detected := Total_Errors_Detected + Warnings_Detected;
572 Warnings_Detected := 0;
575 -- Prevent displaying the same messages again in the future
577 First_Error_Msg := No_Error_Msg;
584 procedure Initialize is
587 First_Error_Msg := No_Error_Msg;
588 Last_Error_Msg := No_Error_Msg;
589 Serious_Errors_Detected := 0;
590 Total_Errors_Detected := 0;
591 Warnings_Detected := 0;
592 Cur_Msg := No_Error_Msg;
594 -- Initialize warnings table, if all warnings are suppressed, supply
595 -- an initial dummy entry covering all possible source locations.
599 if Warning_Mode = Suppress then
600 Warnings.Increment_Last;
601 Warnings.Table (Warnings.Last).Start := Source_Ptr'First;
602 Warnings.Table (Warnings.Last).Stop := Source_Ptr'Last;
606 ------------------------
607 -- Output_Source_Line --
608 ------------------------
610 procedure Output_Source_Line
611 (L : Physical_Line_Number;
612 Sfile : Source_File_Index;
614 Source_Type : String)
619 Line_Number_Output : Boolean := False;
620 -- Set True once line number is output
623 if Sfile /= Current_Error_Source_File then
624 Write_Str ("==============Error messages for ");
625 Write_Str (Source_Type);
626 Write_Str (" file: ");
627 Write_Name (Full_File_Name (Sfile));
629 Current_Error_Source_File := Sfile;
633 Output_Line_Number (Physical_To_Logical (L, Sfile));
634 Line_Number_Output := True;
637 S := Line_Start (L, Sfile);
640 C := Source_Text (Sfile) (S);
641 exit when C = ASCII.LF or else C = ASCII.CR or else C = EOF;
650 if Line_Number_Output then
653 end Output_Source_Line;
655 -----------------------
656 -- Set_Ignore_Errors --
657 -----------------------
659 procedure Set_Ignore_Errors (To : Boolean) is
661 Errors_Must_Be_Ignored := To;
662 end Set_Ignore_Errors;
664 ------------------------------
665 -- Set_Msg_Insertion_Column --
666 ------------------------------
668 procedure Set_Msg_Insertion_Column is
670 if RM_Column_Check then
671 Set_Msg_Str (" in column ");
672 Set_Msg_Int (Int (Error_Msg_Col) + 1);
674 end Set_Msg_Insertion_Column;
680 procedure Set_Msg_Text (Text : String; Flag : Source_Ptr) is
681 C : Character; -- Current character
682 P : Natural; -- Current index;
685 Manual_Quote_Mode := False;
687 Flag_Source := Get_Source_File_Index (Flag);
690 while P <= Text'Last loop
694 -- Check for insertion character
697 if P <= Text'Last and then Text (P) = '%' then
699 Set_Msg_Insertion_Name_Literal;
701 Set_Msg_Insertion_Name;
711 Set_Msg_Insertion_File_Name;
720 Set_Msg_Insertion_Reserved_Name;
729 Set_Msg_Insertion_Line_Number (Error_Msg_Sloc, Flag);
732 Continuation := True;
735 Set_Msg_Insertion_Column;
738 Set_Msg_Insertion_Uint;
741 Manual_Quote_Mode := not Manual_Quote_Mode;
745 Is_Unconditional_Msg := True;
757 Set_Msg_Char (Text (P));
760 -- Upper case letter (start of reserved word if 2 or more)
762 elsif C in 'A' .. 'Z'
763 and then P <= Text'Last
764 and then Text (P) in 'A' .. 'Z'
767 Set_Msg_Insertion_Reserved_Word (Text, P);
769 -- Normal character with no special treatment