1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2013, 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 pragma Style_Checks
(All_Checks
);
27 -- Turn off subprogram body ordering check. Subprograms are in order
28 -- by RM section rather than alphabetical
33 -- Local functions, used only in this chapter
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.
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.
54 -- IDENTIFIER ::= LETTER {[UNDERLINE] LETTER_OR_DIGIT}
56 -- LETTER_OR_DIGIT ::= IDENTIFIER_LETTER | DIGIT
58 -- An IDENTIFIER shall not be a reserved word
60 -- Error recovery: can raise Error_Resync (cannot return Error)
62 function P_Identifier
(C
: Id_Check
:= None
) return Node_Id
is
66 -- All set if we do indeed have an identifier
68 -- Code duplication, see Par_Ch3.P_Defining_Identifier???
70 if Token
= Tok_Identifier
then
72 Ident_Node
:= Token_Node
;
73 Scan
; -- past Identifier
76 -- If we have a reserved identifier, manufacture an identifier with
77 -- a corresponding name after posting an appropriate error message
79 elsif Is_Reserved_Identifier
(C
) then
80 Scan_Reserved_Identifier
(Force_Msg
=> False);
81 Ident_Node
:= Token_Node
;
82 Scan
; -- past the node
85 -- Otherwise we have junk that cannot be interpreted as an identifier
88 T_Identifier
; -- to give message
93 --------------------------
94 -- 2.3 Letter Or Digit --
95 --------------------------
97 -- Parsed by P_Identifier (2.3)
99 --------------------------
100 -- 2.4 Numeric Literal --
101 --------------------------
103 -- NUMERIC_LITERAL ::= DECIMAL_LITERAL | BASED_LITERAL
105 -- Numeric literal is returned by the scanner as either
106 -- Tok_Integer_Literal or Tok_Real_Literal
108 ----------------------------
109 -- 2.4.1 Decimal Literal --
110 ----------------------------
112 -- DECIMAL_LITERAL ::= NUMERAL [.NUMERAL] [EXPONENT]
114 -- Handled by scanner as part of numeric literal handing (see 2.4)
120 -- NUMERAL ::= DIGIT {[UNDERLINE] DIGIT}
122 -- Handled by scanner as part of numeric literal handling (see 2.4)
124 ---------------------
126 ---------------------
128 -- EXPONENT ::= E [+] NUMERAL | E - NUMERAL
130 -- Handled by scanner as part of numeric literal handling (see 2.4)
132 --------------------------
133 -- 2.4.2 Based Literal --
134 --------------------------
137 -- BASE # BASED_NUMERAL [.BASED_NUMERAL] # [EXPONENT]
139 -- Handled by scanner as part of numeric literal handling (see 2.4)
147 -- Handled by scanner as part of numeric literal handling (see 2.4)
149 --------------------------
150 -- 2.4.2 Based Numeral --
151 --------------------------
154 -- EXTENDED_DIGIT {[UNDERLINE] EXTENDED_DIGIT}
156 -- Handled by scanner as part of numeric literal handling (see 2.4)
158 ---------------------------
159 -- 2.4.2 Extended Digit --
160 ---------------------------
162 -- EXTENDED_DIGIT ::= DIGIT | A | B | C | D | E | F
164 -- Handled by scanner as part of numeric literal handling (see 2.4)
166 ----------------------------
167 -- 2.5 Character Literal --
168 ----------------------------
170 -- CHARACTER_LITERAL ::= ' GRAPHIC_CHARACTER '
172 -- Handled by the scanner and returned as Tok_Char_Literal
174 -------------------------
175 -- 2.6 String Literal --
176 -------------------------
178 -- STRING LITERAL ::= "{STRING_ELEMENT}"
180 -- Handled by the scanner and returned as Tok_String_Literal
181 -- or if the string looks like an operator as Tok_Operator_Symbol.
183 -------------------------
184 -- 2.6 String Element --
185 -------------------------
187 -- STRING_ELEMENT ::= "" | non-quotation_mark_GRAPHIC_CHARACTER
189 -- A STRING_ELEMENT is either a pair of quotation marks ("),
190 -- or a single GRAPHIC_CHARACTER other than a quotation mark.
192 -- Handled by scanner as part of string literal handling (see 2.4)
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.
201 -- Handled by the scanner which simply skips past encountered comments
207 -- PRAGMA ::= pragma IDENTIFIER
208 -- [(PRAGMA_ARGUMENT_ASSOCIATION {, PRAGMA_ARGUMENT_ASSOCIATION})];
210 -- The caller has checked that the initial token is PRAGMA
212 -- Error recovery: cannot raise Error_Resync
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.
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
227 Import_Check_Required
: Boolean := False;
228 -- Set True if check of pragma IMPORT is required
230 Arg_Count
: Int
:= 0;
231 -- Number of argument associations processed
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.
239 Semicolon_Loc
: Source_Ptr
;
240 Ident_Node
: Node_Id
;
241 Assoc_Node
: Node_Id
;
244 procedure Skip_Pragma_Semicolon
;
245 -- Skip past semicolon at end of pragma
247 ---------------------------
248 -- Skip_Pragma_Semicolon --
249 ---------------------------
251 procedure Skip_Pragma_Semicolon
is
253 -- If skipping the pragma, ignore a missing semicolon
255 if Token
/= Tok_Semicolon
and then Skipping
then
258 -- Otherwise demand a semicolon
263 end Skip_Pragma_Semicolon
;
265 -- Start of processing for P_Pragma
268 Prag_Node
:= New_Node
(N_Pragma
, Token_Ptr
);
270 Prag_Name
:= Token_Name
;
273 Style
.Check_Pragma_Name
;
276 -- Ada 2005 (AI-284): INTERFACE is a new reserved word but it is
277 -- allowed as a pragma name.
279 if Ada_Version
>= Ada_2005
280 and then Token
= Tok_Interface
282 Prag_Name
:= Name_Interface
;
283 Ident_Node
:= Make_Identifier
(Token_Ptr
, Name_Interface
);
284 Scan
; -- past INTERFACE
286 Ident_Node
:= P_Identifier
;
289 Set_Pragma_Identifier
(Prag_Node
, Ident_Node
);
291 -- See if special INTERFACE/IMPORT check is required
293 if SIS_Entry_Active
then
294 Interface_Check_Required
:= (Prag_Name
= Name_Interface
);
295 Import_Check_Required
:= (Prag_Name
= Name_Import
);
297 Interface_Check_Required
:= False;
298 Import_Check_Required
:= False;
301 -- Scan arguments. We assume that arguments are present if there is
302 -- a left paren, or if a semicolon is missing and there is another
303 -- token on the same line as the pragma name.
305 if Token
= Tok_Left_Paren
306 or else (Token
/= Tok_Semicolon
307 and then not Token_Is_At_Start_Of_Line
)
309 Set_Pragma_Argument_Associations
(Prag_Node
, New_List
);
313 Arg_Count
:= Arg_Count
+ 1;
314 Scan_Pragma_Argument_Association
(Identifier_Seen
, Assoc_Node
);
317 and then (Interface_Check_Required
or else Import_Check_Required
)
319 -- Here is where we cancel the SIS active status if this pragma
320 -- supplies a body for the currently active subprogram spec.
322 if Nkind
(Expression
(Assoc_Node
)) in N_Direct_Name
323 and then Chars
(Expression
(Assoc_Node
)) = Chars
(SIS_Labl
)
325 SIS_Entry_Active
:= False;
329 Append
(Assoc_Node
, Pragma_Argument_Associations
(Prag_Node
));
330 exit when Token
/= Tok_Comma
;
334 -- If we have := for pragma Debug, it is worth special casing the
335 -- error message (it is easy to think of pragma Debug as taking a
336 -- statement, and an assignment statement is the most likely
337 -- candidate for this error)
339 if Token
= Tok_Colon_Equal
and then Prag_Name
= Name_Debug
then
340 Error_Msg_SC
("argument for pragma Debug must be procedure call");
343 -- Normal case, we expect a right paren here
350 Semicolon_Loc
:= Token_Ptr
;
352 -- Now we have two tasks left, we need to scan out the semicolon
353 -- following the pragma, and we have to call Par.Prag to process
354 -- the pragma. Normally we do them in this order, however, there
355 -- is one exception namely pragma Style_Checks where we like to
356 -- skip the semicolon after processing the pragma, since that way
357 -- the style checks for the scanning of the semicolon follow the
358 -- settings of the pragma.
360 -- You might think we could just unconditionally do things in
361 -- the opposite order, but there are other pragmas, notably the
362 -- case of pragma Source_File_Name, which assume the semicolon
363 -- is already scanned out.
365 if Prag_Name
= Name_Style_Checks
then
366 Result
:= Par
.Prag
(Prag_Node
, Semicolon_Loc
);
367 Skip_Pragma_Semicolon
;
370 Skip_Pragma_Semicolon
;
371 return Par
.Prag
(Prag_Node
, Semicolon_Loc
);
376 Resync_Past_Semicolon
;
381 -- This routine is called if a pragma is encountered in an inappropriate
382 -- position, the pragma is scanned out and control returns to continue.
384 -- The caller has checked that the initial token is pragma
386 -- Error recovery: cannot raise Error_Resync
388 procedure P_Pragmas_Misplaced
is
390 while Token
= Tok_Pragma
loop
391 Error_Msg_SC
("pragma not allowed here");
392 Discard_Junk_Node
(P_Pragma
(Skipping
=> True));
394 end P_Pragmas_Misplaced
;
396 -- This function is called to scan out an optional sequence of pragmas.
397 -- If no pragmas are found, then No_List is returned.
399 -- Error recovery: Cannot raise Error_Resync
401 function P_Pragmas_Opt
return List_Id
is
405 if Token
= Tok_Pragma
then
415 -- This procedure is called to scan out an optional sequence of pragmas.
416 -- Any pragmas found are appended to the list provided as an argument.
418 -- Error recovery: Cannot raise Error_Resync
420 procedure P_Pragmas_Opt
(List
: List_Id
) is
424 while Token
= Tok_Pragma
loop
427 if Nkind
(P
) /= N_Error
428 and then Nam_In
(Pragma_Name
(P
), Name_Assert
, Name_Debug
)
430 Error_Msg_Name_1
:= Pragma_Name
(P
);
432 ("pragma% must be in declaration/statement context", P
);
439 --------------------------------------
440 -- 2.8 Pragma_Argument Association --
441 --------------------------------------
443 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
444 -- [pragma_argument_IDENTIFIER =>] NAME
445 -- | [pragma_argument_IDENTIFIER =>] EXPRESSION
447 -- In Ada 2012, there are two more possibilities:
449 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
450 -- [pragma_argument_ASPECT_MARK =>] NAME
451 -- | [pragma_argument_ASPECT_MARK =>] EXPRESSION
453 -- where the interesting allowed cases (which do not fit the syntax of the
454 -- first alternative above) are
457 -- Pre'Class | Post'Class | Invariant'Class | Type_Invariant'Class
459 -- We allow this special usage in all Ada modes, but it would be a pain to
460 -- allow these aspects to pervade the pragma syntax, and the representation
461 -- of pragma nodes internally. So what we do is to replace these
462 -- ASPECT_MARK forms with identifiers whose name is one of the special
463 -- internal names _Pre, _Post, _Invariant, or _Type_Invariant.
465 -- Error recovery: cannot raise Error_Resync
467 procedure Scan_Pragma_Argument_Association
468 (Identifier_Seen
: in out Boolean;
469 Association
: out Node_Id
)
471 Scan_State
: Saved_Scan_State
;
472 Identifier_Node
: Node_Id
;
473 Id_Present
: Boolean;
476 Association
:= New_Node
(N_Pragma_Argument_Association
, Token_Ptr
);
477 Set_Chars
(Association
, No_Name
);
480 -- Argument starts with identifier
482 if Token
= Tok_Identifier
then
483 Identifier_Node
:= Token_Node
;
484 Save_Scan_State
(Scan_State
); -- at Identifier
485 Scan
; -- past Identifier
487 if Token
= Tok_Arrow
then
491 -- Case of one of the special aspect forms
493 elsif Token
= Tok_Apostrophe
then
494 Scan
; -- past apostrophe
496 -- We have apostrophe, so check for identifier'Class
498 if Token
/= Tok_Identifier
or else Token_Name
/= Name_Class
then
501 -- We have identifier'Class, check for arrow
506 if Token
/= Tok_Arrow
then
509 -- Here we have scanned identifier'Class =>
515 case Chars
(Identifier_Node
) is
517 Set_Chars
(Identifier_Node
, Name_uPre
);
520 Set_Chars
(Identifier_Node
, Name_uPost
);
522 when Name_Type_Invariant
=>
523 Set_Chars
(Identifier_Node
, Name_uType_Invariant
);
525 when Name_Invariant
=>
526 Set_Chars
(Identifier_Node
, Name_uInvariant
);
528 -- If it is X'Class => for some invalid X, we will give
529 -- an error, and forget that 'Class was present, which
530 -- will give better error recovery. We could do a spell
531 -- check here, but it seems too much work.
534 Error_Msg_SC
("invalid aspect id for pragma");
540 -- Identifier was present
543 Set_Chars
(Association
, Chars
(Identifier_Node
));
544 Identifier_Seen
:= True;
546 -- Identifier not present after all
549 Restore_Scan_State
(Scan_State
); -- to Identifier
553 -- Diagnose error of "positional" argument for pragma appearing after
554 -- a "named" argument (quotes here are because that's not quite accurate
555 -- Ada RM terminology).
557 -- Since older GNAT versions did not generate this error, disable this
558 -- message in Relaxed_RM_Semantics mode to help legacy code using e.g.
561 if Identifier_Seen
and not Id_Present
and not Relaxed_RM_Semantics
then
562 Error_Msg_SC
("|pragma argument identifier required here");
563 Error_Msg_SC
("\since previous argument had identifier (RM 2.8(4))");
567 Set_Expression
(Association
, P_Expression
);
569 Set_Expression
(Association
, P_Expression_If_OK
);
571 end Scan_Pragma_Argument_Association
;