111
|
1 ------------------------------------------------------------------------------
|
|
2 -- --
|
|
3 -- GNAT COMPILER COMPONENTS --
|
|
4 -- --
|
|
5 -- S E M _ U T I L --
|
|
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 -- Package containing utility procedures used throughout the semantics
|
|
27
|
|
28 with Einfo; use Einfo;
|
|
29 with Exp_Tss; use Exp_Tss;
|
|
30 with Namet; use Namet;
|
|
31 with Opt; use Opt;
|
|
32 with Snames; use Snames;
|
|
33 with Types; use Types;
|
|
34 with Uintp; use Uintp;
|
|
35 with Urealp; use Urealp;
|
|
36
|
|
37 package Sem_Util is
|
|
38
|
|
39 function Abstract_Interface_List (Typ : Entity_Id) return List_Id;
|
|
40 -- The list of interfaces implemented by Typ. Empty if there are none,
|
|
41 -- including the cases where there can't be any because e.g. the type is
|
|
42 -- not tagged.
|
|
43
|
|
44 procedure Add_Access_Type_To_Process (E : Entity_Id; A : Entity_Id);
|
|
45 -- Add A to the list of access types to process when expanding the
|
|
46 -- freeze node of E.
|
|
47
|
|
48 procedure Add_Block_Identifier (N : Node_Id; Id : out Entity_Id);
|
|
49 -- Given a block statement N, generate an internal E_Block label and make
|
|
50 -- it the identifier of the block. Id denotes the generated entity. If the
|
|
51 -- block already has an identifier, Id returns the entity of its label.
|
|
52
|
|
53 procedure Add_Global_Declaration (N : Node_Id);
|
|
54 -- These procedures adds a declaration N at the library level, to be
|
|
55 -- elaborated before any other code in the unit. It is used for example
|
|
56 -- for the entity that marks whether a unit has been elaborated. The
|
|
57 -- declaration is added to the Declarations list of the Aux_Decls_Node
|
|
58 -- for the current unit. The declarations are added in the current scope,
|
|
59 -- so the caller should push a new scope as required before the call.
|
|
60
|
|
61 function Add_Suffix (E : Entity_Id; Suffix : Character) return Name_Id;
|
|
62 -- Returns the name of E adding Suffix
|
|
63
|
|
64 function Address_Integer_Convert_OK (T1, T2 : Entity_Id) return Boolean;
|
|
65 -- Given two types, returns True if we are in Allow_Integer_Address mode
|
|
66 -- and one of the types is (a descendant of) System.Address (and this type
|
|
67 -- is private), and the other type is any integer type.
|
|
68
|
|
69 function Address_Value (N : Node_Id) return Node_Id;
|
|
70 -- Return the underlying value of the expression N of an address clause
|
|
71
|
|
72 function Addressable (V : Uint) return Boolean;
|
|
73 function Addressable (V : Int) return Boolean;
|
|
74 pragma Inline (Addressable);
|
|
75 -- Returns True if the value of V is the word size or an addressable factor
|
|
76 -- of the word size (typically 8, 16, 32 or 64).
|
|
77
|
|
78 procedure Aggregate_Constraint_Checks
|
|
79 (Exp : Node_Id;
|
|
80 Check_Typ : Entity_Id);
|
|
81 -- Checks expression Exp against subtype Check_Typ. If Exp is an aggregate
|
|
82 -- and Check_Typ a constrained record type with discriminants, we generate
|
|
83 -- the appropriate discriminant checks. If Exp is an array aggregate then
|
|
84 -- emit the appropriate length checks. If Exp is a scalar type, or a string
|
|
85 -- literal, Exp is changed into Check_Typ'(Exp) to ensure that range checks
|
|
86 -- are performed at run time. Also used for expressions in the argument of
|
|
87 -- 'Update, which shares some of the features of an aggregate.
|
|
88
|
|
89 function Alignment_In_Bits (E : Entity_Id) return Uint;
|
|
90 -- If the alignment of the type or object E is currently known to the
|
|
91 -- compiler, then this function returns the alignment value in bits.
|
|
92 -- Otherwise Uint_0 is returned, indicating that the alignment of the
|
|
93 -- entity is not yet known to the compiler.
|
|
94
|
|
95 function All_Composite_Constraints_Static (Constr : Node_Id) return Boolean;
|
|
96 -- Used to implement pragma Restrictions (No_Dynamic_Sized_Objects).
|
|
97 -- Given a constraint or subtree of a constraint on a composite
|
|
98 -- subtype/object, returns True if there are no nonstatic constraints,
|
|
99 -- which might cause objects to be created with dynamic size.
|
|
100 -- Called for subtype declarations (including implicit ones created for
|
|
101 -- subtype indications in object declarations, as well as discriminated
|
|
102 -- record aggregate cases). For record aggregates, only records containing
|
|
103 -- discriminant-dependent arrays matter, because the discriminants must be
|
|
104 -- static when governing a variant part. Access discriminants are
|
|
105 -- irrelevant. Also called for array aggregates, but only named notation,
|
|
106 -- because those are the only dynamic cases.
|
|
107
|
|
108 procedure Append_Entity_Name (Buf : in out Bounded_String; E : Entity_Id);
|
|
109 -- Recursive procedure to construct string for qualified name of enclosing
|
|
110 -- program unit. The qualification stops at an enclosing scope has no
|
|
111 -- source name (block or loop). If entity is a subprogram instance, skip
|
|
112 -- enclosing wrapper package. The name is appended to Buf.
|
|
113
|
|
114 procedure Append_Inherited_Subprogram (S : Entity_Id);
|
|
115 -- If the parent of the operation is declared in the visible part of
|
|
116 -- the current scope, the inherited operation is visible even though the
|
|
117 -- derived type that inherits the operation may be completed in the private
|
|
118 -- part of the current package.
|
|
119
|
|
120 procedure Apply_Compile_Time_Constraint_Error
|
|
121 (N : Node_Id;
|
|
122 Msg : String;
|
|
123 Reason : RT_Exception_Code;
|
|
124 Ent : Entity_Id := Empty;
|
|
125 Typ : Entity_Id := Empty;
|
|
126 Loc : Source_Ptr := No_Location;
|
|
127 Rep : Boolean := True;
|
|
128 Warn : Boolean := False);
|
|
129 -- N is a subexpression which will raise constraint error when evaluated
|
|
130 -- at runtime. Msg is a message that explains the reason for raising the
|
|
131 -- exception. The last character is ? if the message is always a warning,
|
|
132 -- even in Ada 95, and is not a ? if the message represents an illegality
|
|
133 -- (because of violation of static expression rules) in Ada 95 (but not
|
|
134 -- in Ada 83). Typically this routine posts all messages at the Sloc of
|
|
135 -- node N. However, if Loc /= No_Location, Loc is the Sloc used to output
|
|
136 -- the message. After posting the appropriate message, and if the flag
|
|
137 -- Rep is set, this routine replaces the expression with an appropriate
|
|
138 -- N_Raise_Constraint_Error node using the given Reason code. This node
|
|
139 -- is then marked as being static if the original node is static, but
|
|
140 -- sets the flag Raises_Constraint_Error, preventing further evaluation.
|
|
141 -- The error message may contain a } or & insertion character. This
|
|
142 -- normally references Etype (N), unless the Ent argument is given
|
|
143 -- explicitly, in which case it is used instead. The type of the raise
|
|
144 -- node that is built is normally Etype (N), but if the Typ parameter
|
|
145 -- is present, this is used instead. Warn is normally False. If it is
|
|
146 -- True then the message is treated as a warning even though it does
|
|
147 -- not end with a ? (this is used when the caller wants to parameterize
|
|
148 -- whether an error or warning is given), or when the message should be
|
|
149 -- treated as a warning even when SPARK_Mode is On (which otherwise would
|
|
150 -- force an error).
|
|
151
|
|
152 function Async_Readers_Enabled (Id : Entity_Id) return Boolean;
|
|
153 -- Given the entity of an abstract state or a variable, determine whether
|
|
154 -- Id is subject to external property Async_Readers and if it is, the
|
|
155 -- related expression evaluates to True.
|
|
156
|
|
157 function Async_Writers_Enabled (Id : Entity_Id) return Boolean;
|
|
158 -- Given the entity of an abstract state or a variable, determine whether
|
|
159 -- Id is subject to external property Async_Writers and if it is, the
|
|
160 -- related expression evaluates to True.
|
|
161
|
|
162 function Available_Full_View_Of_Component (T : Entity_Id) return Boolean;
|
|
163 -- If at the point of declaration an array type has a private or limited
|
|
164 -- component, several array operations are not available on the type, and
|
|
165 -- the array type is flagged accordingly. If in the immediate scope of
|
|
166 -- the array type the component becomes non-private or non-limited, these
|
|
167 -- operations become available. This can happen if the scopes of both types
|
|
168 -- are open, and the scope of the array is not outside the scope of the
|
|
169 -- component.
|
|
170
|
|
171 procedure Bad_Attribute
|
|
172 (N : Node_Id;
|
|
173 Nam : Name_Id;
|
|
174 Warn : Boolean := False);
|
|
175 -- Called when node N is expected to contain a valid attribute name, and
|
|
176 -- Nam is found instead. If Warn is set True this is a warning, else this
|
|
177 -- is an error.
|
|
178
|
|
179 procedure Bad_Predicated_Subtype_Use
|
|
180 (Msg : String;
|
|
181 N : Node_Id;
|
|
182 Typ : Entity_Id;
|
|
183 Suggest_Static : Boolean := False);
|
|
184 -- This is called when Typ, a predicated subtype, is used in a context
|
|
185 -- which does not allow the use of a predicated subtype. Msg is passed to
|
|
186 -- Error_Msg_FE to output an appropriate message using N as the location,
|
|
187 -- and Typ as the entity. The caller must set up any insertions other than
|
|
188 -- the & for the type itself. Note that if Typ is a generic actual type,
|
|
189 -- then the message will be output as a warning, and a raise Program_Error
|
|
190 -- is inserted using Insert_Action with node N as the insertion point. Node
|
|
191 -- N also supplies the source location for construction of the raise node.
|
|
192 -- If Typ does not have any predicates, the call has no effect. Set flag
|
|
193 -- Suggest_Static when the context warrants an advice on how to avoid the
|
|
194 -- use error.
|
|
195
|
|
196 function Bad_Unordered_Enumeration_Reference
|
|
197 (N : Node_Id;
|
|
198 T : Entity_Id) return Boolean;
|
|
199 -- Node N contains a potentially dubious reference to type T, either an
|
|
200 -- explicit comparison, or an explicit range. This function returns True
|
|
201 -- if the type T is an enumeration type for which No pragma Order has been
|
|
202 -- given, and the reference N is not in the same extended source unit as
|
|
203 -- the declaration of T.
|
|
204
|
|
205 function Begin_Keyword_Location (N : Node_Id) return Source_Ptr;
|
|
206 -- Given block statement, entry body, package body, subprogram body, or
|
|
207 -- task body N, return the closest source location to the "begin" keyword.
|
|
208
|
|
209 function Build_Actual_Subtype
|
|
210 (T : Entity_Id;
|
|
211 N : Node_Or_Entity_Id) return Node_Id;
|
|
212 -- Build an anonymous subtype for an entity or expression, using the
|
|
213 -- bounds of the entity or the discriminants of the enclosing record.
|
|
214 -- T is the type for which the actual subtype is required, and N is either
|
|
215 -- a defining identifier, or any subexpression.
|
|
216
|
|
217 function Build_Actual_Subtype_Of_Component
|
|
218 (T : Entity_Id;
|
|
219 N : Node_Id) return Node_Id;
|
|
220 -- Determine whether a selected component has a type that depends on
|
|
221 -- discriminants, and build actual subtype for it if so.
|
|
222
|
|
223 -- Handling of inherited primitives whose ancestors have class-wide
|
|
224 -- pre/postconditions.
|
|
225
|
|
226 -- If a primitive operation of a parent type has a class-wide pre/post-
|
|
227 -- condition that includes calls to other primitives, and that operation
|
|
228 -- is inherited by a descendant type that also overrides some of these
|
|
229 -- other primitives, the condition that applies to the inherited
|
|
230 -- operation has a modified condition in which the overridden primitives
|
|
231 -- have been replaced by the primitives of the descendent type. A call
|
|
232 -- to the inherited operation cannot be simply a call to the parent
|
|
233 -- operation (with an appropriate conversion) as is the case for other
|
|
234 -- inherited operations, but must appear with a wrapper subprogram to which
|
|
235 -- the modified conditions apply. Furthermore the call to the parent
|
|
236 -- operation must not be subject to the original class-wide condition,
|
|
237 -- given that modified conditions apply. To implement these semantics
|
|
238 -- economically we create a subprogram body (a "class-wide clone") to
|
|
239 -- which no pre/postconditions apply, and we create bodies for the
|
|
240 -- original and the inherited operation that have their respective
|
|
241 -- pre/postconditions and simply call the clone. The following operations
|
|
242 -- take care of constructing declaration and body of the clone, and
|
|
243 -- building the calls to it within the appropriate wrappers.
|
|
244
|
|
245 procedure Build_Class_Wide_Clone_Body
|
|
246 (Spec_Id : Entity_Id;
|
|
247 Bod : Node_Id);
|
|
248 -- Build body of subprogram that has a class-wide condition that contains
|
|
249 -- calls to other primitives. Spec_Id is the Id of the subprogram, and B
|
|
250 -- is its source body, which becomes the body of the clone.
|
|
251
|
|
252 function Build_Class_Wide_Clone_Call
|
|
253 (Loc : Source_Ptr;
|
|
254 Decls : List_Id;
|
|
255 Spec_Id : Entity_Id;
|
|
256 Spec : Node_Id) return Node_Id;
|
|
257 -- Build a call to the common class-wide clone of a subprogram with
|
|
258 -- class-wide conditions. The body of the subprogram becomes a wrapper
|
|
259 -- for a call to the clone. The inherited operation becomes a similar
|
|
260 -- wrapper to which modified conditions apply, and the call to the
|
|
261 -- clone includes the proper conversion in a call the parent operation.
|
|
262
|
|
263 procedure Build_Class_Wide_Clone_Decl (Spec_Id : Entity_Id);
|
|
264 -- For a subprogram that has a class-wide condition that contains calls
|
|
265 -- to other primitives, build an internal subprogram that is invoked
|
|
266 -- through a type-specific wrapper for all inherited subprograms that
|
|
267 -- may have a modified condition.
|
|
268
|
|
269 function Build_Default_Subtype
|
|
270 (T : Entity_Id;
|
|
271 N : Node_Id) return Entity_Id;
|
|
272 -- If T is an unconstrained type with defaulted discriminants, build a
|
|
273 -- subtype constrained by the default values, insert the subtype
|
|
274 -- declaration in the tree before N, and return the entity of that
|
|
275 -- subtype. Otherwise, simply return T.
|
|
276
|
|
277 function Build_Discriminal_Subtype_Of_Component
|
|
278 (T : Entity_Id) return Node_Id;
|
|
279 -- Determine whether a record component has a type that depends on
|
|
280 -- discriminants, and build actual subtype for it if so.
|
|
281
|
|
282 procedure Build_Elaboration_Entity (N : Node_Id; Spec_Id : Entity_Id);
|
|
283 -- Given a compilation unit node N, allocate an elaboration counter for
|
|
284 -- the compilation unit, and install it in the Elaboration_Entity field
|
|
285 -- of Spec_Id, the entity for the compilation unit.
|
|
286
|
|
287 function Build_Overriding_Spec
|
|
288 (Op : Node_Id;
|
|
289 Typ : Entity_Id) return Node_Id;
|
|
290 -- Build a subprogram specification for the wrapper of an inherited
|
|
291 -- operation with a modified pre- or postcondition (See AI12-0113).
|
|
292 -- Op is the parent operation, and Typ is the descendant type that
|
|
293 -- inherits the operation.
|
|
294
|
|
295 procedure Build_Explicit_Dereference
|
|
296 (Expr : Node_Id;
|
|
297 Disc : Entity_Id);
|
|
298 -- AI05-139: Names with implicit dereference. If the expression N is a
|
|
299 -- reference type and the context imposes the corresponding designated
|
|
300 -- type, convert N into N.Disc.all. Such expressions are always over-
|
|
301 -- loaded with both interpretations, and the dereference interpretation
|
|
302 -- carries the name of the reference discriminant.
|
|
303
|
|
304 function Cannot_Raise_Constraint_Error (Expr : Node_Id) return Boolean;
|
|
305 -- Returns True if the expression cannot possibly raise Constraint_Error.
|
|
306 -- The response is conservative in the sense that a result of False does
|
|
307 -- not necessarily mean that CE could be raised, but a response of True
|
|
308 -- means that for sure CE cannot be raised.
|
|
309
|
|
310 procedure Check_Dynamically_Tagged_Expression
|
|
311 (Expr : Node_Id;
|
|
312 Typ : Entity_Id;
|
|
313 Related_Nod : Node_Id);
|
|
314 -- Check wrong use of dynamically tagged expression
|
|
315
|
|
316 procedure Check_Fully_Declared (T : Entity_Id; N : Node_Id);
|
|
317 -- Verify that the full declaration of type T has been seen. If not, place
|
|
318 -- error message on node N. Used in object declarations, type conversions
|
|
319 -- and qualified expressions.
|
|
320
|
|
321 procedure Check_Function_With_Address_Parameter (Subp_Id : Entity_Id);
|
|
322 -- A subprogram that has an Address parameter and is declared in a Pure
|
|
323 -- package is not considered Pure, because the parameter may be used as a
|
|
324 -- pointer and the referenced data may change even if the address value
|
|
325 -- itself does not.
|
|
326 -- If the programmer gave an explicit Pure_Function pragma, then we respect
|
|
327 -- the pragma and leave the subprogram Pure.
|
|
328
|
|
329 procedure Check_Function_Writable_Actuals (N : Node_Id);
|
|
330 -- (Ada 2012): If the construct N has two or more direct constituents that
|
|
331 -- are names or expressions whose evaluation may occur in an arbitrary
|
|
332 -- order, at least one of which contains a function call with an in out or
|
|
333 -- out parameter, then the construct is legal only if: for each name that
|
|
334 -- is passed as a parameter of mode in out or out to some inner function
|
|
335 -- call C2 (not including the construct N itself), there is no other name
|
|
336 -- anywhere within a direct constituent of the construct C other than
|
|
337 -- the one containing C2, that is known to refer to the same object (RM
|
|
338 -- 6.4.1(6.17/3)).
|
|
339
|
|
340 procedure Check_Implicit_Dereference (N : Node_Id; Typ : Entity_Id);
|
|
341 -- AI05-139-2: Accessors and iterators for containers. This procedure
|
|
342 -- checks whether T is a reference type, and if so it adds an interprettion
|
|
343 -- to N whose type is the designated type of the reference_discriminant.
|
|
344 -- If N is a generalized indexing operation, the interpretation is added
|
|
345 -- both to the corresponding function call, and to the indexing node.
|
|
346
|
|
347 procedure Check_Internal_Protected_Use (N : Node_Id; Nam : Entity_Id);
|
|
348 -- Within a protected function, the current object is a constant, and
|
|
349 -- internal calls to a procedure or entry are illegal. Similarly, other
|
|
350 -- uses of a protected procedure in a renaming or a generic instantiation
|
|
351 -- in the context of a protected function are illegal (AI05-0225).
|
|
352
|
|
353 procedure Check_Later_Vs_Basic_Declarations
|
|
354 (Decls : List_Id;
|
|
355 During_Parsing : Boolean);
|
|
356 -- If During_Parsing is True, check for misplacement of later vs basic
|
|
357 -- declarations in Ada 83. If During_Parsing is False, and the SPARK
|
|
358 -- restriction is set, do the same: although SPARK 95 removes the
|
|
359 -- distinction between initial and later declarative items, the distinction
|
|
360 -- remains in the Examiner (JB01-005). Note that the Examiner does not
|
|
361 -- count package declarations in later declarative items.
|
|
362
|
|
363 procedure Check_No_Hidden_State (Id : Entity_Id);
|
|
364 -- Determine whether object or state Id introduces a hidden state. If this
|
|
365 -- is the case, emit an error.
|
|
366
|
|
367 procedure Check_Nonvolatile_Function_Profile (Func_Id : Entity_Id);
|
|
368 -- Verify that the profile of nonvolatile function Func_Id does not contain
|
|
369 -- effectively volatile parameters or return type.
|
|
370
|
|
371 procedure Check_Part_Of_Reference (Var_Id : Entity_Id; Ref : Node_Id);
|
|
372 -- Verify the legality of reference Ref to variable Var_Id when the
|
|
373 -- variable is a constituent of a single protected/task type.
|
|
374
|
|
375 procedure Check_Potentially_Blocking_Operation (N : Node_Id);
|
|
376 -- N is one of the statement forms that is a potentially blocking
|
|
377 -- operation. If it appears within a protected action, emit warning.
|
|
378
|
|
379 procedure Check_Previous_Null_Procedure
|
|
380 (Decl : Node_Id;
|
|
381 Prev : Entity_Id);
|
|
382 -- A null procedure or a subprogram renaming can complete a previous
|
|
383 -- declaration, unless that previous declaration is itself a null
|
|
384 -- procedure. This must be treated specially because the analysis of
|
|
385 -- the null procedure leaves the corresponding entity as having no
|
|
386 -- completion, because its completion is provided by a generated body
|
|
387 -- inserted after all other declarations.
|
|
388
|
|
389 procedure Check_Result_And_Post_State (Subp_Id : Entity_Id);
|
|
390 -- Determine whether the contract of subprogram Subp_Id mentions attribute
|
|
391 -- 'Result and it contains an expression that evaluates differently in pre-
|
|
392 -- and post-state.
|
|
393
|
|
394 procedure Check_State_Refinements
|
|
395 (Context : Node_Id;
|
|
396 Is_Main_Unit : Boolean := False);
|
|
397 -- Verify that all abstract states declared in a block statement, entry
|
|
398 -- body, package body, protected body, subprogram body, task body, or a
|
|
399 -- package declaration denoted by Context have proper refinement. Emit an
|
|
400 -- error if this is not the case. Flag Is_Main_Unit should be set when
|
|
401 -- Context denotes the main compilation unit.
|
|
402
|
|
403 procedure Check_Unused_Body_States (Body_Id : Entity_Id);
|
|
404 -- Verify that all abstract states and objects declared in the state space
|
|
405 -- of package body Body_Id are used as constituents. Emit an error if this
|
|
406 -- is not the case.
|
|
407
|
|
408 procedure Check_Unprotected_Access
|
|
409 (Context : Node_Id;
|
|
410 Expr : Node_Id);
|
|
411 -- Check whether the expression is a pointer to a protected component,
|
|
412 -- and the context is external to the protected operation, to warn against
|
|
413 -- a possible unlocked access to data.
|
|
414
|
|
415 function Choice_List (N : Node_Id) return List_Id;
|
|
416 -- Utility to retrieve the choices of a Component_Association or the
|
|
417 -- Discrete_Choices of an Iterated_Component_Association. For various
|
|
418 -- reasons these nodes have a different structure even though they play
|
|
419 -- similar roles in array aggregates.
|
|
420
|
|
421 function Collect_Body_States (Body_Id : Entity_Id) return Elist_Id;
|
|
422 -- Gather the entities of all abstract states and objects declared in the
|
|
423 -- body state space of package body Body_Id.
|
|
424
|
|
425 procedure Collect_Interfaces
|
|
426 (T : Entity_Id;
|
|
427 Ifaces_List : out Elist_Id;
|
|
428 Exclude_Parents : Boolean := False;
|
|
429 Use_Full_View : Boolean := True);
|
|
430 -- Ada 2005 (AI-251): Collect whole list of abstract interfaces that are
|
|
431 -- directly or indirectly implemented by T. Exclude_Parents is used to
|
|
432 -- avoid the addition of inherited interfaces to the generated list.
|
|
433 -- Use_Full_View is used to collect the interfaces using the full-view
|
|
434 -- (if available).
|
|
435
|
|
436 procedure Collect_Interface_Components
|
|
437 (Tagged_Type : Entity_Id;
|
|
438 Components_List : out Elist_Id);
|
|
439 -- Ada 2005 (AI-251): Collect all the tag components associated with the
|
|
440 -- secondary dispatch tables of a tagged type.
|
|
441
|
|
442 procedure Collect_Interfaces_Info
|
|
443 (T : Entity_Id;
|
|
444 Ifaces_List : out Elist_Id;
|
|
445 Components_List : out Elist_Id;
|
|
446 Tags_List : out Elist_Id);
|
|
447 -- Ada 2005 (AI-251): Collect all the interfaces associated with T plus
|
|
448 -- the record component and tag associated with each of these interfaces.
|
|
449 -- On exit Ifaces_List, Components_List and Tags_List have the same number
|
|
450 -- of elements, and elements at the same position on these tables provide
|
|
451 -- information on the same interface type.
|
|
452
|
|
453 procedure Collect_Parents
|
|
454 (T : Entity_Id;
|
|
455 List : out Elist_Id;
|
|
456 Use_Full_View : Boolean := True);
|
|
457 -- Collect all the parents of Typ. Use_Full_View is used to collect them
|
|
458 -- using the full-view of private parents (if available).
|
|
459
|
|
460 function Collect_Primitive_Operations (T : Entity_Id) return Elist_Id;
|
|
461 -- Called upon type derivation and extension. We scan the declarative part
|
|
462 -- in which the type appears, and collect subprograms that have one
|
|
463 -- subsidiary subtype of the type. These subprograms can only appear after
|
|
464 -- the type itself.
|
|
465
|
|
466 function Compile_Time_Constraint_Error
|
|
467 (N : Node_Id;
|
|
468 Msg : String;
|
|
469 Ent : Entity_Id := Empty;
|
|
470 Loc : Source_Ptr := No_Location;
|
|
471 Warn : Boolean := False) return Node_Id;
|
|
472 -- This is similar to Apply_Compile_Time_Constraint_Error in that it
|
|
473 -- generates a warning (or error) message in the same manner, but it does
|
|
474 -- not replace any nodes. For convenience, the function always returns its
|
|
475 -- first argument. The message is a warning if the message ends with ?, or
|
|
476 -- we are operating in Ada 83 mode, or the Warn parameter is set to True.
|
|
477
|
|
478 procedure Conditional_Delay (New_Ent, Old_Ent : Entity_Id);
|
|
479 -- Sets the Has_Delayed_Freeze flag of New_Ent if the Delayed_Freeze flag
|
|
480 -- of Old_Ent is set and Old_Ent has not yet been Frozen (i.e. Is_Frozen is
|
|
481 -- False).
|
|
482
|
|
483 function Contains_Refined_State (Prag : Node_Id) return Boolean;
|
|
484 -- Determine whether pragma Prag contains a reference to the entity of an
|
|
485 -- abstract state with a visible refinement. Prag must denote one of the
|
|
486 -- following pragmas:
|
|
487 -- Depends
|
|
488 -- Global
|
|
489
|
|
490 function Copy_Component_List
|
|
491 (R_Typ : Entity_Id;
|
|
492 Loc : Source_Ptr) return List_Id;
|
|
493 -- Copy components from record type R_Typ that come from source. Used to
|
|
494 -- create a new compatible record type. Loc is the source location assigned
|
|
495 -- to the created nodes.
|
|
496
|
|
497 function Copy_Parameter_List (Subp_Id : Entity_Id) return List_Id;
|
|
498 -- Utility to create a parameter profile for a new subprogram spec, when
|
|
499 -- the subprogram has a body that acts as spec. This is done for some cases
|
|
500 -- of inlining, and for private protected ops. Also used to create bodies
|
|
501 -- for stubbed subprograms.
|
|
502
|
|
503 procedure Copy_SPARK_Mode_Aspect (From : Node_Id; To : Node_Id);
|
|
504 -- Copy the SPARK_Mode aspect if present in the aspect specifications
|
|
505 -- of node From to node To. On entry it is assumed that To does not have
|
|
506 -- aspect specifications. If From has no aspects, the routine has no
|
|
507 -- effect.
|
|
508
|
|
509 function Copy_Subprogram_Spec (Spec : Node_Id) return Node_Id;
|
|
510 -- Replicate a function or a procedure specification denoted by Spec. The
|
|
511 -- resulting tree is an exact duplicate of the original tree. New entities
|
|
512 -- are created for the unit name and the formal parameters.
|
|
513
|
|
514 function Corresponding_Generic_Type (T : Entity_Id) return Entity_Id;
|
|
515 -- If a type is a generic actual type, return the corresponding formal in
|
|
516 -- the generic parent unit. There is no direct link in the tree for this
|
|
517 -- attribute, except in the case of formal private and derived types.
|
|
518 -- Possible optimization???
|
|
519
|
|
520 function Current_Entity (N : Node_Id) return Entity_Id;
|
|
521 pragma Inline (Current_Entity);
|
|
522 -- Find the currently visible definition for a given identifier, that is to
|
|
523 -- say the first entry in the visibility chain for the Chars of N.
|
|
524
|
|
525 function Current_Entity_In_Scope (N : Node_Id) return Entity_Id;
|
|
526 -- Find whether there is a previous definition for identifier N in the
|
|
527 -- current scope. Because declarations for a scope are not necessarily
|
|
528 -- contiguous (e.g. for packages) the first entry on the visibility chain
|
|
529 -- for N is not necessarily in the current scope.
|
|
530
|
|
531 function Current_Scope return Entity_Id;
|
|
532 -- Get entity representing current scope
|
|
533
|
|
534 function Current_Scope_No_Loops return Entity_Id;
|
|
535 -- Return the current scope ignoring internally generated loops
|
|
536
|
|
537 function Current_Subprogram return Entity_Id;
|
|
538 -- Returns current enclosing subprogram. If Current_Scope is a subprogram,
|
|
539 -- then that is what is returned, otherwise the Enclosing_Subprogram of the
|
|
540 -- Current_Scope is returned. The returned value is Empty if this is called
|
|
541 -- from a library package which is not within any subprogram.
|
|
542
|
|
543 function Deepest_Type_Access_Level (Typ : Entity_Id) return Uint;
|
|
544 -- Same as Type_Access_Level, except that if the type is the type of an Ada
|
|
545 -- 2012 stand-alone object of an anonymous access type, then return the
|
|
546 -- static accesssibility level of the object. In that case, the dynamic
|
|
547 -- accessibility level of the object may take on values in a range. The low
|
|
548 -- bound of that range is returned by Type_Access_Level; this function
|
|
549 -- yields the high bound of that range. Also differs from Type_Access_Level
|
|
550 -- in the case of a descendant of a generic formal type (returns Int'Last
|
|
551 -- instead of 0).
|
|
552
|
|
553 function Defining_Entity
|
|
554 (N : Node_Id;
|
|
555 Empty_On_Errors : Boolean := False;
|
|
556 Concurrent_Subunit : Boolean := False) return Entity_Id;
|
|
557 -- Given a declaration N, returns the associated defining entity. If the
|
|
558 -- declaration has a specification, the entity is obtained from the
|
|
559 -- specification. If the declaration has a defining unit name, then the
|
|
560 -- defining entity is obtained from the defining unit name ignoring any
|
|
561 -- child unit prefixes.
|
|
562 --
|
|
563 -- Iterator loops also have a defining entity, which holds the list of
|
|
564 -- local entities declared during loop expansion. These entities need
|
|
565 -- debugging information, generated through Qualify_Entity_Names, and
|
|
566 -- the loop declaration must be placed in the table Name_Qualify_Units.
|
|
567 --
|
|
568 -- Set flag Empty_On_Error to change the behavior of this routine as
|
|
569 -- follows:
|
|
570 --
|
|
571 -- * True - A declaration that lacks a defining entity returns Empty.
|
|
572 -- A node that does not allow for a defining entity returns Empty.
|
|
573 --
|
|
574 -- * False - A declaration that lacks a defining entity is given a new
|
|
575 -- internally generated entity which is subsequently returned. A node
|
|
576 -- that does not allow for a defining entity raises Program_Error.
|
|
577 --
|
|
578 -- The former semantics is appropriate for the back end; the latter
|
|
579 -- semantics is appropriate for the front end.
|
|
580 --
|
|
581 -- Set flag Concurrent_Subunit to handle rewritings of concurrent bodies
|
|
582 -- which act as subunits. Such bodies are generally rewritten as null.
|
|
583
|
|
584 function Denotes_Discriminant
|
|
585 (N : Node_Id;
|
|
586 Check_Concurrent : Boolean := False) return Boolean;
|
|
587 -- Returns True if node N is an Entity_Name node for a discriminant. If the
|
|
588 -- flag Check_Concurrent is true, function also returns true when N denotes
|
|
589 -- the discriminal of the discriminant of a concurrent type. This is needed
|
|
590 -- to disable some optimizations on private components of protected types,
|
|
591 -- and constraint checks on entry families constrained by discriminants.
|
|
592
|
|
593 function Denotes_Same_Object (A1, A2 : Node_Id) return Boolean;
|
|
594 -- Detect suspicious overlapping between actuals in a call, when both are
|
|
595 -- writable (RM 2012 6.4.1(6.4/3))
|
|
596
|
|
597 function Denotes_Same_Prefix (A1, A2 : Node_Id) return Boolean;
|
|
598 -- Functions to detect suspicious overlapping between actuals in a call,
|
|
599 -- when one of them is writable. The predicates are those proposed in
|
|
600 -- AI05-0144, to detect dangerous order dependence in complex calls.
|
|
601 -- I would add a parameter Warn which enables more extensive testing of
|
|
602 -- cases as we find appropriate when we are only warning ??? Or perhaps
|
|
603 -- return an indication of (Error, Warn, OK) ???
|
|
604
|
|
605 function Denotes_Variable (N : Node_Id) return Boolean;
|
|
606 -- Returns True if node N denotes a single variable without parentheses
|
|
607
|
|
608 function Depends_On_Discriminant (N : Node_Id) return Boolean;
|
|
609 -- Returns True if N denotes a discriminant or if N is a range, a subtype
|
|
610 -- indication or a scalar subtype where one of the bounds is a
|
|
611 -- discriminant.
|
|
612
|
|
613 function Designate_Same_Unit
|
|
614 (Name1 : Node_Id;
|
|
615 Name2 : Node_Id) return Boolean;
|
|
616 -- Returns True if Name1 and Name2 designate the same unit name; each of
|
|
617 -- these names is supposed to be a selected component name, an expanded
|
|
618 -- name, a defining program unit name or an identifier.
|
|
619
|
|
620 procedure Diagnose_Iterated_Component_Association (N : Node_Id);
|
|
621 -- Emit an error if iterated component association N is actually an illegal
|
|
622 -- quantified expression lacking a quantifier.
|
|
623
|
|
624 function Dynamic_Accessibility_Level (Expr : Node_Id) return Node_Id;
|
|
625 -- Expr should be an expression of an access type. Builds an integer
|
|
626 -- literal except in cases involving anonymous access types where
|
|
627 -- accessibility levels are tracked at runtime (access parameters and Ada
|
|
628 -- 2012 stand-alone objects).
|
|
629
|
|
630 function Discriminated_Size (Comp : Entity_Id) return Boolean;
|
|
631 -- If a component size is not static then a warning will be emitted
|
|
632 -- in Ravenscar or other restricted contexts. When a component is non-
|
|
633 -- static because of a discriminant constraint we can specialize the
|
|
634 -- warning by mentioning discriminants explicitly. This was created for
|
|
635 -- private components of protected objects, but is generally useful when
|
|
636 -- retriction (No_Implicit_Heap_Allocation) is active.
|
|
637
|
|
638 function Effective_Extra_Accessibility (Id : Entity_Id) return Entity_Id;
|
|
639 -- Same as Einfo.Extra_Accessibility except thtat object renames
|
|
640 -- are looked through.
|
|
641
|
|
642 function Effective_Reads_Enabled (Id : Entity_Id) return Boolean;
|
|
643 -- Given the entity of an abstract state or a variable, determine whether
|
|
644 -- Id is subject to external property Effective_Reads and if it is, the
|
|
645 -- related expression evaluates to True.
|
|
646
|
|
647 function Effective_Writes_Enabled (Id : Entity_Id) return Boolean;
|
|
648 -- Given the entity of an abstract state or a variable, determine whether
|
|
649 -- Id is subject to external property Effective_Writes and if it is, the
|
|
650 -- related expression evaluates to True.
|
|
651
|
|
652 function Enclosing_Comp_Unit_Node (N : Node_Id) return Node_Id;
|
|
653 -- Returns the enclosing N_Compilation_Unit node that is the root of a
|
|
654 -- subtree containing N.
|
|
655
|
|
656 function Enclosing_CPP_Parent (Typ : Entity_Id) return Entity_Id;
|
|
657 -- Returns the closest ancestor of Typ that is a CPP type.
|
|
658
|
|
659 function Enclosing_Declaration (N : Node_Id) return Node_Id;
|
|
660 -- Returns the declaration node enclosing N (including possibly N itself),
|
|
661 -- if any, or Empty otherwise.
|
|
662
|
|
663 function Enclosing_Generic_Body (N : Node_Id) return Node_Id;
|
|
664 -- Returns the Node_Id associated with the innermost enclosing generic
|
|
665 -- body, if any. If none, then returns Empty.
|
|
666
|
|
667 function Enclosing_Generic_Unit (N : Node_Id) return Node_Id;
|
|
668 -- Returns the Node_Id associated with the innermost enclosing generic
|
|
669 -- unit, if any. If none, then returns Empty.
|
|
670
|
|
671 function Enclosing_Lib_Unit_Entity
|
|
672 (E : Entity_Id := Current_Scope) return Entity_Id;
|
|
673 -- Returns the entity of enclosing library unit node which is the root of
|
|
674 -- the current scope (which must not be Standard_Standard, and the caller
|
|
675 -- is responsible for ensuring this condition) or other specified entity.
|
|
676
|
|
677 function Enclosing_Lib_Unit_Node (N : Node_Id) return Node_Id;
|
|
678 -- Returns the N_Compilation_Unit node of the library unit that is directly
|
|
679 -- or indirectly (through a subunit) at the root of a subtree containing
|
|
680 -- N. This may be either the same as Enclosing_Comp_Unit_Node, or if
|
|
681 -- Enclosing_Comp_Unit_Node returns a subunit, then the corresponding
|
|
682 -- library unit. If no such item is found, returns Empty.
|
|
683
|
|
684 function Enclosing_Package (E : Entity_Id) return Entity_Id;
|
|
685 -- Utility function to return the Ada entity of the package enclosing
|
|
686 -- the entity E, if any. Returns Empty if no enclosing package.
|
|
687
|
|
688 function Enclosing_Package_Or_Subprogram (E : Entity_Id) return Entity_Id;
|
|
689 -- Returns the entity of the package or subprogram enclosing E, if any.
|
|
690 -- Returns Empty if no enclosing package or subprogram.
|
|
691
|
|
692 function Enclosing_Subprogram (E : Entity_Id) return Entity_Id;
|
|
693 -- Utility function to return the Ada entity of the subprogram enclosing
|
|
694 -- the entity E, if any. Returns Empty if no enclosing subprogram.
|
|
695
|
|
696 function End_Keyword_Location (N : Node_Id) return Source_Ptr;
|
|
697 -- Given block statement, entry body, package body, package declaration,
|
|
698 -- protected body, [single] protected type declaration, subprogram body,
|
|
699 -- task body, or [single] task type declaration N, return the closest
|
|
700 -- source location of the "end" keyword.
|
|
701
|
|
702 procedure Ensure_Freeze_Node (E : Entity_Id);
|
|
703 -- Make sure a freeze node is allocated for entity E. If necessary, build
|
|
704 -- and initialize a new freeze node and set Has_Delayed_Freeze True for E.
|
|
705
|
|
706 procedure Enter_Name (Def_Id : Entity_Id);
|
|
707 -- Insert new name in symbol table of current scope with check for
|
|
708 -- duplications (error message is issued if a conflict is found).
|
|
709 -- Note: Enter_Name is not used for overloadable entities, instead these
|
|
710 -- are entered using Sem_Ch6.Enter_Overloadable_Entity.
|
|
711
|
|
712 function Entity_Of (N : Node_Id) return Entity_Id;
|
|
713 -- Obtain the entity of arbitrary node N. If N is a renaming, return the
|
|
714 -- entity of the earliest renamed source abstract state or whole object.
|
|
715 -- If no suitable entity is available, return Empty.
|
|
716
|
|
717 procedure Explain_Limited_Type (T : Entity_Id; N : Node_Id);
|
|
718 -- This procedure is called after issuing a message complaining about an
|
|
719 -- inappropriate use of limited type T. If useful, it adds additional
|
|
720 -- continuation lines to the message explaining why type T is limited.
|
|
721 -- Messages are placed at node N.
|
|
722
|
|
723 function Expression_Of_Expression_Function
|
|
724 (Subp : Entity_Id) return Node_Id;
|
|
725 -- Return the expression of expression function Subp
|
|
726
|
|
727 type Extensions_Visible_Mode is
|
|
728 (Extensions_Visible_None,
|
|
729 -- Extensions_Visible does not yield a mode when SPARK_Mode is off. This
|
|
730 -- value acts as a default in a non-SPARK compilation.
|
|
731
|
|
732 Extensions_Visible_False,
|
|
733 -- A value of "False" signifies that Extensions_Visible is either
|
|
734 -- missing or the pragma is present and the value of its Boolean
|
|
735 -- expression is False.
|
|
736
|
|
737 Extensions_Visible_True);
|
|
738 -- A value of "True" signifies that Extensions_Visible is present and
|
|
739 -- the value of its Boolean expression is True.
|
|
740
|
|
741 function Extensions_Visible_Status
|
|
742 (Id : Entity_Id) return Extensions_Visible_Mode;
|
|
743 -- Given the entity of a subprogram or formal parameter subject to pragma
|
|
744 -- Extensions_Visible, return the Boolean value denoted by the expression
|
|
745 -- of the pragma.
|
|
746
|
|
747 procedure Find_Actual
|
|
748 (N : Node_Id;
|
|
749 Formal : out Entity_Id;
|
|
750 Call : out Node_Id);
|
|
751 -- Determines if the node N is an actual parameter of a function or a
|
|
752 -- procedure call. If so, then Formal points to the entity for the formal
|
|
753 -- (Ekind is E_In_Parameter, E_Out_Parameter, or E_In_Out_Parameter) and
|
|
754 -- Call is set to the node for the corresponding call. If the node N is not
|
|
755 -- an actual parameter then Formal and Call are set to Empty.
|
|
756
|
|
757 function Find_Body_Discriminal
|
|
758 (Spec_Discriminant : Entity_Id) return Entity_Id;
|
|
759 -- Given a discriminant of the record type that implements a task or
|
|
760 -- protected type, return the discriminal of the corresponding discriminant
|
|
761 -- of the actual concurrent type.
|
|
762
|
|
763 function Find_Corresponding_Discriminant
|
|
764 (Id : Node_Id;
|
|
765 Typ : Entity_Id) return Entity_Id;
|
|
766 -- Because discriminants may have different names in a generic unit and in
|
|
767 -- an instance, they are resolved positionally when possible. A reference
|
|
768 -- to a discriminant carries the discriminant that it denotes when it is
|
|
769 -- analyzed. Subsequent uses of this id on a different type denotes the
|
|
770 -- discriminant at the same position in this new type.
|
|
771
|
|
772 function Find_Enclosing_Iterator_Loop (Id : Entity_Id) return Entity_Id;
|
|
773 -- Find the nearest iterator loop which encloses arbitrary entity Id. If
|
|
774 -- such a loop exists, return the entity of its identifier (E_Loop scope),
|
|
775 -- otherwise return Empty.
|
|
776
|
|
777 function Find_Enclosing_Scope (N : Node_Id) return Entity_Id;
|
|
778 -- Find the nearest scope which encloses arbitrary node N
|
|
779
|
|
780 function Find_Loop_In_Conditional_Block (N : Node_Id) return Node_Id;
|
|
781 -- Find the nested loop statement in a conditional block. Loops subject to
|
|
782 -- attribute 'Loop_Entry are transformed into blocks. Parts of the original
|
|
783 -- loop are nested within the block.
|
|
784
|
|
785 procedure Find_Overlaid_Entity
|
|
786 (N : Node_Id;
|
|
787 Ent : out Entity_Id;
|
|
788 Off : out Boolean);
|
|
789 -- The node N should be an address representation clause. Determines if
|
|
790 -- the target expression is the address of an entity with an optional
|
|
791 -- offset. If so, set Ent to the entity and, if there is an offset, set
|
|
792 -- Off to True, otherwise to False. If N is not an address representation
|
|
793 -- clause, or if it is not possible to determine that the address is of
|
|
794 -- this form, then set Ent to Empty.
|
|
795
|
|
796 function Find_Parameter_Type (Param : Node_Id) return Entity_Id;
|
|
797 -- Return the type of formal parameter Param as determined by its
|
|
798 -- specification.
|
|
799
|
|
800 -- The following type describes the placement of an arbitrary entity with
|
|
801 -- respect to SPARK visible / hidden state space.
|
|
802
|
|
803 type State_Space_Kind is
|
|
804 (Not_In_Package,
|
|
805 -- An entity is not in the visible, private or body state space when
|
|
806 -- the immediate enclosing construct is not a package.
|
|
807
|
|
808 Visible_State_Space,
|
|
809 -- An entity is in the visible state space when it appears immediately
|
|
810 -- within the visible declarations of a package or when it appears in
|
|
811 -- the visible state space of a nested package which in turn is declared
|
|
812 -- in the visible declarations of an enclosing package:
|
|
813
|
|
814 -- package Pack is
|
|
815 -- Visible_Variable : ...
|
|
816 -- package Nested
|
|
817 -- with Abstract_State => Visible_State
|
|
818 -- is
|
|
819 -- Visible_Nested_Variable : ...
|
|
820 -- end Nested;
|
|
821 -- end Pack;
|
|
822
|
|
823 -- Entities associated with a package instantiation inherit the state
|
|
824 -- space from the instance placement:
|
|
825
|
|
826 -- generic
|
|
827 -- package Gen is
|
|
828 -- Generic_Variable : ...
|
|
829 -- end Gen;
|
|
830
|
|
831 -- with Gen;
|
|
832 -- package Pack is
|
|
833 -- package Inst is new Gen;
|
|
834 -- -- Generic_Variable is in the visible state space of Pack
|
|
835 -- end Pack;
|
|
836
|
|
837 Private_State_Space,
|
|
838 -- An entity is in the private state space when it appears immediately
|
|
839 -- within the private declarations of a package or when it appears in
|
|
840 -- the visible state space of a nested package which in turn is declared
|
|
841 -- in the private declarations of an enclosing package:
|
|
842
|
|
843 -- package Pack is
|
|
844 -- private
|
|
845 -- Private_Variable : ...
|
|
846 -- package Nested
|
|
847 -- with Abstract_State => Private_State
|
|
848 -- is
|
|
849 -- Private_Nested_Variable : ...
|
|
850 -- end Nested;
|
|
851 -- end Pack;
|
|
852
|
|
853 -- The same placement principle applies to package instantiations
|
|
854
|
|
855 Body_State_Space);
|
|
856 -- An entity is in the body state space when it appears immediately
|
|
857 -- within the declarations of a package body or when it appears in the
|
|
858 -- visible state space of a nested package which in turn is declared in
|
|
859 -- the declarations of an enclosing package body:
|
|
860
|
|
861 -- package body Pack is
|
|
862 -- Body_Variable : ...
|
|
863 -- package Nested
|
|
864 -- with Abstract_State => Body_State
|
|
865 -- is
|
|
866 -- Body_Nested_Variable : ...
|
|
867 -- end Nested;
|
|
868 -- end Pack;
|
|
869
|
|
870 -- The same placement principle applies to package instantiations
|
|
871
|
|
872 procedure Find_Placement_In_State_Space
|
|
873 (Item_Id : Entity_Id;
|
|
874 Placement : out State_Space_Kind;
|
|
875 Pack_Id : out Entity_Id);
|
|
876 -- Determine the state space placement of an item. Item_Id denotes the
|
|
877 -- entity of an abstract state, object or package instantiation. Placement
|
|
878 -- captures the precise placement of the item in the enclosing state space.
|
|
879 -- If the state space is that of a package, Pack_Id denotes its entity,
|
|
880 -- otherwise Pack_Id is Empty.
|
|
881
|
|
882 function Find_Specific_Type (CW : Entity_Id) return Entity_Id;
|
|
883 -- Find specific type of a class-wide type, and handle the case of an
|
|
884 -- incomplete type coming either from a limited_with clause or from an
|
|
885 -- incomplete type declaration. If resulting type is private return its
|
|
886 -- full view.
|
|
887
|
|
888 function Find_Static_Alternative (N : Node_Id) return Node_Id;
|
|
889 -- N is a case statement whose expression is a compile-time value.
|
|
890 -- Determine the alternative chosen, so that the code of non-selected
|
|
891 -- alternatives, and the warnings that may apply to them, are removed.
|
|
892
|
|
893 function First_Actual (Node : Node_Id) return Node_Id;
|
|
894 -- Node is an N_Function_Call, N_Procedure_Call_Statement or
|
|
895 -- N_Entry_Call_Statement node. The result returned is the first actual
|
|
896 -- parameter in declaration order (not the order of parameters as they
|
|
897 -- appeared in the source, which can be quite different as a result of the
|
|
898 -- use of named parameters). Empty is returned for a call with no
|
|
899 -- parameters. The procedure for iterating through the actuals in
|
|
900 -- declaration order is to use this function to find the first actual, and
|
|
901 -- then use Next_Actual to obtain the next actual in declaration order.
|
|
902 -- Note that the value returned is always the expression (not the
|
|
903 -- N_Parameter_Association nodes, even if named association is used).
|
|
904
|
|
905 function First_Global
|
|
906 (Subp : Entity_Id;
|
|
907 Global_Mode : Name_Id;
|
|
908 Refined : Boolean := False) return Node_Id;
|
|
909 -- Returns the first global item of mode Global_Mode (which can be
|
|
910 -- Name_Input, Name_Output, Name_In_Out or Name_Proof_In) associated to
|
|
911 -- subprogram Subp, or Empty otherwise. If Refined is True, the global item
|
|
912 -- is retrieved from the Refined_Global aspect/pragma associated to the
|
|
913 -- body of Subp if present. Next_Global can be used to get the next global
|
|
914 -- item with the same mode.
|
|
915
|
|
916 function Fix_Msg (Id : Entity_Id; Msg : String) return String;
|
|
917 -- Replace all occurrences of a particular word in string Msg depending on
|
|
918 -- the Ekind of Id as follows:
|
|
919 -- * Replace "subprogram" with
|
|
920 -- - "entry" when Id is an entry [family]
|
|
921 -- - "task type" when Id is a single task object, task type or task
|
|
922 -- body.
|
|
923 -- * Replace "protected" with
|
|
924 -- - "task" when Id is a single task object, task type or task body
|
|
925 -- All other non-matching words remain as is
|
|
926
|
|
927 function From_Nested_Package (T : Entity_Id) return Boolean;
|
|
928 -- A type declared in a nested package may be frozen by a declaration
|
|
929 -- appearing after the package but before the package is frozen. If the
|
|
930 -- type has aspects that generate subprograms, these may contain references
|
|
931 -- to entities local to the nested package. In that case the package must
|
|
932 -- be installed on the scope stack to prevent spurious visibility errors.
|
|
933
|
|
934 procedure Gather_Components
|
|
935 (Typ : Entity_Id;
|
|
936 Comp_List : Node_Id;
|
|
937 Governed_By : List_Id;
|
|
938 Into : Elist_Id;
|
|
939 Report_Errors : out Boolean);
|
|
940 -- The purpose of this procedure is to gather the valid components in a
|
|
941 -- record type according to the values of its discriminants, in order to
|
|
942 -- validate the components of a record aggregate.
|
|
943 --
|
|
944 -- Typ is the type of the aggregate when its constrained discriminants
|
|
945 -- need to be collected, otherwise it is Empty.
|
|
946 --
|
|
947 -- Comp_List is an N_Component_List node.
|
|
948 --
|
|
949 -- Governed_By is a list of N_Component_Association nodes, where each
|
|
950 -- choice list contains the name of a discriminant and the expression
|
|
951 -- field gives its value. The values of the discriminants governing
|
|
952 -- the (possibly nested) variant parts in Comp_List are found in this
|
|
953 -- Component_Association List.
|
|
954 --
|
|
955 -- Into is the list where the valid components are appended. Note that
|
|
956 -- Into need not be an Empty list. If it's not, components are attached
|
|
957 -- to its tail.
|
|
958 --
|
|
959 -- Report_Errors is set to True if the values of the discriminants are
|
|
960 -- non-static.
|
|
961 --
|
|
962 -- This procedure is also used when building a record subtype. If the
|
|
963 -- discriminant constraint of the subtype is static, the components of the
|
|
964 -- subtype are only those of the variants selected by the values of the
|
|
965 -- discriminants. Otherwise all components of the parent must be included
|
|
966 -- in the subtype for semantic analysis.
|
|
967
|
|
968 function Get_Actual_Subtype (N : Node_Id) return Entity_Id;
|
|
969 -- Given a node for an expression, obtain the actual subtype of the
|
|
970 -- expression. In the case of a parameter where the formal is an
|
|
971 -- unconstrained array or discriminated type, this will be the previously
|
|
972 -- constructed subtype of the actual. Note that this is not quite the
|
|
973 -- "Actual Subtype" of the RM, since it is always a constrained type, i.e.
|
|
974 -- it is the subtype of the value of the actual. The actual subtype is also
|
|
975 -- returned in other cases where it has already been constructed for an
|
|
976 -- object. Otherwise the expression type is returned unchanged, except for
|
|
977 -- the case of an unconstrained array type, where an actual subtype is
|
|
978 -- created, using Insert_Actions if necessary to insert any associated
|
|
979 -- actions.
|
|
980
|
|
981 function Get_Actual_Subtype_If_Available (N : Node_Id) return Entity_Id;
|
|
982 -- This is like Get_Actual_Subtype, except that it never constructs an
|
|
983 -- actual subtype. If an actual subtype is already available, i.e. the
|
|
984 -- Actual_Subtype field of the corresponding entity is set, then it is
|
|
985 -- returned. Otherwise the Etype of the node is returned.
|
|
986
|
|
987 function Get_Body_From_Stub (N : Node_Id) return Node_Id;
|
|
988 -- Return the body node for a stub
|
|
989
|
|
990 function Get_Cursor_Type
|
|
991 (Aspect : Node_Id;
|
|
992 Typ : Entity_Id) return Entity_Id;
|
|
993 -- Find Cursor type in scope of type Typ with Iterable aspect, by locating
|
|
994 -- primitive operation First. For use in resolving the other primitive
|
|
995 -- operations of an Iterable type and expanding loops and quantified
|
|
996 -- expressions over formal containers.
|
|
997
|
|
998 function Get_Cursor_Type (Typ : Entity_Id) return Entity_Id;
|
|
999 -- Find Cursor type in scope of type Typ with Iterable aspect, by locating
|
|
1000 -- primitive operation First. For use after resolving the primitive
|
|
1001 -- operations of an Iterable type.
|
|
1002
|
|
1003 function Get_Default_External_Name (E : Node_Or_Entity_Id) return Node_Id;
|
|
1004 -- This is used to construct the string literal node representing a
|
|
1005 -- default external name, i.e. one that is constructed from the name of an
|
|
1006 -- entity, or (in the case of extended DEC import/export pragmas, an
|
|
1007 -- identifier provided as the external name. Letters in the name are
|
|
1008 -- according to the setting of Opt.External_Name_Default_Casing.
|
|
1009
|
|
1010 function Get_Enclosing_Object (N : Node_Id) return Entity_Id;
|
|
1011 -- If expression N references a part of an object, return this object.
|
|
1012 -- Otherwise return Empty. Expression N should have been resolved already.
|
|
1013
|
|
1014 function Get_Generic_Entity (N : Node_Id) return Entity_Id;
|
|
1015 -- Returns the true generic entity in an instantiation. If the name in the
|
|
1016 -- instantiation is a renaming, the function returns the renamed generic.
|
|
1017
|
|
1018 function Get_Incomplete_View_Of_Ancestor (E : Entity_Id) return Entity_Id;
|
|
1019 -- Implements the notion introduced ever-so briefly in RM 7.3.1 (5.2/3):
|
|
1020 -- in a child unit a derived type is within the derivation class of an
|
|
1021 -- ancestor declared in a parent unit, even if there is an intermediate
|
|
1022 -- derivation that does not see the full view of that ancestor.
|
|
1023
|
|
1024 procedure Get_Index_Bounds
|
|
1025 (N : Node_Id;
|
|
1026 L : out Node_Id;
|
|
1027 H : out Node_Id;
|
|
1028 Use_Full_View : Boolean := False);
|
|
1029 -- This procedure assigns to L and H respectively the values of the low and
|
|
1030 -- high bounds of node N, which must be a range, subtype indication, or the
|
|
1031 -- name of a scalar subtype. The result in L, H may be set to Error if
|
|
1032 -- there was an earlier error in the range.
|
|
1033 -- Use_Full_View is intended for use by clients other than the compiler
|
|
1034 -- (specifically, gnat2scil) to indicate that we want the full view if
|
|
1035 -- the index type turns out to be a partial view; this case should not
|
|
1036 -- arise during normal compilation of semantically correct programs.
|
|
1037
|
|
1038 procedure Get_Interfacing_Aspects
|
|
1039 (Iface_Asp : Node_Id;
|
|
1040 Conv_Asp : out Node_Id;
|
|
1041 EN_Asp : out Node_Id;
|
|
1042 Expo_Asp : out Node_Id;
|
|
1043 Imp_Asp : out Node_Id;
|
|
1044 LN_Asp : out Node_Id;
|
|
1045 Do_Checks : Boolean := False);
|
|
1046 -- Given a single interfacing aspect Iface_Asp, retrieve other interfacing
|
|
1047 -- aspects that apply to the same related entity. The aspects considered by
|
|
1048 -- this routine are as follows:
|
|
1049 --
|
|
1050 -- Conv_Asp - aspect Convention
|
|
1051 -- EN_Asp - aspect External_Name
|
|
1052 -- Expo_Asp - aspect Export
|
|
1053 -- Imp_Asp - aspect Import
|
|
1054 -- LN_Asp - aspect Link_Name
|
|
1055 --
|
|
1056 -- When flag Do_Checks is set, this routine will flag duplicate uses of
|
|
1057 -- aspects.
|
|
1058
|
|
1059 function Get_Enum_Lit_From_Pos
|
|
1060 (T : Entity_Id;
|
|
1061 Pos : Uint;
|
|
1062 Loc : Source_Ptr) return Node_Id;
|
|
1063 -- This function returns an identifier denoting the E_Enumeration_Literal
|
|
1064 -- entity for the specified value from the enumeration type or subtype T.
|
|
1065 -- The second argument is the Pos value. Constraint_Error is raised if
|
|
1066 -- argument Pos is not in range. The third argument supplies a source
|
|
1067 -- location for constructed nodes returned by this function. If No_Location
|
|
1068 -- is supplied as source location, the location of the returned node is
|
|
1069 -- copied from the original source location for the enumeration literal,
|
|
1070 -- when available.
|
|
1071
|
|
1072 function Get_Iterable_Type_Primitive
|
|
1073 (Typ : Entity_Id;
|
|
1074 Nam : Name_Id) return Entity_Id;
|
|
1075 -- Retrieve one of the primitives First, Next, Has_Element, Element from
|
|
1076 -- the value of the Iterable aspect of a type.
|
|
1077
|
|
1078 procedure Get_Library_Unit_Name_String (Decl_Node : Node_Id);
|
|
1079 -- Retrieve the fully expanded name of the library unit declared by
|
|
1080 -- Decl_Node into the name buffer.
|
|
1081
|
|
1082 function Get_Max_Queue_Length (Id : Entity_Id) return Uint;
|
|
1083 -- Return the argument of pragma Max_Queue_Length or zero if the annotation
|
|
1084 -- is not present. It is assumed that Id denotes an entry.
|
|
1085
|
|
1086 function Get_Name_Entity_Id (Id : Name_Id) return Entity_Id;
|
|
1087 pragma Inline (Get_Name_Entity_Id);
|
|
1088 -- An entity value is associated with each name in the name table. The
|
|
1089 -- Get_Name_Entity_Id function fetches the Entity_Id of this entity, which
|
|
1090 -- is the innermost visible entity with the given name. See the body of
|
|
1091 -- Sem_Ch8 for further details on handling of entity visibility.
|
|
1092
|
|
1093 function Get_Name_From_CTC_Pragma (N : Node_Id) return String_Id;
|
|
1094 -- Return the Name component of Test_Case pragma N
|
|
1095 -- Bad name now that this no longer applies to Contract_Case ???
|
|
1096
|
|
1097 function Get_Parent_Entity (Unit : Node_Id) return Entity_Id;
|
|
1098 -- Get defining entity of parent unit of a child unit. In most cases this
|
|
1099 -- is the defining entity of the unit, but for a child instance whose
|
|
1100 -- parent needs a body for inlining, the instantiation node of the parent
|
|
1101 -- has not yet been rewritten as a package declaration, and the entity has
|
|
1102 -- to be retrieved from the Instance_Spec of the unit.
|
|
1103
|
|
1104 function Get_Pragma_Id (N : Node_Id) return Pragma_Id;
|
|
1105 pragma Inline (Get_Pragma_Id);
|
|
1106 -- Obtains the Pragma_Id from Pragma_Name_Unmapped (N)
|
|
1107
|
|
1108 function Get_Qualified_Name
|
|
1109 (Id : Entity_Id;
|
|
1110 Suffix : Entity_Id := Empty) return Name_Id;
|
|
1111 -- Obtain the fully qualified form of entity Id. The format is:
|
|
1112 -- scope_of_id-1__scope_of_id__chars_of_id__chars_of_suffix
|
|
1113
|
|
1114 function Get_Qualified_Name
|
|
1115 (Nam : Name_Id;
|
|
1116 Suffix : Name_Id := No_Name;
|
|
1117 Scop : Entity_Id := Current_Scope) return Name_Id;
|
|
1118 -- Obtain the fully qualified form of name Nam assuming it appears in scope
|
|
1119 -- Scop. The format is:
|
|
1120 -- scop-1__scop__nam__suffix
|
|
1121
|
|
1122 procedure Get_Reason_String (N : Node_Id);
|
|
1123 -- Recursive routine to analyze reason argument for pragma Warnings. The
|
|
1124 -- value of the reason argument is appended to the current string using
|
|
1125 -- Store_String_Chars. The reason argument is expected to be a string
|
|
1126 -- literal or concatenation of string literals. An error is given for
|
|
1127 -- any other form.
|
|
1128
|
|
1129 function Get_Reference_Discriminant (Typ : Entity_Id) return Entity_Id;
|
|
1130 -- If Typ has Implicit_Dereference, return discriminant specified in the
|
|
1131 -- corresponding aspect.
|
|
1132
|
|
1133 function Get_Referenced_Object (N : Node_Id) return Node_Id;
|
|
1134 -- Given a node, return the renamed object if the node represents a renamed
|
|
1135 -- object, otherwise return the node unchanged. The node may represent an
|
|
1136 -- arbitrary expression.
|
|
1137
|
|
1138 function Get_Renamed_Entity (E : Entity_Id) return Entity_Id;
|
|
1139 -- Given an entity for an exception, package, subprogram or generic unit,
|
|
1140 -- returns the ultimately renamed entity if this is a renaming. If this is
|
|
1141 -- not a renamed entity, returns its argument. It is an error to call this
|
|
1142 -- with any other kind of entity.
|
|
1143
|
|
1144 function Get_Return_Object (N : Node_Id) return Entity_Id;
|
|
1145 -- Given an extended return statement, return the corresponding return
|
|
1146 -- object, identified as the one for which Is_Return_Object = True.
|
|
1147
|
|
1148 function Get_Subprogram_Entity (Nod : Node_Id) return Entity_Id;
|
|
1149 -- Nod is either a procedure call statement, or a function call, or an
|
|
1150 -- accept statement node. This procedure finds the Entity_Id of the related
|
|
1151 -- subprogram or entry and returns it, or if no subprogram can be found,
|
|
1152 -- returns Empty.
|
|
1153
|
|
1154 function Get_Task_Body_Procedure (E : Entity_Id) return Entity_Id;
|
|
1155 -- Given an entity for a task type or subtype, retrieves the
|
|
1156 -- Task_Body_Procedure field from the corresponding task type declaration.
|
|
1157
|
|
1158 function Get_User_Defined_Eq (E : Entity_Id) return Entity_Id;
|
|
1159 -- For a type entity, return the entity of the primitive equality function
|
|
1160 -- for the type if it exists, otherwise return Empty.
|
|
1161
|
|
1162 procedure Get_Views
|
|
1163 (Typ : Entity_Id;
|
|
1164 Priv_Typ : out Entity_Id;
|
|
1165 Full_Typ : out Entity_Id;
|
|
1166 Full_Base : out Entity_Id;
|
|
1167 CRec_Typ : out Entity_Id);
|
|
1168 -- Obtain the partial and full view of type Typ and in addition any extra
|
|
1169 -- types the full view may have. The return entities are as follows:
|
|
1170 --
|
|
1171 -- Priv_Typ - the partial view (a private type)
|
|
1172 -- Full_Typ - the full view
|
|
1173 -- Full_Base - the base type of the full view
|
|
1174 -- CRec_Typ - the corresponding record type of the full view
|
|
1175
|
|
1176 function Has_Access_Values (T : Entity_Id) return Boolean;
|
|
1177 -- Returns true if type or subtype T is an access type, or has a component
|
|
1178 -- (at any recursive level) that is an access type. This is a conservative
|
|
1179 -- predicate, if it is not known whether or not T contains access values
|
|
1180 -- (happens for generic formals in some cases), then False is returned.
|
|
1181 -- Note that tagged types return False. Even though the tag is implemented
|
|
1182 -- as an access type internally, this function tests only for access types
|
|
1183 -- known to the programmer. See also Has_Tagged_Component.
|
|
1184
|
|
1185 type Alignment_Result is (Known_Compatible, Unknown, Known_Incompatible);
|
|
1186 -- Result of Has_Compatible_Alignment test, description found below. Note
|
|
1187 -- that the values are arranged in increasing order of problematicness.
|
|
1188
|
|
1189 function Has_Compatible_Alignment
|
|
1190 (Obj : Entity_Id;
|
|
1191 Expr : Node_Id;
|
|
1192 Layout_Done : Boolean) return Alignment_Result;
|
|
1193 -- Obj is an object entity, and expr is a node for an object reference. If
|
|
1194 -- the alignment of the object referenced by Expr is known to be compatible
|
|
1195 -- with the alignment of Obj (i.e. is larger or the same), then the result
|
|
1196 -- is Known_Compatible. If the alignment of the object referenced by Expr
|
|
1197 -- is known to be less than the alignment of Obj, then Known_Incompatible
|
|
1198 -- is returned. If neither condition can be reliably established at compile
|
|
1199 -- time, then Unknown is returned. If Layout_Done is True, the function can
|
|
1200 -- assume that the information on size and alignment of types and objects
|
|
1201 -- is present in the tree. This is used to determine if alignment checks
|
|
1202 -- are required for address clauses (Layout_Done is False in this case) as
|
|
1203 -- well as to issue appropriate warnings for them in the post compilation
|
|
1204 -- phase (Layout_Done is True in this case).
|
|
1205 --
|
|
1206 -- Note: Known_Incompatible does not mean that at run time the alignment
|
|
1207 -- of Expr is known to be wrong for Obj, just that it can be determined
|
|
1208 -- that alignments have been explicitly or implicitly specified which are
|
|
1209 -- incompatible (whereas Unknown means that even this is not known). The
|
|
1210 -- appropriate reaction of a caller to Known_Incompatible is to treat it as
|
|
1211 -- Unknown, but issue a warning that there may be an alignment error.
|
|
1212
|
|
1213 function Has_Declarations (N : Node_Id) return Boolean;
|
|
1214 -- Determines if the node can have declarations
|
|
1215
|
|
1216 function Has_Defaulted_Discriminants (Typ : Entity_Id) return Boolean;
|
|
1217 -- Simple predicate to test for defaulted discriminants
|
|
1218
|
|
1219 function Has_Denormals (E : Entity_Id) return Boolean;
|
|
1220 -- Determines if the floating-point type E supports denormal numbers.
|
|
1221 -- Returns False if E is not a floating-point type.
|
|
1222
|
|
1223 function Has_Discriminant_Dependent_Constraint
|
|
1224 (Comp : Entity_Id) return Boolean;
|
|
1225 -- Returns True if and only if Comp has a constrained subtype that depends
|
|
1226 -- on a discriminant.
|
|
1227
|
|
1228 function Has_Effectively_Volatile_Profile
|
|
1229 (Subp_Id : Entity_Id) return Boolean;
|
|
1230 -- Determine whether subprogram Subp_Id has an effectively volatile formal
|
|
1231 -- parameter or returns an effectively volatile value.
|
|
1232
|
|
1233 function Has_Full_Default_Initialization (Typ : Entity_Id) return Boolean;
|
|
1234 -- Determine whether type Typ defines "full default initialization" as
|
|
1235 -- specified by SPARK RM 3.1. To qualify as such, the type must be
|
|
1236 -- * A scalar type with specified Default_Value
|
|
1237 -- * An array-of-scalar type with specified Default_Component_Value
|
|
1238 -- * An array type whose element type defines full default initialization
|
|
1239 -- * A protected type, record type or type extension whose components
|
|
1240 -- either include a default expression or have a type which defines
|
|
1241 -- full default initialization. In the case of type extensions, the
|
|
1242 -- parent type defines full default initialization.
|
|
1243 -- * A task type
|
|
1244 -- * A private type whose Default_Initial_Condition is non-null
|
|
1245
|
|
1246 function Has_Infinities (E : Entity_Id) return Boolean;
|
|
1247 -- Determines if the range of the floating-point type E includes
|
|
1248 -- infinities. Returns False if E is not a floating-point type.
|
|
1249
|
|
1250 function Has_Interfaces
|
|
1251 (T : Entity_Id;
|
|
1252 Use_Full_View : Boolean := True) return Boolean;
|
|
1253 -- Where T is a concurrent type or a record type, returns true if T covers
|
|
1254 -- any abstract interface types. In case of private types the argument
|
|
1255 -- Use_Full_View controls if the check is done using its full view (if
|
|
1256 -- available).
|
|
1257
|
|
1258 function Has_Max_Queue_Length (Id : Entity_Id) return Boolean;
|
|
1259 -- Determine whether Id is subject to pragma Max_Queue_Length. It is
|
|
1260 -- assumed that Id denotes an entry.
|
|
1261
|
|
1262 function Has_No_Obvious_Side_Effects (N : Node_Id) return Boolean;
|
|
1263 -- This is a simple minded function for determining whether an expression
|
|
1264 -- has no obvious side effects. It is used only for determining whether
|
|
1265 -- warnings are needed in certain situations, and is not guaranteed to
|
|
1266 -- be accurate in either direction. Exceptions may mean an expression
|
|
1267 -- does in fact have side effects, but this may be ignored and True is
|
|
1268 -- returned, or a complex expression may in fact be side effect free
|
|
1269 -- but we don't recognize it here and return False. The Side_Effect_Free
|
|
1270 -- routine in Remove_Side_Effects is much more extensive and perhaps could
|
|
1271 -- be shared, so that this routine would be more accurate.
|
|
1272
|
|
1273 function Has_Non_Null_Refinement (Id : Entity_Id) return Boolean;
|
|
1274 -- Determine whether abstract state Id has at least one nonnull constituent
|
|
1275 -- as expressed in pragma Refined_State. This function does not take into
|
|
1276 -- account the visible refinement region of abstract state Id.
|
|
1277
|
|
1278 function Has_Non_Trivial_Precondition (Subp : Entity_Id) return Boolean;
|
|
1279 -- Determine whether subprogram Subp has a class-wide precondition that is
|
|
1280 -- not statically True.
|
|
1281
|
|
1282 function Has_Null_Body (Proc_Id : Entity_Id) return Boolean;
|
|
1283 -- Determine whether the body of procedure Proc_Id contains a sole null
|
|
1284 -- statement, possibly followed by an optional return. Used to optimize
|
|
1285 -- useless calls to assertion checks.
|
|
1286
|
|
1287 function Has_Null_Exclusion (N : Node_Id) return Boolean;
|
|
1288 -- Determine whether node N has a null exclusion
|
|
1289
|
|
1290 function Has_Null_Refinement (Id : Entity_Id) return Boolean;
|
|
1291 -- Determine whether abstract state Id has a null refinement as expressed
|
|
1292 -- in pragma Refined_State. This function does not take into account the
|
|
1293 -- visible refinement region of abstract state Id.
|
|
1294
|
|
1295 function Has_Overriding_Initialize (T : Entity_Id) return Boolean;
|
|
1296 -- Predicate to determine whether a controlled type has a user-defined
|
|
1297 -- Initialize primitive (and, in Ada 2012, whether that primitive is
|
|
1298 -- non-null), which causes the type to not have preelaborable
|
|
1299 -- initialization.
|
|
1300
|
|
1301 function Has_Preelaborable_Initialization (E : Entity_Id) return Boolean;
|
|
1302 -- Return True iff type E has preelaborable initialization as defined in
|
|
1303 -- Ada 2005 (see AI-161 for details of the definition of this attribute).
|
|
1304
|
|
1305 function Has_Private_Component (Type_Id : Entity_Id) return Boolean;
|
|
1306 -- Check if a type has a (sub)component of a private type that has not
|
|
1307 -- yet received a full declaration.
|
|
1308
|
|
1309 function Has_Signed_Zeros (E : Entity_Id) return Boolean;
|
|
1310 -- Determines if the floating-point type E supports signed zeros.
|
|
1311 -- Returns False if E is not a floating-point type.
|
|
1312
|
|
1313 function Has_Significant_Contract (Subp_Id : Entity_Id) return Boolean;
|
|
1314 -- Determine whether subprogram [body] Subp_Id has a significant contract.
|
|
1315 -- All subprograms have a N_Contract node, but this does not mean that the
|
|
1316 -- contract is useful.
|
|
1317
|
|
1318 function Has_Static_Array_Bounds (Typ : Node_Id) return Boolean;
|
|
1319 -- Return whether an array type has static bounds
|
|
1320
|
|
1321 function Has_Stream (T : Entity_Id) return Boolean;
|
|
1322 -- Tests if type T is derived from Ada.Streams.Root_Stream_Type, or in the
|
|
1323 -- case of a composite type, has a component for which this predicate is
|
|
1324 -- True, and if so returns True. Otherwise a result of False means that
|
|
1325 -- there is no Stream type in sight. For a private type, the test is
|
|
1326 -- applied to the underlying type (or returns False if there is no
|
|
1327 -- underlying type).
|
|
1328
|
|
1329 function Has_Suffix (E : Entity_Id; Suffix : Character) return Boolean;
|
|
1330 -- Returns true if the last character of E is Suffix. Used in Assertions.
|
|
1331
|
|
1332 function Has_Tagged_Component (Typ : Entity_Id) return Boolean;
|
|
1333 -- Returns True if Typ is a composite type (array or record) that is either
|
|
1334 -- a tagged type or has a subcomponent that is tagged. Returns False for a
|
|
1335 -- noncomposite type, or if no tagged subcomponents are present. This
|
|
1336 -- function is used to check if "=" has to be expanded into a bunch
|
|
1337 -- component comparisons.
|
|
1338
|
|
1339 function Has_Undefined_Reference (Expr : Node_Id) return Boolean;
|
|
1340 -- Given arbitrary expression Expr, determine whether it contains at
|
|
1341 -- least one name whose entity is Any_Id.
|
|
1342
|
|
1343 function Has_Volatile_Component (Typ : Entity_Id) return Boolean;
|
|
1344 -- Given arbitrary type Typ, determine whether it contains at least one
|
|
1345 -- volatile component.
|
|
1346
|
|
1347 function Implementation_Kind (Subp : Entity_Id) return Name_Id;
|
|
1348 -- Subp is a subprogram marked with pragma Implemented. Return the specific
|
|
1349 -- implementation requirement which the pragma imposes. The return value is
|
|
1350 -- either Name_By_Any, Name_By_Entry or Name_By_Protected_Procedure.
|
|
1351
|
|
1352 function Implements_Interface
|
|
1353 (Typ_Ent : Entity_Id;
|
|
1354 Iface_Ent : Entity_Id;
|
|
1355 Exclude_Parents : Boolean := False) return Boolean;
|
|
1356 -- Returns true if the Typ_Ent implements interface Iface_Ent
|
|
1357
|
|
1358 function In_Assertion_Expression_Pragma (N : Node_Id) return Boolean;
|
|
1359 -- Returns True if node N appears within a pragma that acts as an assertion
|
|
1360 -- expression. See Sem_Prag for the list of qualifying pragmas.
|
|
1361
|
|
1362 function In_Generic_Scope (E : Entity_Id) return Boolean;
|
|
1363 -- Returns True if entity E is inside a generic scope
|
|
1364
|
|
1365 function In_Instance return Boolean;
|
|
1366 -- Returns True if the current scope is within a generic instance
|
|
1367
|
|
1368 function In_Instance_Body return Boolean;
|
|
1369 -- Returns True if current scope is within the body of an instance, where
|
|
1370 -- several semantic checks (e.g. accessibility checks) are relaxed.
|
|
1371
|
|
1372 function In_Instance_Not_Visible return Boolean;
|
|
1373 -- Returns True if current scope is with the private part or the body of
|
|
1374 -- an instance. Other semantic checks are suppressed in this context.
|
|
1375
|
|
1376 function In_Instance_Visible_Part
|
|
1377 (Id : Entity_Id := Current_Scope) return Boolean;
|
|
1378 -- Returns True if arbitrary entity Id is within the visible part of a
|
|
1379 -- package instance, where several additional semantic checks apply.
|
|
1380
|
|
1381 function In_Package_Body return Boolean;
|
|
1382 -- Returns True if current scope is within a package body
|
|
1383
|
|
1384 function In_Pragma_Expression (N : Node_Id; Nam : Name_Id) return Boolean;
|
|
1385 -- Returns true if the expression N occurs within a pragma with name Nam
|
|
1386
|
|
1387 function In_Pre_Post_Condition (N : Node_Id) return Boolean;
|
|
1388 -- Returns True if node N appears within a pre/postcondition pragma. Note
|
|
1389 -- the pragma Check equivalents are NOT considered.
|
|
1390
|
|
1391 function In_Reverse_Storage_Order_Object (N : Node_Id) return Boolean;
|
|
1392 -- Returns True if N denotes a component or subcomponent in a record or
|
|
1393 -- array that has Reverse_Storage_Order.
|
|
1394
|
|
1395 function In_Subprogram_Or_Concurrent_Unit return Boolean;
|
|
1396 -- Determines if the current scope is within a subprogram compilation unit
|
|
1397 -- (inside a subprogram declaration, subprogram body, or generic subprogram
|
|
1398 -- declaration) or within a task or protected body. The test is for
|
|
1399 -- appearing anywhere within such a construct (that is it does not need
|
|
1400 -- to be directly within).
|
|
1401
|
|
1402 function In_Subtree (N : Node_Id; Root : Node_Id) return Boolean;
|
|
1403 -- Determine whether node N is within the subtree rooted at Root
|
|
1404
|
|
1405 function In_Subtree
|
|
1406 (N : Node_Id;
|
|
1407 Root1 : Node_Id;
|
|
1408 Root2 : Node_Id) return Boolean;
|
|
1409 -- Determine whether node N is within the subtree rooted at Root1 or Root2.
|
|
1410 -- This version is more efficient than calling the single root version of
|
|
1411 -- Is_Subtree twice.
|
|
1412
|
|
1413 function In_Visible_Part (Scope_Id : Entity_Id) return Boolean;
|
|
1414 -- Determine whether a declaration occurs within the visible part of a
|
|
1415 -- package specification. The package must be on the scope stack, and the
|
|
1416 -- corresponding private part must not.
|
|
1417
|
|
1418 function Incomplete_Or_Partial_View (Id : Entity_Id) return Entity_Id;
|
|
1419 -- Given the entity of a constant or a type, retrieve the incomplete or
|
|
1420 -- partial view of the same entity. Note that Id may not have a partial
|
|
1421 -- view in which case the function returns Empty.
|
|
1422
|
|
1423 function Indexed_Component_Bit_Offset (N : Node_Id) return Uint;
|
|
1424 -- Given an N_Indexed_Component node, return the first bit position of the
|
|
1425 -- component if it is known at compile time. A value of No_Uint means that
|
|
1426 -- either the value is not yet known before back-end processing or it is
|
|
1427 -- not known at compile time after back-end processing.
|
|
1428
|
|
1429 procedure Inherit_Rep_Item_Chain (Typ : Entity_Id; From_Typ : Entity_Id);
|
|
1430 -- Inherit the rep item chain of type From_Typ without clobbering any
|
|
1431 -- existing rep items on Typ's chain. Typ is the destination type.
|
|
1432
|
|
1433 procedure Insert_Explicit_Dereference (N : Node_Id);
|
|
1434 -- In a context that requires a composite or subprogram type and where a
|
|
1435 -- prefix is an access type, rewrite the access type node N (which is the
|
|
1436 -- prefix, e.g. of an indexed component) as an explicit dereference.
|
|
1437
|
|
1438 procedure Inspect_Deferred_Constant_Completion (Decls : List_Id);
|
|
1439 -- Examine all deferred constants in the declaration list Decls and check
|
|
1440 -- whether they have been completed by a full constant declaration or an
|
|
1441 -- Import pragma. Emit the error message if that is not the case.
|
|
1442
|
|
1443 procedure Install_Generic_Formals (Subp_Id : Entity_Id);
|
|
1444 -- Install both the generic formal parameters and the formal parameters of
|
|
1445 -- generic subprogram Subp_Id into visibility.
|
|
1446
|
|
1447 procedure Install_SPARK_Mode (Mode : SPARK_Mode_Type; Prag : Node_Id);
|
|
1448 -- Establish the SPARK_Mode and SPARK_Mode_Pragma currently in effect
|
|
1449
|
|
1450 function Is_Actual_Out_Parameter (N : Node_Id) return Boolean;
|
|
1451 -- Determines if N is an actual parameter of out mode in a subprogram call
|
|
1452
|
|
1453 function Is_Actual_Parameter (N : Node_Id) return Boolean;
|
|
1454 -- Determines if N is an actual parameter in a subprogram call
|
|
1455
|
|
1456 function Is_Actual_Tagged_Parameter (N : Node_Id) return Boolean;
|
|
1457 -- Determines if N is an actual parameter of a formal of tagged type in a
|
|
1458 -- subprogram call.
|
|
1459
|
|
1460 function Is_Aliased_View (Obj : Node_Id) return Boolean;
|
|
1461 -- Determine if Obj is an aliased view, i.e. the name of an object to which
|
|
1462 -- 'Access or 'Unchecked_Access can apply. Note that this routine uses the
|
|
1463 -- rules of the language, it does not take into account the restriction
|
|
1464 -- No_Implicit_Aliasing, so it can return True if the restriction is active
|
|
1465 -- and Obj violates the restriction. The caller is responsible for calling
|
|
1466 -- Restrict.Check_No_Implicit_Aliasing if True is returned, but there is a
|
|
1467 -- requirement for obeying the restriction in the call context.
|
|
1468
|
|
1469 function Is_Ancestor_Package
|
|
1470 (E1 : Entity_Id;
|
|
1471 E2 : Entity_Id) return Boolean;
|
|
1472 -- Determine whether package E1 is an ancestor of E2
|
|
1473
|
|
1474 function Is_Atomic_Object (N : Node_Id) return Boolean;
|
|
1475 -- Determines if the given node denotes an atomic object in the sense of
|
|
1476 -- the legality checks described in RM C.6(12).
|
|
1477
|
|
1478 function Is_Atomic_Or_VFA_Object (N : Node_Id) return Boolean;
|
|
1479 -- Determines if the given node is an atomic object (Is_Atomic_Object true)
|
|
1480 -- or else is an object for which VFA is present.
|
|
1481
|
|
1482 function Is_Attribute_Result (N : Node_Id) return Boolean;
|
|
1483 -- Determine whether node N denotes attribute 'Result
|
|
1484
|
|
1485 function Is_Attribute_Update (N : Node_Id) return Boolean;
|
|
1486 -- Determine whether node N denotes attribute 'Update
|
|
1487
|
|
1488 function Is_Body_Or_Package_Declaration (N : Node_Id) return Boolean;
|
|
1489 -- Determine whether node N denotes a body or a package declaration
|
|
1490
|
|
1491 function Is_Bounded_String (T : Entity_Id) return Boolean;
|
|
1492 -- True if T is a bounded string type. Used to make sure "=" composes
|
|
1493 -- properly for bounded string types.
|
|
1494
|
|
1495 function Is_Constant_Bound (Exp : Node_Id) return Boolean;
|
|
1496 -- Exp is the expression for an array bound. Determines whether the
|
|
1497 -- bound is a compile-time known value, or a constant entity, or an
|
|
1498 -- enumeration literal, or an expression composed of constant-bound
|
|
1499 -- subexpressions which are evaluated by means of standard operators.
|
|
1500
|
|
1501 function Is_Container_Element (Exp : Node_Id) return Boolean;
|
|
1502 -- This routine recognizes expressions that denote an element of one of
|
|
1503 -- the predefined containers, when the source only contains an indexing
|
|
1504 -- operation and an implicit dereference is inserted by the compiler.
|
|
1505 -- In the absence of this optimization, the indexing creates a temporary
|
|
1506 -- controlled cursor that sets the tampering bit of the container, and
|
|
1507 -- restricts the use of the convenient notation C (X) to contexts that
|
|
1508 -- do not check the tampering bit (e.g. C.Include (X, C (Y)). Exp is an
|
|
1509 -- explicit dereference. The transformation applies when it has the form
|
|
1510 -- F (X).Discr.all.
|
|
1511
|
|
1512 function Is_Contract_Annotation (Item : Node_Id) return Boolean;
|
|
1513 -- Determine whether aspect specification or pragma Item is a contract
|
|
1514 -- annotation.
|
|
1515
|
|
1516 function Is_Controlling_Limited_Procedure
|
|
1517 (Proc_Nam : Entity_Id) return Boolean;
|
|
1518 -- Ada 2005 (AI-345): Determine whether Proc_Nam is a primitive procedure
|
|
1519 -- of a limited interface with a controlling first parameter.
|
|
1520
|
|
1521 function Is_CPP_Constructor_Call (N : Node_Id) return Boolean;
|
|
1522 -- Returns True if N is a call to a CPP constructor
|
|
1523
|
|
1524 function Is_CCT_Instance
|
|
1525 (Ref_Id : Entity_Id;
|
|
1526 Context_Id : Entity_Id) return Boolean;
|
|
1527 -- Subsidiary to the analysis of pragmas [Refined_]Depends and [Refined_]
|
|
1528 -- Global. Determine whether entity Ref_Id (which must represent either
|
|
1529 -- a protected type or a task type) denotes the current instance of a
|
|
1530 -- concurrent type. Context_Id denotes the associated context where the
|
|
1531 -- pragma appears.
|
|
1532
|
|
1533 function Is_Child_Or_Sibling
|
|
1534 (Pack_1 : Entity_Id;
|
|
1535 Pack_2 : Entity_Id) return Boolean;
|
|
1536 -- Determine the following relations between two arbitrary packages:
|
|
1537 -- 1) One package is the parent of a child package
|
|
1538 -- 2) Both packages are siblings and share a common parent
|
|
1539
|
|
1540 function Is_Concurrent_Interface (T : Entity_Id) return Boolean;
|
|
1541 -- First determine whether type T is an interface and then check whether
|
|
1542 -- it is of protected, synchronized or task kind.
|
|
1543
|
|
1544 function Is_Current_Instance (N : Node_Id) return Boolean;
|
|
1545 -- Predicate is true if N legally denotes a type name within its own
|
|
1546 -- declaration. Prior to Ada 2012 this covered only synchronized type
|
|
1547 -- declarations. In Ada 2012 it also covers type and subtype declarations
|
|
1548 -- with aspects: Invariant, Predicate, and Default_Initial_Condition.
|
|
1549
|
|
1550 function Is_Declaration (N : Node_Id) return Boolean;
|
|
1551 -- Determine whether arbitrary node N denotes a declaration
|
|
1552
|
|
1553 function Is_Declaration_Other_Than_Renaming (N : Node_Id) return Boolean;
|
|
1554 -- Determine whether arbitrary node N denotes a non-renaming declaration
|
|
1555
|
|
1556 function Is_Declared_Within_Variant (Comp : Entity_Id) return Boolean;
|
|
1557 -- Returns True iff component Comp is declared within a variant part
|
|
1558
|
|
1559 function Is_Dependent_Component_Of_Mutable_Object
|
|
1560 (Object : Node_Id) return Boolean;
|
|
1561 -- Returns True if Object is the name of a subcomponent that depends on
|
|
1562 -- discriminants of a variable whose nominal subtype is unconstrained and
|
|
1563 -- not indefinite, and the variable is not aliased. Otherwise returns
|
|
1564 -- False. The nodes passed to this function are assumed to denote objects.
|
|
1565
|
|
1566 function Is_Dereferenced (N : Node_Id) return Boolean;
|
|
1567 -- N is a subexpression node of an access type. This function returns true
|
|
1568 -- if N appears as the prefix of a node that does a dereference of the
|
|
1569 -- access value (selected/indexed component, explicit dereference or a
|
|
1570 -- slice), and false otherwise.
|
|
1571
|
|
1572 function Is_Descendant_Of (T1 : Entity_Id; T2 : Entity_Id) return Boolean;
|
|
1573 -- Returns True if type T1 is a descendant of type T2, and false otherwise.
|
|
1574 -- This is the RM definition, a type is a descendant of another type if it
|
|
1575 -- is the same type or is derived from a descendant of the other type.
|
|
1576
|
|
1577 function Is_Descendant_Of_Suspension_Object
|
|
1578 (Typ : Entity_Id) return Boolean;
|
|
1579 -- Determine whether type Typ is a descendant of type Suspension_Object
|
|
1580 -- defined in Ada.Synchronous_Task_Control. This version is different from
|
|
1581 -- Is_Descendant_Of as the detection of Suspension_Object does not involve
|
|
1582 -- an entity and by extension a call to RTSfind.
|
|
1583
|
|
1584 function Is_Double_Precision_Floating_Point_Type
|
|
1585 (E : Entity_Id) return Boolean;
|
|
1586 -- Return whether E is a double precision floating point type,
|
|
1587 -- characterized by:
|
|
1588 -- . machine_radix = 2
|
|
1589 -- . machine_mantissa = 53
|
|
1590 -- . machine_emax = 2**10
|
|
1591 -- . machine_emin = 3 - machine_emax
|
|
1592
|
|
1593 function Is_Effectively_Volatile (Id : Entity_Id) return Boolean;
|
|
1594 -- Determine whether a type or object denoted by entity Id is effectively
|
|
1595 -- volatile (SPARK RM 7.1.2). To qualify as such, the entity must be either
|
|
1596 -- * Volatile
|
|
1597 -- * An array type subject to aspect Volatile_Components
|
|
1598 -- * An array type whose component type is effectively volatile
|
|
1599 -- * A protected type
|
|
1600 -- * Descendant of type Ada.Synchronous_Task_Control.Suspension_Object
|
|
1601
|
|
1602 function Is_Effectively_Volatile_Object (N : Node_Id) return Boolean;
|
|
1603 -- Determine whether an arbitrary node denotes an effectively volatile
|
|
1604 -- object (SPARK RM 7.1.2).
|
|
1605
|
|
1606 function Is_Entry_Body (Id : Entity_Id) return Boolean;
|
|
1607 -- Determine whether entity Id is the body entity of an entry [family]
|
|
1608
|
|
1609 function Is_Entry_Declaration (Id : Entity_Id) return Boolean;
|
|
1610 -- Determine whether entity Id is the spec entity of an entry [family]
|
|
1611
|
|
1612 function Is_Expanded_Priority_Attribute (E : Entity_Id) return Boolean;
|
|
1613 -- Check whether a function in a call is an expanded priority attribute,
|
|
1614 -- which is transformed into an Rtsfind call to Get_Ceiling. This expansion
|
|
1615 -- does not take place in a configurable runtime.
|
|
1616
|
|
1617 function Is_Expression_Function (Subp : Entity_Id) return Boolean;
|
|
1618 -- Determine whether subprogram [body] Subp denotes an expression function
|
|
1619
|
|
1620 function Is_Expression_Function_Or_Completion
|
|
1621 (Subp : Entity_Id) return Boolean;
|
|
1622 -- Determine whether subprogram [body] Subp denotes an expression function
|
|
1623 -- or is completed by an expression function body.
|
|
1624
|
|
1625 function Is_EVF_Expression (N : Node_Id) return Boolean;
|
|
1626 -- Determine whether node N denotes a reference to a formal parameter of
|
|
1627 -- a specific tagged type whose related subprogram is subject to pragma
|
|
1628 -- Extensions_Visible with value "False" (SPARK RM 6.1.7). Several other
|
|
1629 -- constructs fall under this category:
|
|
1630 -- 1) A qualified expression whose operand is EVF
|
|
1631 -- 2) A type conversion whose operand is EVF
|
|
1632 -- 3) An if expression with at least one EVF dependent_expression
|
|
1633 -- 4) A case expression with at least one EVF dependent_expression
|
|
1634
|
|
1635 function Is_False (U : Uint) return Boolean;
|
|
1636 pragma Inline (Is_False);
|
|
1637 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
|
|
1638 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
|
|
1639 -- if it is False (i.e. zero).
|
|
1640
|
|
1641 function Is_Fixed_Model_Number (U : Ureal; T : Entity_Id) return Boolean;
|
|
1642 -- Returns True iff the number U is a model number of the fixed-point type
|
|
1643 -- T, i.e. if it is an exact multiple of Small.
|
|
1644
|
|
1645 function Is_Fully_Initialized_Type (Typ : Entity_Id) return Boolean;
|
|
1646 -- Typ is a type entity. This function returns true if this type is fully
|
|
1647 -- initialized, meaning that an object of the type is fully initialized.
|
|
1648 -- Note that initialization resulting from use of pragma Normalize_Scalars
|
|
1649 -- does not count. Note that this is only used for the purpose of issuing
|
|
1650 -- warnings for objects that are potentially referenced uninitialized. This
|
|
1651 -- means that the result returned is not crucial, but should err on the
|
|
1652 -- side of thinking things are fully initialized if it does not know.
|
|
1653
|
|
1654 function Is_Generic_Declaration_Or_Body (Decl : Node_Id) return Boolean;
|
|
1655 -- Determine whether arbitrary declaration Decl denotes a generic package,
|
|
1656 -- a generic subprogram or a generic body.
|
|
1657
|
|
1658 function Is_Inherited_Operation (E : Entity_Id) return Boolean;
|
|
1659 -- E is a subprogram. Return True is E is an implicit operation inherited
|
|
1660 -- by a derived type declaration.
|
|
1661
|
|
1662 function Is_Inherited_Operation_For_Type
|
|
1663 (E : Entity_Id;
|
|
1664 Typ : Entity_Id) return Boolean;
|
|
1665 -- E is a subprogram. Return True is E is an implicit operation inherited
|
|
1666 -- by the derived type declaration for type Typ.
|
|
1667
|
|
1668 function Is_Inlinable_Expression_Function (Subp : Entity_Id) return Boolean;
|
|
1669 -- Return True if Subp is an expression function that fulfills all the
|
|
1670 -- following requirements for inlining:
|
|
1671 -- 1. pragma/aspect Inline_Always
|
|
1672 -- 2. No formals
|
|
1673 -- 3. No contracts
|
|
1674 -- 4. No dispatching primitive
|
|
1675 -- 5. Result subtype controlled (or with controlled components)
|
|
1676 -- 6. Result subtype not subject to type-invariant checks
|
|
1677 -- 7. Result subtype not a class-wide type
|
|
1678 -- 8. Return expression naming an object global to the function
|
|
1679 -- 9. Nominal subtype of the returned object statically compatible
|
|
1680 -- with the result subtype of the expression function.
|
|
1681
|
|
1682 function Is_Iterator (Typ : Entity_Id) return Boolean;
|
|
1683 -- AI05-0139-2: Check whether Typ is one of the predefined interfaces in
|
|
1684 -- Ada.Iterator_Interfaces, or it is derived from one.
|
|
1685
|
|
1686 function Is_Iterator_Over_Array (N : Node_Id) return Boolean;
|
|
1687 -- N is an iterator specification. Returns True iff N is an iterator over
|
|
1688 -- an array, either inside a loop of the form 'for X of A' or a quantified
|
|
1689 -- expression of the form 'for all/some X of A' where A is of array type.
|
|
1690
|
|
1691 type Is_LHS_Result is (Yes, No, Unknown);
|
|
1692 function Is_LHS (N : Node_Id) return Is_LHS_Result;
|
|
1693 -- Returns Yes if N is definitely used as Name in an assignment statement.
|
|
1694 -- Returns No if N is definitely NOT used as a Name in an assignment
|
|
1695 -- statement. Returns Unknown if we can't tell at this stage (happens in
|
|
1696 -- the case where we don't know the type of N yet, and we have something
|
|
1697 -- like N.A := 3, where this counts as N being used on the left side of
|
|
1698 -- an assignment only if N is not an access type. If it is an access type
|
|
1699 -- then it is N.all.A that is assigned, not N.
|
|
1700
|
|
1701 function Is_Library_Level_Entity (E : Entity_Id) return Boolean;
|
|
1702 -- A library-level declaration is one that is accessible from Standard,
|
|
1703 -- i.e. a library unit or an entity declared in a library package.
|
|
1704
|
|
1705 function Is_Limited_Class_Wide_Type (Typ : Entity_Id) return Boolean;
|
|
1706 -- Determine whether a given type is a limited class-wide type, in which
|
|
1707 -- case it needs a Master_Id, because extensions of its designated type
|
|
1708 -- may include task components. A class-wide type that comes from a
|
|
1709 -- limited view must be treated in the same way.
|
|
1710
|
|
1711 function Is_Local_Variable_Reference (Expr : Node_Id) return Boolean;
|
|
1712 -- Determines whether Expr is a reference to a variable or IN OUT mode
|
|
1713 -- parameter of the current enclosing subprogram.
|
|
1714 -- Why are OUT parameters not considered here ???
|
|
1715
|
|
1716 function Is_Name_Reference (N : Node_Id) return Boolean;
|
|
1717 -- Determine whether arbitrary node N is a reference to a name. This is
|
|
1718 -- similar to Is_Object_Reference but returns True only if N can be renamed
|
|
1719 -- without the need for a temporary, the typical example of an object not
|
|
1720 -- in this category being a function call.
|
|
1721
|
|
1722 function Is_Nontrivial_DIC_Procedure (Id : Entity_Id) return Boolean;
|
|
1723 -- Determine whether entity Id denotes the procedure that verifies the
|
|
1724 -- assertion expression of pragma Default_Initial_Condition and if it does,
|
|
1725 -- the encapsulated expression is nontrivial.
|
|
1726
|
|
1727 function Is_Null_Record_Type (T : Entity_Id) return Boolean;
|
|
1728 -- Determine whether T is declared with a null record definition or a
|
|
1729 -- null component list.
|
|
1730
|
|
1731 function Is_Object_Image (Prefix : Node_Id) return Boolean;
|
|
1732 -- Returns True if an 'Image, 'Wide_Image, or 'Wide_Wide_Image attribute
|
|
1733 -- is applied to a given object or named value prefix (see below).
|
|
1734
|
|
1735 -- AI12-00124: The ARG has adopted the GNAT semantics of 'Img for scalar
|
|
1736 -- types, so that the prefix of any 'Image attribute can be an object, a
|
|
1737 -- named value, or a type, and there is no need for an argument in the
|
|
1738 -- case it is an object reference.
|
|
1739
|
|
1740 function Is_Object_Reference (N : Node_Id) return Boolean;
|
|
1741 -- Determines if the tree referenced by N represents an object. Both
|
|
1742 -- variable and constant objects return True (compare Is_Variable).
|
|
1743
|
|
1744 function Is_OK_Variable_For_Out_Formal (AV : Node_Id) return Boolean;
|
|
1745 -- Used to test if AV is an acceptable formal for an OUT or IN OUT formal.
|
|
1746 -- Note that the Is_Variable function is not quite the right test because
|
|
1747 -- this is a case in which conversions whose expression is a variable (in
|
|
1748 -- the Is_Variable sense) with an untagged type target are considered view
|
|
1749 -- conversions and hence variables.
|
|
1750
|
|
1751 function Is_OK_Volatile_Context
|
|
1752 (Context : Node_Id;
|
|
1753 Obj_Ref : Node_Id) return Boolean;
|
|
1754 -- Determine whether node Context denotes a "non-interfering context" (as
|
|
1755 -- defined in SPARK RM 7.1.3(12)) where volatile reference Obj_Ref can
|
|
1756 -- safely reside.
|
|
1757
|
|
1758 function Is_Package_Contract_Annotation (Item : Node_Id) return Boolean;
|
|
1759 -- Determine whether aspect specification or pragma Item is one of the
|
|
1760 -- following package contract annotations:
|
|
1761 -- Abstract_State
|
|
1762 -- Initial_Condition
|
|
1763 -- Initializes
|
|
1764 -- Refined_State
|
|
1765
|
|
1766 function Is_Partially_Initialized_Type
|
|
1767 (Typ : Entity_Id;
|
|
1768 Include_Implicit : Boolean := True) return Boolean;
|
|
1769 -- Typ is a type entity. This function returns true if this type is partly
|
|
1770 -- initialized, meaning that an object of the type is at least partly
|
|
1771 -- initialized (in particular in the record case, that at least one
|
|
1772 -- component has an initialization expression). Note that initialization
|
|
1773 -- resulting from the use of pragma Normalize_Scalars does not count.
|
|
1774 -- Include_Implicit controls whether implicit initialization of access
|
|
1775 -- values to null, and of discriminant values, is counted as making the
|
|
1776 -- type be partially initialized. For the default setting of True, these
|
|
1777 -- implicit cases do count, and discriminated types or types containing
|
|
1778 -- access values not explicitly initialized will return True. Otherwise
|
|
1779 -- if Include_Implicit is False, these cases do not count as making the
|
|
1780 -- type be partially initialized.
|
|
1781
|
|
1782 function Is_Potentially_Unevaluated (N : Node_Id) return Boolean;
|
|
1783 -- Predicate to implement definition given in RM 6.1.1 (20/3)
|
|
1784
|
|
1785 function Is_Potentially_Persistent_Type (T : Entity_Id) return Boolean;
|
|
1786 -- Determines if type T is a potentially persistent type. A potentially
|
|
1787 -- persistent type is defined (recursively) as a scalar type, an untagged
|
|
1788 -- record whose components are all of a potentially persistent type, or an
|
|
1789 -- array with all static constraints whose component type is potentially
|
|
1790 -- persistent. A private type is potentially persistent if the full type
|
|
1791 -- is potentially persistent.
|
|
1792
|
|
1793 function Is_Preelaborable_Aggregate (Aggr : Node_Id) return Boolean;
|
|
1794 -- Determine whether aggregate Aggr violates the restrictions of
|
|
1795 -- preelaborable constructs as defined in ARM 10.2.1(5-9).
|
|
1796
|
|
1797 function Is_Preelaborable_Construct (N : Node_Id) return Boolean;
|
|
1798 -- Determine whether arbitrary node N violates the restrictions of
|
|
1799 -- preelaborable constructs as defined in ARM 10.2.1(5-9).
|
|
1800
|
|
1801 function Is_Protected_Self_Reference (N : Node_Id) return Boolean;
|
|
1802 -- Return True if node N denotes a protected type name which represents
|
|
1803 -- the current instance of a protected object according to RM 9.4(21/2).
|
|
1804
|
|
1805 function Is_RCI_Pkg_Spec_Or_Body (Cunit : Node_Id) return Boolean;
|
|
1806 -- Return True if a compilation unit is the specification or the
|
|
1807 -- body of a remote call interface package.
|
|
1808
|
|
1809 function Is_Remote_Access_To_Class_Wide_Type (E : Entity_Id) return Boolean;
|
|
1810 -- Return True if E is a remote access-to-class-wide type
|
|
1811
|
|
1812 function Is_Remote_Access_To_Subprogram_Type (E : Entity_Id) return Boolean;
|
|
1813 -- Return True if E is a remote access to subprogram type
|
|
1814
|
|
1815 function Is_Remote_Call (N : Node_Id) return Boolean;
|
|
1816 -- Return True if N denotes a potentially remote call
|
|
1817
|
|
1818 function Is_Renamed_Entry (Proc_Nam : Entity_Id) return Boolean;
|
|
1819 -- Return True if Proc_Nam is a procedure renaming of an entry
|
|
1820
|
|
1821 function Is_Renaming_Declaration (N : Node_Id) return Boolean;
|
|
1822 -- Determine whether arbitrary node N denotes a renaming declaration
|
|
1823
|
|
1824 function Is_Reversible_Iterator (Typ : Entity_Id) return Boolean;
|
|
1825 -- AI05-0139-2: Check whether Typ is derived from the predefined interface
|
|
1826 -- Ada.Iterator_Interfaces.Reversible_Iterator.
|
|
1827
|
|
1828 function Is_Selector_Name (N : Node_Id) return Boolean;
|
|
1829 -- Given an N_Identifier node N, determines if it is a Selector_Name.
|
|
1830 -- As described in Sinfo, Selector_Names are special because they
|
|
1831 -- represent use of the N_Identifier node for a true identifier, when
|
|
1832 -- normally such nodes represent a direct name.
|
|
1833
|
|
1834 function Is_Single_Concurrent_Object (Id : Entity_Id) return Boolean;
|
|
1835 -- Determine whether arbitrary entity Id denotes the anonymous object
|
|
1836 -- created for a single protected or single task type.
|
|
1837
|
|
1838 function Is_Single_Concurrent_Type (Id : Entity_Id) return Boolean;
|
|
1839 -- Determine whether arbitrary entity Id denotes a single protected or
|
|
1840 -- single task type.
|
|
1841
|
|
1842 function Is_Single_Concurrent_Type_Declaration (N : Node_Id) return Boolean;
|
|
1843 -- Determine whether arbitrary node N denotes the declaration of a single
|
|
1844 -- protected type or single task type.
|
|
1845
|
|
1846 function Is_Single_Precision_Floating_Point_Type
|
|
1847 (E : Entity_Id) return Boolean;
|
|
1848 -- Return whether E is a single precision floating point type,
|
|
1849 -- characterized by:
|
|
1850 -- . machine_radix = 2
|
|
1851 -- . machine_mantissa = 24
|
|
1852 -- . machine_emax = 2**7
|
|
1853 -- . machine_emin = 3 - machine_emax
|
|
1854
|
|
1855 function Is_Single_Protected_Object (Id : Entity_Id) return Boolean;
|
|
1856 -- Determine whether arbitrary entity Id denotes the anonymous object
|
|
1857 -- created for a single protected type.
|
|
1858
|
|
1859 function Is_Single_Task_Object (Id : Entity_Id) return Boolean;
|
|
1860 -- Determine whether arbitrary entity Id denotes the anonymous object
|
|
1861 -- created for a single task type.
|
|
1862
|
|
1863 function Is_SPARK_05_Initialization_Expr (N : Node_Id) return Boolean;
|
|
1864 -- Determines if the tree referenced by N represents an initialization
|
|
1865 -- expression in SPARK 2005, suitable for initializing an object in an
|
|
1866 -- object declaration.
|
|
1867
|
|
1868 function Is_SPARK_05_Object_Reference (N : Node_Id) return Boolean;
|
|
1869 -- Determines if the tree referenced by N represents an object in SPARK
|
|
1870 -- 2005. This differs from Is_Object_Reference in that only variables,
|
|
1871 -- constants, formal parameters, and selected_components of those are
|
|
1872 -- valid objects in SPARK 2005.
|
|
1873
|
|
1874 function Is_Specific_Tagged_Type (Typ : Entity_Id) return Boolean;
|
|
1875 -- Determine whether an arbitrary [private] type is specifically tagged
|
|
1876
|
|
1877 function Is_Statement (N : Node_Id) return Boolean;
|
|
1878 pragma Inline (Is_Statement);
|
|
1879 -- Check if the node N is a statement node. Note that this includes
|
|
1880 -- the case of procedure call statements (unlike the direct use of
|
|
1881 -- the N_Statement_Other_Than_Procedure_Call subtype from Sinfo).
|
|
1882 -- Note that a label is *not* a statement, and will return False.
|
|
1883
|
|
1884 function Is_Subprogram_Contract_Annotation (Item : Node_Id) return Boolean;
|
|
1885 -- Determine whether aspect specification or pragma Item is one of the
|
|
1886 -- following subprogram contract annotations:
|
|
1887 -- Contract_Cases
|
|
1888 -- Depends
|
|
1889 -- Extensions_Visible
|
|
1890 -- Global
|
|
1891 -- Post
|
|
1892 -- Post_Class
|
|
1893 -- Postcondition
|
|
1894 -- Pre
|
|
1895 -- Pre_Class
|
|
1896 -- Precondition
|
|
1897 -- Refined_Depends
|
|
1898 -- Refined_Global
|
|
1899 -- Refined_Post
|
|
1900 -- Test_Case
|
|
1901
|
|
1902 function Is_Subprogram_Stub_Without_Prior_Declaration
|
|
1903 (N : Node_Id) return Boolean;
|
|
1904 -- Return True if N is a subprogram stub with no prior subprogram
|
|
1905 -- declaration.
|
|
1906
|
|
1907 function Is_Suspension_Object (Id : Entity_Id) return Boolean;
|
|
1908 -- Determine whether arbitrary entity Id denotes Suspension_Object defined
|
|
1909 -- in Ada.Synchronous_Task_Control.
|
|
1910
|
|
1911 function Is_Synchronized_Object (Id : Entity_Id) return Boolean;
|
|
1912 -- Determine whether entity Id denotes an object and if it does, whether
|
|
1913 -- this object is synchronized as specified in SPARK RM 9.1. To qualify as
|
|
1914 -- such, the object must be
|
|
1915 -- * Of a type that yields a synchronized object
|
|
1916 -- * An atomic object with enabled Async_Writers
|
|
1917 -- * A constant
|
|
1918 -- * A variable subject to pragma Constant_After_Elaboration
|
|
1919
|
|
1920 function Is_Synchronized_Tagged_Type (E : Entity_Id) return Boolean;
|
|
1921 -- Returns True if E is a synchronized tagged type (AARM 3.9.4 (6/2))
|
|
1922
|
|
1923 function Is_Transfer (N : Node_Id) return Boolean;
|
|
1924 -- Returns True if the node N is a statement which is known to cause an
|
|
1925 -- unconditional transfer of control at runtime, i.e. the following
|
|
1926 -- statement definitely will not be executed.
|
|
1927
|
|
1928 function Is_True (U : Uint) return Boolean;
|
|
1929 pragma Inline (Is_True);
|
|
1930 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
|
|
1931 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
|
|
1932 -- if it is True (i.e. non-zero).
|
|
1933
|
|
1934 function Is_Unchecked_Conversion_Instance (Id : Entity_Id) return Boolean;
|
|
1935 -- Determine whether an arbitrary entity denotes an instance of function
|
|
1936 -- Ada.Unchecked_Conversion.
|
|
1937
|
|
1938 function Is_Universal_Numeric_Type (T : Entity_Id) return Boolean;
|
|
1939 pragma Inline (Is_Universal_Numeric_Type);
|
|
1940 -- True if T is Universal_Integer or Universal_Real
|
|
1941
|
|
1942 function Is_User_Defined_Equality (Id : Entity_Id) return Boolean;
|
|
1943 -- Determine whether an entity denotes a user-defined equality
|
|
1944
|
|
1945 function Is_Validation_Variable_Reference (N : Node_Id) return Boolean;
|
|
1946 -- Determine whether N denotes a reference to a variable which captures the
|
|
1947 -- value of an object for validation purposes.
|
|
1948
|
|
1949 function Is_Variable_Size_Array (E : Entity_Id) return Boolean;
|
|
1950 -- Returns true if E has variable size components
|
|
1951
|
|
1952 function Is_Variable_Size_Record (E : Entity_Id) return Boolean;
|
|
1953 -- Returns true if E has variable size components
|
|
1954
|
|
1955 function Is_Variable
|
|
1956 (N : Node_Id;
|
|
1957 Use_Original_Node : Boolean := True) return Boolean;
|
|
1958 -- Determines if the tree referenced by N represents a variable, i.e. can
|
|
1959 -- appear on the left side of an assignment. There is one situation (formal
|
|
1960 -- parameters) in which untagged type conversions are also considered
|
|
1961 -- variables, but Is_Variable returns False for such cases, since it has
|
|
1962 -- no knowledge of the context. Note that this is the point at which
|
|
1963 -- Assignment_OK is checked, and True is returned for any tree thus marked.
|
|
1964 -- Use_Original_Node is used to perform the test on Original_Node (N). By
|
|
1965 -- default is True since this routine is commonly invoked as part of the
|
|
1966 -- semantic analysis and it must not be disturbed by the rewriten nodes.
|
|
1967
|
|
1968 function Is_Verifiable_DIC_Pragma (Prag : Node_Id) return Boolean;
|
|
1969 -- Determine whether pragma Default_Initial_Condition denoted by Prag has
|
|
1970 -- an assertion expression which should be verified at runtime.
|
|
1971
|
|
1972 function Is_Visibly_Controlled (T : Entity_Id) return Boolean;
|
|
1973 -- Check whether T is derived from a visibly controlled type. This is true
|
|
1974 -- if the root type is declared in Ada.Finalization. If T is derived
|
|
1975 -- instead from a private type whose full view is controlled, an explicit
|
|
1976 -- Initialize/Adjust/Finalize subprogram does not override the inherited
|
|
1977 -- one.
|
|
1978
|
|
1979 function Is_Volatile_Function (Func_Id : Entity_Id) return Boolean;
|
|
1980 -- Determine whether [generic] function Func_Id is subject to enabled
|
|
1981 -- pragma Volatile_Function. Protected functions are treated as volatile
|
|
1982 -- (SPARK RM 7.1.2).
|
|
1983
|
|
1984 function Is_Volatile_Object (N : Node_Id) return Boolean;
|
|
1985 -- Determines if the given node denotes an volatile object in the sense of
|
|
1986 -- the legality checks described in RM C.6(12). Note that the test here is
|
|
1987 -- for something actually declared as volatile, not for an object that gets
|
|
1988 -- treated as volatile (see Einfo.Treat_As_Volatile).
|
|
1989
|
|
1990 generic
|
|
1991 with procedure Handle_Parameter (Formal : Entity_Id; Actual : Node_Id);
|
|
1992 procedure Iterate_Call_Parameters (Call : Node_Id);
|
|
1993 -- Calls Handle_Parameter for each pair of formal and actual parameters of
|
|
1994 -- a function, procedure, or entry call.
|
|
1995
|
|
1996 function Itype_Has_Declaration (Id : Entity_Id) return Boolean;
|
|
1997 -- Applies to Itypes. True if the Itype is attached to a declaration for
|
|
1998 -- the type through its Parent field, which may or not be present in the
|
|
1999 -- tree.
|
|
2000
|
|
2001 procedure Kill_Current_Values (Last_Assignment_Only : Boolean := False);
|
|
2002 -- This procedure is called to clear all constant indications from all
|
|
2003 -- entities in the current scope and in any parent scopes if the current
|
|
2004 -- scope is a block or a package (and that recursion continues to the top
|
|
2005 -- scope that is not a block or a package). This is used when the
|
|
2006 -- sequential flow-of-control assumption is violated (occurrence of a
|
|
2007 -- label, head of a loop, or start of an exception handler). The effect of
|
|
2008 -- the call is to clear the Current_Value field (but we do not need to
|
|
2009 -- clear the Is_True_Constant flag, since that only gets reset if there
|
|
2010 -- really is an assignment somewhere in the entity scope). This procedure
|
|
2011 -- also calls Kill_All_Checks, since this is a special case of needing to
|
|
2012 -- forget saved values. This procedure also clears the Is_Known_Null and
|
|
2013 -- Is_Known_Non_Null and Is_Known_Valid flags in variables, constants or
|
|
2014 -- parameters since these are also not known to be trustable any more.
|
|
2015 --
|
|
2016 -- The Last_Assignment_Only flag is set True to clear only Last_Assignment
|
|
2017 -- fields and leave other fields unchanged. This is used when we encounter
|
|
2018 -- an unconditional flow of control change (return, goto, raise). In such
|
|
2019 -- cases we don't need to clear the current values, since it may be that
|
|
2020 -- the flow of control change occurs in a conditional context, and if it
|
|
2021 -- is not taken, then it is just fine to keep the current values. But the
|
|
2022 -- Last_Assignment field is different, if we have a sequence assign-to-v,
|
|
2023 -- conditional-return, assign-to-v, we do not want to complain that the
|
|
2024 -- second assignment clobbers the first.
|
|
2025
|
|
2026 procedure Kill_Current_Values
|
|
2027 (Ent : Entity_Id;
|
|
2028 Last_Assignment_Only : Boolean := False);
|
|
2029 -- This performs the same processing as described above for the form with
|
|
2030 -- no argument, but for the specific entity given. The call has no effect
|
|
2031 -- if the entity Ent is not for an object. Last_Assignment_Only has the
|
|
2032 -- same meaning as for the call with no Ent.
|
|
2033
|
|
2034 procedure Kill_Size_Check_Code (E : Entity_Id);
|
|
2035 -- Called when an address clause or pragma Import is applied to an entity.
|
|
2036 -- If the entity is a variable or a constant, and size check code is
|
|
2037 -- present, this size check code is killed, since the object will not be
|
|
2038 -- allocated by the program.
|
|
2039
|
|
2040 function Known_Non_Null (N : Node_Id) return Boolean;
|
|
2041 -- Given a node N for a subexpression of an access type, determines if
|
|
2042 -- this subexpression yields a value that is known at compile time to
|
|
2043 -- be non-null and returns True if so. Returns False otherwise. It is
|
|
2044 -- an error to call this function if N is not of an access type.
|
|
2045
|
|
2046 function Known_Null (N : Node_Id) return Boolean;
|
|
2047 -- Given a node N for a subexpression of an access type, determines if this
|
|
2048 -- subexpression yields a value that is known at compile time to be null
|
|
2049 -- and returns True if so. Returns False otherwise. It is an error to call
|
|
2050 -- this function if N is not of an access type.
|
|
2051
|
|
2052 function Known_To_Be_Assigned (N : Node_Id) return Boolean;
|
|
2053 -- The node N is an entity reference. This function determines whether the
|
|
2054 -- reference is for sure an assignment of the entity, returning True if
|
|
2055 -- so. This differs from May_Be_Lvalue in that it defaults in the other
|
|
2056 -- direction. Cases which may possibly be assignments but are not known to
|
|
2057 -- be may return True from May_Be_Lvalue, but False from this function.
|
|
2058
|
|
2059 function Last_Source_Statement (HSS : Node_Id) return Node_Id;
|
|
2060 -- HSS is a handled statement sequence. This function returns the last
|
|
2061 -- statement in Statements (HSS) that has Comes_From_Source set. If no
|
|
2062 -- such statement exists, Empty is returned.
|
|
2063
|
|
2064 procedure Mark_Coextensions (Context_Nod : Node_Id; Root_Nod : Node_Id);
|
|
2065 -- Given a node which designates the context of analysis and an origin in
|
|
2066 -- the tree, traverse from Root_Nod and mark all allocators as either
|
|
2067 -- dynamic or static depending on Context_Nod. Any incorrect marking is
|
|
2068 -- cleaned up during resolution.
|
|
2069
|
|
2070 procedure Mark_Elaboration_Attributes
|
|
2071 (N_Id : Node_Or_Entity_Id;
|
|
2072 Checks : Boolean := False;
|
|
2073 Level : Boolean := False;
|
|
2074 Modes : Boolean := False);
|
|
2075 -- Preserve relevant elaboration-related properties of the context in
|
|
2076 -- arbitrary entity or node N_Id. When flag Checks is set, the routine
|
|
2077 -- saves the status of Elaboration_Check. When flag Level is set, the
|
|
2078 -- routine captures the declaration level of N_Id if applicable. When
|
|
2079 -- flag Modes is set, the routine saves the Ghost and SPARK modes in
|
|
2080 -- effect if applicable.
|
|
2081
|
|
2082 function Matching_Static_Array_Bounds
|
|
2083 (L_Typ : Node_Id;
|
|
2084 R_Typ : Node_Id) return Boolean;
|
|
2085 -- L_Typ and R_Typ are two array types. Returns True when they have the
|
|
2086 -- same number of dimensions, and the same static bounds for each index
|
|
2087 -- position.
|
|
2088
|
|
2089 function May_Be_Lvalue (N : Node_Id) return Boolean;
|
|
2090 -- Determines if N could be an lvalue (e.g. an assignment left hand side).
|
|
2091 -- An lvalue is defined as any expression which appears in a context where
|
|
2092 -- a name is required by the syntax, and the identity, rather than merely
|
|
2093 -- the value of the node is needed (for example, the prefix of an Access
|
|
2094 -- attribute is in this category). Note that, as implied by the name, this
|
|
2095 -- test is conservative. If it cannot be sure that N is NOT an lvalue, then
|
|
2096 -- it returns True. It tries hard to get the answer right, but it is hard
|
|
2097 -- to guarantee this in all cases. Note that it is more possible to give
|
|
2098 -- correct answer if the tree is fully analyzed.
|
|
2099
|
|
2100 function Might_Raise (N : Node_Id) return Boolean;
|
|
2101 -- True if evaluation of N might raise an exception. This is conservative;
|
|
2102 -- if we're not sure, we return True. If N is a subprogram body, this is
|
|
2103 -- about whether execution of that body can raise.
|
|
2104
|
|
2105 function Nearest_Enclosing_Instance (E : Entity_Id) return Entity_Id;
|
|
2106 -- Return the entity of the nearest enclosing instance which encapsulates
|
|
2107 -- entity E. If no such instance exits, return Empty.
|
|
2108
|
|
2109 function Needs_One_Actual (E : Entity_Id) return Boolean;
|
|
2110 -- Returns True if a function has defaults for all but its first formal,
|
|
2111 -- which is a controlling formal. Used in Ada 2005 mode to solve the
|
|
2112 -- syntactic ambiguity that results from an indexing of a function call
|
|
2113 -- that returns an array, so that Obj.F (X, Y) may mean F (Ob) (X, Y).
|
|
2114
|
|
2115 function New_Copy_List_Tree (List : List_Id) return List_Id;
|
|
2116 -- Copy recursively an analyzed list of nodes. Uses New_Copy_Tree defined
|
|
2117 -- below. As for New_Copy_Tree, it is illegal to attempt to copy extended
|
|
2118 -- nodes (entities) either directly or indirectly using this function.
|
|
2119
|
|
2120 function New_Copy_Tree
|
|
2121 (Source : Node_Id;
|
|
2122 Map : Elist_Id := No_Elist;
|
|
2123 New_Sloc : Source_Ptr := No_Location;
|
|
2124 New_Scope : Entity_Id := Empty) return Node_Id;
|
|
2125 -- Perform a deep copy of the subtree rooted at Source. Entities, itypes,
|
|
2126 -- and nodes are handled separately as follows:
|
|
2127 --
|
|
2128 -- * A node is replicated by first creating a shallow copy, then copying
|
|
2129 -- its syntactic fields, where all Parent pointers of the fields are
|
|
2130 -- updated to refer to the copy. In addition, the following semantic
|
|
2131 -- fields are recreated after the replication takes place.
|
|
2132 --
|
|
2133 -- First_Named_Actual
|
|
2134 -- First_Real_Statement
|
|
2135 -- Next_Named_Actual
|
|
2136 --
|
|
2137 -- If applicable, the Etype field (if any) is updated to refer to a
|
|
2138 -- local itype or type (see below).
|
|
2139 --
|
|
2140 -- * An entity defined within an N_Expression_With_Actions node in the
|
|
2141 -- subtree is given a new entity, and all references to the original
|
|
2142 -- entity are updated to refer to the new entity. In addition, the
|
|
2143 -- following semantic fields are replicated and/or updated to refer
|
|
2144 -- to a local entity or itype.
|
|
2145 --
|
|
2146 -- Discriminant_Constraint
|
|
2147 -- Etype
|
|
2148 -- First_Index
|
|
2149 -- Next_Entity
|
|
2150 -- Packed_Array_Impl_Type
|
|
2151 -- Scalar_Range
|
|
2152 -- Scope
|
|
2153 --
|
|
2154 -- Note that currently no other expression can define entities.
|
|
2155 --
|
|
2156 -- * An itype whose Associated_Node_For_Itype node is in the subtree
|
|
2157 -- is given a new entity, and all references to the original itype
|
|
2158 -- are updated to refer to the new itype. In addition, the following
|
|
2159 -- semantic fields are replicated and/or updated to refer to a local
|
|
2160 -- entity or itype.
|
|
2161 --
|
|
2162 -- Discriminant_Constraint
|
|
2163 -- Etype
|
|
2164 -- First_Index
|
|
2165 -- Next_Entity
|
|
2166 -- Packed_Array_Impl_Type
|
|
2167 -- Scalar_Range
|
|
2168 -- Scope
|
|
2169 --
|
|
2170 -- The Associated_Node_For_Itype is updated to refer to a replicated
|
|
2171 -- node.
|
|
2172 --
|
|
2173 -- The routine can replicate both analyzed and unanalyzed trees. Copying an
|
|
2174 -- Empty or Error node yields the same node.
|
|
2175 --
|
|
2176 -- Parameter Map may be used to specify a set of mappings between entities.
|
|
2177 -- These mappings are then taken into account when replicating entities.
|
|
2178 -- The format of Map must be as follows:
|
|
2179 --
|
|
2180 -- old entity 1
|
|
2181 -- new entity to replace references to entity 1
|
|
2182 -- old entity 2
|
|
2183 -- new entity to replace references to entity 2
|
|
2184 -- ...
|
|
2185 --
|
|
2186 -- Map and its contents are left unchanged.
|
|
2187 --
|
|
2188 -- Parameter New_Sloc may be used to specify a new source location for all
|
|
2189 -- replicated entities, itypes, and nodes. The Comes_From_Source indicator
|
|
2190 -- is defaulted if a new source location is provided.
|
|
2191 --
|
|
2192 -- Parameter New_Scope may be used to specify a new scope for all copied
|
|
2193 -- entities and itypes.
|
|
2194
|
|
2195 function New_External_Entity
|
|
2196 (Kind : Entity_Kind;
|
|
2197 Scope_Id : Entity_Id;
|
|
2198 Sloc_Value : Source_Ptr;
|
|
2199 Related_Id : Entity_Id;
|
|
2200 Suffix : Character;
|
|
2201 Suffix_Index : Nat := 0;
|
|
2202 Prefix : Character := ' ') return Entity_Id;
|
|
2203 -- This function creates an N_Defining_Identifier node for an internal
|
|
2204 -- created entity, such as an implicit type or subtype, or a record
|
|
2205 -- initialization procedure. The entity name is constructed with a call
|
|
2206 -- to New_External_Name (Related_Id, Suffix, Suffix_Index, Prefix), so
|
|
2207 -- that the generated name may be referenced as a public entry, and the
|
|
2208 -- Is_Public flag is set if needed (using Set_Public_Status). If the
|
|
2209 -- entity is for a type or subtype, the size/align fields are initialized
|
|
2210 -- to unknown (Uint_0).
|
|
2211
|
|
2212 function New_Internal_Entity
|
|
2213 (Kind : Entity_Kind;
|
|
2214 Scope_Id : Entity_Id;
|
|
2215 Sloc_Value : Source_Ptr;
|
|
2216 Id_Char : Character) return Entity_Id;
|
|
2217 -- This function is similar to New_External_Entity, except that the
|
|
2218 -- name is constructed by New_Internal_Name (Id_Char). This is used
|
|
2219 -- when the resulting entity does not have to be referenced as a
|
|
2220 -- public entity (and in this case Is_Public is not set).
|
|
2221
|
|
2222 procedure Next_Actual (Actual_Id : in out Node_Id);
|
|
2223 pragma Inline (Next_Actual);
|
|
2224 -- Next_Actual (N) is equivalent to N := Next_Actual (N). Note that we
|
|
2225 -- inline this procedural form, but not the functional form that follows.
|
|
2226
|
|
2227 function Next_Actual (Actual_Id : Node_Id) return Node_Id;
|
|
2228 -- Find next actual parameter in declaration order. As described for
|
|
2229 -- First_Actual, this is the next actual in the declaration order, not
|
|
2230 -- the call order, so this does not correspond to simply taking the
|
|
2231 -- next entry of the Parameter_Associations list. The argument is an
|
|
2232 -- actual previously returned by a call to First_Actual or Next_Actual.
|
|
2233 -- Note that the result produced is always an expression, not a parameter
|
|
2234 -- association node, even if named notation was used.
|
|
2235
|
|
2236 procedure Next_Global (Node : in out Node_Id);
|
|
2237 pragma Inline (Next_Actual);
|
|
2238 -- Next_Global (N) is equivalent to N := Next_Global (N). Note that we
|
|
2239 -- inline this procedural form, but not the functional form that follows.
|
|
2240
|
|
2241 function Next_Global (Node : Node_Id) return Node_Id;
|
|
2242 -- Node is a global item from a list, obtained through calling First_Global
|
|
2243 -- and possibly Next_Global a number of times. Returns the next global item
|
|
2244 -- with the same mode.
|
|
2245
|
|
2246 function No_Heap_Finalization (Typ : Entity_Id) return Boolean;
|
|
2247 -- Determine whether type Typ is subject to pragma No_Heap_Finalization
|
|
2248
|
|
2249 procedure Normalize_Actuals
|
|
2250 (N : Node_Id;
|
|
2251 S : Entity_Id;
|
|
2252 Report : Boolean;
|
|
2253 Success : out Boolean);
|
|
2254 -- Reorders lists of actuals according to names of formals, value returned
|
|
2255 -- in Success indicates success of reordering. For more details, see body.
|
|
2256 -- Errors are reported only if Report is set to True.
|
|
2257
|
|
2258 procedure Note_Possible_Modification (N : Node_Id; Sure : Boolean);
|
|
2259 -- This routine is called if the sub-expression N maybe the target of
|
|
2260 -- an assignment (e.g. it is the left side of an assignment, used as
|
|
2261 -- an out parameters, or used as prefixes of access attributes). It
|
|
2262 -- sets May_Be_Modified in the associated entity if there is one,
|
|
2263 -- taking into account the rule that in the case of renamed objects,
|
|
2264 -- it is the flag in the renamed object that must be set.
|
|
2265 --
|
|
2266 -- The parameter Sure is set True if the modification is sure to occur
|
|
2267 -- (e.g. target of assignment, or out parameter), and to False if the
|
|
2268 -- modification is only potential (e.g. address of entity taken).
|
|
2269
|
|
2270 function Null_To_Null_Address_Convert_OK
|
|
2271 (N : Node_Id;
|
|
2272 Typ : Entity_Id := Empty) return Boolean;
|
|
2273 -- Return True if we are compiling in relaxed RM semantics mode and:
|
|
2274 -- 1) N is a N_Null node and Typ is a descendant of System.Address, or
|
|
2275 -- 2) N is a comparison operator, one of the operands is null, and the
|
|
2276 -- type of the other operand is a descendant of System.Address.
|
|
2277
|
|
2278 function Number_Of_Elements_In_Array (T : Entity_Id) return Int;
|
|
2279 -- Returns the number of elements in the array T if the index bounds of T
|
|
2280 -- is known at compile time. If the bounds are not known at compile time,
|
|
2281 -- the function returns the value zero.
|
|
2282
|
|
2283 function Object_Access_Level (Obj : Node_Id) return Uint;
|
|
2284 -- Return the accessibility level of the view of the object Obj. For
|
|
2285 -- convenience, qualified expressions applied to object names are also
|
|
2286 -- allowed as actuals for this function.
|
|
2287
|
|
2288 function Original_Aspect_Pragma_Name (N : Node_Id) return Name_Id;
|
|
2289 -- Retrieve the name of aspect or pragma N, taking into account a possible
|
|
2290 -- rewrite and whether the pragma is generated from an aspect as the names
|
|
2291 -- may be different. The routine also deals with 'Class in which case it
|
|
2292 -- returns the following values:
|
|
2293 --
|
|
2294 -- Invariant -> Name_uInvariant
|
|
2295 -- Post'Class -> Name_uPost
|
|
2296 -- Pre'Class -> Name_uPre
|
|
2297 -- Type_Invariant -> Name_uType_Invariant
|
|
2298 -- Type_Invariant'Class -> Name_uType_Invariant
|
|
2299
|
|
2300 function Original_Corresponding_Operation (S : Entity_Id) return Entity_Id;
|
|
2301 -- [Ada 2012: AI05-0125-1]: If S is an inherited dispatching primitive S2,
|
|
2302 -- or overrides an inherited dispatching primitive S2, the original
|
|
2303 -- corresponding operation of S is the original corresponding operation of
|
|
2304 -- S2. Otherwise, it is S itself.
|
|
2305
|
|
2306 procedure Output_Entity (Id : Entity_Id);
|
|
2307 -- Print entity Id to standard output. The name of the entity appears in
|
|
2308 -- fully qualified form.
|
|
2309 --
|
|
2310 -- WARNING: this routine should be used in debugging scenarios such as
|
|
2311 -- tracking down undefined symbols as it is fairly low level.
|
|
2312
|
|
2313 procedure Output_Name (Nam : Name_Id; Scop : Entity_Id := Current_Scope);
|
|
2314 -- Print name Nam to standard output. The name appears in fully qualified
|
|
2315 -- form assuming it appears in scope Scop. Note that this may not reflect
|
|
2316 -- the final qualification as the entity which carries the name may be
|
|
2317 -- relocated to a different scope.
|
|
2318 --
|
|
2319 -- WARNING: this routine should be used in debugging scenarios such as
|
|
2320 -- tracking down undefined symbols as it is fairly low level.
|
|
2321
|
|
2322 function Policy_In_Effect (Policy : Name_Id) return Name_Id;
|
|
2323 -- Given a policy, return the policy identifier associated with it. If no
|
|
2324 -- such policy is in effect, the value returned is No_Name.
|
|
2325
|
|
2326 function Predicate_Tests_On_Arguments (Subp : Entity_Id) return Boolean;
|
|
2327 -- Subp is the entity for a subprogram call. This function returns True if
|
|
2328 -- predicate tests are required for the arguments in this call (this is the
|
|
2329 -- normal case). It returns False for special cases where these predicate
|
|
2330 -- tests should be skipped (see body for details).
|
|
2331
|
|
2332 function Primitive_Names_Match (E1, E2 : Entity_Id) return Boolean;
|
|
2333 -- Returns True if the names of both entities correspond with matching
|
|
2334 -- primitives. This routine includes support for the case in which one
|
|
2335 -- or both entities correspond with entities built by Derive_Subprogram
|
|
2336 -- with a special name to avoid being overridden (i.e. return true in case
|
|
2337 -- of entities with names "nameP" and "name" or vice versa).
|
|
2338
|
|
2339 function Private_Component (Type_Id : Entity_Id) return Entity_Id;
|
|
2340 -- Returns some private component (if any) of the given Type_Id.
|
|
2341 -- Used to enforce the rules on visibility of operations on composite
|
|
2342 -- types, that depend on the full view of the component type. For a
|
|
2343 -- record type there may be several such components, we just return
|
|
2344 -- the first one.
|
|
2345
|
|
2346 procedure Process_End_Label
|
|
2347 (N : Node_Id;
|
|
2348 Typ : Character;
|
|
2349 Ent : Entity_Id);
|
|
2350 -- N is a node whose End_Label is to be processed, generating all
|
|
2351 -- appropriate cross-reference entries, and performing style checks
|
|
2352 -- for any identifier references in the end label. Typ is either
|
|
2353 -- 'e' or 't indicating the type of the cross-reference entity
|
|
2354 -- (e for spec, t for body, see Lib.Xref spec for details). The
|
|
2355 -- parameter Ent gives the entity to which the End_Label refers,
|
|
2356 -- and to which cross-references are to be generated.
|
|
2357
|
|
2358 procedure Propagate_Concurrent_Flags
|
|
2359 (Typ : Entity_Id;
|
|
2360 Comp_Typ : Entity_Id);
|
|
2361 -- Set Has_Task, Has_Protected and Has_Timing_Event on Typ when the flags
|
|
2362 -- are set on Comp_Typ. This follows the definition of these flags which
|
|
2363 -- are set (recursively) on any composite type which has a component marked
|
|
2364 -- by one of these flags. This procedure can only set flags for Typ, and
|
|
2365 -- never clear them. Comp_Typ is the type of a component or a parent.
|
|
2366
|
|
2367 procedure Propagate_DIC_Attributes
|
|
2368 (Typ : Entity_Id;
|
|
2369 From_Typ : Entity_Id);
|
|
2370 -- Inherit all Default_Initial_Condition-related attributes from type
|
|
2371 -- From_Typ. Typ is the destination type.
|
|
2372
|
|
2373 procedure Propagate_Invariant_Attributes
|
|
2374 (Typ : Entity_Id;
|
|
2375 From_Typ : Entity_Id);
|
|
2376 -- Inherit all invariant-related attributes form type From_Typ. Typ is the
|
|
2377 -- destination type.
|
|
2378
|
|
2379 procedure Record_Possible_Part_Of_Reference
|
|
2380 (Var_Id : Entity_Id;
|
|
2381 Ref : Node_Id);
|
|
2382 -- Save reference Ref to variable Var_Id when the variable is subject to
|
|
2383 -- pragma Part_Of. If the variable is known to be a constituent of a single
|
|
2384 -- protected/task type, the legality of the reference is verified and the
|
|
2385 -- save does not take place.
|
|
2386
|
|
2387 function Referenced (Id : Entity_Id; Expr : Node_Id) return Boolean;
|
|
2388 -- Determine whether entity Id is referenced within expression Expr
|
|
2389
|
|
2390 function References_Generic_Formal_Type (N : Node_Id) return Boolean;
|
|
2391 -- Returns True if the expression Expr contains any references to a generic
|
|
2392 -- type. This can only happen within a generic template.
|
|
2393
|
|
2394 procedure Remove_Entity (Id : Entity_Id);
|
|
2395 -- Remove arbitrary entity Id from both the homonym and scope chains. Use
|
|
2396 -- Remove_Overloaded_Entity for overloadable entities. Note: the removal
|
|
2397 -- performed by this routine does not affect the visibility of existing
|
|
2398 -- homonyms.
|
|
2399
|
|
2400 procedure Remove_Homonym (E : Entity_Id);
|
|
2401 -- Removes E from the homonym chain
|
|
2402
|
|
2403 procedure Remove_Overloaded_Entity (Id : Entity_Id);
|
|
2404 -- Remove arbitrary entity Id from the homonym chain, the scope chain and
|
|
2405 -- the primitive operations list of the associated controlling type. Use
|
|
2406 -- Remove_Entity for non-overloadable entities. Note: the removal performed
|
|
2407 -- by this routine does not affect the visibility of existing homonyms.
|
|
2408
|
|
2409 function Remove_Suffix (E : Entity_Id; Suffix : Character) return Name_Id;
|
|
2410 -- Returns the name of E without Suffix
|
|
2411
|
|
2412 procedure Replace_Null_By_Null_Address (N : Node_Id);
|
|
2413 -- N is N_Null or a binary comparison operator, we are compiling in relaxed
|
|
2414 -- RM semantics mode, and one of the operands is null. Replace null with
|
|
2415 -- System.Null_Address.
|
|
2416
|
|
2417 function Rep_To_Pos_Flag (E : Entity_Id; Loc : Source_Ptr) return Node_Id;
|
|
2418 -- This is used to construct the second argument in a call to Rep_To_Pos
|
|
2419 -- which is Standard_True if range checks are enabled (E is an entity to
|
|
2420 -- which the Range_Checks_Suppressed test is applied), and Standard_False
|
|
2421 -- if range checks are suppressed. Loc is the location for the node that
|
|
2422 -- is returned (which is a New_Occurrence of the appropriate entity).
|
|
2423 --
|
|
2424 -- Note: one might think that it would be fine to always use True and
|
|
2425 -- to ignore the suppress in this case, but it is generally better to
|
|
2426 -- believe a request to suppress exceptions if possible, and further
|
|
2427 -- more there is at least one case in the generated code (the code for
|
|
2428 -- array assignment in a loop) that depends on this suppression.
|
|
2429
|
|
2430 procedure Require_Entity (N : Node_Id);
|
|
2431 -- N is a node which should have an entity value if it is an entity name.
|
|
2432 -- If not, then check if there were previous errors. If so, just fill
|
|
2433 -- in with Any_Id and ignore. Otherwise signal a program error exception.
|
|
2434 -- This is used as a defense mechanism against ill-formed trees caused by
|
|
2435 -- previous errors (particularly in -gnatq mode).
|
|
2436
|
|
2437 function Requires_Transient_Scope (Id : Entity_Id) return Boolean;
|
|
2438 -- Id is a type entity. The result is True when temporaries of this type
|
|
2439 -- need to be wrapped in a transient scope to be reclaimed properly when a
|
|
2440 -- secondary stack is in use. Examples of types requiring such wrapping are
|
|
2441 -- controlled types and variable-sized types including unconstrained
|
|
2442 -- arrays.
|
|
2443
|
|
2444 procedure Reset_Analyzed_Flags (N : Node_Id);
|
|
2445 -- Reset the Analyzed flags in all nodes of the tree whose root is N
|
|
2446
|
|
2447 procedure Restore_SPARK_Mode (Mode : SPARK_Mode_Type; Prag : Node_Id);
|
|
2448 -- Set the current SPARK_Mode to Mode and SPARK_Mode_Pragma to Prag. This
|
|
2449 -- routine must be used in tandem with Set_SPARK_Mode.
|
|
2450
|
|
2451 function Returns_Unconstrained_Type (Subp : Entity_Id) return Boolean;
|
|
2452 -- Return true if Subp is a function that returns an unconstrained type
|
|
2453
|
|
2454 function Root_Type_Of_Full_View (T : Entity_Id) return Entity_Id;
|
|
2455 -- Similar to attribute Root_Type, but this version always follows the
|
|
2456 -- Full_View of a private type (if available) while searching for the
|
|
2457 -- ultimate derivation ancestor.
|
|
2458
|
|
2459 function Safe_To_Capture_Value
|
|
2460 (N : Node_Id;
|
|
2461 Ent : Entity_Id;
|
|
2462 Cond : Boolean := False) return Boolean;
|
|
2463 -- The caller is interested in capturing a value (either the current value,
|
|
2464 -- or an indication that the value is non-null) for the given entity Ent.
|
|
2465 -- This value can only be captured if sequential execution semantics can be
|
|
2466 -- properly guaranteed so that a subsequent reference will indeed be sure
|
|
2467 -- that this current value indication is correct. The node N is the
|
|
2468 -- construct which resulted in the possible capture of the value (this
|
|
2469 -- is used to check if we are in a conditional).
|
|
2470 --
|
|
2471 -- Cond is used to skip the test for being inside a conditional. It is used
|
|
2472 -- in the case of capturing values from if/while tests, which already do a
|
|
2473 -- proper job of handling scoping issues without this help.
|
|
2474 --
|
|
2475 -- The only entities whose values can be captured are OUT and IN OUT formal
|
|
2476 -- parameters, and variables unless Cond is True, in which case we also
|
|
2477 -- allow IN formals, loop parameters and constants, where we cannot ever
|
|
2478 -- capture actual value information, but we can capture conditional tests.
|
|
2479
|
|
2480 function Same_Name (N1, N2 : Node_Id) return Boolean;
|
|
2481 -- Determine if two (possibly expanded) names are the same name. This is
|
|
2482 -- a purely syntactic test, and N1 and N2 need not be analyzed.
|
|
2483
|
|
2484 function Same_Object (Node1, Node2 : Node_Id) return Boolean;
|
|
2485 -- Determine if Node1 and Node2 are known to designate the same object.
|
|
2486 -- This is a semantic test and both nodes must be fully analyzed. A result
|
|
2487 -- of True is decisively correct. A result of False does not necessarily
|
|
2488 -- mean that different objects are designated, just that this could not
|
|
2489 -- be reliably determined at compile time.
|
|
2490
|
|
2491 function Same_Type (T1, T2 : Entity_Id) return Boolean;
|
|
2492 -- Determines if T1 and T2 represent exactly the same type. Two types
|
|
2493 -- are the same if they are identical, or if one is an unconstrained
|
|
2494 -- subtype of the other, or they are both common subtypes of the same
|
|
2495 -- type with identical constraints. The result returned is conservative.
|
|
2496 -- It is True if the types are known to be the same, but a result of
|
|
2497 -- False is indecisive (e.g. the compiler may not be able to tell that
|
|
2498 -- two constraints are identical).
|
|
2499
|
|
2500 function Same_Value (Node1, Node2 : Node_Id) return Boolean;
|
|
2501 -- Determines if Node1 and Node2 are known to be the same value, which is
|
|
2502 -- true if they are both compile time known values and have the same value,
|
|
2503 -- or if they are the same object (in the sense of function Same_Object).
|
|
2504 -- A result of False does not necessarily mean they have different values,
|
|
2505 -- just that it is not possible to determine they have the same value.
|
|
2506
|
|
2507 function Scalar_Part_Present (T : Entity_Id) return Boolean;
|
|
2508 -- Tests if type T can be determined at compile time to have at least one
|
|
2509 -- scalar part in the sense of the Valid_Scalars attribute. Returns True if
|
|
2510 -- this is the case, and False if no scalar parts are present (meaning that
|
|
2511 -- the result of Valid_Scalars applied to T is always vacuously True).
|
|
2512
|
|
2513 function Scope_Within
|
|
2514 (Inner : Entity_Id;
|
|
2515 Outer : Entity_Id) return Boolean;
|
|
2516 -- Determine whether scope Inner appears within scope Outer. Note that
|
|
2517 -- scopes are partially ordered, so Scope_Within (A, B) and Scope_Within
|
|
2518 -- (B, A) may both return False.
|
|
2519
|
|
2520 function Scope_Within_Or_Same
|
|
2521 (Inner : Entity_Id;
|
|
2522 Outer : Entity_Id) return Boolean;
|
|
2523 -- Determine whether scope Inner appears within scope Outer or both renote
|
|
2524 -- the same scope. Note that scopes are partially ordered, so Scope_Within
|
|
2525 -- (A, B) and Scope_Within (B, A) may both return False.
|
|
2526
|
|
2527 procedure Set_Convention (E : Entity_Id; Val : Convention_Id);
|
|
2528 -- Same as Basic_Set_Convention, but with an extra check for access types.
|
|
2529 -- In particular, if E is an access-to-subprogram type, and Val is a
|
|
2530 -- foreign convention, then we set Can_Use_Internal_Rep to False on E.
|
|
2531 -- Also, if the Etype of E is set and is an anonymous access type with
|
|
2532 -- no convention set, this anonymous type inherits the convention of E.
|
|
2533
|
|
2534 procedure Set_Current_Entity (E : Entity_Id);
|
|
2535 pragma Inline (Set_Current_Entity);
|
|
2536 -- Establish the entity E as the currently visible definition of its
|
|
2537 -- associated name (i.e. the Node_Id associated with its name).
|
|
2538
|
|
2539 procedure Set_Debug_Info_Needed (T : Entity_Id);
|
|
2540 -- Sets the Debug_Info_Needed flag on entity T , and also on any entities
|
|
2541 -- that are needed by T (for an object, the type of the object is needed,
|
|
2542 -- and for a type, various subsidiary types are needed -- see body for
|
|
2543 -- details). Never has any effect on T if the Debug_Info_Off flag is set.
|
|
2544 -- This routine should always be used instead of Set_Needs_Debug_Info to
|
|
2545 -- ensure that subsidiary entities are properly handled.
|
|
2546
|
|
2547 procedure Set_Entity_With_Checks (N : Node_Id; Val : Entity_Id);
|
|
2548 -- This procedure has the same calling sequence as Set_Entity, but it
|
|
2549 -- performs additional checks as follows:
|
|
2550 --
|
|
2551 -- If Style_Check is set, then it calls a style checking routine which
|
|
2552 -- can check identifier spelling style. This procedure also takes care
|
|
2553 -- of checking the restriction No_Implementation_Identifiers.
|
|
2554 --
|
|
2555 -- If restriction No_Abort_Statements is set, then it checks that the
|
|
2556 -- entity is not Ada.Task_Identification.Abort_Task.
|
|
2557 --
|
|
2558 -- If restriction No_Dynamic_Attachment is set, then it checks that the
|
|
2559 -- entity is not one of the restricted names for this restriction.
|
|
2560 --
|
|
2561 -- If restriction No_Long_Long_Integers is set, then it checks that the
|
|
2562 -- entity is not Standard.Long_Long_Integer.
|
|
2563 --
|
|
2564 -- If restriction No_Implementation_Identifiers is set, then it checks
|
|
2565 -- that the entity is not implementation defined.
|
|
2566
|
|
2567 procedure Set_Name_Entity_Id (Id : Name_Id; Val : Entity_Id);
|
|
2568 pragma Inline (Set_Name_Entity_Id);
|
|
2569 -- Sets the Entity_Id value associated with the given name, which is the
|
|
2570 -- Id of the innermost visible entity with the given name. See the body
|
|
2571 -- of package Sem_Ch8 for further details on the handling of visibility.
|
|
2572
|
|
2573 procedure Set_Next_Actual (Ass1_Id : Node_Id; Ass2_Id : Node_Id);
|
|
2574 -- The arguments may be parameter associations, whose descendants
|
|
2575 -- are the optional formal name and the actual parameter. Positional
|
|
2576 -- parameters are already members of a list, and do not need to be
|
|
2577 -- chained separately. See also First_Actual and Next_Actual.
|
|
2578
|
|
2579 procedure Set_Optimize_Alignment_Flags (E : Entity_Id);
|
|
2580 pragma Inline (Set_Optimize_Alignment_Flags);
|
|
2581 -- Sets Optimize_Alignment_Space/Time flags in E from current settings
|
|
2582
|
|
2583 procedure Set_Public_Status (Id : Entity_Id);
|
|
2584 -- If an entity (visible or otherwise) is defined in a library
|
|
2585 -- package, or a package that is itself public, then this subprogram
|
|
2586 -- labels the entity public as well.
|
|
2587
|
|
2588 procedure Set_Referenced_Modified (N : Node_Id; Out_Param : Boolean);
|
|
2589 -- N is the node for either a left hand side (Out_Param set to False),
|
|
2590 -- or an Out or In_Out parameter (Out_Param set to True). If there is
|
|
2591 -- an assignable entity being referenced, then the appropriate flag
|
|
2592 -- (Referenced_As_LHS if Out_Param is False, Referenced_As_Out_Parameter
|
|
2593 -- if Out_Param is True) is set True, and the other flag set False.
|
|
2594
|
|
2595 procedure Set_Rep_Info (T1 : Entity_Id; T2 : Entity_Id);
|
|
2596 pragma Inline (Set_Rep_Info);
|
|
2597 -- Copies the Is_Atomic, Is_Independent and Is_Volatile_Full_Access flags
|
|
2598 -- from sub(type) entity T2 to (sub)type entity T1, as well as Is_Volatile
|
|
2599 -- if T1 is a base type.
|
|
2600
|
|
2601 procedure Set_Scope_Is_Transient (V : Boolean := True);
|
|
2602 -- Set the flag Is_Transient of the current scope
|
|
2603
|
|
2604 procedure Set_Size_Info (T1, T2 : Entity_Id);
|
|
2605 pragma Inline (Set_Size_Info);
|
|
2606 -- Copies the Esize field and Has_Biased_Representation flag from sub(type)
|
|
2607 -- entity T2 to (sub)type entity T1. Also copies the Is_Unsigned_Type flag
|
|
2608 -- in the fixed-point and discrete cases, and also copies the alignment
|
|
2609 -- value from T2 to T1. It does NOT copy the RM_Size field, which must be
|
|
2610 -- separately set if this is required to be copied also.
|
|
2611
|
|
2612 procedure Set_SPARK_Mode (Context : Entity_Id);
|
|
2613 -- Establish the SPARK_Mode and SPARK_Mode_Pragma (if any) of a package or
|
|
2614 -- a subprogram denoted by Context. This routine must be used in tandem
|
|
2615 -- with Restore_SPARK_Mode.
|
|
2616
|
|
2617 function Scope_Is_Transient return Boolean;
|
|
2618 -- True if the current scope is transient
|
|
2619
|
|
2620 function Should_Ignore_Pragma_Par (Prag_Name : Name_Id) return Boolean;
|
|
2621 function Should_Ignore_Pragma_Sem (N : Node_Id) return Boolean;
|
|
2622 -- True if we should ignore pragmas with the specified name. In particular,
|
|
2623 -- this returns True if pragma Ignore_Pragma applies, and we are not in a
|
|
2624 -- predefined unit. The _Par version should be called only from the parser;
|
|
2625 -- the _Sem version should be called only during semantic analysis.
|
|
2626
|
|
2627 function Static_Boolean (N : Node_Id) return Uint;
|
|
2628 -- This function analyzes the given expression node and then resolves it
|
|
2629 -- as Standard.Boolean. If the result is static, then Uint_1 or Uint_0 is
|
|
2630 -- returned corresponding to the value, otherwise an error message is
|
|
2631 -- output and No_Uint is returned.
|
|
2632
|
|
2633 function Static_Integer (N : Node_Id) return Uint;
|
|
2634 -- This function analyzes the given expression node and then resolves it
|
|
2635 -- as any integer type. If the result is static, then the value of the
|
|
2636 -- universal expression is returned, otherwise an error message is output
|
|
2637 -- and a value of No_Uint is returned.
|
|
2638
|
|
2639 function Statically_Different (E1, E2 : Node_Id) return Boolean;
|
|
2640 -- Return True if it can be statically determined that the Expressions
|
|
2641 -- E1 and E2 refer to different objects
|
|
2642
|
|
2643 function Subject_To_Loop_Entry_Attributes (N : Node_Id) return Boolean;
|
|
2644 -- Determine whether node N is a loop statement subject to at least one
|
|
2645 -- 'Loop_Entry attribute.
|
|
2646
|
|
2647 function Subprogram_Access_Level (Subp : Entity_Id) return Uint;
|
|
2648 -- Return the accessibility level of the view denoted by Subp
|
|
2649
|
|
2650 function Support_Atomic_Primitives (Typ : Entity_Id) return Boolean;
|
|
2651 -- Return True if Typ supports the GCC built-in atomic operations (i.e. if
|
|
2652 -- Typ is properly sized and aligned).
|
|
2653
|
|
2654 procedure Trace_Scope (N : Node_Id; E : Entity_Id; Msg : String);
|
|
2655 -- Print debugging information on entry to each unit being analyzed
|
|
2656
|
|
2657 procedure Transfer_Entities (From : Entity_Id; To : Entity_Id);
|
|
2658 -- Move a list of entities from one scope to another, and recompute
|
|
2659 -- Is_Public based upon the new scope.
|
|
2660
|
|
2661 function Type_Access_Level (Typ : Entity_Id) return Uint;
|
|
2662 -- Return the accessibility level of Typ
|
|
2663
|
|
2664 function Type_Without_Stream_Operation
|
|
2665 (T : Entity_Id;
|
|
2666 Op : TSS_Name_Type := TSS_Null) return Entity_Id;
|
|
2667 -- AI05-0161: In Ada 2012, if the restriction No_Default_Stream_Attributes
|
|
2668 -- is active then we cannot generate stream subprograms for composite types
|
|
2669 -- with elementary subcomponents that lack user-defined stream subprograms.
|
|
2670 -- This predicate determines whether a type has such an elementary
|
|
2671 -- subcomponent. If Op is TSS_Null, a type that lacks either Read or Write
|
|
2672 -- prevents the construction of a composite stream operation. If Op is
|
|
2673 -- specified we check only for the given stream operation.
|
|
2674
|
|
2675 function Unique_Defining_Entity (N : Node_Id) return Entity_Id;
|
|
2676 -- Return the entity which represents declaration N, so that different
|
|
2677 -- views of the same entity have the same unique defining entity:
|
|
2678 -- * private view and full view of a deferred constant
|
|
2679 -- --> full view
|
|
2680 -- * entry spec and entry body
|
|
2681 -- --> entry spec
|
|
2682 -- * formal parameter on spec and body
|
|
2683 -- --> formal parameter on spec
|
|
2684 -- * package spec, body, and body stub
|
|
2685 -- --> package spec
|
|
2686 -- * protected type, protected body, and protected body stub
|
|
2687 -- --> protected type (full view if private)
|
|
2688 -- * subprogram spec, body, and body stub
|
|
2689 -- --> subprogram spec
|
|
2690 -- * task type, task body, and task body stub
|
|
2691 -- --> task type (full view if private)
|
|
2692 -- * private or incomplete view and full view of a type
|
|
2693 -- --> full view
|
|
2694 -- In other cases, return the defining entity for N.
|
|
2695
|
|
2696 function Unique_Entity (E : Entity_Id) return Entity_Id;
|
|
2697 -- Return the unique entity for entity E, which would be returned by
|
|
2698 -- Unique_Defining_Entity if applied to the enclosing declaration of E.
|
|
2699
|
|
2700 function Unique_Name (E : Entity_Id) return String;
|
|
2701 -- Return a unique name for entity E, which could be used to identify E
|
|
2702 -- across compilation units.
|
|
2703
|
|
2704 function Unit_Is_Visible (U : Entity_Id) return Boolean;
|
|
2705 -- Determine whether a compilation unit is visible in the current context,
|
|
2706 -- because there is a with_clause that makes the unit available. Used to
|
|
2707 -- provide better messages on common visiblity errors on operators.
|
|
2708
|
|
2709 function Universal_Interpretation (Opnd : Node_Id) return Entity_Id;
|
|
2710 -- Yields Universal_Integer or Universal_Real if this is a candidate
|
|
2711
|
|
2712 function Unqualify (Expr : Node_Id) return Node_Id;
|
|
2713 pragma Inline (Unqualify);
|
|
2714 -- Removes any qualifications from Expr. For example, for T1'(T2'(X)), this
|
|
2715 -- returns X. If Expr is not a qualified expression, returns Expr.
|
|
2716
|
|
2717 function Unqual_Conv (Expr : Node_Id) return Node_Id;
|
|
2718 pragma Inline (Unqual_Conv);
|
|
2719 -- Similar to Unqualify, but removes qualified expressions, type
|
|
2720 -- conversions, and unchecked conversions.
|
|
2721
|
|
2722 function Visible_Ancestors (Typ : Entity_Id) return Elist_Id;
|
|
2723 -- [Ada 2012:AI-0125-1]: Collect all the visible parents and progenitors
|
|
2724 -- of a type extension or private extension declaration. If the full-view
|
|
2725 -- of private parents and progenitors is available then it is used to
|
|
2726 -- generate the list of visible ancestors; otherwise their partial
|
|
2727 -- view is added to the resulting list.
|
|
2728
|
|
2729 function Within_Init_Proc return Boolean;
|
|
2730 -- Determines if Current_Scope is within an init proc
|
|
2731
|
|
2732 function Within_Protected_Type (E : Entity_Id) return Boolean;
|
|
2733 -- Returns True if entity E is declared within a protected type
|
|
2734
|
|
2735 function Within_Scope (E : Entity_Id; S : Entity_Id) return Boolean;
|
|
2736 -- Returns True if entity E is declared within scope S
|
|
2737
|
|
2738 procedure Wrong_Type (Expr : Node_Id; Expected_Type : Entity_Id);
|
|
2739 -- Output error message for incorrectly typed expression. Expr is the node
|
|
2740 -- for the incorrectly typed construct (Etype (Expr) is the type found),
|
|
2741 -- and Expected_Type is the entity for the expected type. Note that Expr
|
|
2742 -- does not have to be a subexpression, anything with an Etype field may
|
|
2743 -- be used.
|
|
2744
|
|
2745 function Yields_Synchronized_Object (Typ : Entity_Id) return Boolean;
|
|
2746 -- Determine whether type Typ "yields synchronized object" as specified by
|
|
2747 -- SPARK RM 9.1. To qualify as such, a type must be
|
|
2748 -- * An array type whose element type yields a synchronized object
|
|
2749 -- * A descendant of type Ada.Synchronous_Task_Control.Suspension_Object
|
|
2750 -- * A protected type
|
|
2751 -- * A record type or type extension without defaulted discriminants
|
|
2752 -- whose components are of a type that yields a synchronized object.
|
|
2753 -- * A synchronized interface type
|
|
2754 -- * A task type
|
|
2755
|
|
2756 function Yields_Universal_Type (N : Node_Id) return Boolean;
|
|
2757 -- Determine whether unanalyzed node N yields a universal type
|
|
2758
|
|
2759 end Sem_Util;
|