-- --
-- S p e c --
-- --
--- Copyright (C) 1992-2008, Free Software Foundation, Inc. --
+-- Copyright (C) 1992-2011, Free Software Foundation, Inc. --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- options. The default values shown here correspond to no style checking.
-- If any of these values is set to a non-default value, then
- -- Opt.Style_Check is set True to active calls to this package.
+ -- Opt.Style_Check is set True to activate calls to this package.
-- The actual mechanism for setting these switches to other than default
- -- values is via the Set_Style_Check_Option procedure or through a call to
+ -- values is via the Set_Style_Check_Options procedure or through a call to
-- Set_Default_Style_Check_Options. They should not be set directly in any
-- other manner.
Style_Check_Array_Attribute_Index : Boolean := False;
- -- This can be set True by using -gnatg or -gnatyA switches. If it is True
- -- then index numbers for array attributes (like Length) are required to
- -- be absent for one-dimensional arrays and present for multi-dimensional
+ -- This can be set True by using the -gnatyA switch. If it is True then
+ -- index numbers for array attributes (like Length) are required to be
+ -- absent for one-dimensional arrays and present for multi-dimensional
-- array attribute references.
Style_Check_Attribute_Casing : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatya switches. If it is
- -- True, then attribute names (including keywords such as digits used as
- -- attribute names) must be in mixed case.
+ -- This can be set True by using the -gnatya switch. If it is True, then
+ -- attribute names (including keywords such as digits used as attribute
+ -- names) must be in mixed case.
Style_Check_Blanks_At_End : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyb switches. If it is
- -- True, then spaces at the end of lines are not permitted.
+ -- This can be set True by using the -gnatyb switch. If it is True, then
+ -- spaces at the end of lines are not permitted.
Style_Check_Blank_Lines : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyu switches. If it is
- -- True, then multiple blank lines are not permitted, and there may not be
- -- a blank line at the end of the file.
+ -- This can be set True by using the -gnatyu switch. If it is True, then
+ -- multiple blank lines are not permitted, and there may not be a blank
+ -- line at the end of the file.
+
+ Style_Check_Boolean_And_Or : Boolean := False;
+ -- This can be set True by using the -gnatyB switch. If it is True, then
+ -- the use of AND THEN/OR ELSE rather than AND/OR is required except for
+ -- the following cases:
+ --
+ -- a) Both operands are simple Boolean constants or variables
+ -- b) Both operands are of a modular type
+ -- c) Both operands are of an array type
Style_Check_Comments : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyc switches. If it is
- -- True, then comments are style checked as follows:
+ -- This can be set True by using the -gnatyc switch. If it is True, then
+ -- comments are style checked as follows:
--
-- All comments must be at the start of the line, or the first minus must
-- be preceded by at least one space.
-- For a comment that is not at the start of a line, the only requirement
-- is that a space follow the comment characters.
--
- -- For a coment that is at the start of the line, one of the following
+ -- For a comment that is at the start of the line, one of the following
-- conditions must hold:
--
-- The comment characters are the only non-blank characters on the line
-- The comment characters are followed by an exclamation point (the
-- sequence --! is used by gnatprep for marking deleted lines).
--
- -- The comment characters are followed by two space characters
+ -- The comment characters are followed by two space characters if
+ -- Comment_Spacing = 2, else by one character if Comment_Spacing = 1.
--
-- The line consists entirely of minus signs
--
-- Note: the reason for the last two conditions is to allow "boxed"
-- comments where only a single space separates the comment characters.
+ Style_Check_Comments_Spacing : Nat range 1 .. 2;
+ -- Spacing required for comments, valid only if Style_Check_Comments true.
+
Style_Check_DOS_Line_Terminator : Boolean := False;
- -- This can be set true by using the -gnatg or -gnatyd switches. If it
- -- is True, then the line terminator must be a single LF, without an
- -- associated CR (e.g. DOS line terminator sequence CR/LF not allowed).
+ -- This can be set true by using the -gnatyd switch. If it is True, then
+ -- the line terminator must be a single LF, without an associated CR (e.g.
+ -- DOS line terminator sequence CR/LF not allowed).
Style_Check_End_Labels : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatye switches. If it is
- -- True, then optional END labels must always be present.
+ -- This can be set True by using the -gnatye switch. If it is True, then
+ -- optional END labels must always be present.
Style_Check_Form_Feeds : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyf switches. If it is
- -- True, then form feeds and vertical tabs are not allowed in the source
- -- text.
+ -- This can be set True by using the -gnatyf switch. If it is True, then
+ -- form feeds and vertical tabs are not allowed in the source text.
Style_Check_Horizontal_Tabs : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyh switches. If it is
- -- True, then horizontal tabs are not allowed in source text.
+ -- This can be set True by using the -gnatyh switch. If it is True, then
+ -- horizontal tabs are not allowed in source text.
Style_Check_If_Then_Layout : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyi switches. If it is
- -- True, then a THEN keyword may not appear on the line that immediately
- -- follows the line containing the corresponding IF.
+ -- This can be set True by using the -gnatyi switch. If it is True, then a
+ -- THEN keyword may not appear on the line that immediately follows the
+ -- line containing the corresponding IF.
--
-- This permits one of two styles for IF-THEN layout. Either the IF and
-- THEN keywords are on the same line, where the condition is short enough,
-- is not allowed.
Style_Check_Indentation : Column_Number range 0 .. 9 := 0;
- -- This can be set non-zero by using the -gnatg or -gnatyn (n a digit)
- -- switches. If it is non-zero it activates indentation checking with the
- -- indicated indentation value. A value of zero turns off checking. The
- -- requirement is that any new statement, line comment, declaration or
- -- keyword such as END, start on a column that is a multiple of the
- -- indentiation value.
+ -- This can be set non-zero by using the -gnatyn (n a digit) switch. If
+ -- it is non-zero it activates indentation checking with the indicated
+ -- indentation value. A value of zero turns off checking. The requirement
+ -- is that any new statement, line comment, declaration or keyword such
+ -- as END, start on a column that is a multiple of the indentation value.
Style_Check_Keyword_Casing : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyk switches. If it is
- -- True, then keywords are required to be in all lower case. This rule does
- -- not apply to keywords such as digits appearing as an attribute name.
+ -- This can be set True by using the -gnatyk switch. If it is True, then
+ -- keywords are required to be in all lower case. This rule does not apply
+ -- to keywords such as digits appearing as an attribute name.
Style_Check_Layout : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyl switches. If it is
- -- True, it activates checks that constructs are indented as suggested by
- -- the examples in the RM syntax, e.g. that the ELSE keyword must line up
+ -- This can be set True by using the -gnatyl switch. If it is True, it
+ -- activates checks that constructs are indented as suggested by the
+ -- examples in the RM syntax, e.g. that the ELSE keyword must line up
-- with the IF keyword.
Style_Check_Max_Line_Length : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatym/M switches. If
- -- it is True, it activates checking for a maximum line length of
- -- Style_Max_Line_Length characters.
+ -- This can be set True by using the -gnatym/M switches. If it is True, it
+ -- activates checking for a maximum line length of Style_Max_Line_Length
+ -- characters.
Style_Check_Max_Nesting_Level : Boolean := False;
-- This can be set True by using -gnatyLnnn with a value other than zero
-- (a value of zero resets it to False). If True, it activates checking
-- the maximum nesting level against Style_Max_Nesting_Level.
+ Style_Check_Missing_Overriding : Boolean := False;
+ -- This can be set True by using the -gnatyO switch. If it is True, then
+ -- "overriding" is required in subprogram declarations and bodies where
+ -- appropriate. Note that "not overriding" is never required.
+
Style_Check_Mode_In : Boolean := False;
-- This can be set True by using -gnatyI. If True, it activates checking
-- that mode IN is not used on its own (since it is the default).
Style_Check_Order_Subprograms : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyo switch. If it is
- -- True, then names of subprogram bodies must be in alphabetical order
- -- (not taking casing into account).
+ -- This can be set True by using the -gnatyo switch. If it is True, then
+ -- names of subprogram bodies must be in alphabetical order (not taking
+ -- casing into account).
Style_Check_Pragma_Casing : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyp switches. If it is
- -- True, then pragma names must use mixed case.
+ -- This can be set True by using the -gnatyp switch. If it is True, then
+ -- pragma names must use mixed case.
Style_Check_References : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyr switches. If it is
- -- True, then all references to declared identifiers are checked. The
- -- requirement is that casing of the reference be the same as the casing
- -- of the corresponding declaration.
+ -- This can be set True by using the -gnatyr switch. If it is True, then
+ -- all references to declared identifiers are checked. The requirement
+ -- is that casing of the reference be the same as the casing of the
+ -- corresponding declaration.
Style_Check_Separate_Stmt_Lines : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyS switches. If it is
- -- TRUE, then for the case of keywords THEN (not preceded by AND) or ELSE
- -- (not preceded by OR) which introduce a conditionally executed statement
+ -- This can be set True by using the -gnatyS switch. If it is TRUE,
+ -- then for the case of keywords THEN (not preceded by AND) or ELSE (not
+ -- preceded by OR) which introduce a conditionally executed statement
-- sequence, there must be no tokens on the same line as the keyword, so
-- that coverage testing can clearly identify execution of the statement
-- sequence. A comment is permitted, as is THEN ABORT or a PRAGMA keyword
-- after ELSE (a common style to specify the condition for the ELSE).
Style_Check_Specs : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatys switches. If it is
- -- True, then separate specs are required to be present for all procedures
- -- except parameterless library level procedures. The exception means that
- -- typical main programs do not require separate specs.
+ -- This can be set True by using the -gnatys switches. If it is True, then
+ -- separate specs are required to be present for all procedures except
+ -- parameterless library level procedures. The exception means that typical
+ -- main programs do not require separate specs.
Style_Check_Standard : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyn switches. If it is
- -- True, then any references to names in Standard have to be in mixed case
- -- mode (e.g. Integer, Boolean).
+ -- This can be set True by using the -gnatyn switch. If it is True, then
+ -- any references to names in Standard have to be in mixed case mode (e.g.
+ -- Integer, Boolean).
Style_Check_Tokens : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyt switches. If it is
- -- True, then the style check that requires canonical spacing between
- -- various punctuation tokens as follows:
+ -- This can be set True by using the -gnatyt switch. If it is True, then
+ -- the style check that requires canonical spacing between various
+ -- punctuation tokens as follows:
--
-- ABS and NOT must be followed by a space
--
-- for a space.
Style_Check_Xtra_Parens : Boolean := False;
- -- This can be set True by using the -gnatg or -gnatyx switch. If true,
- -- then it is not allowed to enclose entire conditional expressions in
- -- parentheses (C style).
+ -- This can be set True by using the -gnatyx switch. If true, then it is
+ -- not allowed to enclose entire conditional expressions in parentheses
+ -- (C style).
Style_Max_Line_Length : Int := 0;
- -- Value used to check maximum line length. Gets reset as a result of use
- -- of -gnatym or -gnatyMnnn switches (or by use of -gnatg). This value is
- -- only read if Style_Check_Max_Line_Length is True.
+ -- Value used to check maximum line length. Gets reset as a result of
+ -- use of -gnatym or -gnatyMnnn switches. This value is only read if
+ -- Style_Check_Max_Line_Length is True.
Style_Max_Nesting_Level : Int := 0;
-- Value used to check maximum nesting level. Gets reset as a result
-- Subprograms --
-----------------
+ function RM_Column_Check return Boolean;
+ -- Determines whether style checking is active and the RM column check
+ -- mode is set requiring checking of RM format layout.
+
procedure Set_Default_Style_Check_Options;
-- This procedure is called to set the default style checking options in
-- response to a -gnaty switch with no suboptions or from -gnatyy.
procedure Set_Style_Check_Options (Options : String);
-- Like the above procedure, but used when the Options string is known to
- -- be valid. This is for example appopriate for calls where the string ==
- -- was obtained by Save_Style_Check_Options.
+ -- be valid. This is for example appropriate for calls where the string was
+ -- obtained by Save_Style_Check_Options.
procedure Reset_Style_Check_Options;
-- Sets all style check options to off
OSDN Git Service
