1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                              S T Y L E G                                 --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 1992-2012, 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 generic package collects the routines used for style checking, as
27--  activated by the relevant command line option. These are gathered in
28--  a separate package so that they can more easily be customized. Calls
29--  to these subprograms are only made if Opt.Style_Check is set True.
30--  Styleg does not depends on the GNAT tree (Atree, Sinfo, ...).
31
32with Types; use Types;
33
34generic
35   with procedure Error_Msg (Msg : String; Flag_Location : Source_Ptr);
36   --  Output a message at specified location
37
38   with procedure Error_Msg_S (Msg : String);
39   --  Output a message at current scan pointer location
40
41   with procedure Error_Msg_SC (Msg : String);
42   --  Output a message at the start of the current token
43
44   with procedure Error_Msg_SP (Msg : String);
45   --  Output a message at the start of the previous token
46
47package Styleg is
48
49   procedure Check_Abs_Not;
50   --  Called after scanning an ABS or NOT operator to check spacing
51
52   procedure Check_Apostrophe;
53   --  Called after scanning an apostrophe to check spacing
54
55   procedure Check_Arrow;
56   --  Called after scanning out an arrow to check spacing
57
58   procedure Check_Attribute_Name (Reserved : Boolean);
59   --  The current token is an attribute designator. Check that it
60   --  is capitalized in an appropriate manner. Reserved is set if
61   --  the attribute designator is a reserved word (access, digits,
62   --  delta or range) to allow differing rules for the two cases.
63
64   procedure Check_Boolean_Operator (Node : Node_Id);
65   --  Node is a node for an AND or OR operator. Check that the usage meets
66   --  the style rules.
67
68   procedure Check_Box;
69   --  Called after scanning out a box to check spacing
70
71   procedure Check_Binary_Operator;
72   --  Called after scanning out a binary operator other than a plus, minus
73   --  or exponentiation operator. Intended for checking spacing rules.
74
75   procedure Check_Exponentiation_Operator;
76   --  Called after scanning out an exponentiation operator. Intended for
77   --  checking spacing rules.
78
79   procedure Check_Colon;
80   --  Called after scanning out colon to check spacing
81
82   procedure Check_Colon_Equal;
83   --  Called after scanning out colon equal to check spacing
84
85   procedure Check_Comma;
86   --  Called after scanning out comma to check spacing
87
88   procedure Check_Comment;
89   --  Called with Scan_Ptr pointing to the first minus sign of a comment.
90   --  Intended for checking any specific rules for comment placement/format.
91
92   procedure Check_Dot_Dot;
93   --  Called after scanning out dot dot to check spacing
94
95   procedure Check_EOF;
96   --  Called after scanning out EOF mark
97
98   procedure Check_HT;
99   --  Called with Scan_Ptr pointing to a horizontal tab character
100
101   procedure Check_Indentation;
102   --  Called at the start of a new statement or declaration, with Token_Ptr
103   --  pointing to the first token of the statement or declaration. The check
104   --  is that the starting column is appropriate to the indentation rules if
105   --  Token_Ptr is the first token on the line.
106
107   procedure Check_Left_Paren;
108   --  Called after scanning out a left parenthesis to check spacing
109
110   procedure Check_Line_Max_Length (Len : Int);
111   --  Called with Scan_Ptr pointing to the first line terminator character
112   --  terminating the current line. Used to check for appropriate line length.
113   --  The parameter Len is the length of the current line.
114
115   procedure Check_Line_Terminator (Len : Int);
116   --  Called with Scan_Ptr pointing to the first line terminator terminating
117   --  the current line, used to check for appropriate line terminator usage.
118   --  The parameter Len is the length of the current line.
119
120   procedure Check_Not_In;
121   --  Called with Scan_Ptr pointing to an IN token, and Prev_Token_Ptr
122   --  pointing to a NOT token. Used to check proper layout of NOT IN.
123
124   procedure Check_Pragma_Name;
125   --  The current token is a pragma identifier. Check that it is spelled
126   --  properly (i.e. with an appropriate casing convention).
127
128   procedure Check_Right_Paren;
129   --  Called after scanning out a right parenthesis to check spacing
130
131   procedure Check_Semicolon;
132   --  Called after scanning out a semicolon to check spacing
133
134   procedure Check_Then (If_Loc : Source_Ptr);
135   --  Called to check that THEN and IF keywords are appropriately positioned.
136   --  The parameters show the first characters of the two keywords. This
137   --  procedure is called only if THEN appears at the start of a line with
138   --  Token_Ptr pointing to the THEN keyword.
139
140   procedure Check_Separate_Stmt_Lines;
141   pragma Inline (Check_Separate_Stmt_Lines);
142   --  Called after scanning THEN (not preceded by AND) or ELSE (not preceded
143   --  by OR). Used to check that no tokens follow on the same line (which
144   --  would interfere with coverage testing). Handles case of THEN ABORT as
145   --  an exception, as well as PRAGMA after ELSE.
146
147   procedure Check_Unary_Plus_Or_Minus;
148   --  Called after scanning a unary plus or minus to check spacing
149
150   procedure Check_Vertical_Bar;
151   --  Called after scanning a vertical bar to check spacing
152
153   procedure Check_Xtra_Parens (Loc : Source_Ptr);
154   --  Called after scanning an if, case, or quantified expression that has at
155   --  least one level of parentheses around the entire expression.
156
157   function Mode_In_Check return Boolean;
158   pragma Inline (Mode_In_Check);
159   --  Determines whether style checking is active and the Mode_In_Check is
160   --  set, forbidding the explicit use of mode IN.
161
162   procedure No_End_Name (Name : Node_Id);
163   --  Called if an END is encountered where a name is allowed but not present.
164   --  The parameter is the node whose name is the name that is permitted in
165   --  the END line, and the scan pointer is positioned so that if an error
166   --  message is to be generated in this situation, it should be generated
167   --  using Error_Msg_SP.
168
169   procedure No_Exit_Name (Name : Node_Id);
170   --  Called when exiting a named loop, but a name is not present on the EXIT.
171   --  The parameter is the node whose name should have followed EXIT, and the
172   --  scan pointer is positioned so that if an error message is to be
173   --  generated, it should be generated using Error_Msg_SP.
174
175   procedure Non_Lower_Case_Keyword;
176   --  Called if a reserved keyword is scanned which is not spelled in all
177   --  lower case letters. On entry Token_Ptr points to the keyword token.
178   --  This is not used for keywords appearing as attribute designators,
179   --  where instead Check_Attribute_Name (True) is called.
180
181end Styleg;
182