|
111
|
1 ------------------------------------------------------------------------------
|
|
|
2 -- --
|
|
|
3 -- GNAT COMPILER COMPONENTS --
|
|
|
4 -- --
|
|
|
5 -- S E M _ P R A G --
|
|
|
6 -- --
|
|
|
7 -- S p e c --
|
|
|
8 -- --
|
|
|
9 -- Copyright (C) 1992-2017, 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
|
|
|
26 -- Pragma handling is isolated in a separate package
|
|
|
27 -- (logically this processing belongs in chapter 4)
|
|
|
28
|
|
|
29 with Namet; use Namet;
|
|
|
30 with Opt; use Opt;
|
|
|
31 with Snames; use Snames;
|
|
|
32 with Types; use Types;
|
|
|
33
|
|
|
34 package Sem_Prag is
|
|
|
35
|
|
|
36 -- The following table lists all pragmas that emulate an Ada 2012 aspect
|
|
|
37
|
|
|
38 Aspect_Specifying_Pragma : constant array (Pragma_Id) of Boolean :=
|
|
|
39 (Pragma_Abstract_State => True,
|
|
|
40 Pragma_All_Calls_Remote => True,
|
|
|
41 Pragma_Annotate => True,
|
|
|
42 Pragma_Async_Readers => True,
|
|
|
43 Pragma_Async_Writers => True,
|
|
|
44 Pragma_Asynchronous => True,
|
|
|
45 Pragma_Atomic => True,
|
|
|
46 Pragma_Atomic_Components => True,
|
|
|
47 Pragma_Attach_Handler => True,
|
|
|
48 Pragma_Constant_After_Elaboration => True,
|
|
|
49 Pragma_Contract_Cases => True,
|
|
|
50 Pragma_Convention => True,
|
|
|
51 Pragma_CPU => True,
|
|
|
52 Pragma_Default_Initial_Condition => True,
|
|
|
53 Pragma_Default_Storage_Pool => True,
|
|
|
54 Pragma_Depends => True,
|
|
|
55 Pragma_Discard_Names => True,
|
|
|
56 Pragma_Dispatching_Domain => True,
|
|
|
57 Pragma_Effective_Reads => True,
|
|
|
58 Pragma_Effective_Writes => True,
|
|
|
59 Pragma_Elaborate_Body => True,
|
|
|
60 Pragma_Export => True,
|
|
|
61 Pragma_Extensions_Visible => True,
|
|
|
62 Pragma_Favor_Top_Level => True,
|
|
|
63 Pragma_Ghost => True,
|
|
|
64 Pragma_Global => True,
|
|
|
65 Pragma_Import => True,
|
|
|
66 Pragma_Independent => True,
|
|
|
67 Pragma_Independent_Components => True,
|
|
|
68 Pragma_Initial_Condition => True,
|
|
|
69 Pragma_Initializes => True,
|
|
|
70 Pragma_Inline => True,
|
|
|
71 Pragma_Inline_Always => True,
|
|
|
72 Pragma_Interrupt_Handler => True,
|
|
|
73 Pragma_Interrupt_Priority => True,
|
|
|
74 Pragma_Invariant => True,
|
|
|
75 Pragma_Linker_Section => True,
|
|
|
76 Pragma_Lock_Free => True,
|
|
|
77 Pragma_No_Elaboration_Code_All => True,
|
|
|
78 Pragma_No_Return => True,
|
|
|
79 Pragma_Obsolescent => True,
|
|
|
80 Pragma_Pack => True,
|
|
|
81 Pragma_Part_Of => True,
|
|
|
82 Pragma_Persistent_BSS => True,
|
|
|
83 Pragma_Post => True,
|
|
|
84 Pragma_Post_Class => True,
|
|
|
85 Pragma_Postcondition => True,
|
|
|
86 Pragma_Pre => True,
|
|
|
87 Pragma_Pre_Class => True,
|
|
|
88 Pragma_Precondition => True,
|
|
|
89 Pragma_Predicate => True,
|
|
|
90 Pragma_Preelaborable_Initialization => True,
|
|
|
91 Pragma_Preelaborate => True,
|
|
|
92 Pragma_Priority => True,
|
|
|
93 Pragma_Pure => True,
|
|
|
94 Pragma_Pure_Function => True,
|
|
|
95 Pragma_Refined_Depends => True,
|
|
|
96 Pragma_Refined_Global => True,
|
|
|
97 Pragma_Refined_Post => True,
|
|
|
98 Pragma_Refined_State => True,
|
|
|
99 Pragma_Relative_Deadline => True,
|
|
|
100 Pragma_Remote_Access_Type => True,
|
|
|
101 Pragma_Remote_Call_Interface => True,
|
|
|
102 Pragma_Remote_Types => True,
|
|
|
103 Pragma_Secondary_Stack_Size => True,
|
|
|
104 Pragma_Shared => True,
|
|
|
105 Pragma_Shared_Passive => True,
|
|
|
106 Pragma_Simple_Storage_Pool_Type => True,
|
|
|
107 Pragma_SPARK_Mode => True,
|
|
|
108 Pragma_Storage_Size => True,
|
|
|
109 Pragma_Suppress => True,
|
|
|
110 Pragma_Suppress_Debug_Info => True,
|
|
|
111 Pragma_Suppress_Initialization => True,
|
|
|
112 Pragma_Test_Case => True,
|
|
|
113 Pragma_Thread_Local_Storage => True,
|
|
|
114 Pragma_Type_Invariant => True,
|
|
|
115 Pragma_Unchecked_Union => True,
|
|
|
116 Pragma_Universal_Aliasing => True,
|
|
|
117 Pragma_Universal_Data => True,
|
|
|
118 Pragma_Unmodified => True,
|
|
|
119 Pragma_Unreferenced => True,
|
|
|
120 Pragma_Unreferenced_Objects => True,
|
|
|
121 Pragma_Unsuppress => True,
|
|
|
122 Pragma_Volatile => True,
|
|
|
123 Pragma_Volatile_Components => True,
|
|
|
124 Pragma_Volatile_Full_Access => True,
|
|
|
125 Pragma_Warnings => True,
|
|
|
126 others => False);
|
|
|
127
|
|
|
128 -- The following table lists all pragmas that act as an assertion
|
|
|
129 -- expression.
|
|
|
130
|
|
|
131 Assertion_Expression_Pragma : constant array (Pragma_Id) of Boolean :=
|
|
|
132 (Pragma_Assert => True,
|
|
|
133 Pragma_Assert_And_Cut => True,
|
|
|
134 Pragma_Assume => True,
|
|
|
135 Pragma_Check => True,
|
|
|
136 Pragma_Contract_Cases => True,
|
|
|
137 Pragma_Default_Initial_Condition => True,
|
|
|
138 Pragma_Initial_Condition => True,
|
|
|
139 Pragma_Invariant => True,
|
|
|
140 Pragma_Loop_Invariant => True,
|
|
|
141 Pragma_Loop_Variant => True,
|
|
|
142 Pragma_Post => True,
|
|
|
143 Pragma_Post_Class => True,
|
|
|
144 Pragma_Postcondition => True,
|
|
|
145 Pragma_Pre => True,
|
|
|
146 Pragma_Pre_Class => True,
|
|
|
147 Pragma_Precondition => True,
|
|
|
148 Pragma_Predicate => True,
|
|
|
149 Pragma_Refined_Post => True,
|
|
|
150 Pragma_Test_Case => True,
|
|
|
151 Pragma_Type_Invariant => True,
|
|
|
152 Pragma_Type_Invariant_Class => True,
|
|
|
153 others => False);
|
|
|
154
|
|
|
155 -- The following table lists all the implementation-defined pragmas that
|
|
|
156 -- should apply to the anonymous object produced by the analysis of a
|
|
|
157 -- single protected or task type. The table should be synchronized with
|
|
|
158 -- Aspect_On_Anonymous_Object_OK in unit Aspects.
|
|
|
159
|
|
|
160 Pragma_On_Anonymous_Object_OK : constant array (Pragma_Id) of Boolean :=
|
|
|
161 (Pragma_Depends => True,
|
|
|
162 Pragma_Global => True,
|
|
|
163 Pragma_Part_Of => True,
|
|
|
164 others => False);
|
|
|
165
|
|
|
166 -- The following table lists all the implementation-defined pragmas that
|
|
|
167 -- may apply to a body stub (no language defined pragmas apply). The table
|
|
|
168 -- should be synchronized with Aspect_On_Body_Or_Stub_OK in unit Aspects.
|
|
|
169
|
|
|
170 Pragma_On_Body_Or_Stub_OK : constant array (Pragma_Id) of Boolean :=
|
|
|
171 (Pragma_Refined_Depends => True,
|
|
|
172 Pragma_Refined_Global => True,
|
|
|
173 Pragma_Refined_Post => True,
|
|
|
174 Pragma_SPARK_Mode => True,
|
|
|
175 Pragma_Warnings => True,
|
|
|
176 others => False);
|
|
|
177
|
|
|
178 -- The following table lists all pragmas which are significant in SPARK and
|
|
|
179 -- as a result get translated into verification conditions. The table is an
|
|
|
180 -- amalgamation of the pragmas listed in SPARK RM 16.1 and internally added
|
|
|
181 -- entries.
|
|
|
182
|
|
|
183 Pragma_Significant_In_SPARK : constant array (Pragma_Id) of Boolean :=
|
|
|
184 (Pragma_All_Calls_Remote => False,
|
|
|
185 Pragma_Asynchronous => False,
|
|
|
186 Pragma_Default_Storage_Pool => False,
|
|
|
187 Pragma_Discard_Names => False,
|
|
|
188 Pragma_Dispatching_Domain => False,
|
|
|
189 Pragma_Priority_Specific_Dispatching => False,
|
|
|
190 Pragma_Remote_Call_Interface => False,
|
|
|
191 Pragma_Remote_Types => False,
|
|
|
192 Pragma_Shared_Passive => False,
|
|
|
193 Pragma_Task_Dispatching_Policy => False,
|
|
|
194 Pragma_Warnings => False,
|
|
|
195 others => True);
|
|
|
196
|
|
|
197 -----------------
|
|
|
198 -- Subprograms --
|
|
|
199 -----------------
|
|
|
200
|
|
|
201 procedure Analyze_Pragma (N : Node_Id);
|
|
|
202 -- Analyze procedure for pragma reference node N
|
|
|
203
|
|
|
204 procedure Analyze_Contract_Cases_In_Decl_Part
|
|
|
205 (N : Node_Id;
|
|
|
206 Freeze_Id : Entity_Id := Empty);
|
|
|
207 -- Perform full analysis of delayed pragma Contract_Cases. Freeze_Id is the
|
|
|
208 -- entity of [generic] package body or [generic] subprogram body which
|
|
|
209 -- caused "freezing" of the related contract where the pragma resides.
|
|
|
210
|
|
|
211 procedure Analyze_Depends_In_Decl_Part (N : Node_Id);
|
|
|
212 -- Perform full analysis of delayed pragma Depends. This routine is also
|
|
|
213 -- capable of performing basic analysis of pragma Refined_Depends.
|
|
|
214
|
|
|
215 procedure Analyze_External_Property_In_Decl_Part
|
|
|
216 (N : Node_Id;
|
|
|
217 Expr_Val : out Boolean);
|
|
|
218 -- Perform full analysis of delayed pragmas Async_Readers, Async_Writers,
|
|
|
219 -- Effective_Reads and Effective_Writes. Flag Expr_Val contains the Boolean
|
|
|
220 -- argument of the pragma or a default True if no argument is present.
|
|
|
221
|
|
|
222 procedure Analyze_Global_In_Decl_Part (N : Node_Id);
|
|
|
223 -- Perform full analysis of delayed pragma Global. This routine is also
|
|
|
224 -- capable of performing basic analysis of pragma Refined_Global.
|
|
|
225
|
|
|
226 procedure Analyze_Initial_Condition_In_Decl_Part (N : Node_Id);
|
|
|
227 -- Perform full analysis of delayed pragma Initial_Condition
|
|
|
228
|
|
|
229 procedure Analyze_Initializes_In_Decl_Part (N : Node_Id);
|
|
|
230 -- Perform full analysis of delayed pragma Initializes
|
|
|
231
|
|
|
232 procedure Analyze_Part_Of_In_Decl_Part
|
|
|
233 (N : Node_Id;
|
|
|
234 Freeze_Id : Entity_Id := Empty);
|
|
|
235 -- Perform full analysis of delayed pragma Part_Of. Freeze_Id is the entity
|
|
|
236 -- of [generic] package body or [generic] subprogram body which caused the
|
|
|
237 -- "freezing" of the related contract where the pragma resides.
|
|
|
238
|
|
|
239 procedure Analyze_Pre_Post_Condition_In_Decl_Part
|
|
|
240 (N : Node_Id;
|
|
|
241 Freeze_Id : Entity_Id := Empty);
|
|
|
242 -- Perform full analysis of pragmas Precondition and Postcondition.
|
|
|
243 -- Freeze_Id denotes the entity of [generic] package body or [generic]
|
|
|
244 -- subprogram body which caused "freezing" of the related contract where
|
|
|
245 -- the pragma resides.
|
|
|
246
|
|
|
247 procedure Analyze_Refined_Depends_In_Decl_Part (N : Node_Id);
|
|
|
248 -- Preform full analysis of delayed pragma Refined_Depends. This routine
|
|
|
249 -- uses Analyze_Depends_In_Decl_Part as a starting point, then performs
|
|
|
250 -- various consistency checks between Depends and Refined_Depends.
|
|
|
251
|
|
|
252 procedure Analyze_Refined_Global_In_Decl_Part (N : Node_Id);
|
|
|
253 -- Perform full analysis of delayed pragma Refined_Global. This routine
|
|
|
254 -- uses Analyze_Global_In_Decl_Part as a starting point, then performs
|
|
|
255 -- various consistency checks between Global and Refined_Global.
|
|
|
256
|
|
|
257 procedure Analyze_Refined_State_In_Decl_Part
|
|
|
258 (N : Node_Id;
|
|
|
259 Freeze_Id : Entity_Id := Empty);
|
|
|
260 -- Perform full analysis of delayed pragma Refined_State. Freeze_Id denotes
|
|
|
261 -- the entity of [generic] package body or [generic] subprogram body which
|
|
|
262 -- caused "freezing" of the related contract where the pragma resides.
|
|
|
263
|
|
|
264 procedure Analyze_Test_Case_In_Decl_Part (N : Node_Id);
|
|
|
265 -- Perform preanalysis of pragma Test_Case
|
|
|
266
|
|
|
267 function Build_Pragma_Check_Equivalent
|
|
|
268 (Prag : Node_Id;
|
|
|
269 Subp_Id : Entity_Id := Empty;
|
|
|
270 Inher_Id : Entity_Id := Empty;
|
|
|
271 Keep_Pragma_Id : Boolean := False) return Node_Id;
|
|
|
272 -- Transform a pre- or [refined] postcondition denoted by Prag into an
|
|
|
273 -- equivalent pragma Check. When the pre- or postcondition is inherited,
|
|
|
274 -- the routine replaces the references of all formals of Inher_Id
|
|
|
275 -- and primitive operations of its controlling type by references
|
|
|
276 -- to the corresponding entities of Subp_Id and the descendant type.
|
|
|
277 -- Keep_Pragma_Id is True when the newly created pragma should be
|
|
|
278 -- in fact of the same kind as the source pragma Prag. This is used
|
|
|
279 -- in GNATprove_Mode to generate the inherited pre- and postconditions.
|
|
|
280
|
|
|
281 procedure Check_Applicable_Policy (N : Node_Id);
|
|
|
282 -- N is either an N_Aspect or an N_Pragma node. There are two cases. If
|
|
|
283 -- the name of the aspect or pragma is not one of those recognized as
|
|
|
284 -- an assertion kind by an Assertion_Policy pragma, then the call has
|
|
|
285 -- no effect. Note that in the case of a pragma derived from an aspect,
|
|
|
286 -- the name we use for the purpose of this procedure is the aspect name,
|
|
|
287 -- which may be different from the pragma name (e.g. Precondition for
|
|
|
288 -- Pre aspect). In addition, 'Class aspects are recognized (and the
|
|
|
289 -- corresponding special names used in the processing).
|
|
|
290 --
|
|
|
291 -- If the name is a valid assertion kind name, then the Check_Policy pragma
|
|
|
292 -- chain is checked for a matching entry (or for an Assertion entry which
|
|
|
293 -- matches all possibilities). If a matching entry is found then the policy
|
|
|
294 -- is checked. If it is On or Check, then the Is_Checked flag is set in
|
|
|
295 -- the aspect or pragma node. If it is Off, Ignore, or Disable, then the
|
|
|
296 -- Is_Ignored flag is set in the aspect or pragma node. Additionally for
|
|
|
297 -- policy Disable, the Is_Disabled flag is set.
|
|
|
298 --
|
|
|
299 -- If no matching Check_Policy pragma is found then the effect depends on
|
|
|
300 -- whether -gnata was used, if so, then the call has no effect, otherwise
|
|
|
301 -- Is_Ignored (but not Is_Disabled) is set True.
|
|
|
302
|
|
|
303 procedure Check_External_Properties
|
|
|
304 (Item : Node_Id;
|
|
|
305 AR : Boolean;
|
|
|
306 AW : Boolean;
|
|
|
307 ER : Boolean;
|
|
|
308 EW : Boolean);
|
|
|
309 -- Flags AR, AW, ER and EW denote the static values of external properties
|
|
|
310 -- Async_Readers, Async_Writers, Effective_Reads and Effective_Writes. Item
|
|
|
311 -- is the related variable or state. Ensure legality of the combination and
|
|
|
312 -- issue an error for an illegal combination.
|
|
|
313
|
|
|
314 function Check_Kind (Nam : Name_Id) return Name_Id;
|
|
|
315 -- This function is used in connection with pragmas Assert, Check,
|
|
|
316 -- and assertion aspects and pragmas, to determine if Check pragmas
|
|
|
317 -- (or corresponding assertion aspects or pragmas) are currently active
|
|
|
318 -- as determined by the presence of -gnata on the command line (which
|
|
|
319 -- sets the default), and the appearance of pragmas Check_Policy and
|
|
|
320 -- Assertion_Policy as configuration pragmas either in a configuration
|
|
|
321 -- pragma file, or at the start of the current unit, or locally given
|
|
|
322 -- Check_Policy and Assertion_Policy pragmas that are currently active.
|
|
|
323 --
|
|
|
324 -- The value returned is one of the names Check, Ignore, Disable (On
|
|
|
325 -- returns Check, and Off returns Ignore).
|
|
|
326 --
|
|
|
327 -- Note: for assertion kinds Pre'Class, Post'Class, Invariant'Class,
|
|
|
328 -- and Type_Invariant'Class, the name passed is Name_uPre, Name_uPost,
|
|
|
329 -- Name_uInvariant, or Name_uType_Invariant, which corresponds to _Pre,
|
|
|
330 -- _Post, _Invariant, or _Type_Invariant, which are special names used
|
|
|
331 -- in identifiers to represent these attribute references.
|
|
|
332
|
|
|
333 procedure Check_Missing_Part_Of (Item_Id : Entity_Id);
|
|
|
334 -- Determine whether the placement within the state space of an abstract
|
|
|
335 -- state, variable or package instantiation denoted by Item_Id requires the
|
|
|
336 -- use of indicator/option Part_Of. If this is the case, emit an error.
|
|
|
337
|
|
|
338 procedure Collect_Inherited_Class_Wide_Conditions (Subp : Entity_Id);
|
|
|
339 -- In GNATprove mode, when analyzing an overriding subprogram, check
|
|
|
340 -- whether the overridden operations have class-wide pre/postconditions,
|
|
|
341 -- and generate the corresponding pragmas. The pragmas are inserted after
|
|
|
342 -- the subprogram declaration, together with those generated for other
|
|
|
343 -- aspects of the subprogram.
|
|
|
344
|
|
|
345 procedure Collect_Subprogram_Inputs_Outputs
|
|
|
346 (Subp_Id : Entity_Id;
|
|
|
347 Synthesize : Boolean := False;
|
|
|
348 Subp_Inputs : in out Elist_Id;
|
|
|
349 Subp_Outputs : in out Elist_Id;
|
|
|
350 Global_Seen : out Boolean);
|
|
|
351 -- Subsidiary to the analysis of pragmas Depends, Global, Refined_Depends
|
|
|
352 -- and Refined_Global. The routine is also used by GNATprove. Collect all
|
|
|
353 -- inputs and outputs of subprogram Subp_Id in lists Subp_Inputs (inputs)
|
|
|
354 -- and Subp_Outputs (outputs). The inputs and outputs are gathered from:
|
|
|
355 -- 1) The formal parameters of the subprogram
|
|
|
356 -- 2) The generic formal parameters of the generic subprogram
|
|
|
357 -- 3) The current instance of a concurrent type
|
|
|
358 -- 4) The items of pragma [Refined_]Global
|
|
|
359 -- or
|
|
|
360 -- 5) The items of pragma [Refined_]Depends if there is no pragma
|
|
|
361 -- [Refined_]Global present and flag Synthesize is set to True.
|
|
|
362 -- If the subprogram has no inputs and/or outputs, then the returned list
|
|
|
363 -- is No_Elist. Flag Global_Seen is set when the related subprogram has
|
|
|
364 -- pragma [Refined_]Global.
|
|
|
365
|
|
|
366 function Delay_Config_Pragma_Analyze (N : Node_Id) return Boolean;
|
|
|
367 -- N is a pragma appearing in a configuration pragma file. Most such
|
|
|
368 -- pragmas are analyzed when the file is read, before parsing and analyzing
|
|
|
369 -- the main unit. However, the analysis of certain pragmas results in
|
|
|
370 -- adding information to the compiled main unit, and this cannot be done
|
|
|
371 -- till the main unit is processed. Such pragmas return True from this
|
|
|
372 -- function and in Frontend pragmas where Delay_Config_Pragma_Analyze is
|
|
|
373 -- True have their analysis delayed until after the main program is parsed
|
|
|
374 -- and analyzed.
|
|
|
375
|
|
|
376 function Find_Related_Package_Or_Body
|
|
|
377 (Prag : Node_Id;
|
|
|
378 Do_Checks : Boolean := False) return Node_Id;
|
|
|
379 -- Subsidiary to the analysis of pragmas
|
|
|
380 -- Abstract_State
|
|
|
381 -- Initial_Condition
|
|
|
382 -- Initializes
|
|
|
383 -- Refined_State
|
|
|
384 -- Find the declaration of the related package [body] subject to pragma
|
|
|
385 -- Prag. The return value is either N_Package_Declaration, N_Package_Body,
|
|
|
386 -- or Empty if the placement of the pragma is illegal. If flag Do_Checks is
|
|
|
387 -- set, the routine reports duplicate pragmas.
|
|
|
388
|
|
|
389 function Find_Related_Declaration_Or_Body
|
|
|
390 (Prag : Node_Id;
|
|
|
391 Do_Checks : Boolean := False) return Node_Id;
|
|
|
392 -- Subsidiary to the analysis of pragmas
|
|
|
393 -- Contract_Cases
|
|
|
394 -- Depends
|
|
|
395 -- Extensions_Visible
|
|
|
396 -- Global
|
|
|
397 -- Initializes
|
|
|
398 -- Max_Queue_Length
|
|
|
399 -- Post
|
|
|
400 -- Post_Class
|
|
|
401 -- Postcondition
|
|
|
402 -- Pre
|
|
|
403 -- Pre_Class
|
|
|
404 -- Precondition
|
|
|
405 -- Refined_Depends
|
|
|
406 -- Refined_Global
|
|
|
407 -- Refined_Post
|
|
|
408 -- Refined_State
|
|
|
409 -- Test_Case
|
|
|
410 -- Volatile_Function
|
|
|
411 -- as well as attributes 'Old and 'Result. Find the declaration of the
|
|
|
412 -- related entry, subprogram or task type [body] subject to pragma Prag.
|
|
|
413 -- If flag Do_Checks is set, the routine reports duplicate pragmas and
|
|
|
414 -- detects improper use of refinement pragmas in stand alone expression
|
|
|
415 -- functions.
|
|
|
416
|
|
|
417 function Get_Argument
|
|
|
418 (Prag : Node_Id;
|
|
|
419 Context_Id : Node_Id := Empty) return Node_Id;
|
|
|
420 -- Obtain the argument of pragma Prag depending on context and the nature
|
|
|
421 -- of the pragma. The argument is extracted in the following manner:
|
|
|
422 --
|
|
|
423 -- When the pragma is generated from an aspect, return the corresponding
|
|
|
424 -- aspect for ASIS or when Context_Id denotes a generic unit.
|
|
|
425 --
|
|
|
426 -- Otherwise return the first argument of Prag
|
|
|
427 --
|
|
|
428 -- Context denotes the entity of the function, package or procedure where
|
|
|
429 -- Prag resides.
|
|
|
430
|
|
|
431 function Get_SPARK_Mode_From_Annotation
|
|
|
432 (N : Node_Id) return SPARK_Mode_Type;
|
|
|
433 -- Given an aspect or pragma SPARK_Mode node, return corresponding mode id
|
|
|
434
|
|
|
435 procedure Initialize;
|
|
|
436 -- Initializes data structures used for pragma processing. Must be called
|
|
|
437 -- before analyzing each new main source program.
|
|
|
438
|
|
|
439 function Is_Config_Static_String (Arg : Node_Id) return Boolean;
|
|
|
440 -- This is called for a configuration pragma that requires either string
|
|
|
441 -- literal or a concatenation of string literals. We cannot use normal
|
|
|
442 -- static string processing because it is too early in the case of the
|
|
|
443 -- pragma appearing in a configuration pragmas file. If Arg is of an
|
|
|
444 -- appropriate form, then this call obtains the string (doing any necessary
|
|
|
445 -- concatenations) and places it in Name_Buffer, setting Name_Len to its
|
|
|
446 -- length, and then returns True. If it is not of the correct form, then an
|
|
|
447 -- appropriate error message is posted, and False is returned.
|
|
|
448
|
|
|
449 function Is_Elaboration_SPARK_Mode (N : Node_Id) return Boolean;
|
|
|
450 -- Determine whether pragma SPARK_Mode appears in the statement part of a
|
|
|
451 -- package body.
|
|
|
452
|
|
|
453 function Is_Enabled_Pragma (Prag : Node_Id) return Boolean;
|
|
|
454 -- Determine whether a Boolean-like SPARK pragma Prag is enabled. To be
|
|
|
455 -- considered enabled, the pragma must either:
|
|
|
456 -- * Appear without its Boolean expression
|
|
|
457 -- * The Boolean expression evaluates to "True"
|
|
|
458 --
|
|
|
459 -- Boolean-like SPARK pragmas differ from pure Boolean Ada pragmas in that
|
|
|
460 -- their optional Boolean expression must be static and cannot benefit from
|
|
|
461 -- forward references. The following are Boolean-like SPARK pragmas:
|
|
|
462 -- Async_Readers
|
|
|
463 -- Async_Writers
|
|
|
464 -- Constant_After_Elaboration
|
|
|
465 -- Effective_Reads
|
|
|
466 -- Effective_Writes
|
|
|
467 -- Extensions_Visible
|
|
|
468 -- Volatile_Function
|
|
|
469
|
|
|
470 function Is_Non_Significant_Pragma_Reference (N : Node_Id) return Boolean;
|
|
|
471 -- The node N is a node for an entity and the issue is whether the
|
|
|
472 -- occurrence is a reference for the purposes of giving warnings about
|
|
|
473 -- unreferenced variables. This function returns True if the reference is
|
|
|
474 -- not a reference from this point of view (e.g. the occurrence in a pragma
|
|
|
475 -- Pack) and False if it is a real reference (e.g. the occurrence in a
|
|
|
476 -- pragma Export);
|
|
|
477
|
|
|
478 function Is_Pragma_String_Literal (Par : Node_Id) return Boolean;
|
|
|
479 -- Given an N_Pragma_Argument_Association node, Par, which has the form of
|
|
|
480 -- an operator symbol, determines whether or not it should be treated as an
|
|
|
481 -- string literal. This is called by Sem_Ch6.Analyze_Operator_Symbol. If
|
|
|
482 -- True is returned, the argument is converted to a string literal. If
|
|
|
483 -- False is returned, then the argument is treated as an entity reference
|
|
|
484 -- to the operator.
|
|
|
485
|
|
|
486 function Is_Private_SPARK_Mode (N : Node_Id) return Boolean;
|
|
|
487 -- Determine whether pragma SPARK_Mode appears in the private part of a
|
|
|
488 -- package.
|
|
|
489
|
|
|
490 function Is_Valid_Assertion_Kind (Nam : Name_Id) return Boolean;
|
|
|
491 -- Returns True if Nam is one of the names recognized as a valid assertion
|
|
|
492 -- kind by the Assertion_Policy pragma. Note that the 'Class cases are
|
|
|
493 -- represented by the corresponding special names Name_uPre, Name_uPost,
|
|
|
494 -- Name_uInvariant, and Name_uType_Invariant (_Pre, _Post, _Invariant,
|
|
|
495 -- and _Type_Invariant).
|
|
|
496
|
|
|
497 procedure Process_Compile_Time_Warning_Or_Error
|
|
|
498 (N : Node_Id;
|
|
|
499 Eloc : Source_Ptr);
|
|
|
500 -- Common processing for Compile_Time_Error and Compile_Time_Warning of
|
|
|
501 -- pragma N. Called when the pragma is processed as part of its regular
|
|
|
502 -- analysis but also called after calling the back end to validate these
|
|
|
503 -- pragmas for size and alignment appropriateness.
|
|
|
504
|
|
|
505 procedure Process_Compilation_Unit_Pragmas (N : Node_Id);
|
|
|
506 -- Called at the start of processing compilation unit N to deal with any
|
|
|
507 -- special issues regarding pragmas. In particular, we have to deal with
|
|
|
508 -- Suppress_All at this stage, since it can appear after the unit instead
|
|
|
509 -- of before (actually we allow it to appear anywhere).
|
|
|
510
|
|
|
511 procedure Relocate_Pragmas_To_Anonymous_Object
|
|
|
512 (Typ_Decl : Node_Id;
|
|
|
513 Obj_Decl : Node_Id);
|
|
|
514 -- Relocate all pragmas that appear in the visible declarations of task or
|
|
|
515 -- protected type declaration Typ_Decl after the declaration of anonymous
|
|
|
516 -- object Obj_Decl. Table Pragmas_On_Anonymous_Object_OK contains the list
|
|
|
517 -- of candidate pragmas.
|
|
|
518
|
|
|
519 procedure Relocate_Pragmas_To_Body
|
|
|
520 (Subp_Body : Node_Id;
|
|
|
521 Target_Body : Node_Id := Empty);
|
|
|
522 -- Resocate all pragmas that follow and apply to subprogram body Subp_Body
|
|
|
523 -- to its own declaration list. Candidate pragmas are classified in table
|
|
|
524 -- Pragma_On_Body_Or_Stub_OK. If Target_Body is set, the pragma are moved
|
|
|
525 -- to the declarations of Target_Body. This formal should be set when
|
|
|
526 -- dealing with subprogram body stubs or expression functions.
|
|
|
527
|
|
|
528 procedure Set_Encoded_Interface_Name (E : Entity_Id; S : Node_Id);
|
|
|
529 -- This routine is used to set an encoded interface name. The node S is
|
|
|
530 -- an N_String_Literal node for the external name to be set, and E is an
|
|
|
531 -- entity whose Interface_Name field is to be set. In the normal case where
|
|
|
532 -- S contains a name that is a valid C identifier, then S is simply set as
|
|
|
533 -- the value of the Interface_Name. Otherwise it is encoded as needed by
|
|
|
534 -- particular operating systems. See the body for details of the encoding.
|
|
|
535
|
|
|
536 function Test_Case_Arg
|
|
|
537 (Prag : Node_Id;
|
|
|
538 Arg_Nam : Name_Id;
|
|
|
539 From_Aspect : Boolean := False) return Node_Id;
|
|
|
540 -- Obtain argument "Name", "Mode", "Ensures" or "Requires" from Test_Case
|
|
|
541 -- pragma Prag as denoted by Arg_Nam. When From_Aspect is set, an attempt
|
|
|
542 -- is made to retrieve the argument from the corresponding aspect if there
|
|
|
543 -- is one. The returned argument has several formats:
|
|
|
544 --
|
|
|
545 -- N_Pragma_Argument_Association if retrieved directly from the pragma
|
|
|
546 --
|
|
|
547 -- N_Component_Association if retrieved from the corresponding aspect and
|
|
|
548 -- the argument appears in a named association form.
|
|
|
549 --
|
|
|
550 -- An arbitrary expression if retrieved from the corresponding aspect and
|
|
|
551 -- the argument appears in positional form.
|
|
|
552 --
|
|
|
553 -- Empty if there is no such argument
|
|
|
554
|
|
|
555 end Sem_Prag;
|
