1------------------------------------------------------------------------------ 2-- -- 3-- GNAT COMPILER COMPONENTS -- 4-- -- 5-- P A R . C H 2 -- 6-- -- 7-- B o d y -- 8-- -- 9-- Copyright (C) 1992-2014, 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 26pragma Style_Checks (All_Checks); 27-- Turn off subprogram body ordering check. Subprograms are in order 28-- by RM section rather than alphabetical 29 30separate (Par) 31package body Ch2 is 32 33 -- Local functions, used only in this chapter 34 35 procedure Scan_Pragma_Argument_Association 36 (Identifier_Seen : in out Boolean; 37 Association : out Node_Id); 38 -- Scans out a pragma argument association. Identifier_Seen is true on 39 -- entry if a previous association had an identifier, and gets set True if 40 -- the scanned association has an identifier (this is used to check the 41 -- rule that no associations without identifiers can follow an association 42 -- which has an identifier). The result is returned in Association. 43 -- 44 -- Note: We allow attribute forms Pre'Class, Post'Class, Invariant'Class, 45 -- Type_Invariant'Class in place of a pragma argument identifier. Rather 46 -- than handle this case specially, we replace such references with 47 -- one of the special internal identifiers _Pre, _Post, _Invariant, or 48 -- _Type_Invariant, and this procedure is where this replacement occurs. 49 50 --------------------- 51 -- 2.3 Identifier -- 52 --------------------- 53 54 -- IDENTIFIER ::= LETTER {[UNDERLINE] LETTER_OR_DIGIT} 55 56 -- LETTER_OR_DIGIT ::= IDENTIFIER_LETTER | DIGIT 57 58 -- An IDENTIFIER shall not be a reserved word 59 60 -- Error recovery: can raise Error_Resync (cannot return Error) 61 62 function P_Identifier (C : Id_Check := None) return Node_Id is 63 Ident_Node : Node_Id; 64 65 begin 66 -- All set if we do indeed have an identifier 67 68 -- Code duplication, see Par_Ch3.P_Defining_Identifier??? 69 70 if Token = Tok_Identifier then 71 Check_Future_Keyword; 72 Ident_Node := Token_Node; 73 Scan; -- past Identifier 74 return Ident_Node; 75 76 -- If we have a reserved identifier, manufacture an identifier with 77 -- a corresponding name after posting an appropriate error message 78 79 elsif Is_Reserved_Identifier (C) then 80 Scan_Reserved_Identifier (Force_Msg => False); 81 Ident_Node := Token_Node; 82 Scan; -- past the node 83 return Ident_Node; 84 85 -- Otherwise we have junk that cannot be interpreted as an identifier 86 87 else 88 T_Identifier; -- to give message 89 raise Error_Resync; 90 end if; 91 end P_Identifier; 92 93 -------------------------- 94 -- 2.3 Letter Or Digit -- 95 -------------------------- 96 97 -- Parsed by P_Identifier (2.3) 98 99 -------------------------- 100 -- 2.4 Numeric Literal -- 101 -------------------------- 102 103 -- NUMERIC_LITERAL ::= DECIMAL_LITERAL | BASED_LITERAL 104 105 -- Numeric literal is returned by the scanner as either 106 -- Tok_Integer_Literal or Tok_Real_Literal 107 108 ---------------------------- 109 -- 2.4.1 Decimal Literal -- 110 ---------------------------- 111 112 -- DECIMAL_LITERAL ::= NUMERAL [.NUMERAL] [EXPONENT] 113 114 -- Handled by scanner as part of numeric literal handing (see 2.4) 115 116 -------------------- 117 -- 2.4.1 Numeral -- 118 -------------------- 119 120 -- NUMERAL ::= DIGIT {[UNDERLINE] DIGIT} 121 122 -- Handled by scanner as part of numeric literal handling (see 2.4) 123 124 --------------------- 125 -- 2.4.1 Exponent -- 126 --------------------- 127 128 -- EXPONENT ::= E [+] NUMERAL | E - NUMERAL 129 130 -- Handled by scanner as part of numeric literal handling (see 2.4) 131 132 -------------------------- 133 -- 2.4.2 Based Literal -- 134 -------------------------- 135 136 -- BASED_LITERAL ::= 137 -- BASE # BASED_NUMERAL [.BASED_NUMERAL] # [EXPONENT] 138 139 -- Handled by scanner as part of numeric literal handling (see 2.4) 140 141 ----------------- 142 -- 2.4.2 Base -- 143 ----------------- 144 145 -- BASE ::= NUMERAL 146 147 -- Handled by scanner as part of numeric literal handling (see 2.4) 148 149 -------------------------- 150 -- 2.4.2 Based Numeral -- 151 -------------------------- 152 153 -- BASED_NUMERAL ::= 154 -- EXTENDED_DIGIT {[UNDERLINE] EXTENDED_DIGIT} 155 156 -- Handled by scanner as part of numeric literal handling (see 2.4) 157 158 --------------------------- 159 -- 2.4.2 Extended Digit -- 160 --------------------------- 161 162 -- EXTENDED_DIGIT ::= DIGIT | A | B | C | D | E | F 163 164 -- Handled by scanner as part of numeric literal handling (see 2.4) 165 166 ---------------------------- 167 -- 2.5 Character Literal -- 168 ---------------------------- 169 170 -- CHARACTER_LITERAL ::= ' GRAPHIC_CHARACTER ' 171 172 -- Handled by the scanner and returned as Tok_Char_Literal 173 174 ------------------------- 175 -- 2.6 String Literal -- 176 ------------------------- 177 178 -- STRING LITERAL ::= "{STRING_ELEMENT}" 179 180 -- Handled by the scanner and returned as Tok_String_Literal 181 -- or if the string looks like an operator as Tok_Operator_Symbol. 182 183 ------------------------- 184 -- 2.6 String Element -- 185 ------------------------- 186 187 -- STRING_ELEMENT ::= "" | non-quotation_mark_GRAPHIC_CHARACTER 188 189 -- A STRING_ELEMENT is either a pair of quotation marks ("), 190 -- or a single GRAPHIC_CHARACTER other than a quotation mark. 191 192 -- Handled by scanner as part of string literal handling (see 2.4) 193 194 ------------------ 195 -- 2.7 Comment -- 196 ------------------ 197 198 -- A COMMENT starts with two adjacent hyphens and extends up to the 199 -- end of the line. A COMMENT may appear on any line of a program. 200 201 -- Handled by the scanner which simply skips past encountered comments 202 203 ----------------- 204 -- 2.8 Pragma -- 205 ----------------- 206 207 -- PRAGMA ::= pragma IDENTIFIER 208 -- [(PRAGMA_ARGUMENT_ASSOCIATION {, PRAGMA_ARGUMENT_ASSOCIATION})]; 209 210 -- The caller has checked that the initial token is PRAGMA 211 212 -- Error recovery: cannot raise Error_Resync 213 214 -- One special piece of processing is needed in this routine. As described 215 -- in the section on "Handling semicolon used in place of IS" in module 216 -- Parse, the parser detects the case of missing subprogram bodies to 217 -- allow recovery from this syntactic error. Pragma INTERFACE (and, for 218 -- Ada 95, pragma IMPORT) can appear in place of the body. The parser must 219 -- recognize the use of these two pragmas in this context, otherwise it 220 -- will think there are missing bodies, and try to change ; to IS, when 221 -- in fact the bodies ARE present, supplied by these pragmas. 222 223 function P_Pragma (Skipping : Boolean := False) return Node_Id is 224 Interface_Check_Required : Boolean := False; 225 -- Set True if check of pragma INTERFACE is required 226 227 Import_Check_Required : Boolean := False; 228 -- Set True if check of pragma IMPORT is required 229 230 Arg_Count : Int := 0; 231 -- Number of argument associations processed 232 233 Identifier_Seen : Boolean := False; 234 -- Set True if an identifier is encountered for a pragma argument. Used 235 -- to check that there are no more arguments without identifiers. 236 237 Prag_Node : Node_Id; 238 Prag_Name : Name_Id; 239 Semicolon_Loc : Source_Ptr; 240 Ident_Node : Node_Id; 241 Assoc_Node : Node_Id; 242 Result : Node_Id; 243 244 procedure Skip_Pragma_Semicolon; 245 -- Skip past semicolon at end of pragma 246 247 --------------------------- 248 -- Skip_Pragma_Semicolon -- 249 --------------------------- 250 251 procedure Skip_Pragma_Semicolon is 252 begin 253 -- If skipping the pragma, ignore a missing semicolon 254 255 if Token /= Tok_Semicolon and then Skipping then 256 null; 257 258 -- Otherwise demand a semicolon 259 260 else 261 T_Semicolon; 262 end if; 263 end Skip_Pragma_Semicolon; 264 265 -- Start of processing for P_Pragma 266 267 begin 268 Prag_Node := New_Node (N_Pragma, Token_Ptr); 269 Scan; -- past PRAGMA 270 Prag_Name := Token_Name; 271 272 if Style_Check then 273 Style.Check_Pragma_Name; 274 end if; 275 276 -- Ada 2005 (AI-284): INTERFACE is a new reserved word but it is 277 -- allowed as a pragma name. 278 279 if Ada_Version >= Ada_2005 280 and then Token = Tok_Interface 281 then 282 Prag_Name := Name_Interface; 283 Ident_Node := Make_Identifier (Token_Ptr, Name_Interface); 284 Scan; -- past INTERFACE 285 else 286 Ident_Node := P_Identifier; 287 end if; 288 289 Set_Pragma_Identifier (Prag_Node, Ident_Node); 290 291 -- See if special INTERFACE/IMPORT check is required 292 293 if SIS_Entry_Active then 294 Interface_Check_Required := (Prag_Name = Name_Interface); 295 Import_Check_Required := (Prag_Name = Name_Import); 296 else 297 Interface_Check_Required := False; 298 Import_Check_Required := False; 299 end if; 300 301 -- Set global to indicate if we are within a Depends pragma 302 303 if Chars (Ident_Node) = Name_Depends then 304 Inside_Depends := True; 305 end if; 306 307 -- Scan arguments. We assume that arguments are present if there is 308 -- a left paren, or if a semicolon is missing and there is another 309 -- token on the same line as the pragma name. 310 311 if Token = Tok_Left_Paren 312 or else (Token /= Tok_Semicolon 313 and then not Token_Is_At_Start_Of_Line) 314 then 315 Set_Pragma_Argument_Associations (Prag_Node, New_List); 316 T_Left_Paren; 317 318 loop 319 Arg_Count := Arg_Count + 1; 320 Scan_Pragma_Argument_Association (Identifier_Seen, Assoc_Node); 321 322 if Arg_Count = 2 323 and then (Interface_Check_Required or else Import_Check_Required) 324 then 325 -- Here is where we cancel the SIS active status if this pragma 326 -- supplies a body for the currently active subprogram spec. 327 328 if Nkind (Expression (Assoc_Node)) in N_Direct_Name 329 and then Chars (Expression (Assoc_Node)) = Chars (SIS_Labl) 330 then 331 SIS_Entry_Active := False; 332 end if; 333 end if; 334 335 Append (Assoc_Node, Pragma_Argument_Associations (Prag_Node)); 336 exit when Token /= Tok_Comma; 337 Scan; -- past comma 338 end loop; 339 340 -- If we have := for pragma Debug, it is worth special casing the 341 -- error message (it is easy to think of pragma Debug as taking a 342 -- statement, and an assignment statement is the most likely 343 -- candidate for this error) 344 345 if Token = Tok_Colon_Equal and then Prag_Name = Name_Debug then 346 Error_Msg_SC ("argument for pragma Debug must be procedure call"); 347 Resync_To_Semicolon; 348 349 -- Normal case, we expect a right paren here 350 351 else 352 T_Right_Paren; 353 end if; 354 end if; 355 356 Semicolon_Loc := Token_Ptr; 357 358 -- Cancel indication of being within Depends pragm. Can be done 359 -- unconditionally, since quicker than doing a test. 360 361 Inside_Depends := False; 362 363 -- Now we have two tasks left, we need to scan out the semicolon 364 -- following the pragma, and we have to call Par.Prag to process 365 -- the pragma. Normally we do them in this order, however, there 366 -- is one exception namely pragma Style_Checks where we like to 367 -- skip the semicolon after processing the pragma, since that way 368 -- the style checks for the scanning of the semicolon follow the 369 -- settings of the pragma. 370 371 -- You might think we could just unconditionally do things in 372 -- the opposite order, but there are other pragmas, notably the 373 -- case of pragma Source_File_Name, which assume the semicolon 374 -- is already scanned out. 375 376 if Prag_Name = Name_Style_Checks then 377 Result := Par.Prag (Prag_Node, Semicolon_Loc); 378 Skip_Pragma_Semicolon; 379 return Result; 380 else 381 Skip_Pragma_Semicolon; 382 return Par.Prag (Prag_Node, Semicolon_Loc); 383 end if; 384 385 exception 386 when Error_Resync => 387 Resync_Past_Semicolon; 388 return Error; 389 390 end P_Pragma; 391 392 -- This routine is called if a pragma is encountered in an inappropriate 393 -- position, the pragma is scanned out and control returns to continue. 394 395 -- The caller has checked that the initial token is pragma 396 397 -- Error recovery: cannot raise Error_Resync 398 399 procedure P_Pragmas_Misplaced is 400 begin 401 while Token = Tok_Pragma loop 402 Error_Msg_SC ("pragma not allowed here"); 403 Discard_Junk_Node (P_Pragma (Skipping => True)); 404 end loop; 405 end P_Pragmas_Misplaced; 406 407 -- This function is called to scan out an optional sequence of pragmas. 408 -- If no pragmas are found, then No_List is returned. 409 410 -- Error recovery: Cannot raise Error_Resync 411 412 function P_Pragmas_Opt return List_Id is 413 L : List_Id; 414 415 begin 416 if Token = Tok_Pragma then 417 L := New_List; 418 P_Pragmas_Opt (L); 419 return L; 420 421 else 422 return No_List; 423 end if; 424 end P_Pragmas_Opt; 425 426 -- This procedure is called to scan out an optional sequence of pragmas. 427 -- Any pragmas found are appended to the list provided as an argument. 428 429 -- Error recovery: Cannot raise Error_Resync 430 431 procedure P_Pragmas_Opt (List : List_Id) is 432 P : Node_Id; 433 434 begin 435 while Token = Tok_Pragma loop 436 P := P_Pragma; 437 438 if Nkind (P) /= N_Error 439 and then Nam_In (Pragma_Name (P), Name_Assert, Name_Debug) 440 then 441 Error_Msg_Name_1 := Pragma_Name (P); 442 Error_Msg_N 443 ("pragma% must be in declaration/statement context", P); 444 else 445 Append (P, List); 446 end if; 447 end loop; 448 end P_Pragmas_Opt; 449 450 -------------------------------------- 451 -- 2.8 Pragma_Argument Association -- 452 -------------------------------------- 453 454 -- PRAGMA_ARGUMENT_ASSOCIATION ::= 455 -- [pragma_argument_IDENTIFIER =>] NAME 456 -- | [pragma_argument_IDENTIFIER =>] EXPRESSION 457 458 -- In Ada 2012, there are two more possibilities: 459 460 -- PRAGMA_ARGUMENT_ASSOCIATION ::= 461 -- [pragma_argument_ASPECT_MARK =>] NAME 462 -- | [pragma_argument_ASPECT_MARK =>] EXPRESSION 463 464 -- where the interesting allowed cases (which do not fit the syntax of the 465 -- first alternative above) are 466 467 -- ASPECT_MARK ::= 468 -- Pre'Class | Post'Class | Invariant'Class | Type_Invariant'Class 469 470 -- We allow this special usage in all Ada modes, but it would be a pain to 471 -- allow these aspects to pervade the pragma syntax, and the representation 472 -- of pragma nodes internally. So what we do is to replace these 473 -- ASPECT_MARK forms with identifiers whose name is one of the special 474 -- internal names _Pre, _Post, _Invariant, or _Type_Invariant. 475 476 -- Error recovery: cannot raise Error_Resync 477 478 procedure Scan_Pragma_Argument_Association 479 (Identifier_Seen : in out Boolean; 480 Association : out Node_Id) 481 is 482 Scan_State : Saved_Scan_State; 483 Identifier_Node : Node_Id; 484 Id_Present : Boolean; 485 486 begin 487 Association := New_Node (N_Pragma_Argument_Association, Token_Ptr); 488 Set_Chars (Association, No_Name); 489 Id_Present := False; 490 491 -- Argument starts with identifier 492 493 if Token = Tok_Identifier then 494 Identifier_Node := Token_Node; 495 Save_Scan_State (Scan_State); -- at Identifier 496 Scan; -- past Identifier 497 498 if Token = Tok_Arrow then 499 Scan; -- past arrow 500 Id_Present := True; 501 502 -- Case of one of the special aspect forms 503 504 elsif Token = Tok_Apostrophe then 505 Scan; -- past apostrophe 506 507 -- We have apostrophe, so check for identifier'Class 508 509 if Token /= Tok_Identifier or else Token_Name /= Name_Class then 510 null; 511 512 -- We have identifier'Class, check for arrow 513 514 else 515 Scan; -- Past Class 516 517 if Token /= Tok_Arrow then 518 null; 519 520 -- Here we have scanned identifier'Class => 521 522 else 523 Id_Present := True; 524 Scan; -- past arrow 525 526 case Chars (Identifier_Node) is 527 when Name_Pre => 528 Set_Chars (Identifier_Node, Name_uPre); 529 530 when Name_Post => 531 Set_Chars (Identifier_Node, Name_uPost); 532 533 when Name_Type_Invariant => 534 Set_Chars (Identifier_Node, Name_uType_Invariant); 535 536 when Name_Invariant => 537 Set_Chars (Identifier_Node, Name_uInvariant); 538 539 -- If it is X'Class => for some invalid X, we will give 540 -- an error, and forget that 'Class was present, which 541 -- will give better error recovery. We could do a spell 542 -- check here, but it seems too much work. 543 544 when others => 545 Error_Msg_SC ("invalid aspect id for pragma"); 546 end case; 547 end if; 548 end if; 549 end if; 550 551 -- Identifier was present 552 553 if Id_Present then 554 Set_Chars (Association, Chars (Identifier_Node)); 555 Identifier_Seen := True; 556 557 -- Identifier not present after all 558 559 else 560 Restore_Scan_State (Scan_State); -- to Identifier 561 end if; 562 end if; 563 564 -- Diagnose error of "positional" argument for pragma appearing after 565 -- a "named" argument (quotes here are because that's not quite accurate 566 -- Ada RM terminology). 567 568 -- Since older GNAT versions did not generate this error, disable this 569 -- message in Relaxed_RM_Semantics mode to help legacy code using e.g. 570 -- codepeer. 571 572 if Identifier_Seen and not Id_Present and not Relaxed_RM_Semantics then 573 Error_Msg_SC ("|pragma argument identifier required here"); 574 Error_Msg_SC ("\since previous argument had identifier (RM 2.8(4))"); 575 end if; 576 577 if Id_Present then 578 Set_Expression (Association, P_Expression); 579 else 580 Set_Expression (Association, P_Expression_If_OK); 581 end if; 582 end Scan_Pragma_Argument_Association; 583 584end Ch2; 585