1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2008, 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 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. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree; use Atree;
27 with Csets; use Csets;
28 with Hostparm; use Hostparm;
29 with Namet; use Namet;
31 with Output; use Output;
32 with Restrict; use Restrict;
33 with Rident; use Rident;
34 with Scans; use Scans;
35 with Sinfo; use Sinfo;
36 with Sinput; use Sinput;
37 with Uintp; use Uintp;
39 with GNAT.Byte_Order_Mark; use GNAT.Byte_Order_Mark;
41 with System.WCh_Con; use System.WCh_Con;
47 Obsolescent_Check_Flag : Boolean := True;
48 -- Obsolescent check activation. Set to False during integrated
51 Used_As_Identifier : array (Token_Type) of Boolean;
52 -- Flags set True if a given keyword is used as an identifier (used to
53 -- make sure that we only post an error message for incorrect use of a
54 -- keyword as an identifier once for a given keyword).
56 procedure Check_End_Of_Line;
57 -- Called when end of line encountered. Checks that line is not too long,
58 -- and that other style checks for the end of line are met.
60 function Determine_License return License_Type;
61 -- Scan header of file and check that it has an appropriate GNAT-style
62 -- header with a proper license statement. Returns GPL, Unrestricted,
63 -- or Modified_GPL depending on header. If none of these, returns Unknown.
65 procedure Error_Long_Line;
66 -- Signal error of excessively long line
68 -----------------------
69 -- Check_End_Of_Line --
70 -----------------------
72 procedure Check_End_Of_Line is
73 Len : constant Int := Int (Scan_Ptr) - Int (Current_Line_Start);
76 Style.Check_Line_Terminator (Len);
77 elsif Len > Max_Line_Length then
80 end Check_End_Of_Line;
82 -----------------------
83 -- Determine_License --
84 -----------------------
86 function Determine_License return License_Type is
87 GPL_Found : Boolean := False;
88 Result : License_Type;
90 function Contains (S : String) return Boolean;
91 -- See if current comment contains successive non-blank characters
92 -- matching the contents of S. If so leave Scan_Ptr unchanged and
93 -- return True, otherwise leave Scan_Ptr unchanged and return False.
96 -- Skip to line terminator character
102 function Contains (S : String) return Boolean is
108 -- Loop to check characters. This loop is terminated by end of
109 -- line, and also we need to check for the EOF case, to take
110 -- care of files containing only comments.
113 while Source (SP) /= CR and then
114 Source (SP) /= LF and then
117 if Source (SP) = S (S'First) then
129 while Source (SS) = ' ' loop
133 exit when Source (SS) /= S (CP);
147 procedure Skip_EOL is
149 while Source (Scan_Ptr) /= CR
150 and then Source (Scan_Ptr) /= LF
151 and then Source (Scan_Ptr) /= EOF
153 Scan_Ptr := Scan_Ptr + 1;
157 -- Start of processing for Determine_License
161 if Source (Scan_Ptr) /= '-'
162 or else Source (Scan_Ptr + 1) /= '-'
172 elsif Contains ("Asaspecialexception") then
174 Result := Modified_GPL;
178 elsif Contains ("GNUGeneralPublicLicense") then
183 ("ThisspecificationisadaptedfromtheAdaSemanticInterface")
186 ("ThisspecificationisderivedfromtheAdaReferenceManual")
188 Result := Unrestricted;
196 if Source (Scan_Ptr) /= EOF then
198 -- We have to take into account a degenerate case when the source
199 -- file contains only comments and no Ada code.
205 Skip_Line_Terminators (Scan_Ptr, Physical);
207 -- If we are at start of physical line, update scan pointers
208 -- to reflect the start of the new line.
211 Current_Line_Start := Scan_Ptr;
212 Start_Column := Scanner.Set_Start_Column;
213 First_Non_Blank_Location := Scan_Ptr;
220 end Determine_License;
222 ----------------------------
223 -- Determine_Token_Casing --
224 ----------------------------
226 function Determine_Token_Casing return Casing_Type is
228 return Scanner.Determine_Token_Casing;
229 end Determine_Token_Casing;
231 ---------------------
232 -- Error_Long_Line --
233 ---------------------
235 procedure Error_Long_Line is
238 ("this line is too long",
239 Current_Line_Start + Source_Ptr (Max_Line_Length));
242 ------------------------
243 -- Initialize_Scanner --
244 ------------------------
246 procedure Initialize_Scanner
247 (Unit : Unit_Number_Type;
248 Index : Source_File_Index)
250 GNAT_Hedr : constant Text_Buffer (1 .. 78) := (others => '-');
253 Scanner.Initialize_Scanner (Index);
255 if Index /= Internal_Source_File then
256 Set_Unit (Index, Unit);
259 Current_Source_Unit := Unit;
261 -- Set default for Comes_From_Source (except if we are going to process
262 -- an artificial string internally created within the compiler and
263 -- placed into internal source duffer). All nodes built now until we
264 -- reenter the analyzer will have Comes_From_Source set to True
266 if Index /= Internal_Source_File then
267 Set_Comes_From_Source_Default (True);
270 -- Check license if GNAT type header possibly present
272 if Source_Last (Index) - Scan_Ptr > 80
273 and then Source (Scan_Ptr .. Scan_Ptr + 77) = GNAT_Hedr
275 Set_License (Current_Source_File, Determine_License);
283 Tst : String (1 .. 5);
287 Tst (J) := Source (Scan_Ptr + Source_Ptr (J) - 1);
290 Read_BOM (Tst, Len, BOM, False);
294 Scan_Ptr := Scan_Ptr + Source_Ptr (Len);
295 Wide_Character_Encoding_Method := WCEM_UTF8;
296 Upper_Half_Encoding := True;
298 when UTF16_LE | UTF16_BE =>
300 Write_Line ("UTF-16 encoding format not recognized");
302 raise Unrecoverable_Error;
304 when UTF32_LE | UTF32_BE =>
306 Write_Line ("UTF-32 encoding format not recognized");
308 raise Unrecoverable_Error;
318 -- Because of the License stuff above, Scng.Initialize_Scanner cannot
319 -- call Scan. Scan initial token (note this initializes Prev_Token,
322 -- There are two reasons not to do the Scan step in case if we
323 -- initialize the scanner for the internal source buffer:
325 -- - The artificial string may not be created by the compiler in this
326 -- buffer when we call Initialize_Scanner
328 -- - For these artificial strings a special way of scanning is used, so
329 -- the standard step of the scanner may just break the algorithm of
330 -- processing these strings.
332 if Index /= Internal_Source_File then
336 -- Clear flags for reserved words used as identifiers
338 for J in Token_Type loop
339 Used_As_Identifier (J) := False;
341 end Initialize_Scanner;
343 -----------------------
344 -- Obsolescent_Check --
345 -----------------------
347 procedure Obsolescent_Check (S : Source_Ptr) is
349 if Obsolescent_Check_Flag then
350 -- This is a pain in the neck case, since we normally need a node to
351 -- call Check_Restrictions, and all we have is a source pointer. The
352 -- easiest thing is to construct a dummy node. A bit kludgy, but this
353 -- is a marginal case. It's not worth trying to do things more
356 Check_Restriction (No_Obsolescent_Features, New_Node (N_Empty, S));
358 end Obsolescent_Check;
364 procedure Post_Scan is
367 when Tok_Char_Literal =>
368 Token_Node := New_Node (N_Character_Literal, Token_Ptr);
369 Set_Char_Literal_Value (Token_Node, UI_From_CC (Character_Code));
370 Set_Chars (Token_Node, Token_Name);
372 when Tok_Identifier =>
373 Token_Node := New_Node (N_Identifier, Token_Ptr);
374 Set_Chars (Token_Node, Token_Name);
376 when Tok_Real_Literal =>
377 Token_Node := New_Node (N_Real_Literal, Token_Ptr);
378 Set_Realval (Token_Node, Real_Literal_Value);
380 when Tok_Integer_Literal =>
381 Token_Node := New_Node (N_Integer_Literal, Token_Ptr);
382 Set_Intval (Token_Node, Int_Literal_Value);
384 when Tok_String_Literal =>
385 Token_Node := New_Node (N_String_Literal, Token_Ptr);
386 Set_Has_Wide_Character (Token_Node, Wide_Character_Found);
387 Set_Strval (Token_Node, String_Literal_Id);
389 when Tok_Operator_Symbol =>
390 Token_Node := New_Node (N_Operator_Symbol, Token_Ptr);
391 Set_Chars (Token_Node, Token_Name);
392 Set_Strval (Token_Node, String_Literal_Id);
399 ------------------------------
400 -- Scan_Reserved_Identifier --
401 ------------------------------
403 procedure Scan_Reserved_Identifier (Force_Msg : Boolean) is
404 Token_Chars : constant String := Token_Type'Image (Token);
407 -- We have in Token_Chars the image of the Token name, i.e. Tok_xxx.
408 -- This code extracts the xxx and makes an identifier out of it.
412 for J in 5 .. Token_Chars'Length loop
413 Name_Len := Name_Len + 1;
414 Name_Buffer (Name_Len) := Fold_Lower (Token_Chars (J));
417 Token_Name := Name_Find;
419 if not Used_As_Identifier (Token) or else Force_Msg then
420 Error_Msg_Name_1 := Token_Name;
421 Error_Msg_SC ("reserved word* cannot be used as identifier!");
422 Used_As_Identifier (Token) := True;
425 Token := Tok_Identifier;
426 Token_Node := New_Node (N_Identifier, Token_Ptr);
427 Set_Chars (Token_Node, Token_Name);
428 end Scan_Reserved_Identifier;
430 ---------------------------
431 -- Set_Obsolescent_Check --
432 ---------------------------
434 procedure Set_Obsolescent_Check (Value : Boolean) is
436 Obsolescent_Check_Flag := Value;
437 end Set_Obsolescent_Check;