1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2016, 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 -- This version of the Style package implements the standard GNAT style
27 -- checking rules. For documentation of these rules, see comments on the
28 -- individual procedures.
30 with Atree
; use Atree
;
31 with Casing
; use Casing
;
32 with Csets
; use Csets
;
33 with Einfo
; use Einfo
;
34 with Err_Vars
; use Err_Vars
;
36 with Scans
; use Scans
;
37 with Sinfo
; use Sinfo
;
38 with Sinput
; use Sinput
;
39 with Stylesw
; use Stylesw
;
41 package body Styleg
is
45 Blank_Lines
: Nat
:= 0;
46 -- Counts number of empty lines seen. Reset to zero if a non-empty line
47 -- is encountered. Used to check for trailing blank lines in Check_EOF,
48 -- and for multiple blank lines.
50 Blank_Line_Location
: Source_Ptr
;
51 -- Remembers location of first blank line in a series. Used to issue an
52 -- appropriate diagnostic if subsequent blank lines or the end of file
55 -----------------------
56 -- Local Subprograms --
57 -----------------------
59 procedure Check_No_Space_After
;
60 -- Checks that there is a non-white space character after the current
61 -- token, or white space followed by a comment, or the end of line.
62 -- Issue error message if not.
64 procedure Check_No_Space_Before
;
65 -- Check that token is first token on line, or else is not preceded
66 -- by white space. Signal error of space not allowed if not.
68 procedure Check_Separate_Stmt_Lines_Cont
;
69 -- Non-inlined continuation of Check_Separate_Stmt_Lines
71 function Determine_Token_Casing
return Casing_Type
;
72 -- Determine casing of current token
74 procedure Error_Space_Not_Allowed
(S
: Source_Ptr
);
75 -- Posts an error message indicating that a space is not allowed
76 -- at the given source location.
78 procedure Error_Space_Required
(S
: Source_Ptr
);
79 -- Posts an error message indicating that a space is required at
80 -- the given source location.
82 function Is_White_Space
(C
: Character) return Boolean;
83 pragma Inline
(Is_White_Space
);
84 -- Returns True for space or HT, False otherwise
85 -- What about VT and FF, should they return True ???
87 procedure Require_Following_Space
;
88 pragma Inline
(Require_Following_Space
);
89 -- Require token to be followed by white space. Used only if in GNAT
90 -- style checking mode.
92 procedure Require_Preceding_Space
;
93 pragma Inline
(Require_Preceding_Space
);
94 -- Require token to be preceded by white space. Used only if in GNAT
95 -- style checking mode.
97 ----------------------
98 -- Check_Abs_Or_Not --
99 ----------------------
101 -- In check token mode (-gnatyt), ABS/NOT must be followed by a space
103 procedure Check_Abs_Not
is
105 if Style_Check_Tokens
then
106 if Source
(Scan_Ptr
) > ' ' then -- ???
107 Error_Space_Required
(Scan_Ptr
);
112 ----------------------
113 -- Check_Apostrophe --
114 ----------------------
116 -- Do not allow space before or after apostrophe -- OR AFTER???
118 procedure Check_Apostrophe
is
120 if Style_Check_Tokens
then
121 Check_No_Space_After
;
123 end Check_Apostrophe
;
129 -- In check tokens mode (-gnatys), arrow must be surrounded by spaces,
130 -- except that within the argument of a Depends macro the required format
131 -- is =>+ rather than => +).
133 procedure Check_Arrow
(Inside_Depends
: Boolean := False) is
135 if Style_Check_Tokens
then
136 Require_Preceding_Space
;
138 if not Inside_Depends
then
139 Require_Following_Space
;
141 -- Special handling for Inside_Depends
144 if Source
(Scan_Ptr
) = ' '
145 and then Source
(Scan_Ptr
+ 1) = '+'
147 Error_Space_Not_Allowed
(Scan_Ptr
);
149 elsif Source
(Scan_Ptr
) /= ' '
150 and then Source
(Scan_Ptr
) /= '+'
152 Require_Following_Space
;
158 --------------------------
159 -- Check_Attribute_Name --
160 --------------------------
162 -- In check attribute casing mode (-gnatya), attribute names must be
163 -- mixed case, i.e. start with an upper case letter, and otherwise
164 -- lower case, except after an underline character.
166 procedure Check_Attribute_Name
(Reserved
: Boolean) is
167 pragma Warnings
(Off
, Reserved
);
169 if Style_Check_Attribute_Casing
then
170 if Determine_Token_Casing
/= Mixed_Case
then
171 Error_Msg_SC
-- CODEFIX
172 ("(style) bad capitalization, mixed case required");
175 end Check_Attribute_Name
;
177 ---------------------------
178 -- Check_Binary_Operator --
179 ---------------------------
181 -- In check token mode (-gnatyt), binary operators other than the special
182 -- case of exponentiation require surrounding space characters.
184 procedure Check_Binary_Operator
is
186 if Style_Check_Tokens
then
187 Require_Preceding_Space
;
188 Require_Following_Space
;
190 end Check_Binary_Operator
;
192 ----------------------------
193 -- Check_Boolean_Operator --
194 ----------------------------
196 procedure Check_Boolean_Operator
(Node
: Node_Id
) is
198 function OK_Boolean_Operand
(N
: Node_Id
) return Boolean;
199 -- Returns True for simple variable, or "not X1" or "X1 and X2" or
200 -- "X1 or X2" where X1, X2 are recursively OK_Boolean_Operand's.
202 ------------------------
203 -- OK_Boolean_Operand --
204 ------------------------
206 function OK_Boolean_Operand
(N
: Node_Id
) return Boolean is
208 if Nkind_In
(N
, N_Identifier
, N_Expanded_Name
) then
211 elsif Nkind
(N
) = N_Op_Not
then
212 return OK_Boolean_Operand
(Original_Node
(Right_Opnd
(N
)));
214 elsif Nkind_In
(N
, N_Op_And
, N_Op_Or
) then
215 return OK_Boolean_Operand
(Original_Node
(Left_Opnd
(N
)))
217 OK_Boolean_Operand
(Original_Node
(Right_Opnd
(N
)));
222 end OK_Boolean_Operand
;
224 -- Start of processing for Check_Boolean_Operator
227 if Style_Check_Boolean_And_Or
228 and then Comes_From_Source
(Node
)
231 Orig
: constant Node_Id
:= Original_Node
(Node
);
234 if Nkind_In
(Orig
, N_Op_And
, N_Op_Or
) then
236 L
: constant Node_Id
:= Original_Node
(Left_Opnd
(Orig
));
237 R
: constant Node_Id
:= Original_Node
(Right_Opnd
(Orig
));
240 -- First OK case, simple boolean constants/identifiers
242 if OK_Boolean_Operand
(L
)
244 OK_Boolean_Operand
(R
)
248 -- Second OK case, modular types
250 elsif Is_Modular_Integer_Type
(Etype
(Node
)) then
253 -- Third OK case, array types
255 elsif Is_Array_Type
(Etype
(Node
)) then
258 -- Otherwise we have an error
260 elsif Nkind
(Orig
) = N_Op_And
then
262 ("(style) `AND THEN` required", Sloc
(Orig
));
265 ("(style) `OR ELSE` required", Sloc
(Orig
));
271 end Check_Boolean_Operator
;
277 -- In check token mode (-gnatyt), box must be preceded by a space or by
278 -- a left parenthesis. Spacing checking on the surrounding tokens takes
279 -- care of the remaining checks.
281 procedure Check_Box
is
283 if Style_Check_Tokens
then
284 if Prev_Token
/= Tok_Left_Paren
then
285 Require_Preceding_Space
;
294 -- In check token mode (-gnatyt), colon must be surrounded by spaces
296 procedure Check_Colon
is
298 if Style_Check_Tokens
then
299 Require_Preceding_Space
;
300 Require_Following_Space
;
304 -----------------------
305 -- Check_Colon_Equal --
306 -----------------------
308 -- In check token mode (-gnatyt), := must be surrounded by spaces
310 procedure Check_Colon_Equal
is
312 if Style_Check_Tokens
then
313 Require_Preceding_Space
;
314 Require_Following_Space
;
316 end Check_Colon_Equal
;
322 -- In check token mode (-gnatyt), comma must be either the first
323 -- token on a line, or be preceded by a non-blank character.
324 -- It must also always be followed by a blank.
326 procedure Check_Comma
is
328 if Style_Check_Tokens
then
329 Check_No_Space_Before
;
331 if Source
(Scan_Ptr
) > ' ' then
332 Error_Space_Required
(Scan_Ptr
);
341 -- In check comment mode (-gnatyc) there are several requirements on the
342 -- format of comments. The following are permissible comment formats:
344 -- 1. Any comment that is not at the start of a line, i.e. where the
345 -- initial minuses are not the first non-blank characters on the
346 -- line must have at least one blank after the second minus or a
347 -- special character as defined in rule 5.
349 -- 2. A row of all minuses of any length is permitted (see procedure
350 -- box above in the source of this routine).
352 -- 3. A comment line starting with two minuses and a space, and ending
353 -- with a space and two minuses. Again see the procedure title box
354 -- immediately above in the source.
356 -- 4. A full line comment where two spaces follow the two minus signs.
357 -- This is the normal comment format in GNAT style, as typified by
358 -- the comments you are reading now.
360 -- 5. A full line comment where the first character after the second
361 -- minus is a special character, i.e. a character in the ASCII
362 -- range 16#21#..16#2F# or 16#3A#..16#3F#. This allows special
363 -- comments, such as those generated by gnatprep, or those that
364 -- appear in the SPARK annotation language to be accepted.
366 -- Note: for GNAT internal files (-gnatg switch set on for the
367 -- compilation), the only special sequence recognized and allowed
368 -- is --! as generated by gnatprep.
370 -- 6. In addition, the comment must be properly indented if comment
371 -- indentation checking is active (Style_Check_Indentation non-zero).
372 -- Either the start column must be a multiple of this indentation,
373 -- or the indentation must match that of the next non-blank line,
374 -- or must match the indentation of the immediately preciding line
375 -- if it is non-blank.
377 procedure Check_Comment
is
381 function Is_Box_Comment
return Boolean;
382 -- Returns True if the last two characters on the line are -- which
383 -- characterizes a box comment (as for example follows this spec).
385 function Is_Special_Character
(C
: Character) return Boolean;
386 -- Determines if C is a special character (see rule 5 above)
388 function Same_Column_As_Next_Non_Blank_Line
return Boolean;
389 -- Called for a full line comment. If the indentation of this comment
390 -- matches that of the next non-blank line in the source, then True is
391 -- returned, otherwise False.
393 function Same_Column_As_Previous_Line
return Boolean;
394 -- Called for a full line comment. If the previous line is blank, then
395 -- returns False. Otherwise, if the indentation of this comment matches
396 -- that of the previous line in the source, then True is returned,
403 function Is_Box_Comment
return Boolean is
407 -- Do we need to worry about UTF_32 line terminators here ???
410 while Source
(S
) not in Line_Terminator
loop
414 return Source
(S
- 1) = '-' and then Source
(S
- 2) = '-';
417 --------------------------
418 -- Is_Special_Character --
419 --------------------------
421 function Is_Special_Character
(C
: Character) return Boolean is
427 Character'Pos (C
) in 16#
21#
.. 16#
2F#
429 Character'Pos (C
) in 16#
3A#
.. 16#
3F#
;
431 end Is_Special_Character
;
433 ----------------------------------------
434 -- Same_Column_As_Next_Non_Blank_Line --
435 ----------------------------------------
437 function Same_Column_As_Next_Non_Blank_Line
return Boolean is
441 -- Step to end of line
444 while Source
(P
) not in Line_Terminator
loop
448 -- Step past blanks, and line terminators (UTF_32 case???)
450 while Source
(P
) <= ' ' and then Source
(P
) /= EOF
loop
456 return Get_Column_Number
(Scan_Ptr
) = Get_Column_Number
(P
);
457 end Same_Column_As_Next_Non_Blank_Line
;
459 ----------------------------------
460 -- Same_Column_As_Previous_Line --
461 ----------------------------------
463 function Same_Column_As_Previous_Line
return Boolean is
467 -- Point S to start of this line, and P to start of previous line
469 S
:= Line_Start
(Scan_Ptr
);
473 -- Step P to first non-blank character on line
476 -- If we get back to start of current line, then the previous line
477 -- was blank, and we always return False in that situation.
483 exit when Source
(P
) /= ' ' and then Source
(P
) /= ASCII
.HT
;
489 return Get_Column_Number
(Scan_Ptr
) = Get_Column_Number
(P
);
490 end Same_Column_As_Previous_Line
;
492 -- Start of processing for Check_Comment
495 -- Can never have a non-blank character preceding the first minus.
496 -- The "+ 3" is to leave room for a possible byte order mark (BOM);
497 -- we want to avoid a warning for a comment at the start of the
498 -- file just after the BOM.
500 if Style_Check_Comments
then
501 if Scan_Ptr
> Source_First
(Current_Source_File
) + 3
502 and then Source
(Scan_Ptr
- 1) > ' '
504 Error_Msg_S
-- CODEFIX
505 ("(style) space required");
509 -- For a comment that is not at the start of the line, the only
510 -- requirement is that we cannot have a non-blank character after
511 -- the second minus sign or a special character.
513 if Scan_Ptr
/= First_Non_Blank_Location
then
514 if Style_Check_Comments
then
515 if Source
(Scan_Ptr
+ 2) > ' '
516 and then not Is_Special_Character
(Source
(Scan_Ptr
+ 2))
519 ("(style) space required", Scan_Ptr
+ 2);
525 -- Case of a comment that is at the start of a line
528 -- First check, must be in appropriately indented column
530 if Style_Check_Indentation
/= 0 then
531 if Start_Column
rem Style_Check_Indentation
/= 0 then
532 if not Same_Column_As_Next_Non_Blank_Line
533 and then not Same_Column_As_Previous_Line
535 Error_Msg_S
-- CODEFIX
536 ("(style) bad column");
543 -- If we are not checking comments, nothing more to do
545 if not Style_Check_Comments
then
549 -- Case of not followed by a blank. Usually wrong, but there are
550 -- some exceptions that we permit.
552 if Source
(Scan_Ptr
+ 2) /= ' ' then
553 C
:= Source
(Scan_Ptr
+ 2);
555 -- Case of -- all on its own on a line is OK
561 -- Case of --x, x special character is OK (gnatprep/SPARK/etc.)
562 -- This is not permitted in internal GNAT implementation units
563 -- except for the case of --! as used by gnatprep output.
565 if Is_Special_Character
(C
) then
569 -- The only other case in which we allow a character after
570 -- the -- other than a space is when we have a row of minus
571 -- signs (case of header lines for a box comment for example).
574 while Source
(S
) >= ' ' loop
575 if Source
(S
) /= '-' then
577 or else Style_Check_Comments_Spacing
= 1
579 Error_Space_Required
(Scan_Ptr
+ 2);
582 ("(style) two spaces required", Scan_Ptr
+ 2);
591 -- If we are followed by a blank, then the comment is OK if the
592 -- character following this blank is another blank or a format
593 -- effector, or if the required comment spacing is 1.
595 elsif Source
(Scan_Ptr
+ 3) <= ' '
596 or else Style_Check_Comments_Spacing
= 1
600 -- Here is the case where we only have one blank after the two minus
601 -- signs, with Style_Check_Comments_Spacing set to 2, which is an
602 -- error unless the line ends with two minus signs, the case of a
605 elsif not Is_Box_Comment
then
606 Error_Space_Required
(Scan_Ptr
+ 3);
615 -- In check token mode (-gnatyt), ".." must be surrounded by spaces
617 procedure Check_Dot_Dot
is
619 if Style_Check_Tokens
then
620 Require_Preceding_Space
;
621 Require_Following_Space
;
629 -- In check blanks at end mode, check no blank lines precede the EOF
631 procedure Check_EOF
is
633 if Style_Check_Blank_Lines
then
635 -- We expect one blank line, from the EOF, but no more than one
637 if Blank_Lines
= 2 then
639 ("(style) blank line not allowed at end of file",
640 Blank_Line_Location
);
642 elsif Blank_Lines
>= 3 then
644 ("(style) blank lines not allowed at end of file",
645 Blank_Line_Location
);
650 -----------------------------------
651 -- Check_Exponentiation_Operator --
652 -----------------------------------
654 -- No spaces are required for the ** operator in GNAT style check mode
656 procedure Check_Exponentiation_Operator
is
659 end Check_Exponentiation_Operator
;
665 -- In check horizontal tab mode (-gnatyh), tab characters are not allowed
667 procedure Check_HT
is
669 if Style_Check_Horizontal_Tabs
then
670 Error_Msg_S
-- CODEFIX
671 ("(style) horizontal tab not allowed");
675 -----------------------
676 -- Check_Indentation --
677 -----------------------
679 -- In check indentation mode (-gnaty? for ? a digit), a new statement or
680 -- declaration is required to start in a column that is a multiple of the
681 -- indentation amount.
683 procedure Check_Indentation
is
685 if Style_Check_Indentation
/= 0 then
686 if Token_Ptr
= First_Non_Blank_Location
687 and then Start_Column
rem Style_Check_Indentation
/= 0
689 Error_Msg_SC
-- CODEFIX
690 ("(style) bad indentation");
693 end Check_Indentation
;
695 ----------------------
696 -- Check_Left_Paren --
697 ----------------------
699 -- In check token mode (-gnatyt), left paren must not be preceded by an
700 -- identifier character or digit (a separating space is required) and may
701 -- never be followed by a space.
703 procedure Check_Left_Paren
is
705 if Style_Check_Tokens
then
706 if Token_Ptr
> Source_First
(Current_Source_File
)
707 and then Identifier_Char
(Source
(Token_Ptr
- 1))
709 Error_Space_Required
(Token_Ptr
);
712 Check_No_Space_After
;
714 end Check_Left_Paren
;
716 ---------------------------
717 -- Check_Line_Max_Length --
718 ---------------------------
720 -- In check max line length mode (-gnatym), the line length must
721 -- not exceed the permitted maximum value.
723 procedure Check_Line_Max_Length
(Len
: Nat
) is
725 if Style_Check_Max_Line_Length
then
726 if Len
> Style_Max_Line_Length
then
728 ("(style) this line is too long",
729 Current_Line_Start
+ Source_Ptr
(Style_Max_Line_Length
));
732 end Check_Line_Max_Length
;
734 ---------------------------
735 -- Check_Line_Terminator --
736 ---------------------------
738 -- In check blanks at end mode (-gnatyb), lines may not end with a
741 -- In check form feeds mode (-gnatyf), the line terminator may not
742 -- be either of the characters FF or VT.
744 -- In check DOS line terminators node (-gnatyd), the line terminator
745 -- must be a single LF, without a following CR.
747 procedure Check_Line_Terminator
(Len
: Nat
) is
751 -- Length of line (adjusted down for blanks at end of line)
754 -- Reset count of blank lines if first line
756 if Get_Logical_Line_Number
(Scan_Ptr
) = 1 then
760 -- Check FF/VT terminators
762 if Style_Check_Form_Feeds
then
763 if Source
(Scan_Ptr
) = ASCII
.FF
then
764 Error_Msg_S
-- CODEFIX
765 ("(style) form feed not allowed");
766 elsif Source
(Scan_Ptr
) = ASCII
.VT
then
767 Error_Msg_S
-- CODEFIX
768 ("(style) vertical tab not allowed");
772 -- Check DOS line terminator
774 if Style_Check_DOS_Line_Terminator
then
776 -- Ignore EOF, since we only get called with an EOF if it is the last
777 -- character in the buffer (and was therefore not in the source
778 -- file), since the terminating EOF is added to stop the scan.
780 if Source
(Scan_Ptr
) = EOF
then
783 -- Bad terminator if we don't have an LF
785 elsif Source
(Scan_Ptr
) /= LF
then
786 Error_Msg_S
("(style) incorrect line terminator");
790 -- Remove trailing spaces
793 while L
> 0 and then Is_White_Space
(Source
(S
- 1)) loop
798 -- Issue message for blanks at end of line if option enabled
800 if Style_Check_Blanks_At_End
and then L
< Len
then
802 ("(style) trailing spaces not permitted", S
);
805 -- Deal with empty (blank) line
809 -- Increment blank line count
811 Blank_Lines
:= Blank_Lines
+ 1;
813 -- If first blank line, record location for later error message
815 if Blank_Lines
= 1 then
816 Blank_Line_Location
:= Scan_Ptr
;
819 -- Non-blank line, check for previous multiple blank lines
822 if Style_Check_Blank_Lines
and then Blank_Lines
> 1 then
824 ("(style) multiple blank lines", Blank_Line_Location
);
827 -- And reset blank line count
831 end Check_Line_Terminator
;
837 -- In check tokens mode, only one space between NOT and IN
839 procedure Check_Not_In
is
841 if Style_Check_Tokens
then
842 if Source
(Token_Ptr
- 1) /= ' '
843 or else Token_Ptr
- Prev_Token_Ptr
/= 4
846 ("(style) single space must separate NOT and IN", Token_Ptr
- 1);
851 --------------------------
852 -- Check_No_Space_After --
853 --------------------------
855 procedure Check_No_Space_After
is
859 if Is_White_Space
(Source
(Scan_Ptr
)) then
861 -- Allow one or more spaces if followed by comment
865 if Source
(S
) = '-' and then Source
(S
+ 1) = '-' then
868 elsif Is_White_Space
(Source
(S
)) then
876 Error_Space_Not_Allowed
(Scan_Ptr
);
878 end Check_No_Space_After
;
880 ---------------------------
881 -- Check_No_Space_Before --
882 ---------------------------
884 procedure Check_No_Space_Before
is
886 if Token_Ptr
> First_Non_Blank_Location
887 and then Source
(Token_Ptr
- 1) <= ' '
889 Error_Space_Not_Allowed
(Token_Ptr
- 1);
891 end Check_No_Space_Before
;
893 -----------------------
894 -- Check_Pragma_Name --
895 -----------------------
897 -- In check pragma casing mode (-gnatyp), pragma names must be mixed
898 -- case, i.e. start with an upper case letter, and otherwise lower case,
899 -- except after an underline character.
901 procedure Check_Pragma_Name
is
903 if Style_Check_Pragma_Casing
then
904 if Determine_Token_Casing
/= Mixed_Case
then
905 Error_Msg_SC
-- CODEFIX
906 ("(style) bad capitalization, mixed case required");
909 end Check_Pragma_Name
;
911 -----------------------
912 -- Check_Right_Paren --
913 -----------------------
915 -- In check token mode (-gnatyt), right paren must not be immediately
916 -- followed by an identifier character, and must never be preceded by
917 -- a space unless it is the initial non-blank character on the line.
919 procedure Check_Right_Paren
is
921 if Style_Check_Tokens
then
922 if Identifier_Char
(Source
(Token_Ptr
+ 1)) then
923 Error_Space_Required
(Token_Ptr
+ 1);
926 Check_No_Space_Before
;
928 end Check_Right_Paren
;
930 ---------------------
931 -- Check_Semicolon --
932 ---------------------
934 -- In check token mode (-gnatyt), semicolon does not permit a preceding
935 -- space and a following space is required.
937 procedure Check_Semicolon
is
939 if Style_Check_Tokens
then
940 Check_No_Space_Before
;
942 if Source
(Scan_Ptr
) > ' ' then
943 Error_Space_Required
(Scan_Ptr
);
948 -------------------------------
949 -- Check_Separate_Stmt_Lines --
950 -------------------------------
952 procedure Check_Separate_Stmt_Lines
is
954 if Style_Check_Separate_Stmt_Lines
then
955 Check_Separate_Stmt_Lines_Cont
;
957 end Check_Separate_Stmt_Lines
;
959 ------------------------------------
960 -- Check_Separate_Stmt_Lines_Cont --
961 ------------------------------------
963 procedure Check_Separate_Stmt_Lines_Cont
is
967 -- Skip past white space
970 while Is_White_Space
(Source
(S
)) loop
974 -- Line terminator is OK
976 if Source
(S
) in Line_Terminator
then
981 elsif Source
(S
) = '-' and then Source
(S
+ 1) = '-' then
984 -- ABORT keyword is OK after THEN (THEN ABORT case)
986 elsif Token
= Tok_Then
987 and then (Source
(S
+ 0) = 'a' or else Source
(S
+ 0) = 'A')
988 and then (Source
(S
+ 1) = 'b' or else Source
(S
+ 1) = 'B')
989 and then (Source
(S
+ 2) = 'o' or else Source
(S
+ 2) = 'O')
990 and then (Source
(S
+ 3) = 'r' or else Source
(S
+ 3) = 'R')
991 and then (Source
(S
+ 4) = 't' or else Source
(S
+ 4) = 'T')
992 and then (Source
(S
+ 5) in Line_Terminator
993 or else Is_White_Space
(Source
(S
+ 5)))
997 -- PRAGMA keyword is OK after ELSE
999 elsif Token
= Tok_Else
1000 and then (Source
(S
+ 0) = 'p' or else Source
(S
+ 0) = 'P')
1001 and then (Source
(S
+ 1) = 'r' or else Source
(S
+ 1) = 'R')
1002 and then (Source
(S
+ 2) = 'a' or else Source
(S
+ 2) = 'A')
1003 and then (Source
(S
+ 3) = 'g' or else Source
(S
+ 3) = 'G')
1004 and then (Source
(S
+ 4) = 'm' or else Source
(S
+ 4) = 'M')
1005 and then (Source
(S
+ 5) = 'a' or else Source
(S
+ 5) = 'A')
1006 and then (Source
(S
+ 6) in Line_Terminator
1007 or else Is_White_Space
(Source
(S
+ 6)))
1011 -- Otherwise we have the style violation we are looking for
1014 if Token
= Tok_Then
then
1015 Error_Msg
-- CODEFIX
1016 ("(style) no statements may follow THEN on same line", S
);
1019 ("(style) no statements may follow ELSE on same line", S
);
1022 end Check_Separate_Stmt_Lines_Cont
;
1028 -- In check if then layout mode (-gnatyi), we expect a THEN keyword to
1029 -- appear either on the same line as the IF, or on a separate line if
1030 -- the IF statement extends for more than one line.
1032 procedure Check_Then
(If_Loc
: Source_Ptr
) is
1034 if Style_Check_If_Then_Layout
then
1036 If_Line
: constant Physical_Line_Number
:=
1037 Get_Physical_Line_Number
(If_Loc
);
1038 Then_Line
: constant Physical_Line_Number
:=
1039 Get_Physical_Line_Number
(Token_Ptr
);
1041 if If_Line
= Then_Line
then
1043 elsif Token_Ptr
/= First_Non_Blank_Location
then
1044 Error_Msg_SC
("(style) misplaced THEN");
1050 -------------------------------
1051 -- Check_Unary_Plus_Or_Minus --
1052 -------------------------------
1054 -- In check token mode (-gnatyt), unary plus or minus must not be
1055 -- followed by a space.
1057 -- Annoying exception: if we have the sequence =>+ within a Depends pragma
1058 -- or aspect, then we insist on a space rather than forbidding it.
1060 procedure Check_Unary_Plus_Or_Minus
(Inside_Depends
: Boolean := False) is
1062 if Style_Check_Tokens
then
1063 if not Inside_Depends
then
1064 Check_No_Space_After
;
1066 Require_Following_Space
;
1069 end Check_Unary_Plus_Or_Minus
;
1071 ------------------------
1072 -- Check_Vertical_Bar --
1073 ------------------------
1075 -- In check token mode (-gnatyt), vertical bar must be surrounded by spaces
1077 procedure Check_Vertical_Bar
is
1079 if Style_Check_Tokens
then
1080 Require_Preceding_Space
;
1081 Require_Following_Space
;
1083 end Check_Vertical_Bar
;
1085 -----------------------
1086 -- Check_Xtra_Parens --
1087 -----------------------
1089 procedure Check_Xtra_Parens
(Loc
: Source_Ptr
) is
1091 if Style_Check_Xtra_Parens
then
1092 Error_Msg
-- CODEFIX
1093 ("(style) redundant parentheses", Loc
);
1095 end Check_Xtra_Parens
;
1097 ----------------------------
1098 -- Determine_Token_Casing --
1099 ----------------------------
1101 function Determine_Token_Casing
return Casing_Type
is
1103 return Determine_Casing
(Source
(Token_Ptr
.. Scan_Ptr
- 1));
1104 end Determine_Token_Casing
;
1106 -----------------------------
1107 -- Error_Space_Not_Allowed --
1108 -----------------------------
1110 procedure Error_Space_Not_Allowed
(S
: Source_Ptr
) is
1112 Error_Msg
-- CODEFIX
1113 ("(style) space not allowed", S
);
1114 end Error_Space_Not_Allowed
;
1116 --------------------------
1117 -- Error_Space_Required --
1118 --------------------------
1120 procedure Error_Space_Required
(S
: Source_Ptr
) is
1122 Error_Msg
-- CODEFIX
1123 ("(style) space required", S
);
1124 end Error_Space_Required
;
1126 --------------------
1127 -- Is_White_Space --
1128 --------------------
1130 function Is_White_Space
(C
: Character) return Boolean is
1132 return C
= ' ' or else C
= HT
;
1139 function Mode_In_Check
return Boolean is
1141 return Style_Check
and Style_Check_Mode_In
;
1148 -- In check end/exit labels mode (-gnatye), always require the name of
1149 -- a subprogram or package to be present on the END, so this is an error.
1151 procedure No_End_Name
(Name
: Node_Id
) is
1153 if Style_Check_End_Labels
then
1154 Error_Msg_Node_1
:= Name
;
1155 Error_Msg_SP
-- CODEFIX
1156 ("(style) `END &` required");
1164 -- In check end/exit labels mode (-gnatye), always require the name of
1165 -- the loop to be present on the EXIT when exiting a named loop.
1167 procedure No_Exit_Name
(Name
: Node_Id
) is
1169 if Style_Check_End_Labels
then
1170 Error_Msg_Node_1
:= Name
;
1171 Error_Msg_SP
-- CODEFIX
1172 ("(style) `EXIT &` required");
1176 ----------------------------
1177 -- Non_Lower_Case_Keyword --
1178 ----------------------------
1180 -- In check casing mode (-gnatyk), reserved keywords must be spelled
1181 -- in all lower case (excluding keywords range, access, delta and digits
1182 -- used as attribute designators).
1184 procedure Non_Lower_Case_Keyword
is
1186 if Style_Check_Keyword_Casing
then
1187 Error_Msg_SC
-- CODEFIX
1188 ("(style) reserved words must be all lower case");
1190 end Non_Lower_Case_Keyword
;
1192 -----------------------------
1193 -- Require_Following_Space --
1194 -----------------------------
1196 procedure Require_Following_Space
is
1198 if Source
(Scan_Ptr
) > ' ' then
1199 Error_Space_Required
(Scan_Ptr
);
1201 end Require_Following_Space
;
1203 -----------------------------
1204 -- Require_Preceding_Space --
1205 -----------------------------
1207 procedure Require_Preceding_Space
is
1209 if Token_Ptr
> Source_First
(Current_Source_File
)
1210 and then Source
(Token_Ptr
- 1) > ' '
1212 Error_Space_Required
(Token_Ptr
);
1214 end Require_Preceding_Space
;