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 --                            $Revision: 1.1 $
  10 --                                                                          --
  11 --          Copyright (C) 1992-2000 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  14 -- terms of the  GNU General Public License as published  by the Free Soft- --
  15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  19 -- for  more details.  You should have  received  a copy of the GNU General --
  20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  22 -- MA 02111-1307, USA.                                                      --
  23 --                                                                          --
  24 -- GNAT was originally developed  by the GNAT team at  New York University. --
  25 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  26 --                                                                          --
  27 ------------------------------------------------------------------------------
  28
  29 --  This package collects all the routines used for style checking, as
  30 --  activated by the relevant command line option. These are gathered in
  31 --  a separate package so that they can more easily be customized. Calls
  32 --  to these subprograms are only made if Opt.Style_Check is set True.
  33
  34 with Types; use Types;
  35
  36 package Style is
  37
  38    procedure Body_With_No_Spec (N : Node_Id);
  39    --  Called where N is a subprogram body node for a subprogram body
  40    --  for which no spec was given, i.e. a body acting as its own spec.
  41
  42    procedure Check_Abs_Not;
  43    --  Called after scanning an ABS or NOT operator to check spacing
  44
  45    procedure Check_Arrow;
  46    --  Called after scanning out an arrow to check spacing
  47
  48    procedure Check_Attribute_Name (Reserved : Boolean);
  49    --  The current token is an attribute designator. Check that it is
  50    --  capitalized in an appropriate manner. Reserved is set if the
  51    --  attribute designator is a reserved word (access, digits, delta
  52    --  or range) to allow differing rules for the two cases.
  53
  54    procedure Check_Box;
  55    --  Called after scanning out a box to check spacing
  56
  57    procedure Check_Binary_Operator;
  58    --  Called after scanning out a binary operator other than a plus, minus
  59    --  or exponentiation operator. Intended for checking spacing rules.
  60
  61    procedure Check_Exponentiation_Operator;
  62    --  Called after scanning out an exponentiation operator. Intended for
  63    --  checking spacing rules.
  64
  65    procedure Check_Colon;
  66    --  Called after scanning out colon to check spacing
  67
  68    procedure Check_Colon_Equal;
  69    --  Called after scanning out colon equal to check spacing
  70
  71    procedure Check_Comma;
  72    --  Called after scanning out comma to check spacing
  73
  74    procedure Check_Comment;
  75    --  Called with Scan_Ptr pointing to the first minus sign of a comment.
  76    --  Intended for checking any specific rules for comment placement/format.
  77
  78    procedure Check_Dot_Dot;
  79    --  Called after scanning out dot dot to check spacing
  80
  81    procedure Check_HT;
  82    --  Called with Scan_Ptr pointing to a horizontal tab character
  83
  84    procedure Check_Identifier
  85      (Ref : Node_Or_Entity_Id;
  86       Def : Node_Or_Entity_Id);
  87    --  Check style of identifier occurrence. Ref is an N_Identifier node whose
  88    --  spelling is to be checked against the Chars spelling in identifier node
  89    --  Def (which may be either an N_Identifier, or N_Defining_Identifier node)
  90
  91    procedure Check_Indentation;
  92    --  Called at the start of a new statement or declaration, with Token_Ptr
  93    --  pointing to the first token of the statement or declaration. The check
  94    --  is that the starting column is appropriate to the indentation rules if
  95    --  Token_Ptr is the first token on the line.
  96
  97    procedure Check_Left_Paren;
  98    --  Called after scanning out a left parenthesis to check spacing.
  99
 100    procedure Check_Line_Terminator (Len : Int);
 101    --  Called with Scan_Ptr pointing to the first line terminator terminating
 102    --  the current line, used to check for appropriate line terminator and
 103    --  to check the line length (Len is the length of the current line).
 104    --  Note that the terminator may be the EOF character.
 105
 106    procedure Check_Pragma_Name;
 107    --  The current token is a pragma identifier. Check that it is spelled
 108    --  properly (i.e. with an appropriate casing convention).
 109
 110    procedure Check_Right_Paren;
 111    --  Called after scanning out a right parenthesis to check spacing.
 112
 113    procedure Check_Semicolon;
 114    --  Called after scanning out a semicolon to check spacing
 115
 116    procedure Check_Then (If_Loc : Source_Ptr);
 117    --  Called to check that THEN and IF keywords are appropriately positioned.
 118    --  The parameters show the first characters of the two keywords. This
 119    --  procedure is called only if THEN appears at the start of a line with
 120    --  Token_Ptr pointing to the THEN keyword.
 121
 122    procedure Check_Unary_Plus_Or_Minus;
 123    --  Called after scanning a unary plus or minus to check spacing
 124
 125    procedure Check_Vertical_Bar;
 126    --  Called after scanning a vertical bar to check spacing
 127
 128    procedure No_End_Name (Name : Node_Id);
 129    --  Called if an END is encountered where a name is allowed but not present.
 130    --  The parameter is the node whose name is the name that is permitted in
 131    --  the END line, and the scan pointer is positioned so that if an error
 132    --  message is to be generated in this situation, it should be generated
 133    --  using Error_Msg_SP.
 134
 135    procedure No_Exit_Name (Name : Node_Id);
 136    --  Called when exiting a named loop, but a name is not present on the EXIT.
 137    --  The parameter is the node whose name should have followed EXIT, and the
 138    --  scan pointer is positioned so that if an error message is to be
 139    --  generated, it should be generated using Error_Msg_SP.
 140
 141    procedure Non_Lower_Case_Keyword;
 142    --  Called if a reserved keyword is scanned which is not spelled in all
 143    --  lower case letters. On entry Token_Ptr points to the keyword token.
 144    --  This is not used for keywords appearing as attribute designators,
 145    --  where instead Check_Attribute_Name (True) is called.
 146
 147    function RM_Column_Check return Boolean;
 148    pragma Inline (RM_Column_Check);
 149    --  Determines whether style checking is active and the RM column check
 150    --  mode is set requiring checking of RM format layout.
 151
 152    procedure Subprogram_Not_In_Alpha_Order (Name : Node_Id);
 153    --  Called if Name is the name of a subprogram body in a package body
 154    --  that is not in alphabetical order.
 155
 156 end Style;