OSDN Git Service

2009-07-20 Bob Duff <duff@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / stylesw.ads
index 5822ce9..37154c0 100644 (file)
@@ -6,7 +6,7 @@
 --                                                                          --
 --                                 S p e c                                  --
 --                                                                          --
---          Copyright (C) 1992-2008, Free Software Foundation, Inc.         --
+--          Copyright (C) 1992-2009, 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- --
@@ -48,28 +48,28 @@ package Stylesw is
    --  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_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.
@@ -96,27 +96,26 @@ package Stylesw is
    --  comments where only a single space separates the comment characters.
 
    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,
@@ -137,28 +136,27 @@ package Stylesw is
    --  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
-   --  indentation 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
@@ -175,44 +173,44 @@ package Stylesw is
    --  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
    --
@@ -254,14 +252,14 @@ package Stylesw is
    --  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