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 handling is isolated in a separate package
27 -- (logically this processing belongs in chapter 4)
29 with Namet
; use Namet
;
30 with Snames
; use Snames
;
31 with Types
; use Types
;
35 -- The following table lists all the implementation-defined pragmas that
36 -- may apply to a body stub (no language defined pragmas apply). The table
37 -- should be synchronized with Aspect_On_Body_Or_Stub_OK in unit Aspects if
38 -- the pragmas below implement an aspect.
40 Pragma_On_Body_Or_Stub_OK
: constant array (Pragma_Id
) of Boolean :=
41 (Pragma_Refined_Depends
=> True,
42 Pragma_Refined_Global
=> True,
43 Pragma_Refined_Post
=> True,
44 Pragma_SPARK_Mode
=> True,
45 Pragma_Warnings
=> True,
52 procedure Analyze_Pragma
(N
: Node_Id
);
53 -- Analyze procedure for pragma reference node N
55 procedure Analyze_Contract_Cases_In_Decl_Part
(N
: Node_Id
);
56 -- Perform full analysis and expansion of delayed pragma Contract_Cases
58 procedure Analyze_Depends_In_Decl_Part
(N
: Node_Id
);
59 -- Perform full analysis of delayed pragma Depends. This routine is also
60 -- capable of performing basic analysis of pragma Refined_Depends.
62 procedure Analyze_Global_In_Decl_Part
(N
: Node_Id
);
63 -- Perform full analysis of delayed pragma Global. This routine is also
64 -- capable of performing basic analysis of pragma Refind_Global.
66 procedure Analyze_Initial_Condition_In_Decl_Part
(N
: Node_Id
);
67 -- Perform full analysis of delayed pragma Initial_Condition
69 procedure Analyze_Initializes_In_Decl_Part
(N
: Node_Id
);
70 -- Perform full analysis of delayed pragma Initializes
72 procedure Analyze_Pre_Post_Condition_In_Decl_Part
75 -- Perform preanalysis of a [refined] precondition or postcondition that
76 -- appears on a subprogram declaration or body [stub]. Prag denotes the
77 -- pragma, Subp_Id is the entity of the related subprogram. The preanalysis
78 -- of the expression is done as "spec expression" (see section "Handling
79 -- of Default and Per-Object Expressions in Sem).
81 procedure Analyze_Refined_Depends_In_Decl_Part
(N
: Node_Id
);
82 -- Preform full analysis of delayed pragma Refined_Depends. This routine
83 -- uses Analyze_Depends_In_Decl_Part as a starting point, then performs
84 -- various consistency checks between Depends and Refined_Depends.
86 procedure Analyze_Refined_Global_In_Decl_Part
(N
: Node_Id
);
87 -- Perform full analysis of delayed pragma Refined_Global. This routine
88 -- uses Analyze_Global_In_Decl_Part as a starting point, then performs
89 -- various consistency checks between Global and Refined_Global.
91 procedure Analyze_Refined_State_In_Decl_Part
(N
: Node_Id
);
92 -- Perform full analysis of delayed pragma Refined_State
94 procedure Analyze_Test_Case_In_Decl_Part
(N
: Node_Id
; S
: Entity_Id
);
95 -- Perform preanalysis of pragma Test_Case that applies to a subprogram
96 -- declaration. Parameter N denotes the pragma, S is the entity of the
97 -- related subprogram. The preanalysis of the expression is done as "spec
98 -- expression" (see section "Handling of Default and Per-Object Expressions
101 procedure Check_Applicable_Policy
(N
: Node_Id
);
102 -- N is either an N_Aspect or an N_Pragma node. There are two cases. If
103 -- the name of the aspect or pragma is not one of those recognized as
104 -- an assertion kind by an Assertion_Policy pragma, then the call has
105 -- no effect. Note that in the case of a pragma derived from an aspect,
106 -- the name we use for the purpose of this procedure is the aspect name,
107 -- which may be different from the pragma name (e.g. Precondition for
108 -- Pre aspect). In addition, 'Class aspects are recognized (and the
109 -- corresponding special names used in the processing).
111 -- If the name is a valid assertion kind name, then the Check_Policy pragma
112 -- chain is checked for a matching entry (or for an Assertion entry which
113 -- matches all possibilities). If a matching entry is found then the policy
114 -- is checked. If it is On or Check, then the Is_Checked flag is set in
115 -- the aspect or pragma node. If it is Off, Ignore, or Disable, then the
116 -- Is_Ignored flag is set in the aspect or pragma node. Additionally for
117 -- policy Disable, the Is_Disabled flag is set.
119 -- If no matching Check_Policy pragma is found then the effect depends on
120 -- whether -gnata was used, if so, then the call has no effect, otherwise
121 -- Is_Ignored (but not Is_Disabled) is set True.
123 function Delay_Config_Pragma_Analyze
(N
: Node_Id
) return Boolean;
124 -- N is a pragma appearing in a configuration pragma file. Most such
125 -- pragmas are analyzed when the file is read, before parsing and analyzing
126 -- the main unit. However, the analysis of certain pragmas results in
127 -- adding information to the compiled main unit, and this cannot be done
128 -- till the main unit is processed. Such pragmas return True from this
129 -- function and in Frontend pragmas where Delay_Config_Pragma_Analyze is
130 -- True have their analysis delayed until after the main program is parsed
133 function Get_SPARK_Mode_Id
(N
: Node_Id
) return SPARK_Mode_Id
;
134 -- Given a pragma SPARK_Mode node, return the corresponding mode id
136 procedure Initialize
;
137 -- Initializes data structures used for pragma processing. Must be called
138 -- before analyzing each new main source program.
140 function Is_Config_Static_String
(Arg
: Node_Id
) return Boolean;
141 -- This is called for a configuration pragma that requires either string
142 -- literal or a concatenation of string literals. We cannot use normal
143 -- static string processing because it is too early in the case of the
144 -- pragma appearing in a configuration pragmas file. If Arg is of an
145 -- appropriate form, then this call obtains the string (doing any necessary
146 -- concatenations) and places it in Name_Buffer, setting Name_Len to its
147 -- length, and then returns True. If it is not of the correct form, then an
148 -- appropriate error message is posted, and False is returned.
150 function Is_Elaboration_SPARK_Mode
(N
: Node_Id
) return Boolean;
151 -- Determine whether pragma SPARK_Mode appears in the statement part of a
154 function Is_Non_Significant_Pragma_Reference
(N
: Node_Id
) return Boolean;
155 -- The node N is a node for an entity and the issue is whether the
156 -- occurrence is a reference for the purposes of giving warnings about
157 -- unreferenced variables. This function returns True if the reference is
158 -- not a reference from this point of view (e.g. the occurrence in a pragma
159 -- Pack) and False if it is a real reference (e.g. the occurrence in a
162 function Is_Pragma_String_Literal
(Par
: Node_Id
) return Boolean;
163 -- Given an N_Pragma_Argument_Association node, Par, which has the form of
164 -- an operator symbol, determines whether or not it should be treated as an
165 -- string literal. This is called by Sem_Ch6.Analyze_Operator_Symbol. If
166 -- True is returned, the argument is converted to a string literal. If
167 -- False is returned, then the argument is treated as an entity reference
170 function Is_Private_SPARK_Mode
(N
: Node_Id
) return Boolean;
171 -- Determine whether pragma SPARK_Mode appears in the private part of a
174 function Is_Valid_Assertion_Kind
(Nam
: Name_Id
) return Boolean;
175 -- Returns True if Nam is one of the names recognized as a valid assertion
176 -- kind by the Assertion_Policy pragma. Note that the 'Class cases are
177 -- represented by the corresponding special names Name_uPre, Name_uPost,
178 -- Name_uInviarnat, and Name_uType_Invariant (_Pre, _Post, _Invariant,
179 -- and _Type_Invariant).
181 procedure Make_Aspect_For_PPC_In_Gen_Sub_Decl
(Decl
: Node_Id
);
182 -- This routine makes aspects from precondition or postcondition pragmas
183 -- that appear within a generic subprogram declaration. Decl is the generic
184 -- subprogram declaration node. Note that the aspects are attached to the
185 -- generic copy and also to the orginal tree.
187 procedure Process_Compilation_Unit_Pragmas
(N
: Node_Id
);
188 -- Called at the start of processing compilation unit N to deal with any
189 -- special issues regarding pragmas. In particular, we have to deal with
190 -- Suppress_All at this stage, since it can appear after the unit instead
191 -- of before (actually we allow it to appear anywhere).
193 procedure Relocate_Pragmas_To_Body
194 (Subp_Body
: Node_Id
;
195 Target_Body
: Node_Id
:= Empty
);
196 -- Resocate all pragmas that follow and apply to subprogram body Subp_Body
197 -- to its own declaration list. Candidate pragmas are classified in table
198 -- Pragma_On_Body_Or_Stub_OK. If Target_Body is set, the pragma are moved
199 -- to the declarations of Target_Body. This formal should be set when
200 -- dealing with subprogram body stubs or expression functions.
202 procedure Set_Encoded_Interface_Name
(E
: Entity_Id
; S
: Node_Id
);
203 -- This routine is used to set an encoded interface name. The node S is an
204 -- N_String_Literal node for the external name to be set, and E is an
205 -- entity whose Interface_Name field is to be set. In the normal case where
206 -- S contains a name that is a valid C identifier, then S is simply set as
207 -- the value of the Interface_Name. Otherwise it is encoded. See the body
208 -- for details of the encoding. This encoding is only done on VMS systems,
209 -- since it seems pretty silly, but is needed to pass some dubious tests in