gcc/ada/style.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                S T Y L E                                 --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2007, Free Software Foundation, Inc.         --
  10 --                                                                          --
  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.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  This package collects all the routines used for style checking, as
  27 --  activated by the relevant command line option. These are gathered in a
  28 --  separate package so that they can more easily be customized. Calls to
  29 --  these subprograms are only made if Opt.Style_Check is set True.
  30
  31 with Errout;
  32 with Styleg;
  33 with Styleg.C;
  34 with Types;    use Types;
  35
  36 package Style is
  37
  38    package Style_Inst is new Styleg
  39      (Errout.Error_Msg,
  40       Errout.Error_Msg_S,
  41       Errout.Error_Msg_SC,
  42       Errout.Error_Msg_SP);
  43    --  Instantiation of Styleg for all subprograms that do not depend directly
  44    --  depend on the GNAT tree.
  45
  46    package Style_C_Inst is new Style_Inst.C
  47      (Errout.Error_Msg_N);
  48    --  Instantiation of Styleg.C for the subprograms that depend directly
  49    --  on the GNAT tree.
  50
  51    --  All subroutines below are renames of subroutines in the two
  52    --  instantiations above.
  53
  54    procedure Body_With_No_Spec (N : Node_Id)
  55      renames Style_C_Inst.Body_With_No_Spec;
  56    --  Called where N is a subprogram body node for a subprogram body
  57    --  for which no spec was given, i.e. a body acting as its own spec.
  58
  59    procedure Check_Abs_Not
  60      renames Style_Inst.Check_Abs_Not;
  61    --  Called after scanning an ABS or NOT operator to check spacing
  62
  63    procedure Check_Apostrophe
  64      renames Style_Inst.Check_Apostrophe;
  65    --  Called after scanning an apostrophe to check spacing
  66
  67    procedure Check_Array_Attribute_Index
  68      (N  : Node_Id;
  69       E1 : Node_Id;
  70       D  : Int)
  71      renames Style_C_Inst.Check_Array_Attribute_Index;
  72    --  Called for an array attribute specifying an index number. N is the
  73    --  node for the attribute, and E1 is the index expression (Empty if none
  74    --  present). If E1 is present, it is known to be a static integer. D is
  75    --  the number of dimensions of the array.
  76
  77    procedure Check_Arrow
  78      renames Style_Inst.Check_Arrow;
  79    --  Called after scanning out an arrow to check spacing
  80
  81    procedure Check_Attribute_Name (Reserved : Boolean)
  82      renames Style_Inst.Check_Attribute_Name;
  83    --  The current token is an attribute designator. Check that it is
  84    --  capitalized in an appropriate manner. Reserved is set if the attribute
  85    --  designator is a reserved word (access, digits, delta or range) to allow
  86    --  differing rules for the two cases.
  87
  88    procedure Check_Box
  89      renames Style_Inst.Check_Box;
  90    --  Called after scanning out a box to check spacing
  91
  92    procedure Check_Binary_Operator
  93      renames Style_Inst.Check_Binary_Operator;
  94    --  Called after scanning out a binary operator other than a plus, minus
  95    --  or exponentiation operator. Intended for checking spacing rules.
  96
  97    procedure Check_Exponentiation_Operator
  98      renames Style_Inst.Check_Exponentiation_Operator;
  99    --  Called after scanning out an exponentiation operator. Intended for
 100    --  checking spacing rules.
 101
 102    procedure Check_Colon
 103      renames Style_Inst.Check_Colon;
 104    --  Called after scanning out colon to check spacing
 105
 106    procedure Check_Colon_Equal
 107      renames Style_Inst.Check_Colon_Equal;
 108    --  Called after scanning out colon equal to check spacing
 109
 110    procedure Check_Comma
 111      renames Style_Inst.Check_Comma;
 112    --  Called after scanning out comma to check spacing
 113
 114    procedure Check_Comment
 115      renames Style_Inst.Check_Comment;
 116    --  Called with Scan_Ptr pointing to the first minus sign of a comment.
 117    --  Intended for checking any specific rules for comment placement/format.
 118
 119    procedure Check_Dot_Dot
 120      renames Style_Inst.Check_Dot_Dot;
 121    --  Called after scanning out dot dot to check spacing
 122
 123    procedure Check_EOF
 124      renames Style_Inst.Check_EOF;
 125    --  Called after scanning out end of file mark
 126
 127    procedure Check_HT
 128      renames Style_Inst.Check_HT;
 129    --  Called with Scan_Ptr pointing to a horizontal tab character
 130
 131    procedure Check_Identifier
 132      (Ref : Node_Or_Entity_Id;
 133       Def : Node_Or_Entity_Id)
 134      renames Style_C_Inst.Check_Identifier;
 135    --  Check style of identifier occurrence. Ref is an N_Identifier node whose
 136    --  spelling is to be checked against the Chars spelling in identifier node
 137    --  Def (which may be either an N_Identifier, or N_Defining_Identifier node)
 138
 139    procedure Check_Indentation
 140      renames Style_Inst.Check_Indentation;
 141    --  Called at the start of a new statement or declaration, with Token_Ptr
 142    --  pointing to the first token of the statement or declaration. The check
 143    --  is that the starting column is appropriate to the indentation rules if
 144    --  Token_Ptr is the first token on the line.
 145
 146    procedure Check_Left_Paren
 147      renames Style_Inst.Check_Left_Paren;
 148    --  Called after scanning out a left parenthesis to check spacing
 149
 150    procedure Check_Line_Terminator (Len : Int)
 151      renames Style_Inst.Check_Line_Terminator;
 152    --  Called with Scan_Ptr pointing to the first line terminator terminating
 153    --  the current line, used to check for appropriate line terminator and to
 154    --  check the line length (Len is the length of the current line). Note that
 155    --  the terminator may be the EOF character.
 156
 157    procedure Check_Pragma_Name
 158      renames Style_Inst.Check_Pragma_Name;
 159    --  The current token is a pragma identifier. Check that it is spelled
 160    --  properly (i.e. with an appropriate casing convention).
 161
 162    procedure Check_Right_Paren
 163      renames Style_Inst.Check_Right_Paren;
 164    --  Called after scanning out a right parenthesis to check spacing
 165
 166    procedure Check_Semicolon
 167      renames Style_Inst.Check_Semicolon;
 168    --  Called after scanning out a semicolon to check spacing
 169
 170    procedure Check_Then (If_Loc : Source_Ptr)
 171      renames Style_Inst.Check_Then;
 172    --  Called to check that THEN and IF keywords are appropriately positioned.
 173    --  The parameters show the first characters of the two keywords. This
 174    --  procedure is called only if THEN appears at the start of a line with
 175    --  Token_Ptr pointing to the THEN keyword.
 176
 177    procedure Check_Unary_Plus_Or_Minus
 178      renames Style_Inst.Check_Unary_Plus_Or_Minus;
 179    --  Called after scanning a unary plus or minus to check spacing
 180
 181    procedure Check_Vertical_Bar
 182      renames Style_Inst.Check_Vertical_Bar;
 183    --  Called after scanning a vertical bar to check spacing
 184
 185    procedure Check_Xtra_Parens (Loc : Source_Ptr)
 186      renames Style_Inst.Check_Xtra_Parens;
 187    --  Called after scanning a conditional expression that has at least one
 188    --  level of parentheses around the entire expression.
 189
 190    function Mode_In_Check return Boolean
 191      renames Style_Inst.Mode_In_Check;
 192    --  Determines whether style checking is active and the Mode_In_Check is
 193    --  set, forbidding the explicit use of mode IN.
 194
 195    procedure No_End_Name (Name : Node_Id)
 196      renames Style_Inst.No_End_Name;
 197    --  Called if an END is encountered where a name is allowed but not present.
 198    --  The parameter is the node whose name is the name that is permitted in
 199    --  the END line, and the scan pointer is positioned so that if an error
 200    --  message is to be generated in this situation, it should be generated
 201    --  using Error_Msg_SP.
 202
 203    procedure No_Exit_Name (Name : Node_Id)
 204      renames Style_Inst.No_Exit_Name;
 205    --  Called when exiting a named loop, but a name is not present on the EXIT.
 206    --  The parameter is the node whose name should have followed EXIT, and the
 207    --  scan pointer is positioned so that if an error message is to be
 208    --  generated, it should be generated using Error_Msg_SP.
 209
 210    procedure Non_Lower_Case_Keyword
 211      renames Style_Inst.Non_Lower_Case_Keyword;
 212    --  Called if a reserved keyword is scanned which is not spelled in all
 213    --  lower case letters. On entry Token_Ptr points to the keyword token.
 214    --  This is not used for keywords appearing as attribute designators,
 215    --  where instead Check_Attribute_Name (True) is called.
 216
 217    function RM_Column_Check return Boolean
 218      renames Style_Inst.RM_Column_Check;
 219    --  Determines whether style checking is active and the RM column check
 220    --  mode is set requiring checking of RM format layout.
 221
 222    procedure Subprogram_Not_In_Alpha_Order (Name : Node_Id)
 223      renames Style_C_Inst.Subprogram_Not_In_Alpha_Order;
 224    --  Called if Name is the name of a subprogram body in a package body
 225    --  that is not in alphabetical order.
 226
 227 end Style;