1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2002 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 -- Generally the parser checks the basic syntax of pragmas, but does not
28 -- do specialized syntax checks for individual pragmas, these are deferred
29 -- to semantic analysis time (see unit Sem_Prag). There are some pragmas
30 -- which require recognition and either partial or complete processing
31 -- during parsing, and this unit performs this required processing.
33 with Fname.UF; use Fname.UF;
34 with Osint; use Osint;
35 with Stringt; use Stringt;
36 with Stylesw; use Stylesw;
37 with Uintp; use Uintp;
38 with Uname; use Uname;
42 function Prag (Pragma_Node : Node_Id; Semi : Source_Ptr) return Node_Id is
43 Pragma_Name : constant Name_Id := Chars (Pragma_Node);
44 Pragma_Sloc : constant Source_Ptr := Sloc (Pragma_Node);
48 -----------------------
49 -- Local Subprograms --
50 -----------------------
52 function Arg1 return Node_Id;
53 function Arg2 return Node_Id;
54 function Arg3 return Node_Id;
55 -- Obtain specified Pragma_Argument_Association. It is allowable to call
56 -- the routine for the argument one past the last present argument, but
57 -- that is the only case in which a non-present argument can be referenced.
59 procedure Check_Arg_Count (Required : Int);
60 -- Check argument count for pragma = Required.
61 -- If not give error and raise Error_Resync.
63 procedure Check_Arg_Is_String_Literal (Arg : Node_Id);
64 -- Check the expression of the specified argument to make sure that it
65 -- is a string literal. If not give error and raise Error_Resync.
67 procedure Check_Arg_Is_On_Or_Off (Arg : Node_Id);
68 -- Check the expression of the specified argument to make sure that it
69 -- is an identifier which is either ON or OFF, and if not, then issue
70 -- an error message and raise Error_Resync.
72 procedure Check_No_Identifier (Arg : Node_Id);
73 -- Checks that the given argument does not have an identifier. If an
74 -- identifier is present, then an error message is issued, and
75 -- Error_Resync is raised.
77 procedure Check_Optional_Identifier (Arg : Node_Id; Id : Name_Id);
78 -- Checks if the given argument has an identifier, and if so, requires
79 -- it to match the given identifier name. If there is a non-matching
80 -- identifier, then an error message is given and Error_Resync raised.
82 procedure Check_Required_Identifier (Arg : Node_Id; Id : Name_Id);
83 -- Same as Check_Optional_Identifier, except that the name is required
84 -- to be present and to match the given Id value.
90 function Arg1 return Node_Id is
92 return First (Pragma_Argument_Associations (Pragma_Node));
99 function Arg2 return Node_Id is
108 function Arg3 return Node_Id is
113 ---------------------
114 -- Check_Arg_Count --
115 ---------------------
117 procedure Check_Arg_Count (Required : Int) is
119 if Arg_Count /= Required then
120 Error_Msg ("wrong number of arguments for pragma%", Pragma_Sloc);
125 ----------------------------
126 -- Check_Arg_Is_On_Or_Off --
127 ----------------------------
129 procedure Check_Arg_Is_On_Or_Off (Arg : Node_Id) is
130 Argx : constant Node_Id := Expression (Arg);
133 if Nkind (Expression (Arg)) /= N_Identifier
134 or else (Chars (Argx) /= Name_On
136 Chars (Argx) /= Name_Off)
138 Error_Msg_Name_2 := Name_On;
139 Error_Msg_Name_3 := Name_Off;
142 ("argument for pragma% must be% or%", Sloc (Argx));
145 end Check_Arg_Is_On_Or_Off;
147 ---------------------------------
148 -- Check_Arg_Is_String_Literal --
149 ---------------------------------
151 procedure Check_Arg_Is_String_Literal (Arg : Node_Id) is
153 if Nkind (Expression (Arg)) /= N_String_Literal then
155 ("argument for pragma% must be string literal",
156 Sloc (Expression (Arg)));
159 end Check_Arg_Is_String_Literal;
161 -------------------------
162 -- Check_No_Identifier --
163 -------------------------
165 procedure Check_No_Identifier (Arg : Node_Id) is
167 if Chars (Arg) /= No_Name then
168 Error_Msg_N ("pragma% does not permit named arguments", Arg);
171 end Check_No_Identifier;
173 -------------------------------
174 -- Check_Optional_Identifier --
175 -------------------------------
177 procedure Check_Optional_Identifier (Arg : Node_Id; Id : Name_Id) is
179 if Present (Arg) and then Chars (Arg) /= No_Name then
180 if Chars (Arg) /= Id then
181 Error_Msg_Name_2 := Id;
182 Error_Msg_N ("pragma% argument expects identifier%", Arg);
185 end Check_Optional_Identifier;
187 -------------------------------
188 -- Check_Required_Identifier --
189 -------------------------------
191 procedure Check_Required_Identifier (Arg : Node_Id; Id : Name_Id) is
193 if Chars (Arg) /= Id then
194 Error_Msg_Name_2 := Id;
195 Error_Msg_N ("pragma% argument must have identifier%", Arg);
197 end Check_Required_Identifier;
204 Error_Msg_Name_1 := Pragma_Name;
206 -- Ignore unrecognized pragma. We let Sem post the warning for this, since
207 -- it is a semantic error, not a syntactic one (we have already checked
208 -- the syntax for the unrecognized pragma as required by (RM 2.8(11)).
210 if not Is_Pragma_Name (Chars (Pragma_Node)) then
214 -- Count number of arguments. This loop also checks if any of the arguments
215 -- are Error, indicating a syntax error as they were parsed. If so, we
216 -- simply return, because we get into trouble with cascaded errors if we
217 -- try to perform our error checks on junk arguments.
221 if Present (Pragma_Argument_Associations (Pragma_Node)) then
224 while Arg_Node /= Empty loop
225 Arg_Count := Arg_Count + 1;
227 if Expression (Arg_Node) = Error then
235 -- Remaining processing is pragma dependent
237 case Get_Pragma_Id (Pragma_Name) is
243 -- This pragma must be processed at parse time, since we want to set
244 -- the Ada 83 and Ada 95 switches properly at parse time to recognize
245 -- Ada 83 syntax or Ada 95 syntax as appropriate.
247 when Pragma_Ada_83 =>
255 -- This pragma must be processed at parse time, since we want to set
256 -- the Ada 83 and Ada_95 switches properly at parse time to recognize
257 -- Ada 83 syntax or Ada 95 syntax as appropriate.
259 when Pragma_Ada_95 =>
267 -- pragma Debug (PROCEDURE_CALL_STATEMENT);
269 -- This has to be processed by the parser because of the very peculiar
270 -- form of the second parameter, which is syntactically from a formal
271 -- point of view a function call (since it must be an expression), but
272 -- semantically we treat it as a procedure call (which has exactly the
273 -- same syntactic form, so that's why we can get away with this!)
277 Check_No_Identifier (Arg1);
280 Expr : constant Node_Id := New_Copy (Expression (Arg1));
283 if Nkind (Expr) /= N_Indexed_Component
284 and then Nkind (Expr) /= N_Function_Call
285 and then Nkind (Expr) /= N_Identifier
286 and then Nkind (Expr) /= N_Selected_Component
289 ("argument of pragma% is not procedure call", Sloc (Expr));
293 (Pragma_Node, P_Statement_Name (Expr));
297 -------------------------------
298 -- Extensions_Allowed (GNAT) --
299 -------------------------------
301 -- pragma Extensions_Allowed (Off | On)
303 -- The processing for pragma Extensions_Allowed must be done at
304 -- parse time, since extensions mode may affect what is accepted.
306 when Pragma_Extensions_Allowed =>
308 Check_No_Identifier (Arg1);
309 Check_Arg_Is_On_Or_Off (Arg1);
310 Opt.Extensions_Allowed := (Chars (Expression (Arg1)) = Name_On);
316 -- pragma List (Off | On)
318 -- The processing for pragma List must be done at parse time,
319 -- since a listing can be generated in parse only mode.
323 Check_No_Identifier (Arg1);
324 Check_Arg_Is_On_Or_Off (Arg1);
326 -- We unconditionally make a List_On entry for the pragma, so that
327 -- in the List (Off) case, the pragma will print even in a region
328 -- of code with listing turned off (this is required!)
330 List_Pragmas.Increment_Last;
331 List_Pragmas.Table (List_Pragmas.Last) :=
332 (Ptyp => List_On, Ploc => Sloc (Pragma_Node));
334 -- Now generate the list off entry for pragma List (Off)
336 if Chars (Expression (Arg1)) = Name_Off then
337 List_Pragmas.Increment_Last;
338 List_Pragmas.Table (List_Pragmas.Last) :=
339 (Ptyp => List_Off, Ploc => Semi);
348 -- Processing for this pragma must be done at parse time, since a
349 -- listing can be generated in parse only mode with semantics off.
353 List_Pragmas.Increment_Last;
354 List_Pragmas.Table (List_Pragmas.Last) := (Page, Semi);
356 -----------------------------
357 -- Source_File_Name (GNAT) --
358 -----------------------------
360 -- There are five forms of this pragma:
362 -- pragma Source_File_Name (
363 -- [UNIT_NAME =>] unit_NAME,
364 -- BODY_FILE_NAME => STRING_LITERAL);
366 -- pragma Source_File_Name (
367 -- [UNIT_NAME =>] unit_NAME,
368 -- SPEC_FILE_NAME => STRING_LITERAL);
370 -- pragma Source_File_Name (
371 -- BODY_FILE_NAME => STRING_LITERAL
372 -- [, DOT_REPLACEMENT => STRING_LITERAL]
373 -- [, CASING => CASING_SPEC]);
375 -- pragma Source_File_Name (
376 -- SPEC_FILE_NAME => STRING_LITERAL
377 -- [, DOT_REPLACEMENT => STRING_LITERAL]
378 -- [, CASING => CASING_SPEC]);
380 -- pragma Source_File_Name (
381 -- SUBUNIT_FILE_NAME => STRING_LITERAL
382 -- [, DOT_REPLACEMENT => STRING_LITERAL]
383 -- [, CASING => CASING_SPEC]);
385 -- CASING_SPEC ::= Uppercase | Lowercase | Mixedcase
387 -- Note: we process this during parsing, since we need to have the
388 -- source file names set well before the semantic analysis starts,
389 -- since we load the spec and with'ed packages before analysis.
391 when Pragma_Source_File_Name => Source_File_Name : declare
392 Unam : Unit_Name_Type;
400 function Get_Fname (Arg : Node_Id) return Name_Id;
401 -- Process file name from unit name form of pragma
403 function Get_String_Argument (Arg : Node_Id) return String_Ptr;
404 -- Process string literal value from argument
406 procedure Process_Casing (Arg : Node_Id);
407 -- Process Casing argument of pattern form of pragma
409 procedure Process_Dot_Replacement (Arg : Node_Id);
410 -- Process Dot_Replacement argument of patterm form of pragma
416 function Get_Fname (Arg : Node_Id) return Name_Id is
418 String_To_Name_Buffer (Strval (Expression (Arg)));
420 for J in 1 .. Name_Len loop
421 if Is_Directory_Separator (Name_Buffer (J)) then
423 ("directory separator character not allowed",
424 Sloc (Expression (Arg)) + Source_Ptr (J));
431 -------------------------
432 -- Get_String_Argument --
433 -------------------------
435 function Get_String_Argument (Arg : Node_Id) return String_Ptr is
439 if Nkind (Expression (Arg)) /= N_String_Literal
441 Nkind (Expression (Arg)) /= N_Operator_Symbol
444 ("argument for pragma% must be string literal", Arg);
448 Str := Strval (Expression (Arg));
450 -- Check string has no wide chars
452 for J in 1 .. String_Length (Str) loop
453 if Get_String_Char (Str, J) > 255 then
455 ("wide character not allowed in pattern for pragma%",
456 Sloc (Expression (Arg2)) + Text_Ptr (J) - 1);
462 String_To_Name_Buffer (Str);
463 return new String'(Name_Buffer (1 .. Name_Len));
464 end Get_String_Argument;
470 procedure Process_Casing (Arg : Node_Id) is
471 Expr : constant Node_Id := Expression (Arg);
474 Check_Required_Identifier (Arg, Name_Casing);
476 if Nkind (Expr) = N_Identifier then
477 if Chars (Expr) = Name_Lowercase then
478 Cas := All_Lower_Case;
480 elsif Chars (Expr) = Name_Uppercase then
481 Cas := All_Upper_Case;
483 elsif Chars (Expr) = Name_Mixedcase then
490 ("Casing argument for pragma% must be " &
491 "one of Mixedcase, Lowercase, Uppercase",
495 -----------------------------
496 -- Process_Dot_Replacement --
497 -----------------------------
499 procedure Process_Dot_Replacement (Arg : Node_Id) is
501 Check_Required_Identifier (Arg, Name_Dot_Replacement);
502 Dot := Get_String_Argument (Arg);
503 end Process_Dot_Replacement;
505 -- Start of processing for Source_File_Name pragma
508 -- We permit from 1 to 3 arguments
510 if Arg_Count not in 1 .. 3 then
514 Expr1 := Expression (Arg1);
516 -- If first argument is identifier or selected component, then
517 -- we have the specific file case of the Source_File_Name pragma,
518 -- and the first argument is a unit name.
520 if Nkind (Expr1) = N_Identifier
522 (Nkind (Expr1) = N_Selected_Component
524 Nkind (Selector_Name (Expr1)) = N_Identifier)
526 if Nkind (Expr1) = N_Identifier
527 and then Chars (Expr1) = Name_System
530 ("pragma Source_File_Name may not be used for System", Arg1);
536 Check_Optional_Identifier (Arg1, Name_Unit_Name);
537 Unam := Get_Unit_Name (Expr1);
539 Check_Arg_Is_String_Literal (Arg2);
541 if Chars (Arg2) = Name_Spec_File_Name then
542 Set_File_Name (Get_Spec_Name (Unam), Get_Fname (Arg2));
544 elsif Chars (Arg2) = Name_Body_File_Name then
545 Set_File_Name (Unam, Get_Fname (Arg2));
548 Error_Msg_N ("pragma% argument has incorrect identifier", Arg2);
552 -- If the first argument is not an identifier, then we must have
553 -- the pattern form of the pragma, and the first argument must be
554 -- the pattern string with an appropriate name.
557 if Chars (Arg1) = Name_Spec_File_Name then
560 elsif Chars (Arg1) = Name_Body_File_Name then
563 elsif Chars (Arg1) = Name_Subunit_File_Name then
566 elsif Chars (Arg1) = Name_Unit_Name then
568 ("Unit_Name parameter for pragma% must be an identifier",
573 Error_Msg_N ("pragma% argument has incorrect identifier", Arg1);
577 Pat := Get_String_Argument (Arg1);
579 -- Check pattern has exactly one asterisk
582 for J in Pat'Range loop
583 if Pat (J) = '*' then
590 ("file name pattern must have exactly one * character",
595 -- Set defaults for Casing and Dot_Separator parameters
597 Cas := All_Lower_Case;
599 Dot := new String'(".");
601 -- Process second and third arguments if present
603 if Arg_Count > 1 then
604 if Chars (Arg2) = Name_Casing then
605 Process_Casing (Arg2);
607 if Arg_Count = 3 then
608 Process_Dot_Replacement (Arg3);
612 Process_Dot_Replacement (Arg2);
614 if Arg_Count = 3 then
615 Process_Casing (Arg3);
620 Set_File_Name_Pattern (Pat, Typ, Dot, Cas);
622 end Source_File_Name;
624 -----------------------------
625 -- Source_Reference (GNAT) --
626 -----------------------------
628 -- pragma Source_Reference
629 -- (INTEGER_LITERAL [, STRING_LITERAL] );
631 -- Processing for this pragma must be done at parse time, since error
632 -- messages needing the proper line numbers can be generated in parse
633 -- only mode with semantic checking turned off, and indeed we usually
634 -- turn off semantic checking anyway if any parse errors are found.
636 when Pragma_Source_Reference => Source_Reference : declare
640 if Arg_Count /= 1 then
642 Check_No_Identifier (Arg2);
645 -- Check that this is first line of file. We skip this test if
646 -- we are in syntax check only mode, since we may be dealing with
647 -- multiple compilation units.
649 if Get_Physical_Line_Number (Pragma_Sloc) /= 1
650 and then Num_SRef_Pragmas (Current_Source_File) = 0
651 and then Operating_Mode /= Check_Syntax
654 ("first % pragma must be first line of file", Pragma_Sloc);
658 Check_No_Identifier (Arg1);
660 if Arg_Count = 1 then
661 if Num_SRef_Pragmas (Current_Source_File) = 0 then
663 ("file name required for first % pragma in file",
674 Check_Arg_Is_String_Literal (Arg2);
675 String_To_Name_Buffer (Strval (Expression (Arg2)));
678 if Num_SRef_Pragmas (Current_Source_File) > 0 then
679 if Fname /= Full_Ref_Name (Current_Source_File) then
681 ("file name must be same in all % pragmas", Pragma_Sloc);
687 if Nkind (Expression (Arg1)) /= N_Integer_Literal then
689 ("argument for pragma% must be integer literal",
690 Sloc (Expression (Arg1)));
693 -- OK, this source reference pragma is effective, however, we
694 -- ignore it if it is not in the first unit in the multiple unit
695 -- case. This is because the only purpose in this case is to
696 -- provide source pragmas for subsequent use by gnatchop.
699 if Num_Library_Units = 1 then
700 Register_Source_Ref_Pragma
702 Strip_Directory (Fname),
703 UI_To_Int (Intval (Expression (Arg1))),
704 Get_Physical_Line_Number (Pragma_Sloc) + 1);
707 end Source_Reference;
709 -------------------------
710 -- Style_Checks (GNAT) --
711 -------------------------
713 -- pragma Style_Checks (On | Off | ALL_CHECKS | STRING_LITERAL);
715 -- This is processed by the parser since some of the style
716 -- checks take place during source scanning and parsing.
718 when Pragma_Style_Checks => Style_Checks : declare
722 OK : Boolean := True;
725 -- Two argument case is only for semantics
727 if Arg_Count = 2 then
732 Check_No_Identifier (Arg1);
733 A := Expression (Arg1);
735 if Nkind (A) = N_String_Literal then
739 Slen : Natural := Natural (String_Length (S));
740 Options : String (1 .. Slen);
747 C := Get_String_Char (S, Int (J));
749 if not In_Character_Range (C) then
755 Options (J) := Get_Character (C);
759 Set_Style_Check_Options (Options, OK, Ptr);
769 ("invalid style check option",
770 Sloc (Expression (Arg1)) + Source_Ptr (Ptr));
775 elsif Nkind (A) /= N_Identifier then
778 elsif Chars (A) = Name_All_Checks then
779 Stylesw.Set_Default_Style_Check_Options;
781 elsif Chars (A) = Name_On then
784 elsif Chars (A) = Name_Off then
785 Style_Check := False;
792 Error_Msg ("incorrect argument for pragma%", Sloc (A));
798 ---------------------
799 -- Warnings (GNAT) --
800 ---------------------
802 -- pragma Warnings (On | Off, [LOCAL_NAME])
804 -- The one argument case is processed by the parser, since it may
805 -- control parser warnings as well as semantic warnings, and in any
806 -- case we want to be absolutely sure that the range in the warnings
807 -- table is set well before any semantic analysis is performed.
809 when Pragma_Warnings =>
810 if Arg_Count = 1 then
811 Check_No_Identifier (Arg1);
812 Check_Arg_Is_On_Or_Off (Arg1);
814 if Chars (Expression (Arg1)) = Name_On then
815 Set_Warnings_Mode_On (Pragma_Sloc);
817 Set_Warnings_Mode_Off (Pragma_Sloc);
821 -----------------------
822 -- All Other Pragmas --
823 -----------------------
825 -- For all other pragmas, checking and processing is handled
826 -- entirely in Sem_Prag, and no further checking is done by Par.
828 when Pragma_Abort_Defer |
830 Pragma_All_Calls_Remote |
833 Pragma_Asynchronous |
835 Pragma_Atomic_Components |
836 Pragma_Attach_Handler |
837 Pragma_Convention_Identifier |
839 Pragma_CPP_Constructor |
842 Pragma_C_Pass_By_Copy |
844 Pragma_Common_Object |
845 Pragma_Complex_Representation |
846 Pragma_Component_Alignment |
849 Pragma_Discard_Names |
852 Pragma_Elaborate_All |
853 Pragma_Elaborate_Body |
854 Pragma_Elaboration_Checks |
856 Pragma_Export_Exception |
857 Pragma_Export_Function |
858 Pragma_Export_Object |
859 Pragma_Export_Procedure |
860 Pragma_Export_Valued_Procedure |
861 Pragma_Extend_System |
863 Pragma_External_Name_Casing |
864 Pragma_Finalize_Storage_Only |
865 Pragma_Float_Representation |
868 Pragma_Import_Exception |
869 Pragma_Import_Function |
870 Pragma_Import_Object |
871 Pragma_Import_Procedure |
872 Pragma_Import_Valued_Procedure |
873 Pragma_Initialize_Scalars |
875 Pragma_Inline_Always |
876 Pragma_Inline_Generic |
877 Pragma_Inspection_Point |
879 Pragma_Interface_Name |
880 Pragma_Interrupt_Handler |
881 Pragma_Interrupt_Priority |
882 Pragma_Java_Constructor |
883 Pragma_Java_Interface |
886 Pragma_Linker_Alias |
887 Pragma_Linker_Options |
888 Pragma_Linker_Section |
889 Pragma_Locking_Policy |
891 Pragma_Machine_Attribute |
893 Pragma_Main_Storage |
897 Pragma_Normalize_Scalars |
902 Pragma_Preelaborate |
904 Pragma_Propagate_Exceptions |
905 Pragma_Psect_Object |
907 Pragma_Pure_Function |
908 Pragma_Queuing_Policy |
909 Pragma_Remote_Call_Interface |
910 Pragma_Remote_Types |
911 Pragma_Restrictions |
912 Pragma_Restricted_Run_Time |
915 Pragma_Share_Generic |
917 Pragma_Shared_Passive |
918 Pragma_Storage_Size |
919 Pragma_Storage_Unit |
920 Pragma_Stream_Convert |
923 Pragma_Suppress_All |
924 Pragma_Suppress_Debug_Info |
925 Pragma_Suppress_Initialization |
927 Pragma_Task_Dispatching_Policy |
930 Pragma_Task_Storage |
933 Pragma_Unchecked_Union |
934 Pragma_Unimplemented_Unit |
935 Pragma_Universal_Data |
936 Pragma_Unreferenced |
937 Pragma_Unreserve_All_Interrupts |
939 Pragma_Use_VADS_Size |
941 Pragma_Volatile_Components |
942 Pragma_Weak_External |
943 Pragma_Validity_Checks =>