1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2005, 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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 -- This package contains the style switches used for setting style options.
28 -- The only clients of this package are the body of Style and the body of
29 -- Switches. All other style checking issues are handled using the public
30 -- interfaces in the spec of Style.
32 with Types; use Types;
36 --------------------------
37 -- Style Check Switches --
38 --------------------------
40 -- These flags are used to control the details of the style checking
41 -- options. The default values shown here correspond to no style
42 -- checking. If any of these values is set to a non-default value,
43 -- then Opt.Style_Check is set True to active calls to this package.
45 -- The actual mechanism for setting these switches to other than
46 -- default values is via the Set_Style_Check_Option procedure or
47 -- through a call to Set_Default_Style_Check_Options. They should
48 -- not be set directly in any other manner.
50 Style_Check_Attribute_Casing : Boolean := False;
51 -- This can be set True by using the -gnatg or -gnatya switches. If
52 -- it is True, then attribute names (including keywords such as
53 -- digits used as attribute names) must be in mixed case.
55 Style_Check_Blanks_At_End : Boolean := False;
56 -- This can be set True by using the -gnatg or -gnatyb switches. If
57 -- it is True, then spaces at the end of lines are not permitted.
59 Style_Check_Comments : Boolean := False;
60 -- This can be set True by using the -gnatg or -gnatyc switches. If
61 -- it is True, then comments are style checked as follows:
63 -- All comments must be at the start of the line, or the first
64 -- minus must be preceded by at least one space.
66 -- For a comment that is not at the start of a line, the only
67 -- requirement is that a space follow the comment characters.
69 -- For a coment that is at the start of the line, one of the
70 -- following conditions must hold:
72 -- The comment characters are the only non-blank characters on the line
74 -- The comment characters are followed by an exclamation point (the
75 -- sequence --! is used by gnatprep for marking deleted lines).
77 -- The comment characters are followed by two space characters
79 -- The line consists entirely of minus signs
81 -- The comment characters are followed by a single space, and the
82 -- last two characters on the line are also comment characters.
84 -- Note: the reason for the last two conditions is to allow "boxed"
85 -- comments where only a single space separates the comment characters.
87 Style_Check_DOS_Line_Terminator : Boolean := False;
88 -- This can be set true by using the -gnatg or -gnatyd switches. If
89 -- it is True, then the line terminator must be a single LF, without an
90 -- associated CR (e.g. DOS line terminator sequence CR/LF not allowed).
92 Style_Check_End_Labels : Boolean := False;
93 -- This can be set True by using the -gnatg or -gnatye switches. If
94 -- it is True, then optional END labels must always be present.
96 Style_Check_Form_Feeds : Boolean := False;
97 -- This can be set True by using the -gnatg or -gnatyf switches. If
98 -- it is True, then form feeds and vertical tabs are not allowed in
101 Style_Check_Horizontal_Tabs : Boolean := False;
102 -- This can be set True by using the -gnatg or -gnatyh switches. If
103 -- it is True, then horizontal tabs are not allowed in source text.
105 Style_Check_If_Then_Layout : Boolean := False;
106 -- This can be set True by using the -gnatg or -gnatyi switches. If
107 -- it is True, then a THEN keyword may not appear on the line that
108 -- immediately follows the line containing the corresponding IF.
110 -- This permits one of two styles for IF-THEN layout. Either the
111 -- IF and THEN keywords are on the same line, where the condition
112 -- is short enough, or the conditions are continued over to the
113 -- lines following the IF and the THEN stands on its own. For
129 Style_Check_Indentation : Column_Number range 0 .. 9 := 0;
130 -- This can be set non-zero by using the -gnatg or -gnatyn (n a digit)
131 -- switches. If it is non-zero it activates indentation checking with
132 -- the indicated indentation value. A value of zero turns off checking.
133 -- The requirement is that any new statement, line comment, declaration
134 -- or keyword such as END, start on a column that is a multiple of the
135 -- indentiation value.
137 Style_Check_Keyword_Casing : Boolean := False;
138 -- This can be set True by using the -gnatg or -gnatyk switches. If
139 -- it is True, then keywords are required to be in all lower case.
140 -- This rule does not apply to keywords such as digits appearing as
141 -- an attribute name.
143 Style_Check_Max_Line_Length : Boolean := False;
144 -- This can be set True by using the -gnatg or -gnatym/M switches.
145 -- If it is True, it activates checking for a maximum line length of
146 -- Style_Max_Line_Length characters.
148 Style_Check_Max_Nesting_Level : Boolean := False;
149 -- This can be set True by using -gnatyLnnn with a value other than
150 -- zero (a value of zero resets it to False). If True, it activates
151 -- checking the maximum nesting level against Style_Max_Nesting_Level.
153 Style_Check_Order_Subprograms : Boolean := False;
154 -- This can be set True by using the -gnatg or -gnatyo switch. If it
155 -- is True, then names of subprogram bodies must be in alphabetical
156 -- order (not taking casing into account).
158 Style_Check_Pragma_Casing : Boolean := False;
159 -- This can be set True by using the -gnatg or -gnatyp switches. If
160 -- it is True, then pragma names must use mixed case.
162 Style_Check_Layout : Boolean := False;
163 -- This can be set True by using the -gnatg or -gnatyl switches. If
164 -- it is True, it activates checks that constructs are indented as
165 -- suggested by the examples in the RM syntax, e.g. that the ELSE
166 -- keyword must line up with the IF keyword.
168 Style_Check_References : Boolean := False;
169 -- This can be set True by using the -gnatg or -gnatyr switches. If
170 -- it is True, then all references to declared identifiers are
171 -- checked. The requirement is that casing of the reference be the
172 -- same as the casing of the corresponding declaration.
174 Style_Check_Specs : Boolean := False;
175 -- This can be set True by using the -gnatg or -gnatys switches. If
176 -- it is True, then separate specs are required to be present for
177 -- all procedures except parameterless library level procedures.
178 -- The exception means that typical main programs do not require
181 Style_Check_Standard : Boolean := False;
182 -- This can be set True by using the -gnatg or -gnatyn switches. If
183 -- it is True, then any references to names in Standard have to be
184 -- in mixed case mode (e.g. Integer, Boolean).
186 Style_Check_Tokens : Boolean := False;
187 -- This can be set True by using the -gnatg or -gnatyt switches. If
188 -- it is True, then the style check that requires canonical spacing
189 -- between various punctuation tokens as follows:
191 -- ABS and NOT must be followed by a space
193 -- => must be surrounded by spaces
195 -- <> must be preceded by a space or left paren
197 -- Binary operators other than ** must be surrounded by spaces.
198 -- There is no restriction on the layout of the ** binary operator.
200 -- Colon must be surrounded by spaces
202 -- Colon-equal (assignment) must be surrounded by spaces
204 -- Comma must be the first non-blank character on the line, or be
205 -- immediately preceded by a non-blank character, and must be followed
208 -- A space must precede a left paren following a digit or letter,
209 -- and a right paren must not be followed by a space (it can be
210 -- at the end of the line).
212 -- A right paren must either be the first non-blank character on
213 -- a line, or it must be preceded by a non-blank character.
215 -- A semicolon must not be preceded by a blank, and must not be
216 -- followed by a non-blank character.
218 -- A unary plus or minus may not be followed by a space
220 -- A vertical bar must be surrounded by spaces
222 -- Note that a requirement that a token be preceded by a space is
223 -- met by placing the token at the start of the line, and similarly
224 -- a requirement that a token be followed by a space is met by
225 -- placing the token at the end of the line. Note that in the case
226 -- where horizontal tabs are permitted, a horizontal tab is acceptable
227 -- for meeting the requirement for a space.
229 Style_Check_Xtra_Parens : Boolean := False;
230 -- This can be set True by using the -gnatg or -gnatyx switch. If true,
231 -- then it is not allowed to enclose entire conditional expressions
232 -- in parentheses (C style).
234 Style_Max_Line_Length : Int := 0;
235 -- Value used to check maximum line length. Gets reset as a result of
236 -- use of -gnatym or -gnatyMnnn switches (or by use of -gnatg). This
237 -- value is only read if Style_Check_Max_Line_Length is True.
239 Style_Max_Nesting_Level : Int := 0;
240 -- Value used to check maximum nesting level. Gets reset as a result
241 -- of use of the -gnatyLnnn switch. This value is only read if
242 -- Style_Check_Max_Nesting_Level is True.
248 procedure Set_Default_Style_Check_Options;
249 -- This procedure is called to set the default style checking options
250 -- in response to a -gnaty switch with no suboptions.
252 procedure Set_Style_Check_Options
255 Err_Col : out Natural);
256 -- This procedure is called to set the style check options that
257 -- correspond to the characters in the given Options string. If
258 -- all options are valid, they are set in an additive manner:
259 -- any previous options are retained unless overridden. If any
260 -- invalid character is found, then OK is False on exit, and
261 -- Err_Col is the index in options of the bad character. If all
262 -- options are valid, OK is True on return, and Err_Col is set
263 -- to Options'Last + 1.
265 procedure Set_Style_Check_Options (Options : String);
266 -- Like the above procedure, except that the call is simply ignored if
267 -- there are any error conditions, this is for example appopriate for
268 -- calls where the string is known to be valid, e.g. because it was
269 -- obtained by Save_Style_Check_Options.
271 procedure Reset_Style_Check_Options;
272 -- Sets all style check options to off
274 subtype Style_Check_Options is String (1 .. 64);
275 -- Long enough string to hold all options from Save call below
277 procedure Save_Style_Check_Options (Options : out Style_Check_Options);
278 -- Sets Options to represent current selection of options. This
279 -- set can be restored by first calling Reset_Style_Check_Options,
280 -- and then calling Set_Style_Check_Options with the Options string.
OSDN Git Service
