1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2020, 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 Csets; use Csets;
27 with Namet.Sp; use Namet.Sp;
28 with Stylesw; use Stylesw;
29 with Uintp; use Uintp;
30 with Warnsw; use Warnsw;
32 with GNAT.Spelling_Checker; use GNAT.Spelling_Checker;
41 function Bad_Spelling_Of (T : Token_Type) return Boolean is
42 Tname : constant String := Token_Type'Image (T);
43 -- Characters of token name
45 S : String (1 .. Tname'Last - 4);
46 -- Characters of token name folded to lower case, omitting TOK_ at start
48 M1 : String (1 .. 42) := "incorrect spelling of keyword ************";
49 M2 : String (1 .. 44) := "illegal abbreviation of keyword ************";
50 -- Buffers used to construct error message
54 -- Starting subscripts in M1, M2 for keyword name
56 SL : constant Natural := S'Length;
57 -- Length of expected token name excluding TOK_ at start
60 if Token /= Tok_Identifier then
65 S (J) := Fold_Lower (Tname (J + 4));
68 Get_Name_String (Token_Name);
70 -- A special check for case of PROGRAM used for PROCEDURE
74 and then Name_Buffer (1 .. 7) = "program"
76 Error_Msg_SC -- CODEFIX
77 ("PROCEDURE expected");
81 -- A special check for an illegal abbreviation
83 elsif Name_Len < S'Length
84 and then Name_Len >= 4
85 and then Name_Buffer (1 .. Name_Len) = S (1 .. Name_Len)
87 for J in 1 .. S'Last loop
88 M2 (P2 + J - 1) := Fold_Upper (S (J));
91 Error_Msg_SC (M2 (1 .. P2 - 1 + S'Last));
96 -- Now we go into the full circuit to check for a misspelling
98 -- Never consider something a misspelling if either the actual or
99 -- expected string is less than 3 characters (before this check we
100 -- used to consider i to be a misspelled if in some cases).
102 if SL < 3 or else Name_Len < 3 then
105 -- Special case: prefix matches, i.e. the leading characters of the
106 -- token that we have exactly match the required keyword. If there
107 -- are at least two characters left over, assume that we have a case
108 -- of two keywords joined together which should not be joined.
110 elsif Name_Len > SL + 1
111 and then S = Name_Buffer (1 .. SL)
113 Scan_Ptr := Token_Ptr + S'Length;
114 Error_Msg_S ("|missing space");
119 if Is_Bad_Spelling_Of (Name_Buffer (1 .. Name_Len), S) then
120 for J in 1 .. S'Last loop
121 M1 (P1 + J - 1) := Fold_Upper (S (J));
124 Error_Msg_SC -- CODFIX
125 (M1 (1 .. P1 - 1 + S'Last));
134 ----------------------
135 -- Check_95_Keyword --
136 ----------------------
138 -- On entry, the caller has checked that current token is an identifier
139 -- whose name matches the name of the 95 keyword New_Tok.
141 procedure Check_95_Keyword (Token_95, Next : Token_Type) is
142 Scan_State : Saved_Scan_State;
145 Save_Scan_State (Scan_State); -- at identifier/keyword
146 Scan; -- past identifier/keyword
149 Restore_Scan_State (Scan_State); -- to identifier
150 Error_Msg_Name_1 := Token_Name;
151 Error_Msg_SC ("(Ada 83) keyword* cannot be used!");
154 Restore_Scan_State (Scan_State); -- to identifier
156 end Check_95_Keyword;
158 ----------------------
159 -- Check_Bad_Layout --
160 ----------------------
162 procedure Check_Bad_Layout is
164 if RM_Column_Check and then Token_Is_At_Start_Of_Line
165 and then Start_Column <= Scopes (Scope.Last).Ecol
167 Error_Msg_BC -- CODEFIX
168 ("(style) incorrect layout");
170 end Check_Bad_Layout;
172 --------------------------
173 -- Check_Future_Keyword --
174 --------------------------
176 procedure Check_Future_Keyword is
178 -- Ada 2005 (AI-284): Compiling in Ada 95 mode we warn that INTERFACE,
179 -- OVERRIDING, and SYNCHRONIZED are new reserved words.
181 if Ada_Version = Ada_95
182 and then Warn_On_Ada_2005_Compatibility
184 if Nam_In (Token_Name, Name_Overriding, Name_Synchronized)
185 or else (Token_Name = Name_Interface
186 and then Prev_Token /= Tok_Pragma)
188 Error_Msg_N ("& is a reserved word in Ada 2005?y?", Token_Node);
192 -- Similarly, warn about Ada 2012 reserved words
194 if Ada_Version in Ada_95 .. Ada_2005
195 and then Warn_On_Ada_2012_Compatibility
197 if Token_Name = Name_Some then
198 Error_Msg_N ("& is a reserved word in Ada 2012?y?", Token_Node);
202 -- Note: we deliberately do not emit these warnings when operating in
203 -- Ada 83 mode because in that case we assume the user is building
204 -- legacy code anyway and is not interested in updating Ada versions.
206 end Check_Future_Keyword;
208 --------------------------
209 -- Check_Misspelling_Of --
210 --------------------------
212 procedure Check_Misspelling_Of (T : Token_Type) is
214 if Bad_Spelling_Of (T) then
217 end Check_Misspelling_Of;
219 -----------------------------
220 -- Check_Simple_Expression --
221 -----------------------------
223 procedure Check_Simple_Expression (E : Node_Id) is
225 if Expr_Form = EF_Non_Simple then
226 Error_Msg_N ("this expression must be parenthesized", E);
228 end Check_Simple_Expression;
230 ---------------------------------------
231 -- Check_Simple_Expression_In_Ada_83 --
232 ---------------------------------------
234 procedure Check_Simple_Expression_In_Ada_83 (E : Node_Id) is
236 if Expr_Form = EF_Non_Simple then
237 if Ada_Version = Ada_83 then
238 Error_Msg_N ("(Ada 83) this expression must be parenthesized!", E);
241 end Check_Simple_Expression_In_Ada_83;
243 ------------------------
244 -- Check_Subtype_Mark --
245 ------------------------
247 function Check_Subtype_Mark (Mark : Node_Id) return Node_Id is
249 if Nkind (Mark) = N_Identifier
250 or else Nkind (Mark) = N_Selected_Component
251 or else (Nkind (Mark) = N_Attribute_Reference
252 and then Is_Type_Attribute_Name (Attribute_Name (Mark)))
257 Error_Msg ("subtype mark expected", Sloc (Mark));
260 end Check_Subtype_Mark;
266 function Comma_Present return Boolean is
267 Scan_State : Saved_Scan_State;
271 -- First check, if a comma is present, then a comma is present
273 if Token = Tok_Comma then
277 -- If we have a right paren, then that is taken as ending the list
278 -- i.e. no comma is present.
279 -- Ditto for a right bracket in Ada 2020.
281 elsif Token = Tok_Right_Paren
282 or else (Token = Tok_Right_Bracket and then Ada_Version >= Ada_2020)
286 -- If pragmas, then get rid of them and make a recursive call
287 -- to process what follows these pragmas.
289 elsif Token = Tok_Pragma then
291 return Comma_Present;
293 -- At this stage we have an error, and the goal is to decide on whether
294 -- or not we should diagnose an error and report a (non-existent)
295 -- comma as being present, or simply to report no comma is present
297 -- If we are a semicolon, then the question is whether we have a missing
298 -- right paren, or whether the semicolon should have been a comma. To
299 -- guess the right answer, we scan ahead keeping track of the paren
300 -- level, looking for a clue that helps us make the right decision.
302 -- This approach is highly accurate in the single error case, and does
303 -- not make bad mistakes in the multiple error case (indeed we can't
304 -- really make a very bad decision at this point in any case).
306 elsif Token = Tok_Semicolon then
307 Save_Scan_State (Scan_State);
308 Scan; -- past semicolon
310 -- Check for being followed by identifier => which almost certainly
311 -- means we are still in a parameter list and the comma should have
312 -- been a semicolon (such a sequence could not follow a semicolon)
314 if Token = Tok_Identifier then
317 if Token = Tok_Arrow then
322 -- If that test didn't work, loop ahead looking for a comma or
323 -- semicolon at the same parenthesis level. Always remember that
324 -- we can't go badly wrong in an error situation like this.
328 -- Here is the look ahead loop, Paren_Count tells us whether the
329 -- token we are looking at is at the same paren level as the
330 -- suspicious semicolon that we are trying to figure out.
334 -- If we hit another semicolon or an end of file, and we have
335 -- not seen a right paren or another comma on the way, then
336 -- probably the semicolon did end the list. Indeed that is
337 -- certainly the only single error correction possible here.
339 if Token = Tok_Semicolon or else Token = Tok_EOF then
340 Restore_Scan_State (Scan_State);
343 -- A comma at the same paren level as the semicolon is a strong
344 -- indicator that the semicolon should have been a comma, indeed
345 -- again this is the only possible single error correction.
347 elsif Token = Tok_Comma then
348 exit when Paren_Count = 0;
350 -- A left paren just bumps the paren count
352 elsif Token = Tok_Left_Paren then
353 Paren_Count := Paren_Count + 1;
355 -- A right paren that is at the same paren level as the semicolon
356 -- also means that the only possible single error correction is
357 -- to assume that the semicolon should have been a comma. If we
358 -- are not at the same paren level, then adjust the paren level.
360 elsif Token = Tok_Right_Paren then
361 exit when Paren_Count = 0;
362 Paren_Count := Paren_Count - 1;
365 -- Keep going, we haven't made a decision yet
370 -- If we fall through the loop, it means that we found a terminating
371 -- right paren or another comma. In either case it is reasonable to
372 -- assume that the semicolon was really intended to be a comma. Also
373 -- come here for the identifier arrow case.
376 Restore_Scan_State (Scan_State);
377 Error_Msg_SC -- CODEFIX
378 ("|"";"" should be "",""");
379 Scan; -- past the semicolon
382 -- If we are not at semicolon or a right paren, then we base the
383 -- decision on whether or not the next token can be part of an
384 -- expression. If not, then decide that no comma is present (the
385 -- caller will eventually generate a missing right parent message)
387 elsif Token in Token_Class_Eterm then
390 -- Otherwise we assume a comma is present, even if none is present,
391 -- since the next token must be part of an expression, so if we were
392 -- at the end of the list, then there is more than one error present.
395 T_Comma; -- to give error
400 -----------------------
401 -- Discard_Junk_List --
402 -----------------------
404 procedure Discard_Junk_List (L : List_Id) is
405 pragma Warnings (Off, L);
408 end Discard_Junk_List;
410 -----------------------
411 -- Discard_Junk_Node --
412 -----------------------
414 procedure Discard_Junk_Node (N : Node_Id) is
415 pragma Warnings (Off, N);
418 end Discard_Junk_Node;
424 procedure Ignore (T : Token_Type) is
427 if T = Tok_Comma then
428 Error_Msg_SC -- CODEFIX
429 ("|extra "","" ignored");
431 elsif T = Tok_Left_Paren then
432 Error_Msg_SC -- CODEFIX
433 ("|extra ""("" ignored");
435 -- Note: the following error used to be labeled as a non-serious
436 -- error like the other similar messages here (with a | at the start
437 -- of the message). But this caused some annoying cascaded errors
438 -- that were confusing, as shown by this example:
440 -- A : array (1 .. 9) of Integer :=
443 -- >>> positional aggregate cannot have one component
444 -- >>> named association cannot follow positional association
445 -- >>> extra ")" ignored
447 -- So we decided to label it as serious after all
449 elsif T = Tok_Right_Paren then
450 Error_Msg_SC -- CODEFIX
451 ("extra "")"" ignored");
453 elsif T = Tok_Semicolon then
454 Error_Msg_SC -- CODEFIX
455 ("|extra "";"" ignored");
457 elsif T = Tok_Colon then
458 Error_Msg_SC -- CODEFIX
459 ("|extra "":"" ignored");
463 Tname : constant String := Token_Type'Image (Token);
465 Error_Msg_SC ("|extra " & Tname (5 .. Tname'Last) & "ignored");
469 Scan; -- Scan past ignored token
473 ----------------------------
474 -- Is_Reserved_Identifier --
475 ----------------------------
477 function Is_Reserved_Identifier (C : Id_Check := None) return Boolean is
479 if not Is_Reserved_Keyword (Token) then
484 Ident_Casing : constant Casing_Type :=
485 Identifier_Casing (Current_Source_File);
486 Key_Casing : constant Casing_Type :=
487 Keyword_Casing (Current_Source_File);
490 -- If the casing of identifiers and keywords is different in
491 -- this source file, and the casing of this token matches the
492 -- keyword casing, then we return False, since it is pretty
493 -- clearly intended to be a keyword.
495 if Ident_Casing = Unknown
496 or else Key_Casing = Unknown
497 or else Ident_Casing = Key_Casing
498 or else Determine_Token_Casing /= Key_Casing
502 -- Here we have a keyword written clearly with keyword casing.
503 -- In default mode, we would not be willing to consider this as
504 -- a reserved identifier, but if C is set, we may still accept it
508 Scan_State : Saved_Scan_State;
509 OK_Next_Tok : Boolean;
512 Save_Scan_State (Scan_State);
515 if Token_Is_At_Start_Of_Line then
523 when C_Comma_Right_Paren =>
525 Token = Tok_Comma or else Token = Tok_Right_Paren;
527 when C_Comma_Colon =>
529 Token = Tok_Comma or else Token = Tok_Colon;
539 when C_Greater_Greater =>
541 Token = Tok_Greater_Greater;
551 when C_Left_Paren_Semicolon =>
553 Token = Tok_Left_Paren or else Token = Tok_Semicolon;
559 when C_Vertical_Bar_Arrow =>
561 Token = Tok_Vertical_Bar or else Token = Tok_Arrow;
564 Restore_Scan_State (Scan_State);
574 -- If we fall through it is not a reserved identifier
577 end Is_Reserved_Identifier;
579 ----------------------
580 -- Merge_Identifier --
581 ----------------------
583 procedure Merge_Identifier (Prev : Node_Id; Nxt : Token_Type) is
585 if Token /= Tok_Identifier then
590 S : Saved_Scan_State;
597 Restore_Scan_State (S);
604 -- Check exactly one space between identifiers
606 if Source (Token_Ptr - 1) /= ' '
607 or else Int (Token_Ptr) /=
608 Int (Prev_Token_Ptr) + Length_Of_Name (Chars (Prev)) + 1
615 Get_Name_String (Chars (Token_Node));
618 Buf : constant String (1 .. Name_Len) :=
619 Name_Buffer (1 .. Name_Len);
622 Get_Name_String (Chars (Prev));
623 Add_Char_To_Name_Buffer ('_');
624 Add_Str_To_Name_Buffer (Buf);
625 Set_Chars (Prev, Name_Find);
628 Error_Msg_Node_1 := Prev;
629 Error_Msg_SC ("unexpected identifier, possibly & was meant here");
631 end Merge_Identifier;
637 function Next_Token_Is (Tok : Token_Type) return Boolean is
638 Scan_State : Saved_Scan_State;
641 Save_Scan_State (Scan_State);
643 Result := (Token = Tok);
644 Restore_Scan_State (Scan_State);
652 procedure No_Constraint is
654 -- If we have a token that could start a constraint on the same line
655 -- then cnsider this an illegal constraint. It seems unlikely it could
656 -- be anything else if it is on the same line.
658 if Token in Token_Class_Consk then
659 Error_Msg_SC ("constraint not allowed here");
660 Discard_Junk_Node (P_Constraint_Opt);
664 ---------------------
665 -- Pop_Scope_Stack --
666 ---------------------
668 procedure Pop_Scope_Stack is
670 pragma Assert (Scope.Last > 0);
671 Scope.Decrement_Last;
673 if Include_Subprogram_In_Messages
674 and then Scopes (Scope.Last).Labl /= Error
676 Current_Node := Scopes (Scope.Last).Labl;
680 Error_Msg_Uint_1 := UI_From_Int (Scope.Last);
681 Error_Msg_SC ("decrement scope stack ptr, new value = ^!");
685 ----------------------
686 -- Push_Scope_Stack --
687 ----------------------
689 procedure Push_Scope_Stack is
691 Scope.Increment_Last;
693 if Style_Check_Max_Nesting_Level
694 and then Scope.Last = Style_Max_Nesting_Level + 1
697 ("(style) maximum nesting level exceeded",
698 First_Non_Blank_Location);
701 Scopes (Scope.Last).Junk := False;
702 Scopes (Scope.Last).Node := Empty;
705 Error_Msg_Uint_1 := UI_From_Int (Scope.Last);
706 Error_Msg_SC ("increment scope stack ptr, new value = ^!");
708 end Push_Scope_Stack;
710 ----------------------
711 -- Separate_Present --
712 ----------------------
714 function Separate_Present return Boolean is
715 Scan_State : Saved_Scan_State;
718 if Token = Tok_Separate then
721 elsif Token /= Tok_Identifier then
725 Save_Scan_State (Scan_State);
726 Scan; -- past identifier
728 if Token = Tok_Semicolon then
729 Restore_Scan_State (Scan_State);
730 return Bad_Spelling_Of (Tok_Separate);
733 Restore_Scan_State (Scan_State);
737 end Separate_Present;
739 --------------------------
740 -- Signal_Bad_Attribute --
741 --------------------------
743 procedure Signal_Bad_Attribute is
745 Bad_Attribute (Token_Node, Token_Name, Warn => False);
746 end Signal_Bad_Attribute;
748 -----------------------------
749 -- Token_Is_At_End_Of_Line --
750 -----------------------------
752 function Token_Is_At_End_Of_Line return Boolean is
756 -- Skip past blanks and horizontal tabs
759 while Source (S) = ' ' or else Source (S) = ASCII.HT loop
763 -- We are at end of line if at a control character (CR/LF/VT/FF/EOF)
764 -- or if we are at the start of an end of line comment sequence.
766 return Source (S) < ' '
767 or else (Source (S) = '-' and then Source (S + 1) = '-');
768 end Token_Is_At_End_Of_Line;
770 -------------------------------
771 -- Token_Is_At_Start_Of_Line --
772 -------------------------------
774 function Token_Is_At_Start_Of_Line return Boolean is
776 return (Token_Ptr = First_Non_Blank_Location or else Token = Tok_EOF);
777 end Token_Is_At_Start_Of_Line;
779 -----------------------------------
780 -- Warn_If_Standard_Redefinition --
781 -----------------------------------
783 procedure Warn_If_Standard_Redefinition (N : Node_Id) is
785 if Warn_On_Standard_Redefinition then
787 C : constant Entity_Id := Current_Entity (N);
789 if Present (C) and then Sloc (C) = Standard_Location then
790 Error_Msg_N ("redefinition of entity& in Standard?K?", N);
794 end Warn_If_Standard_Redefinition;