1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2005 Free Software Foundation, Inc. --
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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 with Atree; use Atree;
28 with Csets; use Csets;
29 with Namet; use Namet;
31 with Restrict; use Restrict;
32 with Rident; use Rident;
33 with Scans; use Scans;
34 with Sinfo; use Sinfo;
35 with Sinput; use Sinput;
36 with Uintp; use Uintp;
42 Used_As_Identifier : array (Token_Type) of Boolean;
43 -- Flags set True if a given keyword is used as an identifier (used to
44 -- make sure that we only post an error message for incorrect use of a
45 -- keyword as an identifier once for a given keyword).
47 procedure Check_End_Of_Line;
48 -- Called when end of line encountered. Checks that line is not too long,
49 -- and that other style checks for the end of line are met.
51 function Determine_License return License_Type;
52 -- Scan header of file and check that it has an appropriate GNAT-style
53 -- header with a proper license statement. Returns GPL, Unrestricted,
54 -- or Modified_GPL depending on header. If none of these, returns Unknown.
56 procedure Error_Long_Line;
57 -- Signal error of excessively long line
63 procedure Post_Scan is
66 when Tok_Char_Literal =>
67 Token_Node := New_Node (N_Character_Literal, Token_Ptr);
68 Set_Char_Literal_Value (Token_Node, UI_From_CC (Character_Code));
69 Set_Chars (Token_Node, Token_Name);
71 when Tok_Identifier =>
72 Token_Node := New_Node (N_Identifier, Token_Ptr);
73 Set_Chars (Token_Node, Token_Name);
75 when Tok_Real_Literal =>
76 Token_Node := New_Node (N_Real_Literal, Token_Ptr);
77 Set_Realval (Token_Node, Real_Literal_Value);
79 when Tok_Integer_Literal =>
80 Token_Node := New_Node (N_Integer_Literal, Token_Ptr);
81 Set_Intval (Token_Node, Int_Literal_Value);
83 when Tok_String_Literal =>
84 Token_Node := New_Node (N_String_Literal, Token_Ptr);
85 Set_Has_Wide_Character (Token_Node, Wide_Character_Found);
86 Set_Strval (Token_Node, String_Literal_Id);
88 when Tok_Operator_Symbol =>
89 Token_Node := New_Node (N_Operator_Symbol, Token_Ptr);
90 Set_Chars (Token_Node, Token_Name);
91 Set_Strval (Token_Node, String_Literal_Id);
98 -----------------------
99 -- Check_End_Of_Line --
100 -----------------------
102 procedure Check_End_Of_Line is
103 Len : constant Int := Int (Scan_Ptr) - Int (Current_Line_Start);
106 Style.Check_Line_Terminator (Len);
107 elsif Len > Opt.Max_Line_Length then
110 end Check_End_Of_Line;
112 -----------------------
113 -- Determine_License --
114 -----------------------
116 function Determine_License return License_Type is
117 GPL_Found : Boolean := False;
118 Result : License_Type;
120 function Contains (S : String) return Boolean;
121 -- See if current comment contains successive non-blank characters
122 -- matching the contents of S. If so leave Scan_Ptr unchanged and
123 -- return True, otherwise leave Scan_Ptr unchanged and return False.
126 -- Skip to line terminator character
132 function Contains (S : String) return Boolean is
138 -- Loop to check characters. This loop is terminated by end of
139 -- line, and also we need to check for the EOF case, to take
140 -- care of files containing only comments.
143 while Source (SP) /= CR and then
144 Source (SP) /= LF and then
147 if Source (SP) = S (S'First) then
159 while Source (SS) = ' ' loop
163 exit when Source (SS) /= S (CP);
177 procedure Skip_EOL is
179 while Source (Scan_Ptr) /= CR
180 and then Source (Scan_Ptr) /= LF
181 and then Source (Scan_Ptr) /= EOF
183 Scan_Ptr := Scan_Ptr + 1;
187 -- Start of processing for Determine_License
191 if Source (Scan_Ptr) /= '-'
192 or else Source (Scan_Ptr + 1) /= '-'
202 elsif Contains ("Asaspecialexception") then
204 Result := Modified_GPL;
208 elsif Contains ("GNUGeneralPublicLicense") then
213 ("ThisspecificationisadaptedfromtheAdaSemanticInterface")
216 ("ThisspecificationisderivedfromtheAdaReferenceManual")
218 Result := Unrestricted;
226 if Source (Scan_Ptr) /= EOF then
228 -- We have to take into account a degenerate case when the source
229 -- file contains only comments and no Ada code.
235 Skip_Line_Terminators (Scan_Ptr, Physical);
237 -- If we are at start of physical line, update scan pointers
238 -- to reflect the start of the new line.
241 Current_Line_Start := Scan_Ptr;
242 Start_Column := Scanner.Set_Start_Column;
243 First_Non_Blank_Location := Scan_Ptr;
250 end Determine_License;
252 ----------------------------
253 -- Determine_Token_Casing --
254 ----------------------------
256 function Determine_Token_Casing return Casing_Type is
258 return Scanner.Determine_Token_Casing;
259 end Determine_Token_Casing;
261 ---------------------
262 -- Error_Long_Line --
263 ---------------------
265 procedure Error_Long_Line is
268 ("this line is too long",
269 Current_Line_Start + Source_Ptr (Opt.Max_Line_Length));
272 ------------------------
273 -- Initialize_Scanner --
274 ------------------------
276 procedure Initialize_Scanner
277 (Unit : Unit_Number_Type;
278 Index : Source_File_Index)
280 GNAT_Hedr : constant Text_Buffer (1 .. 78) := (others => '-');
283 Scanner.Initialize_Scanner (Unit, Index);
285 -- Set default for Comes_From_Source (except if we are going to process
286 -- an artificial string internally created within the compiler and
287 -- placed into internal source duffer). All nodes built now until we
288 -- reenter the analyzer will have Comes_From_Source set to True
290 if Index /= Internal_Source_File then
291 Set_Comes_From_Source_Default (True);
294 -- Check license if GNAT type header possibly present
296 if Source_Last (Index) - Scan_Ptr > 80
297 and then Source (Scan_Ptr .. Scan_Ptr + 77) = GNAT_Hedr
299 Set_License (Current_Source_File, Determine_License);
302 -- Because of the License stuff above, Scng.Initialize_Scanner cannot
303 -- call Scan. Scan initial token (note this initializes Prev_Token,
306 -- There are two reasons not to do the Scan step in case if we
307 -- initialize the scanner for the internal source buffer:
309 -- - The artificial string may not be created by the compiler in this
310 -- buffer when we call Initialize_Scanner
312 -- - For these artificial strings a special way of scanning is used, so
313 -- the standard step of the scanner may just break the algorithm of
314 -- processing these strings.
316 if Index /= Internal_Source_File then
320 -- Clear flags for reserved words used as indentifiers
322 for J in Token_Type loop
323 Used_As_Identifier (J) := False;
325 end Initialize_Scanner;
327 -----------------------
328 -- Obsolescent_Check --
329 -----------------------
331 procedure Obsolescent_Check (S : Source_Ptr) is
333 -- This is a pain in the neck case, since we normally need a node to
334 -- call Check_Restrictions, and all we have is a source pointer. The
335 -- easiest thing is to construct a dummy node. A bit kludgy, but this
336 -- is a marginal case. It's not worth trying to do things more cleanly.
338 Check_Restriction (No_Obsolescent_Features, New_Node (N_Empty, S));
339 end Obsolescent_Check;
341 ------------------------------
342 -- Scan_Reserved_Identifier --
343 ------------------------------
345 procedure Scan_Reserved_Identifier (Force_Msg : Boolean) is
346 Token_Chars : constant String := Token_Type'Image (Token);
349 -- We have in Token_Chars the image of the Token name, i.e. Tok_xxx.
350 -- This code extracts the xxx and makes an identifier out of it.
354 for J in 5 .. Token_Chars'Length loop
355 Name_Len := Name_Len + 1;
356 Name_Buffer (Name_Len) := Fold_Lower (Token_Chars (J));
359 Token_Name := Name_Find;
361 if not Used_As_Identifier (Token) or else Force_Msg then
362 Error_Msg_Name_1 := Token_Name;
363 Error_Msg_SC ("reserved word* cannot be used as identifier!");
364 Used_As_Identifier (Token) := True;
367 Token := Tok_Identifier;
368 Token_Node := New_Node (N_Identifier, Token_Ptr);
369 Set_Chars (Token_Node, Token_Name);
370 end Scan_Reserved_Identifier;