gcc/ada/scn.adb

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                                  S C N                                   --
   6 --                                                                          --
   7 --                                 B o d y                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2006, 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 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,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, USA.                                              --
  21 --                                                                          --
  22 -- GNAT was originally developed  by the GNAT team at  New York University. --
  23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  24 --                                                                          --
  25 ------------------------------------------------------------------------------
  26
  27 with Atree;    use Atree;
  28 with Csets;    use Csets;
  29 with Hostparm; use Hostparm;
  30 with Namet;    use Namet;
  31 with Opt;      use Opt;
  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;
  38
  39 package body Scn is
  40
  41    use ASCII;
  42
  43    Used_As_Identifier : array (Token_Type) of Boolean;
  44    --  Flags set True if a given keyword is used as an identifier (used to
  45    --  make sure that we only post an error message for incorrect use of a
  46    --  keyword as an identifier once for a given keyword).
  47
  48    procedure Check_End_Of_Line;
  49    --  Called when end of line encountered. Checks that line is not too long,
  50    --  and that other style checks for the end of line are met.
  51
  52    function Determine_License return License_Type;
  53    --  Scan header of file and check that it has an appropriate GNAT-style
  54    --  header with a proper license statement. Returns GPL, Unrestricted,
  55    --  or Modified_GPL depending on header. If none of these, returns Unknown.
  56
  57    procedure Error_Long_Line;
  58    --  Signal error of excessively long line
  59
  60    ---------------
  61    -- Post_Scan --
  62    ---------------
  63
  64    procedure Post_Scan is
  65    begin
  66       case Token is
  67          when Tok_Char_Literal =>
  68             Token_Node := New_Node (N_Character_Literal, Token_Ptr);
  69             Set_Char_Literal_Value (Token_Node, UI_From_CC (Character_Code));
  70             Set_Chars (Token_Node, Token_Name);
  71
  72          when Tok_Identifier =>
  73             Token_Node := New_Node (N_Identifier, Token_Ptr);
  74             Set_Chars (Token_Node, Token_Name);
  75
  76          when Tok_Real_Literal =>
  77             Token_Node := New_Node (N_Real_Literal, Token_Ptr);
  78             Set_Realval (Token_Node, Real_Literal_Value);
  79
  80          when Tok_Integer_Literal =>
  81             Token_Node := New_Node (N_Integer_Literal, Token_Ptr);
  82             Set_Intval (Token_Node, Int_Literal_Value);
  83
  84          when Tok_String_Literal =>
  85             Token_Node := New_Node (N_String_Literal, Token_Ptr);
  86             Set_Has_Wide_Character (Token_Node, Wide_Character_Found);
  87             Set_Strval (Token_Node, String_Literal_Id);
  88
  89          when Tok_Operator_Symbol =>
  90             Token_Node := New_Node (N_Operator_Symbol, Token_Ptr);
  91             Set_Chars (Token_Node, Token_Name);
  92             Set_Strval (Token_Node, String_Literal_Id);
  93
  94          when others =>
  95             null;
  96       end case;
  97    end Post_Scan;
  98
  99    -----------------------
 100    -- Check_End_Of_Line --
 101    -----------------------
 102
 103    procedure Check_End_Of_Line is
 104       Len : constant Int := Int (Scan_Ptr) - Int (Current_Line_Start);
 105    begin
 106       if Style_Check then
 107          Style.Check_Line_Terminator (Len);
 108       elsif Len > Max_Line_Length then
 109          Error_Long_Line;
 110       end if;
 111    end Check_End_Of_Line;
 112
 113    -----------------------
 114    -- Determine_License --
 115    -----------------------
 116
 117    function Determine_License return License_Type is
 118       GPL_Found : Boolean := False;
 119       Result    : License_Type;
 120
 121       function Contains (S : String) return Boolean;
 122       --  See if current comment contains successive non-blank characters
 123       --  matching the contents of S. If so leave Scan_Ptr unchanged and
 124       --  return True, otherwise leave Scan_Ptr unchanged and return False.
 125
 126       procedure Skip_EOL;
 127       --  Skip to line terminator character
 128
 129       --------------
 130       -- Contains --
 131       --------------
 132
 133       function Contains (S : String) return Boolean is
 134          CP : Natural;
 135          SP : Source_Ptr;
 136          SS : Source_Ptr;
 137
 138       begin
 139          --  Loop to check characters. This loop is terminated by end of
 140          --  line, and also we need to check for the EOF case, to take
 141          --  care of files containing only comments.
 142
 143          SP := Scan_Ptr;
 144          while Source (SP) /= CR and then
 145                Source (SP) /= LF and then
 146                Source (SP) /= EOF
 147          loop
 148             if Source (SP) = S (S'First) then
 149                SS := SP;
 150                CP := S'First;
 151
 152                loop
 153                   SS := SS + 1;
 154                   CP := CP + 1;
 155
 156                   if CP > S'Last then
 157                      return True;
 158                   end if;
 159
 160                   while Source (SS) = ' ' loop
 161                      SS := SS + 1;
 162                   end loop;
 163
 164                   exit when Source (SS) /= S (CP);
 165                end loop;
 166             end if;
 167
 168             SP := SP + 1;
 169          end loop;
 170
 171          return False;
 172       end Contains;
 173
 174       --------------
 175       -- Skip_EOL --
 176       --------------
 177
 178       procedure Skip_EOL is
 179       begin
 180          while Source (Scan_Ptr) /= CR
 181            and then Source (Scan_Ptr) /= LF
 182            and then Source (Scan_Ptr) /= EOF
 183          loop
 184             Scan_Ptr := Scan_Ptr + 1;
 185          end loop;
 186       end Skip_EOL;
 187
 188    --  Start of processing for Determine_License
 189
 190    begin
 191       loop
 192          if Source (Scan_Ptr) /= '-'
 193            or else Source (Scan_Ptr + 1) /= '-'
 194          then
 195             if GPL_Found then
 196                Result := GPL;
 197                exit;
 198             else
 199                Result := Unknown;
 200                exit;
 201             end if;
 202
 203          elsif Contains ("Asaspecialexception") then
 204             if GPL_Found then
 205                Result := Modified_GPL;
 206                exit;
 207             end if;
 208
 209          elsif Contains ("GNUGeneralPublicLicense") then
 210             GPL_Found := True;
 211
 212          elsif
 213              Contains
 214                ("ThisspecificationisadaptedfromtheAdaSemanticInterface")
 215            or else
 216              Contains
 217               ("ThisspecificationisderivedfromtheAdaReferenceManual")
 218          then
 219             Result := Unrestricted;
 220             exit;
 221          end if;
 222
 223          Skip_EOL;
 224
 225          Check_End_Of_Line;
 226
 227          if Source (Scan_Ptr) /= EOF then
 228
 229             --  We have to take into account a degenerate case when the source
 230             --  file contains only comments and no Ada code.
 231
 232             declare
 233                Physical : Boolean;
 234
 235             begin
 236                Skip_Line_Terminators (Scan_Ptr, Physical);
 237
 238                --  If we are at start of physical line, update scan pointers
 239                --  to reflect the start of the new line.
 240
 241                if Physical then
 242                   Current_Line_Start       := Scan_Ptr;
 243                   Start_Column             := Scanner.Set_Start_Column;
 244                   First_Non_Blank_Location := Scan_Ptr;
 245                end if;
 246             end;
 247          end if;
 248       end loop;
 249
 250       return Result;
 251    end Determine_License;
 252
 253    ----------------------------
 254    -- Determine_Token_Casing --
 255    ----------------------------
 256
 257    function Determine_Token_Casing return Casing_Type is
 258    begin
 259       return Scanner.Determine_Token_Casing;
 260    end Determine_Token_Casing;
 261
 262    ---------------------
 263    -- Error_Long_Line --
 264    ---------------------
 265
 266    procedure Error_Long_Line is
 267    begin
 268       Error_Msg
 269         ("this line is too long",
 270          Current_Line_Start + Source_Ptr (Max_Line_Length));
 271    end Error_Long_Line;
 272
 273    ------------------------
 274    -- Initialize_Scanner --
 275    ------------------------
 276
 277    procedure Initialize_Scanner
 278      (Unit  : Unit_Number_Type;
 279       Index : Source_File_Index)
 280    is
 281       GNAT_Hedr : constant Text_Buffer (1 .. 78) := (others => '-');
 282
 283    begin
 284       Scanner.Initialize_Scanner (Index);
 285
 286       if Index /= Internal_Source_File then
 287          Set_Unit (Index, Unit);
 288       end if;
 289
 290       Current_Source_Unit := Unit;
 291
 292       --  Set default for Comes_From_Source (except if we are going to process
 293       --  an artificial string internally created within the compiler and
 294       --  placed into internal source duffer). All nodes built now until we
 295       --  reenter the analyzer will have Comes_From_Source set to True
 296
 297       if Index /= Internal_Source_File then
 298          Set_Comes_From_Source_Default (True);
 299       end if;
 300
 301       --  Check license if GNAT type header possibly present
 302
 303       if Source_Last (Index) - Scan_Ptr > 80
 304         and then Source (Scan_Ptr .. Scan_Ptr + 77) = GNAT_Hedr
 305       then
 306          Set_License (Current_Source_File, Determine_License);
 307       end if;
 308
 309       --  Because of the License stuff above, Scng.Initialize_Scanner cannot
 310       --  call Scan. Scan initial token (note this initializes Prev_Token,
 311       --  Prev_Token_Ptr).
 312
 313       --  There are two reasons not to do the Scan step in case if we
 314       --  initialize the scanner for the internal source buffer:
 315
 316       --  - The artificial string may not be created by the compiler in this
 317       --    buffer when we call Initialize_Scanner
 318
 319       --  - For these artificial strings a special way of scanning is used, so
 320       --    the standard step of the scanner may just break the algorithm of
 321       --    processing these strings.
 322
 323       if Index /= Internal_Source_File then
 324          Scan;
 325       end if;
 326
 327       --  Clear flags for reserved words used as indentifiers
 328
 329       for J in Token_Type loop
 330          Used_As_Identifier (J) := False;
 331       end loop;
 332    end Initialize_Scanner;
 333
 334    -----------------------
 335    -- Obsolescent_Check --
 336    -----------------------
 337
 338    procedure Obsolescent_Check (S : Source_Ptr) is
 339    begin
 340       --  This is a pain in the neck case, since we normally need a node to
 341       --  call Check_Restrictions, and all we have is a source pointer. The
 342       --  easiest thing is to construct a dummy node. A bit kludgy, but this
 343       --  is a marginal case. It's not worth trying to do things more cleanly.
 344
 345       Check_Restriction (No_Obsolescent_Features, New_Node (N_Empty, S));
 346    end Obsolescent_Check;
 347
 348    ------------------------------
 349    -- Scan_Reserved_Identifier --
 350    ------------------------------
 351
 352    procedure Scan_Reserved_Identifier (Force_Msg : Boolean) is
 353       Token_Chars : constant String := Token_Type'Image (Token);
 354
 355    begin
 356       --  We have in Token_Chars the image of the Token name, i.e. Tok_xxx.
 357       --  This code extracts the xxx and makes an identifier out of it.
 358
 359       Name_Len := 0;
 360
 361       for J in 5 .. Token_Chars'Length loop
 362          Name_Len := Name_Len + 1;
 363          Name_Buffer (Name_Len) := Fold_Lower (Token_Chars (J));
 364       end loop;
 365
 366       Token_Name := Name_Find;
 367
 368       if not Used_As_Identifier (Token) or else Force_Msg then
 369          Error_Msg_Name_1 := Token_Name;
 370          Error_Msg_SC ("reserved word* cannot be used as identifier!");
 371          Used_As_Identifier (Token) := True;
 372       end if;
 373
 374       Token := Tok_Identifier;
 375       Token_Node := New_Node (N_Identifier, Token_Ptr);
 376       Set_Chars (Token_Node, Token_Name);
 377    end Scan_Reserved_Identifier;
 378
 379 end Scn;