1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2008, 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 generic package collects the routines used for style checking, as
27 -- activated by the relevant command line option. These are gathered in
28 -- a separate package so that they can more easily be customized. Calls
29 -- to these subprograms are only made if Opt.Style_Check is set True.
30 -- Styleg does not depends on the GNAT tree (Atree, Sinfo, ...).
32 -- For the compiler, there is also a child package Styleg.C that depends
35 with Types
; use Types
;
38 with procedure Error_Msg
(Msg
: String; Flag_Location
: Source_Ptr
);
39 -- Output a message at specified location
41 with procedure Error_Msg_S
(Msg
: String);
42 -- Output a message at current scan pointer location
44 with procedure Error_Msg_SC
(Msg
: String);
45 -- Output a message at the start of the current token
47 with procedure Error_Msg_SP
(Msg
: String);
48 -- Output a message at the start of the previous token
52 procedure Check_Abs_Not
;
53 -- Called after scanning an ABS or NOT operator to check spacing
55 procedure Check_Apostrophe
;
56 -- Called after scanning an apostrophe to check spacing
58 procedure Check_Arrow
;
59 -- Called after scanning out an arrow to check spacing
61 procedure Check_Attribute_Name
(Reserved
: Boolean);
62 -- The current token is an attribute designator. Check that it
63 -- is capitalized in an appropriate manner. Reserved is set if
64 -- the attribute designator is a reserved word (access, digits,
65 -- delta or range) to allow differing rules for the two cases.
68 -- Called after scanning out a box to check spacing
70 procedure Check_Binary_Operator
;
71 -- Called after scanning out a binary operator other than a plus, minus
72 -- or exponentiation operator. Intended for checking spacing rules.
74 procedure Check_Exponentiation_Operator
;
75 -- Called after scanning out an exponentiation operator. Intended for
76 -- checking spacing rules.
78 procedure Check_Colon
;
79 -- Called after scanning out colon to check spacing
81 procedure Check_Colon_Equal
;
82 -- Called after scanning out colon equal to check spacing
84 procedure Check_Comma
;
85 -- Called after scanning out comma to check spacing
87 procedure Check_Comment
;
88 -- Called with Scan_Ptr pointing to the first minus sign of a comment.
89 -- Intended for checking any specific rules for comment placement/format.
91 procedure Check_Dot_Dot
;
92 -- Called after scanning out dot dot to check spacing
95 -- Called after scanning out EOF mark
98 -- Called with Scan_Ptr pointing to a horizontal tab character
100 procedure Check_Indentation
;
101 -- Called at the start of a new statement or declaration, with Token_Ptr
102 -- pointing to the first token of the statement or declaration. The check
103 -- is that the starting column is appropriate to the indentation rules if
104 -- Token_Ptr is the first token on the line.
106 procedure Check_Left_Paren
;
107 -- Called after scanning out a left parenthesis to check spacing
109 procedure Check_Line_Max_Length
(Len
: Int
);
110 -- Called with Scan_Ptr pointing to the first line terminator character
111 -- terminating the current line. Used to check for appropriate line length.
112 -- The parameter Len is the length of the current line.
114 procedure Check_Line_Terminator
(Len
: Int
);
115 -- Called with Scan_Ptr pointing to the first line terminator terminating
116 -- the current line, used to check for appropriate line terminator usage.
117 -- The parameter Len is the length of the current line.
119 procedure Check_Pragma_Name
;
120 -- The current token is a pragma identifier. Check that it is spelled
121 -- properly (i.e. with an appropriate casing convention).
123 procedure Check_Right_Paren
;
124 -- Called after scanning out a right parenthesis to check spacing
126 procedure Check_Semicolon
;
127 -- Called after scanning out a semicolon to check spacing
129 procedure Check_Then
(If_Loc
: Source_Ptr
);
130 -- Called to check that THEN and IF keywords are appropriately positioned.
131 -- The parameters show the first characters of the two keywords. This
132 -- procedure is called only if THEN appears at the start of a line with
133 -- Token_Ptr pointing to the THEN keyword.
135 procedure Check_Separate_Stmt_Lines
;
136 pragma Inline
(Check_Separate_Stmt_Lines
);
137 -- Called after scanning THEN (not preceded by AND) or ELSE (not preceded
138 -- by OR). Used to check that no tokens follow on the same line (which
139 -- would interfere with coverage testing). Handles case of THEN ABORT as
140 -- an exception, as well as PRAGMA after ELSE.
142 procedure Check_Unary_Plus_Or_Minus
;
143 -- Called after scanning a unary plus or minus to check spacing
145 procedure Check_Vertical_Bar
;
146 -- Called after scanning a vertical bar to check spacing
148 procedure Check_Xtra_Parens
(Loc
: Source_Ptr
);
149 -- Called after scanning a conditional expression that has at least one
150 -- level of parentheses around the entire expression.
152 function Mode_In_Check
return Boolean;
153 pragma Inline
(Mode_In_Check
);
154 -- Determines whether style checking is active and the Mode_In_Check is
155 -- set, forbidding the explicit use of mode IN.
157 procedure No_End_Name
(Name
: Node_Id
);
158 -- Called if an END is encountered where a name is allowed but not present.
159 -- The parameter is the node whose name is the name that is permitted in
160 -- the END line, and the scan pointer is positioned so that if an error
161 -- message is to be generated in this situation, it should be generated
162 -- using Error_Msg_SP.
164 procedure No_Exit_Name
(Name
: Node_Id
);
165 -- Called when exiting a named loop, but a name is not present on the EXIT.
166 -- The parameter is the node whose name should have followed EXIT, and the
167 -- scan pointer is positioned so that if an error message is to be
168 -- generated, it should be generated using Error_Msg_SP.
170 procedure Non_Lower_Case_Keyword
;
171 -- Called if a reserved keyword is scanned which is not spelled in all
172 -- lower case letters. On entry Token_Ptr points to the keyword token.
173 -- This is not used for keywords appearing as attribute designators,
174 -- where instead Check_Attribute_Name (True) is called.
176 function RM_Column_Check
return Boolean;
177 pragma Inline
(RM_Column_Check
);
178 -- Determines whether style checking is active and the RM column check
179 -- mode is set requiring checking of RM format layout.