1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2019, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- Package containing utility procedures used throughout the semantics
28 with Einfo
; use Einfo
;
29 with Exp_Tss
; use Exp_Tss
;
30 with Namet
; use Namet
;
32 with Snames
; use Snames
;
33 with Types
; use Types
;
34 with Uintp
; use Uintp
;
35 with Urealp
; use Urealp
;
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
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
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.
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.
61 function Add_Suffix
(E
: Entity_Id
; Suffix
: Character) return Name_Id
;
62 -- Returns the name of E adding Suffix
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.
69 function Address_Value
(N
: Node_Id
) return Node_Id
;
70 -- Return the underlying value of the expression N of an address clause
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).
78 procedure Aggregate_Constraint_Checks
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.
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.
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.
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.
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.
120 procedure Apply_Compile_Time_Constraint_Error
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 that will raise Constraint_Error when evaluated
130 -- at run time. 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
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.
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.
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
171 procedure Bad_Attribute
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
179 procedure Bad_Predicated_Subtype_Use
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
196 function Bad_Unordered_Enumeration_Reference
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.
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.
209 function Build_Actual_Subtype
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.
217 function Build_Actual_Subtype_Of_Component
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.
223 -- Handling of inherited primitives whose ancestors have class-wide
224 -- pre/postconditions.
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.
245 procedure Build_Class_Wide_Clone_Body
246 (Spec_Id
: Entity_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.
252 function Build_Class_Wide_Clone_Call
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.
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.
269 function Build_Default_Subtype
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.
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.
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.
287 function Build_Overriding_Spec
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.
295 procedure Build_Explicit_Dereference
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.
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.
310 procedure Check_Dynamically_Tagged_Expression
313 Related_Nod
: Node_Id
);
314 -- Check wrong use of dynamically tagged expression
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.
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
326 -- If the programmer gave an explicit Pure_Function pragma, then we respect
327 -- the pragma and leave the subprogram Pure.
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
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.
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).
353 procedure Check_Later_Vs_Basic_Declarations
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.
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.
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.
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.
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.
379 procedure Check_Previous_Null_Procedure
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.
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-
394 procedure Check_State_Refinements
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.
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
408 procedure Check_Unprotected_Access
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.
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.
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.
425 procedure Collect_Interfaces
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
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.
442 procedure Collect_Interfaces_Info
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.
453 procedure Collect_Parents
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).
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
466 function Compile_Time_Constraint_Error
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.
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
483 function Copy_Component_List
485 Loc
: Source_Ptr
) return List_Id
;
486 -- Copy components from record type R_Typ that come from source. Used to
487 -- create a new compatible record type. Loc is the source location assigned
488 -- to the created nodes.
490 function Copy_Parameter_List
(Subp_Id
: Entity_Id
) return List_Id
;
491 -- Utility to create a parameter profile for a new subprogram spec, when
492 -- the subprogram has a body that acts as spec. This is done for some cases
493 -- of inlining, and for private protected ops. Also used to create bodies
494 -- for stubbed subprograms.
496 procedure Copy_SPARK_Mode_Aspect
(From
: Node_Id
; To
: Node_Id
);
497 -- Copy the SPARK_Mode aspect if present in the aspect specifications
498 -- of node From to node To. On entry it is assumed that To does not have
499 -- aspect specifications. If From has no aspects, the routine has no
502 function Copy_Subprogram_Spec
(Spec
: Node_Id
) return Node_Id
;
503 -- Replicate a function or a procedure specification denoted by Spec. The
504 -- resulting tree is an exact duplicate of the original tree. New entities
505 -- are created for the unit name and the formal parameters.
507 function Corresponding_Generic_Type
(T
: Entity_Id
) return Entity_Id
;
508 -- If a type is a generic actual type, return the corresponding formal in
509 -- the generic parent unit. There is no direct link in the tree for this
510 -- attribute, except in the case of formal private and derived types.
511 -- Possible optimization???
513 function Current_Entity
(N
: Node_Id
) return Entity_Id
;
514 pragma Inline
(Current_Entity
);
515 -- Find the currently visible definition for a given identifier, that is to
516 -- say the first entry in the visibility chain for the Chars of N.
518 function Current_Entity_In_Scope
(N
: Node_Id
) return Entity_Id
;
519 -- Find whether there is a previous definition for identifier N in the
520 -- current scope. Because declarations for a scope are not necessarily
521 -- contiguous (e.g. for packages) the first entry on the visibility chain
522 -- for N is not necessarily in the current scope.
524 function Current_Scope
return Entity_Id
;
525 -- Get entity representing current scope
527 function Current_Scope_No_Loops
return Entity_Id
;
528 -- Return the current scope ignoring internally generated loops
530 function Current_Subprogram
return Entity_Id
;
531 -- Returns current enclosing subprogram. If Current_Scope is a subprogram,
532 -- then that is what is returned, otherwise the Enclosing_Subprogram of the
533 -- Current_Scope is returned. The returned value is Empty if this is called
534 -- from a library package which is not within any subprogram.
536 function Deepest_Type_Access_Level
(Typ
: Entity_Id
) return Uint
;
537 -- Same as Type_Access_Level, except that if the type is the type of an Ada
538 -- 2012 stand-alone object of an anonymous access type, then return the
539 -- static accesssibility level of the object. In that case, the dynamic
540 -- accessibility level of the object may take on values in a range. The low
541 -- bound of that range is returned by Type_Access_Level; this function
542 -- yields the high bound of that range. Also differs from Type_Access_Level
543 -- in the case of a descendant of a generic formal type (returns Int'Last
546 function Defining_Entity
548 Empty_On_Errors
: Boolean := False;
549 Concurrent_Subunit
: Boolean := False) return Entity_Id
;
550 -- Given a declaration N, returns the associated defining entity. If the
551 -- declaration has a specification, the entity is obtained from the
552 -- specification. If the declaration has a defining unit name, then the
553 -- defining entity is obtained from the defining unit name ignoring any
554 -- child unit prefixes.
556 -- Iterator loops also have a defining entity, which holds the list of
557 -- local entities declared during loop expansion. These entities need
558 -- debugging information, generated through Qualify_Entity_Names, and
559 -- the loop declaration must be placed in the table Name_Qualify_Units.
561 -- Set flag Empty_On_Error to change the behavior of this routine as
564 -- * True - A declaration that lacks a defining entity returns Empty.
565 -- A node that does not allow for a defining entity returns Empty.
567 -- * False - A declaration that lacks a defining entity is given a new
568 -- internally generated entity which is subsequently returned. A node
569 -- that does not allow for a defining entity raises Program_Error.
571 -- The former semantics is appropriate for the back end; the latter
572 -- semantics is appropriate for the front end.
574 -- Set flag Concurrent_Subunit to handle rewritings of concurrent bodies
575 -- which act as subunits. Such bodies are generally rewritten as null.
577 function Denotes_Discriminant
579 Check_Concurrent
: Boolean := False) return Boolean;
580 -- Returns True if node N is an Entity_Name node for a discriminant. If the
581 -- flag Check_Concurrent is true, function also returns true when N denotes
582 -- the discriminal of the discriminant of a concurrent type. This is needed
583 -- to disable some optimizations on private components of protected types,
584 -- and constraint checks on entry families constrained by discriminants.
586 function Denotes_Same_Object
(A1
, A2
: Node_Id
) return Boolean;
587 -- Detect suspicious overlapping between actuals in a call, when both are
588 -- writable (RM 2012 6.4.1(6.4/3)).
590 function Denotes_Same_Prefix
(A1
, A2
: Node_Id
) return Boolean;
591 -- Functions to detect suspicious overlapping between actuals in a call,
592 -- when one of them is writable. The predicates are those proposed in
593 -- AI05-0144, to detect dangerous order dependence in complex calls.
594 -- I would add a parameter Warn which enables more extensive testing of
595 -- cases as we find appropriate when we are only warning ??? Or perhaps
596 -- return an indication of (Error, Warn, OK) ???
598 function Denotes_Variable
(N
: Node_Id
) return Boolean;
599 -- Returns True if node N denotes a single variable without parentheses
601 function Depends_On_Discriminant
(N
: Node_Id
) return Boolean;
602 -- Returns True if N denotes a discriminant or if N is a range, a subtype
603 -- indication or a scalar subtype where one of the bounds is a
606 function Designate_Same_Unit
608 Name2
: Node_Id
) return Boolean;
609 -- Returns True if Name1 and Name2 designate the same unit name; each of
610 -- these names is supposed to be a selected component name, an expanded
611 -- name, a defining program unit name or an identifier.
613 procedure Diagnose_Iterated_Component_Association
(N
: Node_Id
);
614 -- Emit an error if iterated component association N is actually an illegal
615 -- quantified expression lacking a quantifier.
617 function Discriminated_Size
(Comp
: Entity_Id
) return Boolean;
618 -- If a component size is not static then a warning will be emitted
619 -- in Ravenscar or other restricted contexts. When a component is non-
620 -- static because of a discriminant constraint we can specialize the
621 -- warning by mentioning discriminants explicitly. This was created for
622 -- private components of protected objects, but is generally useful when
623 -- restriction No_Implicit_Heap_Allocation is active.
625 function Dynamic_Accessibility_Level
(Expr
: Node_Id
) return Node_Id
;
626 -- Expr should be an expression of an access type. Builds an integer
627 -- literal except in cases involving anonymous access types, where
628 -- accessibility levels are tracked at run time (access parameters and
629 -- Ada 2012 stand-alone objects).
631 function Effective_Extra_Accessibility
(Id
: Entity_Id
) return Entity_Id
;
632 -- Same as Einfo.Extra_Accessibility except thtat object renames
633 -- are looked through.
635 function Effective_Reads_Enabled
(Id
: Entity_Id
) return Boolean;
636 -- Given the entity of an abstract state or a variable, determine whether
637 -- Id is subject to external property Effective_Reads and if it is, the
638 -- related expression evaluates to True.
640 function Effective_Writes_Enabled
(Id
: Entity_Id
) return Boolean;
641 -- Given the entity of an abstract state or a variable, determine whether
642 -- Id is subject to external property Effective_Writes and if it is, the
643 -- related expression evaluates to True.
645 function Enclosing_Comp_Unit_Node
(N
: Node_Id
) return Node_Id
;
646 -- Returns the enclosing N_Compilation_Unit node that is the root of a
647 -- subtree containing N.
649 function Enclosing_CPP_Parent
(Typ
: Entity_Id
) return Entity_Id
;
650 -- Returns the closest ancestor of Typ that is a CPP type.
652 function Enclosing_Declaration
(N
: Node_Id
) return Node_Id
;
653 -- Returns the declaration node enclosing N (including possibly N itself),
654 -- if any, or Empty otherwise.
656 function Enclosing_Generic_Body
(N
: Node_Id
) return Node_Id
;
657 -- Returns the Node_Id associated with the innermost enclosing generic
658 -- body, if any. If none, then returns Empty.
660 function Enclosing_Generic_Unit
(N
: Node_Id
) return Node_Id
;
661 -- Returns the Node_Id associated with the innermost enclosing generic
662 -- unit, if any. If none, then returns Empty.
664 function Enclosing_Lib_Unit_Entity
665 (E
: Entity_Id
:= Current_Scope
) return Entity_Id
;
666 -- Returns the entity of enclosing library unit node which is the root of
667 -- the current scope (which must not be Standard_Standard, and the caller
668 -- is responsible for ensuring this condition) or other specified entity.
670 function Enclosing_Lib_Unit_Node
(N
: Node_Id
) return Node_Id
;
671 -- Returns the N_Compilation_Unit node of the library unit that is directly
672 -- or indirectly (through a subunit) at the root of a subtree containing
673 -- N. This may be either the same as Enclosing_Comp_Unit_Node, or if
674 -- Enclosing_Comp_Unit_Node returns a subunit, then the corresponding
675 -- library unit. If no such item is found, returns Empty.
677 function Enclosing_Package
(E
: Entity_Id
) return Entity_Id
;
678 -- Utility function to return the Ada entity of the package enclosing
679 -- the entity E, if any. Returns Empty if no enclosing package.
681 function Enclosing_Package_Or_Subprogram
(E
: Entity_Id
) return Entity_Id
;
682 -- Returns the entity of the package or subprogram enclosing E, if any.
683 -- Returns Empty if no enclosing package or subprogram.
685 function Enclosing_Subprogram
(E
: Entity_Id
) return Entity_Id
;
686 -- Utility function to return the Ada entity of the subprogram enclosing
687 -- the entity E, if any. Returns Empty if no enclosing subprogram.
689 function End_Keyword_Location
(N
: Node_Id
) return Source_Ptr
;
690 -- Given block statement, entry body, package body, package declaration,
691 -- protected body, [single] protected type declaration, subprogram body,
692 -- task body, or [single] task type declaration N, return the closest
693 -- source location of the "end" keyword.
695 procedure Ensure_Freeze_Node
(E
: Entity_Id
);
696 -- Make sure a freeze node is allocated for entity E. If necessary, build
697 -- and initialize a new freeze node and set Has_Delayed_Freeze True for E.
699 procedure Enter_Name
(Def_Id
: Entity_Id
);
700 -- Insert new name in symbol table of current scope with check for
701 -- duplications (error message is issued if a conflict is found).
702 -- Note: Enter_Name is not used for overloadable entities, instead these
703 -- are entered using Sem_Ch6.Enter_Overloadable_Entity.
705 function Entity_Of
(N
: Node_Id
) return Entity_Id
;
706 -- Obtain the entity of arbitrary node N. If N is a renaming, return the
707 -- entity of the earliest renamed source abstract state or whole object.
708 -- If no suitable entity is available, return Empty. This routine carries
709 -- out actions that are tied to SPARK semantics.
711 procedure Explain_Limited_Type
(T
: Entity_Id
; N
: Node_Id
);
712 -- This procedure is called after issuing a message complaining about an
713 -- inappropriate use of limited type T. If useful, it adds additional
714 -- continuation lines to the message explaining why type T is limited.
715 -- Messages are placed at node N.
717 function Expression_Of_Expression_Function
718 (Subp
: Entity_Id
) return Node_Id
;
719 -- Return the expression of expression function Subp
721 type Extensions_Visible_Mode
is
722 (Extensions_Visible_None
,
723 -- Extensions_Visible does not yield a mode when SPARK_Mode is off. This
724 -- value acts as a default in a non-SPARK compilation.
726 Extensions_Visible_False
,
727 -- A value of "False" signifies that Extensions_Visible is either
728 -- missing or the pragma is present and the value of its Boolean
729 -- expression is False.
731 Extensions_Visible_True
);
732 -- A value of "True" signifies that Extensions_Visible is present and
733 -- the value of its Boolean expression is True.
735 function Extensions_Visible_Status
736 (Id
: Entity_Id
) return Extensions_Visible_Mode
;
737 -- Given the entity of a subprogram or formal parameter subject to pragma
738 -- Extensions_Visible, return the Boolean value denoted by the expression
741 procedure Find_Actual
743 Formal
: out Entity_Id
;
745 -- Determines if the node N is an actual parameter of a function or a
746 -- procedure call. If so, then Formal points to the entity for the formal
747 -- (Ekind is E_In_Parameter, E_Out_Parameter, or E_In_Out_Parameter) and
748 -- Call is set to the node for the corresponding call. If the node N is not
749 -- an actual parameter then Formal and Call are set to Empty.
751 function Find_Body_Discriminal
752 (Spec_Discriminant
: Entity_Id
) return Entity_Id
;
753 -- Given a discriminant of the record type that implements a task or
754 -- protected type, return the discriminal of the corresponding discriminant
755 -- of the actual concurrent type.
757 function Find_Corresponding_Discriminant
759 Typ
: Entity_Id
) return Entity_Id
;
760 -- Because discriminants may have different names in a generic unit and in
761 -- an instance, they are resolved positionally when possible. A reference
762 -- to a discriminant carries the discriminant that it denotes when it is
763 -- analyzed. Subsequent uses of this id on a different type denotes the
764 -- discriminant at the same position in this new type.
766 function Find_DIC_Type
(Typ
: Entity_Id
) return Entity_Id
;
767 -- Subsidiary to all Build_DIC_Procedure_xxx routines. Find the type which
768 -- defines the Default_Initial_Condition pragma of type Typ. This is either
769 -- Typ itself or a parent type when the pragma is inherited.
771 function Find_Enclosing_Iterator_Loop
(Id
: Entity_Id
) return Entity_Id
;
772 -- Find the nearest iterator loop which encloses arbitrary entity Id. If
773 -- such a loop exists, return the entity of its identifier (E_Loop scope),
774 -- otherwise return Empty.
776 function Find_Enclosing_Scope
(N
: Node_Id
) return Entity_Id
;
777 -- Find the nearest scope which encloses arbitrary node N
779 function Find_Loop_In_Conditional_Block
(N
: Node_Id
) return Node_Id
;
780 -- Find the nested loop statement in a conditional block. Loops subject to
781 -- attribute 'Loop_Entry are transformed into blocks. Parts of the original
782 -- loop are nested within the block.
784 procedure Find_Overlaid_Entity
788 -- The node N should be an address representation clause. Determines if
789 -- the target expression is the address of an entity with an optional
790 -- offset. If so, set Ent to the entity and, if there is an offset, set
791 -- Off to True, otherwise to False. If N is not an address representation
792 -- clause, or if it is not possible to determine that the address is of
793 -- this form, then set Ent to Empty.
795 function Find_Parameter_Type
(Param
: Node_Id
) return Entity_Id
;
796 -- Return the type of formal parameter Param as determined by its
799 -- The following type describes the placement of an arbitrary entity with
800 -- respect to SPARK visible / hidden state space.
802 type State_Space_Kind
is
804 -- An entity is not in the visible, private or body state space when
805 -- the immediate enclosing construct is not a package.
808 -- An entity is in the visible state space when it appears immediately
809 -- within the visible declarations of a package or when it appears in
810 -- the visible state space of a nested package which in turn is declared
811 -- in the visible declarations of an enclosing package:
814 -- Visible_Variable : ...
816 -- with Abstract_State => Visible_State
818 -- Visible_Nested_Variable : ...
822 -- Entities associated with a package instantiation inherit the state
823 -- space from the instance placement:
827 -- Generic_Variable : ...
832 -- package Inst is new Gen;
833 -- -- Generic_Variable is in the visible state space of Pack
837 -- An entity is in the private state space when it appears immediately
838 -- within the private declarations of a package or when it appears in
839 -- the visible state space of a nested package which in turn is declared
840 -- in the private declarations of an enclosing package:
844 -- Private_Variable : ...
846 -- with Abstract_State => Private_State
848 -- Private_Nested_Variable : ...
852 -- The same placement principle applies to package instantiations
855 -- An entity is in the body state space when it appears immediately
856 -- within the declarations of a package body or when it appears in the
857 -- visible state space of a nested package which in turn is declared in
858 -- the declarations of an enclosing package body:
860 -- package body Pack is
861 -- Body_Variable : ...
863 -- with Abstract_State => Body_State
865 -- Body_Nested_Variable : ...
869 -- The same placement principle applies to package instantiations
871 procedure Find_Placement_In_State_Space
872 (Item_Id
: Entity_Id
;
873 Placement
: out State_Space_Kind
;
874 Pack_Id
: out Entity_Id
);
875 -- Determine the state space placement of an item. Item_Id denotes the
876 -- entity of an abstract state, object, or package instantiation. Placement
877 -- captures the precise placement of the item in the enclosing state space.
878 -- If the state space is that of a package, Pack_Id denotes its entity,
879 -- otherwise Pack_Id is Empty.
881 function Find_Primitive_Eq
(Typ
: Entity_Id
) return Entity_Id
;
882 -- Locate primitive equality for type if it exists. Return Empty if it is
885 function Find_Specific_Type
(CW
: Entity_Id
) return Entity_Id
;
886 -- Find specific type of a class-wide type, and handle the case of an
887 -- incomplete type coming either from a limited_with clause or from an
888 -- incomplete type declaration. If resulting type is private return its
891 function Find_Static_Alternative
(N
: Node_Id
) return Node_Id
;
892 -- N is a case statement whose expression is a compile-time value.
893 -- Determine the alternative chosen, so that the code of non-selected
894 -- alternatives, and the warnings that may apply to them, are removed.
896 function First_Actual
(Node
: Node_Id
) return Node_Id
;
897 -- Node is an N_Function_Call, N_Procedure_Call_Statement or
898 -- N_Entry_Call_Statement node. The result returned is the first actual
899 -- parameter in declaration order (not the order of parameters as they
900 -- appeared in the source, which can be quite different as a result of the
901 -- use of named parameters). Empty is returned for a call with no
902 -- parameters. The procedure for iterating through the actuals in
903 -- declaration order is to use this function to find the first actual, and
904 -- then use Next_Actual to obtain the next actual in declaration order.
905 -- Note that the value returned is always the expression (not the
906 -- N_Parameter_Association nodes, even if named association is used).
908 function First_Global
910 Global_Mode
: Name_Id
;
911 Refined
: Boolean := False) return Node_Id
;
912 -- Returns the first global item of mode Global_Mode (which can be
913 -- Name_Input, Name_Output, Name_In_Out or Name_Proof_In) associated to
914 -- subprogram Subp, or Empty otherwise. If Refined is True, the global item
915 -- is retrieved from the Refined_Global aspect/pragma associated to the
916 -- body of Subp if present. Next_Global can be used to get the next global
917 -- item with the same mode.
919 function Fix_Msg
(Id
: Entity_Id
; Msg
: String) return String;
920 -- Replace all occurrences of a particular word in string Msg depending on
921 -- the Ekind of Id as follows:
922 -- * Replace "subprogram" with
923 -- - "entry" when Id is an entry [family]
924 -- - "task type" when Id is a single task object, task type or task
926 -- * Replace "protected" with
927 -- - "task" when Id is a single task object, task type or task body
928 -- All other non-matching words remain as is
930 function From_Nested_Package
(T
: Entity_Id
) return Boolean;
931 -- A type declared in a nested package may be frozen by a declaration
932 -- appearing after the package but before the package is frozen. If the
933 -- type has aspects that generate subprograms, these may contain references
934 -- to entities local to the nested package. In that case the package must
935 -- be installed on the scope stack to prevent spurious visibility errors.
937 procedure Gather_Components
940 Governed_By
: List_Id
;
942 Report_Errors
: out Boolean);
943 -- The purpose of this procedure is to gather the valid components in a
944 -- record type according to the values of its discriminants, in order to
945 -- validate the components of a record aggregate.
947 -- Typ is the type of the aggregate when its constrained discriminants
948 -- need to be collected, otherwise it is Empty.
950 -- Comp_List is an N_Component_List node.
952 -- Governed_By is a list of N_Component_Association nodes, where each
953 -- choice list contains the name of a discriminant and the expression
954 -- field gives its value. The values of the discriminants governing
955 -- the (possibly nested) variant parts in Comp_List are found in this
956 -- Component_Association List.
958 -- Into is the list where the valid components are appended. Note that
959 -- Into need not be an Empty list. If it's not, components are attached
962 -- Report_Errors is set to True if the values of the discriminants are
965 -- This procedure is also used when building a record subtype. If the
966 -- discriminant constraint of the subtype is static, the components of the
967 -- subtype are only those of the variants selected by the values of the
968 -- discriminants. Otherwise all components of the parent must be included
969 -- in the subtype for semantic analysis.
971 function Get_Actual_Subtype
(N
: Node_Id
) return Entity_Id
;
972 -- Given a node for an expression, obtain the actual subtype of the
973 -- expression. In the case of a parameter where the formal is an
974 -- unconstrained array or discriminated type, this will be the previously
975 -- constructed subtype of the actual. Note that this is not quite the
976 -- "Actual Subtype" of the RM, since it is always a constrained type, i.e.
977 -- it is the subtype of the value of the actual. The actual subtype is also
978 -- returned in other cases where it has already been constructed for an
979 -- object. Otherwise the expression type is returned unchanged, except for
980 -- the case of an unconstrained array type, where an actual subtype is
981 -- created, using Insert_Actions if necessary to insert any associated
984 function Get_Actual_Subtype_If_Available
(N
: Node_Id
) return Entity_Id
;
985 -- This is like Get_Actual_Subtype, except that it never constructs an
986 -- actual subtype. If an actual subtype is already available, i.e. the
987 -- Actual_Subtype field of the corresponding entity is set, then it is
988 -- returned. Otherwise the Etype of the node is returned.
990 function Get_Body_From_Stub
(N
: Node_Id
) return Node_Id
;
991 -- Return the body node for a stub
993 function Get_Cursor_Type
995 Typ
: Entity_Id
) return Entity_Id
;
996 -- Find Cursor type in scope of type Typ with Iterable aspect, by locating
997 -- primitive operation First. For use in resolving the other primitive
998 -- operations of an Iterable type and expanding loops and quantified
999 -- expressions over formal containers.
1001 function Get_Cursor_Type
(Typ
: Entity_Id
) return Entity_Id
;
1002 -- Find Cursor type in scope of type Typ with Iterable aspect, by locating
1003 -- primitive operation First. For use after resolving the primitive
1004 -- operations of an Iterable type.
1006 function Get_Default_External_Name
(E
: Node_Or_Entity_Id
) return Node_Id
;
1007 -- This is used to construct the string literal node representing a
1008 -- default external name, i.e. one that is constructed from the name of an
1009 -- entity, or (in the case of extended DEC import/export pragmas) an
1010 -- identifier provided as the external name. Letters in the name are
1011 -- according to the setting of Opt.External_Name_Default_Casing.
1013 function Get_Enclosing_Object
(N
: Node_Id
) return Entity_Id
;
1014 -- If expression N references a part of an object, return this object.
1015 -- Otherwise return Empty. Expression N should have been resolved already.
1017 function Get_Generic_Entity
(N
: Node_Id
) return Entity_Id
;
1018 -- Returns the true generic entity in an instantiation. If the name in the
1019 -- instantiation is a renaming, the function returns the renamed generic.
1021 function Get_Incomplete_View_Of_Ancestor
(E
: Entity_Id
) return Entity_Id
;
1022 -- Implements the notion introduced ever-so briefly in RM 7.3.1 (5.2/3):
1023 -- in a child unit a derived type is within the derivation class of an
1024 -- ancestor declared in a parent unit, even if there is an intermediate
1025 -- derivation that does not see the full view of that ancestor.
1027 procedure Get_Index_Bounds
1031 Use_Full_View
: Boolean := False);
1032 -- This procedure assigns to L and H respectively the values of the low and
1033 -- high bounds of node N, which must be a range, subtype indication, or the
1034 -- name of a scalar subtype. The result in L, H may be set to Error if
1035 -- there was an earlier error in the range.
1036 -- Use_Full_View is intended for use by clients other than the compiler
1037 -- (specifically, gnat2scil) to indicate that we want the full view if
1038 -- the index type turns out to be a partial view; this case should not
1039 -- arise during normal compilation of semantically correct programs.
1041 procedure Get_Interfacing_Aspects
1042 (Iface_Asp
: Node_Id
;
1043 Conv_Asp
: out Node_Id
;
1044 EN_Asp
: out Node_Id
;
1045 Expo_Asp
: out Node_Id
;
1046 Imp_Asp
: out Node_Id
;
1047 LN_Asp
: out Node_Id
;
1048 Do_Checks
: Boolean := False);
1049 -- Given a single interfacing aspect Iface_Asp, retrieve other interfacing
1050 -- aspects that apply to the same related entity. The aspects considered by
1051 -- this routine are as follows:
1053 -- Conv_Asp - aspect Convention
1054 -- EN_Asp - aspect External_Name
1055 -- Expo_Asp - aspect Export
1056 -- Imp_Asp - aspect Import
1057 -- LN_Asp - aspect Link_Name
1059 -- When flag Do_Checks is set, this routine will flag duplicate uses of
1062 function Get_Enum_Lit_From_Pos
1065 Loc
: Source_Ptr
) return Node_Id
;
1066 -- This function returns an identifier denoting the E_Enumeration_Literal
1067 -- entity for the specified value from the enumeration type or subtype T.
1068 -- The second argument is the Pos value. Constraint_Error is raised if
1069 -- argument Pos is not in range. The third argument supplies a source
1070 -- location for constructed nodes returned by this function. If No_Location
1071 -- is supplied as source location, the location of the returned node is
1072 -- copied from the original source location for the enumeration literal,
1075 function Get_Iterable_Type_Primitive
1077 Nam
: Name_Id
) return Entity_Id
;
1078 -- Retrieve one of the primitives First, Next, Has_Element, Element from
1079 -- the value of the Iterable aspect of a type.
1081 procedure Get_Library_Unit_Name_String
(Decl_Node
: Node_Id
);
1082 -- Retrieve the fully expanded name of the library unit declared by
1083 -- Decl_Node into the name buffer.
1085 function Get_Max_Queue_Length
(Id
: Entity_Id
) return Uint
;
1086 -- Return the argument of pragma Max_Queue_Length or zero if the annotation
1087 -- is not present. It is assumed that Id denotes an entry.
1089 function Get_Name_Entity_Id
(Id
: Name_Id
) return Entity_Id
;
1090 pragma Inline
(Get_Name_Entity_Id
);
1091 -- An entity value is associated with each name in the name table. The
1092 -- Get_Name_Entity_Id function fetches the Entity_Id of this entity, which
1093 -- is the innermost visible entity with the given name. See the body of
1094 -- Sem_Ch8 for further details on handling of entity visibility.
1096 function Get_Name_From_CTC_Pragma
(N
: Node_Id
) return String_Id
;
1097 -- Return the Name component of Test_Case pragma N
1098 -- Bad name now that this no longer applies to Contract_Case ???
1100 function Get_Parent_Entity
(Unit
: Node_Id
) return Entity_Id
;
1101 -- Get defining entity of parent unit of a child unit. In most cases this
1102 -- is the defining entity of the unit, but for a child instance whose
1103 -- parent needs a body for inlining, the instantiation node of the parent
1104 -- has not yet been rewritten as a package declaration, and the entity has
1105 -- to be retrieved from the Instance_Spec of the unit.
1107 function Get_Pragma_Id
(N
: Node_Id
) return Pragma_Id
;
1108 pragma Inline
(Get_Pragma_Id
);
1109 -- Obtains the Pragma_Id from Pragma_Name_Unmapped (N)
1111 function Get_Qualified_Name
1113 Suffix
: Entity_Id
:= Empty
) return Name_Id
;
1114 -- Obtain the fully qualified form of entity Id. The format is:
1115 -- scope_of_id-1__scope_of_id__chars_of_id__chars_of_suffix
1117 function Get_Qualified_Name
1119 Suffix
: Name_Id
:= No_Name
;
1120 Scop
: Entity_Id
:= Current_Scope
) return Name_Id
;
1121 -- Obtain the fully qualified form of name Nam assuming it appears in scope
1122 -- Scop. The format is:
1123 -- scop-1__scop__nam__suffix
1125 procedure Get_Reason_String
(N
: Node_Id
);
1126 -- Recursive routine to analyze reason argument for pragma Warnings. The
1127 -- value of the reason argument is appended to the current string using
1128 -- Store_String_Chars. The reason argument is expected to be a string
1129 -- literal or concatenation of string literals. An error is given for
1132 function Get_Reference_Discriminant
(Typ
: Entity_Id
) return Entity_Id
;
1133 -- If Typ has Implicit_Dereference, return discriminant specified in the
1134 -- corresponding aspect.
1136 function Get_Referenced_Object
(N
: Node_Id
) return Node_Id
;
1137 -- Given a node, return the renamed object if the node represents a renamed
1138 -- object, otherwise return the node unchanged. The node may represent an
1139 -- arbitrary expression.
1141 function Get_Renamed_Entity
(E
: Entity_Id
) return Entity_Id
;
1142 -- Given an entity for an exception, package, subprogram or generic unit,
1143 -- returns the ultimately renamed entity if this is a renaming. If this is
1144 -- not a renamed entity, returns its argument. It is an error to call this
1145 -- with any other kind of entity.
1147 function Get_Return_Object
(N
: Node_Id
) return Entity_Id
;
1148 -- Given an extended return statement, return the corresponding return
1149 -- object, identified as the one for which Is_Return_Object = True.
1151 function Get_Subprogram_Entity
(Nod
: Node_Id
) return Entity_Id
;
1152 -- Nod is either a procedure call statement, or a function call, or an
1153 -- accept statement node. This procedure finds the Entity_Id of the related
1154 -- subprogram or entry and returns it, or if no subprogram can be found,
1157 function Get_Task_Body_Procedure
(E
: Entity_Id
) return Entity_Id
;
1158 -- Given an entity for a task type or subtype, retrieves the
1159 -- Task_Body_Procedure field from the corresponding task type declaration.
1161 function Get_User_Defined_Eq
(E
: Entity_Id
) return Entity_Id
;
1162 -- For a type entity, return the entity of the primitive equality function
1163 -- for the type if it exists, otherwise return Empty.
1167 Priv_Typ
: out Entity_Id
;
1168 Full_Typ
: out Entity_Id
;
1169 Full_Base
: out Entity_Id
;
1170 CRec_Typ
: out Entity_Id
);
1171 -- Obtain the partial and full view of type Typ and in addition any extra
1172 -- types the full view may have. The return entities are as follows:
1174 -- Priv_Typ - the partial view (a private type)
1175 -- Full_Typ - the full view
1176 -- Full_Base - the base type of the full view
1177 -- CRec_Typ - the corresponding record type of the full view
1179 function Has_Access_Values
(T
: Entity_Id
) return Boolean;
1180 -- Returns true if type or subtype T is an access type, or has a component
1181 -- (at any recursive level) that is an access type. This is a conservative
1182 -- predicate, if it is not known whether or not T contains access values
1183 -- (happens for generic formals in some cases), then False is returned.
1184 -- Note that tagged types return False. Even though the tag is implemented
1185 -- as an access type internally, this function tests only for access types
1186 -- known to the programmer. See also Has_Tagged_Component.
1188 type Alignment_Result
is (Known_Compatible
, Unknown
, Known_Incompatible
);
1189 -- Result of Has_Compatible_Alignment test, description found below. Note
1190 -- that the values are arranged in increasing order of problematicness.
1192 function Has_Compatible_Alignment
1195 Layout_Done
: Boolean) return Alignment_Result
;
1196 -- Obj is an object entity, and expr is a node for an object reference. If
1197 -- the alignment of the object referenced by Expr is known to be compatible
1198 -- with the alignment of Obj (i.e. is larger or the same), then the result
1199 -- is Known_Compatible. If the alignment of the object referenced by Expr
1200 -- is known to be less than the alignment of Obj, then Known_Incompatible
1201 -- is returned. If neither condition can be reliably established at compile
1202 -- time, then Unknown is returned. If Layout_Done is True, the function can
1203 -- assume that the information on size and alignment of types and objects
1204 -- is present in the tree. This is used to determine if alignment checks
1205 -- are required for address clauses (Layout_Done is False in this case) as
1206 -- well as to issue appropriate warnings for them in the post compilation
1207 -- phase (Layout_Done is True in this case).
1209 -- Note: Known_Incompatible does not mean that at run time the alignment
1210 -- of Expr is known to be wrong for Obj, just that it can be determined
1211 -- that alignments have been explicitly or implicitly specified which are
1212 -- incompatible (whereas Unknown means that even this is not known). The
1213 -- appropriate reaction of a caller to Known_Incompatible is to treat it as
1214 -- Unknown, but issue a warning that there may be an alignment error.
1216 function Has_Declarations
(N
: Node_Id
) return Boolean;
1217 -- Determines if the node can have declarations
1219 function Has_Defaulted_Discriminants
(Typ
: Entity_Id
) return Boolean;
1220 -- Simple predicate to test for defaulted discriminants
1222 function Has_Denormals
(E
: Entity_Id
) return Boolean;
1223 -- Determines if the floating-point type E supports denormal numbers.
1224 -- Returns False if E is not a floating-point type.
1226 function Has_Discriminant_Dependent_Constraint
1227 (Comp
: Entity_Id
) return Boolean;
1228 -- Returns True if and only if Comp has a constrained subtype that depends
1229 -- on a discriminant.
1231 function Has_Effectively_Volatile_Profile
1232 (Subp_Id
: Entity_Id
) return Boolean;
1233 -- Determine whether subprogram Subp_Id has an effectively volatile formal
1234 -- parameter or returns an effectively volatile value.
1236 function Has_Full_Default_Initialization
(Typ
: Entity_Id
) return Boolean;
1237 -- Determine whether type Typ defines "full default initialization" as
1238 -- specified by SPARK RM 3.1. To qualify as such, the type must be
1239 -- * A scalar type with specified Default_Value
1240 -- * An array-of-scalar type with specified Default_Component_Value
1241 -- * An array type whose element type defines full default initialization
1242 -- * A protected type, record type or type extension whose components
1243 -- either include a default expression or have a type which defines
1244 -- full default initialization. In the case of type extensions, the
1245 -- parent type defines full default initialization.
1247 -- * A private type with pragma Default_Initial_Condition that provides
1248 -- full default initialization.
1250 function Has_Fully_Default_Initializing_DIC_Pragma
1251 (Typ
: Entity_Id
) return Boolean;
1252 -- Determine whether type Typ has a suitable Default_Initial_Condition
1253 -- pragma which provides the full default initialization of the type.
1255 function Has_Infinities
(E
: Entity_Id
) return Boolean;
1256 -- Determines if the range of the floating-point type E includes
1257 -- infinities. Returns False if E is not a floating-point type.
1259 function Has_Interfaces
1261 Use_Full_View
: Boolean := True) return Boolean;
1262 -- Where T is a concurrent type or a record type, returns true if T covers
1263 -- any abstract interface types. In case of private types the argument
1264 -- Use_Full_View controls if the check is done using its full view (if
1267 function Has_Max_Queue_Length
(Id
: Entity_Id
) return Boolean;
1268 -- Determine whether Id is subject to pragma Max_Queue_Length. It is
1269 -- assumed that Id denotes an entry.
1271 function Has_No_Obvious_Side_Effects
(N
: Node_Id
) return Boolean;
1272 -- This is a simple minded function for determining whether an expression
1273 -- has no obvious side effects. It is used only for determining whether
1274 -- warnings are needed in certain situations, and is not guaranteed to
1275 -- be accurate in either direction. Exceptions may mean an expression
1276 -- does in fact have side effects, but this may be ignored and True is
1277 -- returned, or a complex expression may in fact be side effect free
1278 -- but we don't recognize it here and return False. The Side_Effect_Free
1279 -- routine in Remove_Side_Effects is much more extensive and perhaps could
1280 -- be shared, so that this routine would be more accurate.
1282 function Has_Non_Null_Refinement
(Id
: Entity_Id
) return Boolean;
1283 -- Determine whether abstract state Id has at least one nonnull constituent
1284 -- as expressed in pragma Refined_State. This function does not take into
1285 -- account the visible refinement region of abstract state Id.
1287 function Has_Non_Trivial_Precondition
(Subp
: Entity_Id
) return Boolean;
1288 -- Determine whether subprogram Subp has a class-wide precondition that is
1289 -- not statically True.
1291 function Has_Null_Body
(Proc_Id
: Entity_Id
) return Boolean;
1292 -- Determine whether the body of procedure Proc_Id contains a sole null
1293 -- statement, possibly followed by an optional return. Used to optimize
1294 -- useless calls to assertion checks.
1296 function Has_Null_Exclusion
(N
: Node_Id
) return Boolean;
1297 -- Determine whether node N has a null exclusion
1299 function Has_Null_Refinement
(Id
: Entity_Id
) return Boolean;
1300 -- Determine whether abstract state Id has a null refinement as expressed
1301 -- in pragma Refined_State. This function does not take into account the
1302 -- visible refinement region of abstract state Id.
1304 function Has_Non_Null_Statements
(L
: List_Id
) return Boolean;
1305 -- Return True if L has non-null statements
1307 function Has_Overriding_Initialize
(T
: Entity_Id
) return Boolean;
1308 -- Predicate to determine whether a controlled type has a user-defined
1309 -- Initialize primitive (and, in Ada 2012, whether that primitive is
1310 -- non-null), which causes the type to not have preelaborable
1313 function Has_Preelaborable_Initialization
(E
: Entity_Id
) return Boolean;
1314 -- Return True iff type E has preelaborable initialization as defined in
1315 -- Ada 2005 (see AI-161 for details of the definition of this attribute).
1317 function Has_Prefix
(N
: Node_Id
) return Boolean;
1318 -- Return True if N has attribute Prefix
1320 function Has_Private_Component
(Type_Id
: Entity_Id
) return Boolean;
1321 -- Check if a type has a (sub)component of a private type that has not
1322 -- yet received a full declaration.
1324 function Has_Signed_Zeros
(E
: Entity_Id
) return Boolean;
1325 -- Determines if the floating-point type E supports signed zeros.
1326 -- Returns False if E is not a floating-point type.
1328 function Has_Significant_Contract
(Subp_Id
: Entity_Id
) return Boolean;
1329 -- Determine whether subprogram [body] Subp_Id has a significant contract.
1330 -- All subprograms have a N_Contract node, but this does not mean that the
1331 -- contract is useful.
1333 function Has_Static_Array_Bounds
(Typ
: Node_Id
) return Boolean;
1334 -- Return whether an array type has static bounds
1336 function Has_Static_Non_Empty_Array_Bounds
(Typ
: Node_Id
) return Boolean;
1337 -- Determine whether array type Typ has static non-empty bounds
1339 function Has_Stream
(T
: Entity_Id
) return Boolean;
1340 -- Tests if type T is derived from Ada.Streams.Root_Stream_Type, or in the
1341 -- case of a composite type, has a component for which this predicate is
1342 -- True, and if so returns True. Otherwise a result of False means that
1343 -- there is no Stream type in sight. For a private type, the test is
1344 -- applied to the underlying type (or returns False if there is no
1345 -- underlying type).
1347 function Has_Suffix
(E
: Entity_Id
; Suffix
: Character) return Boolean;
1348 -- Returns true if the last character of E is Suffix. Used in Assertions.
1350 function Has_Tagged_Component
(Typ
: Entity_Id
) return Boolean;
1351 -- Returns True if Typ is a composite type (array or record) that is either
1352 -- a tagged type or has a subcomponent that is tagged. Returns False for a
1353 -- noncomposite type, or if no tagged subcomponents are present. This
1354 -- function is used to check if "=" has to be expanded into a bunch
1355 -- component comparisons.
1357 function Has_Undefined_Reference
(Expr
: Node_Id
) return Boolean;
1358 -- Given arbitrary expression Expr, determine whether it contains at
1359 -- least one name whose entity is Any_Id.
1361 function Has_Volatile_Component
(Typ
: Entity_Id
) return Boolean;
1362 -- Given arbitrary type Typ, determine whether it contains at least one
1363 -- volatile component.
1365 function Implementation_Kind
(Subp
: Entity_Id
) return Name_Id
;
1366 -- Subp is a subprogram marked with pragma Implemented. Return the specific
1367 -- implementation requirement which the pragma imposes. The return value is
1368 -- either Name_By_Any, Name_By_Entry or Name_By_Protected_Procedure.
1370 function Implements_Interface
1371 (Typ_Ent
: Entity_Id
;
1372 Iface_Ent
: Entity_Id
;
1373 Exclude_Parents
: Boolean := False) return Boolean;
1374 -- Returns true if the Typ_Ent implements interface Iface_Ent
1376 function In_Assertion_Expression_Pragma
(N
: Node_Id
) return Boolean;
1377 -- Returns True if node N appears within a pragma that acts as an assertion
1378 -- expression. See Sem_Prag for the list of qualifying pragmas.
1380 function In_Generic_Scope
(E
: Entity_Id
) return Boolean;
1381 -- Returns True if entity E is inside a generic scope
1383 function In_Instance
return Boolean;
1384 -- Returns True if the current scope is within a generic instance
1386 function In_Instance_Body
return Boolean;
1387 -- Returns True if current scope is within the body of an instance, where
1388 -- several semantic checks (e.g. accessibility checks) are relaxed.
1390 function In_Instance_Not_Visible
return Boolean;
1391 -- Returns True if current scope is with the private part or the body of
1392 -- an instance. Other semantic checks are suppressed in this context.
1394 function In_Instance_Visible_Part
1395 (Id
: Entity_Id
:= Current_Scope
) return Boolean;
1396 -- Returns True if arbitrary entity Id is within the visible part of a
1397 -- package instance, where several additional semantic checks apply.
1399 function In_Package_Body
return Boolean;
1400 -- Returns True if current scope is within a package body
1402 function In_Pragma_Expression
(N
: Node_Id
; Nam
: Name_Id
) return Boolean;
1403 -- Returns true if the expression N occurs within a pragma with name Nam
1405 function In_Pre_Post_Condition
(N
: Node_Id
) return Boolean;
1406 -- Returns True if node N appears within a pre/postcondition pragma. Note
1407 -- the pragma Check equivalents are NOT considered.
1409 function In_Reverse_Storage_Order_Object
(N
: Node_Id
) return Boolean;
1410 -- Returns True if N denotes a component or subcomponent in a record or
1411 -- array that has Reverse_Storage_Order.
1413 function In_Same_Declarative_Part
1415 N
: Node_Id
) return Boolean;
1416 -- True if the node N appears within the same declarative part denoted by
1417 -- the node Context.
1419 function In_Subprogram_Or_Concurrent_Unit
return Boolean;
1420 -- Determines if the current scope is within a subprogram compilation unit
1421 -- (inside a subprogram declaration, subprogram body, or generic subprogram
1422 -- declaration) or within a task or protected body. The test is for
1423 -- appearing anywhere within such a construct (that is it does not need
1424 -- to be directly within).
1426 function In_Subtree
(N
: Node_Id
; Root
: Node_Id
) return Boolean;
1427 -- Determine whether node N is within the subtree rooted at Root
1432 Root2
: Node_Id
) return Boolean;
1433 -- Determine whether node N is within the subtree rooted at Root1 or Root2.
1434 -- This version is more efficient than calling the single root version of
1435 -- Is_Subtree twice.
1437 function In_Visible_Part
(Scope_Id
: Entity_Id
) return Boolean;
1438 -- Determine whether a declaration occurs within the visible part of a
1439 -- package specification. The package must be on the scope stack, and the
1440 -- corresponding private part must not.
1442 function Incomplete_Or_Partial_View
(Id
: Entity_Id
) return Entity_Id
;
1443 -- Given the entity of a constant or a type, retrieve the incomplete or
1444 -- partial view of the same entity. Note that Id may not have a partial
1445 -- view in which case the function returns Empty.
1447 function Incomplete_View_From_Limited_With
1448 (Typ
: Entity_Id
) return Entity_Id
;
1449 -- Typ is a type entity. This normally returns Typ. However, if there is
1450 -- an incomplete view of this entity that comes from a limited-with'ed
1451 -- package, then this returns that incomplete view.
1453 function Indexed_Component_Bit_Offset
(N
: Node_Id
) return Uint
;
1454 -- Given an N_Indexed_Component node, return the first bit position of the
1455 -- component if it is known at compile time. A value of No_Uint means that
1456 -- either the value is not yet known before back-end processing or it is
1457 -- not known at compile time after back-end processing.
1459 procedure Inherit_Rep_Item_Chain
(Typ
: Entity_Id
; From_Typ
: Entity_Id
);
1460 -- Inherit the rep item chain of type From_Typ without clobbering any
1461 -- existing rep items on Typ's chain. Typ is the destination type.
1463 function Inherits_From_Tagged_Full_View
(Typ
: Entity_Id
) return Boolean;
1464 pragma Inline
(Inherits_From_Tagged_Full_View
);
1465 -- Return True if Typ is an untagged private type completed with a
1466 -- derivation of an untagged private type declaration whose full view
1467 -- is a tagged type.
1469 procedure Insert_Explicit_Dereference
(N
: Node_Id
);
1470 -- In a context that requires a composite or subprogram type and where a
1471 -- prefix is an access type, rewrite the access type node N (which is the
1472 -- prefix, e.g. of an indexed component) as an explicit dereference.
1474 procedure Inspect_Deferred_Constant_Completion
(Decls
: List_Id
);
1475 -- Examine all deferred constants in the declaration list Decls and check
1476 -- whether they have been completed by a full constant declaration or an
1477 -- Import pragma. Emit the error message if that is not the case.
1479 procedure Install_Elaboration_Model
(Unit_Id
: Entity_Id
);
1480 -- Install the elaboration model specified by pragma Elaboration_Checks
1481 -- associated with compilation unit Unit_Id. No action is taken when the
1482 -- unit lacks such pragma.
1484 procedure Install_Generic_Formals
(Subp_Id
: Entity_Id
);
1485 -- Install both the generic formal parameters and the formal parameters of
1486 -- generic subprogram Subp_Id into visibility.
1488 procedure Install_SPARK_Mode
(Mode
: SPARK_Mode_Type
; Prag
: Node_Id
);
1489 -- Establish the SPARK_Mode and SPARK_Mode_Pragma currently in effect
1491 function Invalid_Scalar_Value
1493 Scal_Typ
: Scalar_Id
) return Node_Id
;
1494 -- Obtain the invalid value for scalar type Scal_Typ as either specified by
1495 -- pragma Initialize_Scalars or by the binder. Return an expression created
1496 -- at source location Loc, which denotes the invalid value.
1498 function Is_Actual_Out_Parameter
(N
: Node_Id
) return Boolean;
1499 -- Determines if N is an actual parameter of out mode in a subprogram call
1501 function Is_Actual_Parameter
(N
: Node_Id
) return Boolean;
1502 -- Determines if N is an actual parameter in a subprogram call
1504 function Is_Actual_Tagged_Parameter
(N
: Node_Id
) return Boolean;
1505 -- Determines if N is an actual parameter of a formal of tagged type in a
1508 function Is_Aliased_View
(Obj
: Node_Id
) return Boolean;
1509 -- Determine if Obj is an aliased view, i.e. the name of an object to which
1510 -- 'Access or 'Unchecked_Access can apply. Note that this routine uses the
1511 -- rules of the language, it does not take into account the restriction
1512 -- No_Implicit_Aliasing, so it can return True if the restriction is active
1513 -- and Obj violates the restriction. The caller is responsible for calling
1514 -- Restrict.Check_No_Implicit_Aliasing if True is returned, but there is a
1515 -- requirement for obeying the restriction in the call context.
1517 function Is_Ancestor_Package
1519 E2
: Entity_Id
) return Boolean;
1520 -- Determine whether package E1 is an ancestor of E2
1522 function Is_Atomic_Object
(N
: Node_Id
) return Boolean;
1523 -- Determine whether arbitrary node N denotes a reference to an atomic
1524 -- object as per Ada RM C.6(12).
1526 function Is_Atomic_Object_Entity
(Id
: Entity_Id
) return Boolean;
1527 -- Determine whether arbitrary entity Id denotes an atomic object as per
1530 function Is_Atomic_Or_VFA_Object
(N
: Node_Id
) return Boolean;
1531 -- Determine whether arbitrary node N denotes a reference to an object
1532 -- which is either atomic or Volatile_Full_Access.
1534 function Is_Attribute_Result
(N
: Node_Id
) return Boolean;
1535 -- Determine whether node N denotes attribute 'Result
1537 function Is_Attribute_Update
(N
: Node_Id
) return Boolean;
1538 -- Determine whether node N denotes attribute 'Update
1540 function Is_Body_Or_Package_Declaration
(N
: Node_Id
) return Boolean;
1541 -- Determine whether node N denotes a body or a package declaration
1543 function Is_Bounded_String
(T
: Entity_Id
) return Boolean;
1544 -- True if T is a bounded string type. Used to make sure "=" composes
1545 -- properly for bounded string types.
1547 function Is_Constant_Bound
(Exp
: Node_Id
) return Boolean;
1548 -- Exp is the expression for an array bound. Determines whether the
1549 -- bound is a compile-time known value, or a constant entity, or an
1550 -- enumeration literal, or an expression composed of constant-bound
1551 -- subexpressions which are evaluated by means of standard operators.
1553 function Is_Container_Element
(Exp
: Node_Id
) return Boolean;
1554 -- This routine recognizes expressions that denote an element of one of
1555 -- the predefined containers, when the source only contains an indexing
1556 -- operation and an implicit dereference is inserted by the compiler.
1557 -- In the absence of this optimization, the indexing creates a temporary
1558 -- controlled cursor that sets the tampering bit of the container, and
1559 -- restricts the use of the convenient notation C (X) to contexts that
1560 -- do not check the tampering bit (e.g. C.Include (X, C (Y)). Exp is an
1561 -- explicit dereference. The transformation applies when it has the form
1564 function Is_Contract_Annotation
(Item
: Node_Id
) return Boolean;
1565 -- Determine whether aspect specification or pragma Item is a contract
1568 function Is_Controlling_Limited_Procedure
1569 (Proc_Nam
: Entity_Id
) return Boolean;
1570 -- Ada 2005 (AI-345): Determine whether Proc_Nam is a primitive procedure
1571 -- of a limited interface with a controlling first parameter.
1573 function Is_CPP_Constructor_Call
(N
: Node_Id
) return Boolean;
1574 -- Returns True if N is a call to a CPP constructor
1576 function Is_CCT_Instance
1577 (Ref_Id
: Entity_Id
;
1578 Context_Id
: Entity_Id
) return Boolean;
1579 -- Subsidiary to the analysis of pragmas [Refined_]Depends and [Refined_]
1580 -- Global; also used when analyzing default expressions of protected and
1581 -- record components. Determine whether entity Ref_Id (which must represent
1582 -- either a protected type or a task type) denotes the current instance of
1583 -- a concurrent type. Context_Id denotes the associated context where the
1586 function Is_Child_Or_Sibling
1587 (Pack_1
: Entity_Id
;
1588 Pack_2
: Entity_Id
) return Boolean;
1589 -- Determine the following relations between two arbitrary packages:
1590 -- 1) One package is the parent of a child package
1591 -- 2) Both packages are siblings and share a common parent
1593 function Is_Concurrent_Interface
(T
: Entity_Id
) return Boolean;
1594 -- First determine whether type T is an interface and then check whether
1595 -- it is of protected, synchronized or task kind.
1597 function Is_Current_Instance
(N
: Node_Id
) return Boolean;
1598 -- Predicate is true if N legally denotes a type name within its own
1599 -- declaration. Prior to Ada 2012 this covered only synchronized type
1600 -- declarations. In Ada 2012 it also covers type and subtype declarations
1601 -- with aspects: Invariant, Predicate, and Default_Initial_Condition.
1603 function Is_Declaration
1605 Body_OK
: Boolean := True;
1606 Concurrent_OK
: Boolean := True;
1607 Formal_OK
: Boolean := True;
1608 Generic_OK
: Boolean := True;
1609 Instantiation_OK
: Boolean := True;
1610 Renaming_OK
: Boolean := True;
1611 Stub_OK
: Boolean := True;
1612 Subprogram_OK
: Boolean := True;
1613 Type_OK
: Boolean := True) return Boolean;
1614 -- Determine whether arbitrary node N denotes a declaration depending
1615 -- on the allowed subsets of declarations. Set the following flags to
1616 -- consider specific subsets of declarations:
1618 -- * Body_OK - body declarations
1620 -- * Concurrent_OK - concurrent type declarations
1622 -- * Formal_OK - formal declarations
1624 -- * Generic_OK - generic declarations, including generic renamings
1626 -- * Instantiation_OK - generic instantiations
1628 -- * Renaming_OK - renaming declarations, including generic renamings
1630 -- * Stub_OK - stub declarations
1632 -- * Subprogram_OK - entry, expression function, and subprogram
1635 -- * Type_OK - type declarations, including concurrent types
1637 function Is_Declared_Within_Variant
(Comp
: Entity_Id
) return Boolean;
1638 -- Returns True iff component Comp is declared within a variant part
1640 function Is_Dependent_Component_Of_Mutable_Object
1641 (Object
: Node_Id
) return Boolean;
1642 -- Returns True if Object is the name of a subcomponent that depends on
1643 -- discriminants of a variable whose nominal subtype is unconstrained and
1644 -- not indefinite, and the variable is not aliased. Otherwise returns
1645 -- False. The nodes passed to this function are assumed to denote objects.
1647 function Is_Dereferenced
(N
: Node_Id
) return Boolean;
1648 -- N is a subexpression node of an access type. This function returns true
1649 -- if N appears as the prefix of a node that does a dereference of the
1650 -- access value (selected/indexed component, explicit dereference or a
1651 -- slice), and false otherwise.
1653 function Is_Descendant_Of
(T1
: Entity_Id
; T2
: Entity_Id
) return Boolean;
1654 -- Returns True if type T1 is a descendant of type T2, and false otherwise.
1655 -- This is the RM definition, a type is a descendant of another type if it
1656 -- is the same type or is derived from a descendant of the other type.
1658 function Is_Descendant_Of_Suspension_Object
1659 (Typ
: Entity_Id
) return Boolean;
1660 -- Determine whether type Typ is a descendant of type Suspension_Object
1661 -- defined in Ada.Synchronous_Task_Control. This version is different from
1662 -- Is_Descendant_Of as the detection of Suspension_Object does not involve
1663 -- an entity and by extension a call to RTSfind.
1665 function Is_Double_Precision_Floating_Point_Type
1666 (E
: Entity_Id
) return Boolean;
1667 -- Return whether E is a double precision floating point type,
1668 -- characterized by:
1669 -- . machine_radix = 2
1670 -- . machine_mantissa = 53
1671 -- . machine_emax = 2**10
1672 -- . machine_emin = 3 - machine_emax
1674 function Is_Effectively_Volatile
(Id
: Entity_Id
) return Boolean;
1675 -- Determine whether a type or object denoted by entity Id is effectively
1676 -- volatile (SPARK RM 7.1.2). To qualify as such, the entity must be either
1678 -- * An array type subject to aspect Volatile_Components
1679 -- * An array type whose component type is effectively volatile
1680 -- * A protected type
1681 -- * Descendant of type Ada.Synchronous_Task_Control.Suspension_Object
1683 function Is_Effectively_Volatile_Object
(N
: Node_Id
) return Boolean;
1684 -- Determine whether an arbitrary node denotes an effectively volatile
1685 -- object (SPARK RM 7.1.2).
1687 function Is_Entry_Body
(Id
: Entity_Id
) return Boolean;
1688 -- Determine whether entity Id is the body entity of an entry [family]
1690 function Is_Entry_Declaration
(Id
: Entity_Id
) return Boolean;
1691 -- Determine whether entity Id is the spec entity of an entry [family]
1693 function Is_Expanded_Priority_Attribute
(E
: Entity_Id
) return Boolean;
1694 -- Check whether a function in a call is an expanded priority attribute,
1695 -- which is transformed into an Rtsfind call to Get_Ceiling. This expansion
1696 -- does not take place in a configurable runtime.
1698 function Is_Expression_Function
(Subp
: Entity_Id
) return Boolean;
1699 -- Determine whether subprogram [body] Subp denotes an expression function
1701 function Is_Expression_Function_Or_Completion
1702 (Subp
: Entity_Id
) return Boolean;
1703 -- Determine whether subprogram [body] Subp denotes an expression function
1704 -- or is completed by an expression function body.
1706 function Is_EVF_Expression
(N
: Node_Id
) return Boolean;
1707 -- Determine whether node N denotes a reference to a formal parameter of
1708 -- a specific tagged type whose related subprogram is subject to pragma
1709 -- Extensions_Visible with value "False" (SPARK RM 6.1.7). Several other
1710 -- constructs fall under this category:
1711 -- 1) A qualified expression whose operand is EVF
1712 -- 2) A type conversion whose operand is EVF
1713 -- 3) An if expression with at least one EVF dependent_expression
1714 -- 4) A case expression with at least one EVF dependent_expression
1716 function Is_False
(U
: Uint
) return Boolean;
1717 pragma Inline
(Is_False
);
1718 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
1719 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
1720 -- if it is False (i.e. zero).
1722 function Is_Fixed_Model_Number
(U
: Ureal
; T
: Entity_Id
) return Boolean;
1723 -- Returns True iff the number U is a model number of the fixed-point type
1724 -- T, i.e. if it is an exact multiple of Small.
1726 function Is_Fully_Initialized_Type
(Typ
: Entity_Id
) return Boolean;
1727 -- Typ is a type entity. This function returns true if this type is fully
1728 -- initialized, meaning that an object of the type is fully initialized.
1729 -- Note that initialization resulting from use of pragma Normalize_Scalars
1730 -- does not count. Note that this is only used for the purpose of issuing
1731 -- warnings for objects that are potentially referenced uninitialized. This
1732 -- means that the result returned is not crucial, but should err on the
1733 -- side of thinking things are fully initialized if it does not know.
1735 function Is_Generic_Declaration_Or_Body
(Decl
: Node_Id
) return Boolean;
1736 -- Determine whether arbitrary declaration Decl denotes a generic package,
1737 -- a generic subprogram or a generic body.
1739 function Is_Inherited_Operation
(E
: Entity_Id
) return Boolean;
1740 -- E is a subprogram. Return True is E is an implicit operation inherited
1741 -- by a derived type declaration.
1743 function Is_Inherited_Operation_For_Type
1745 Typ
: Entity_Id
) return Boolean;
1746 -- E is a subprogram. Return True is E is an implicit operation inherited
1747 -- by the derived type declaration for type Typ.
1749 function Is_Inlinable_Expression_Function
(Subp
: Entity_Id
) return Boolean;
1750 -- Return True if Subp is an expression function that fulfills all the
1751 -- following requirements for inlining:
1752 -- 1. pragma/aspect Inline_Always
1755 -- 4. No dispatching primitive
1756 -- 5. Result subtype controlled (or with controlled components)
1757 -- 6. Result subtype not subject to type-invariant checks
1758 -- 7. Result subtype not a class-wide type
1759 -- 8. Return expression naming an object global to the function
1760 -- 9. Nominal subtype of the returned object statically compatible
1761 -- with the result subtype of the expression function.
1763 function Is_Iterator
(Typ
: Entity_Id
) return Boolean;
1764 -- AI05-0139-2: Check whether Typ is one of the predefined interfaces in
1765 -- Ada.Iterator_Interfaces, or it is derived from one.
1767 function Is_Iterator_Over_Array
(N
: Node_Id
) return Boolean;
1768 -- N is an iterator specification. Returns True iff N is an iterator over
1769 -- an array, either inside a loop of the form 'for X of A' or a quantified
1770 -- expression of the form 'for all/some X of A' where A is of array type.
1772 type Is_LHS_Result
is (Yes
, No
, Unknown
);
1773 function Is_LHS
(N
: Node_Id
) return Is_LHS_Result
;
1774 -- Returns Yes if N is definitely used as Name in an assignment statement.
1775 -- Returns No if N is definitely NOT used as a Name in an assignment
1776 -- statement. Returns Unknown if we can't tell at this stage (happens in
1777 -- the case where we don't know the type of N yet, and we have something
1778 -- like N.A := 3, where this counts as N being used on the left side of
1779 -- an assignment only if N is not an access type. If it is an access type
1780 -- then it is N.all.A that is assigned, not N.
1782 function Is_Library_Level_Entity
(E
: Entity_Id
) return Boolean;
1783 -- A library-level declaration is one that is accessible from Standard,
1784 -- i.e. a library unit or an entity declared in a library package.
1786 function Is_Limited_Class_Wide_Type
(Typ
: Entity_Id
) return Boolean;
1787 -- Determine whether a given type is a limited class-wide type, in which
1788 -- case it needs a Master_Id, because extensions of its designated type
1789 -- may include task components. A class-wide type that comes from a
1790 -- limited view must be treated in the same way.
1792 function Is_Local_Variable_Reference
(Expr
: Node_Id
) return Boolean;
1793 -- Determines whether Expr is a reference to a variable or IN OUT mode
1794 -- parameter of the current enclosing subprogram.
1795 -- Why are OUT parameters not considered here ???
1797 function Is_Name_Reference
(N
: Node_Id
) return Boolean;
1798 -- Determine whether arbitrary node N is a reference to a name. This is
1799 -- similar to Is_Object_Reference but returns True only if N can be renamed
1800 -- without the need for a temporary, the typical example of an object not
1801 -- in this category being a function call.
1803 function Is_Non_Preelaborable_Construct
(N
: Node_Id
) return Boolean;
1804 -- Determine whether arbitrary construct N violates preelaborability as
1805 -- defined in ARM 10.2.1 5-9/3. This routine takes into account both the
1806 -- syntactic and semantic properties of the construct.
1808 function Is_Nontrivial_DIC_Procedure
(Id
: Entity_Id
) return Boolean;
1809 -- Determine whether entity Id denotes the procedure that verifies the
1810 -- assertion expression of pragma Default_Initial_Condition and if it does,
1811 -- the encapsulated expression is nontrivial.
1813 function Is_Null_Record_Type
(T
: Entity_Id
) return Boolean;
1814 -- Determine whether T is declared with a null record definition or a
1815 -- null component list.
1817 function Is_Object_Image
(Prefix
: Node_Id
) return Boolean;
1818 -- Returns True if an 'Image, 'Wide_Image, or 'Wide_Wide_Image attribute
1819 -- is applied to a given object or named value prefix (see below).
1821 -- AI12-00124: The ARG has adopted the GNAT semantics of 'Img for scalar
1822 -- types, so that the prefix of any 'Image attribute can be an object, a
1823 -- named value, or a type, and there is no need for an argument in the
1824 -- case it is an object reference.
1826 function Is_Object_Reference
(N
: Node_Id
) return Boolean;
1827 -- Determines if the tree referenced by N represents an object. Both
1828 -- variable and constant objects return True (compare Is_Variable).
1830 function Is_OK_Variable_For_Out_Formal
(AV
: Node_Id
) return Boolean;
1831 -- Used to test if AV is an acceptable formal for an OUT or IN OUT formal.
1832 -- Note that the Is_Variable function is not quite the right test because
1833 -- this is a case in which conversions whose expression is a variable (in
1834 -- the Is_Variable sense) with an untagged type target are considered view
1835 -- conversions and hence variables.
1837 function Is_OK_Volatile_Context
1839 Obj_Ref
: Node_Id
) return Boolean;
1840 -- Determine whether node Context denotes a "non-interfering context" (as
1841 -- defined in SPARK RM 7.1.3(12)) where volatile reference Obj_Ref can
1844 function Is_Package_Contract_Annotation
(Item
: Node_Id
) return Boolean;
1845 -- Determine whether aspect specification or pragma Item is one of the
1846 -- following package contract annotations:
1848 -- Initial_Condition
1852 function Is_Partially_Initialized_Type
1854 Include_Implicit
: Boolean := True) return Boolean;
1855 -- Typ is a type entity. This function returns true if this type is partly
1856 -- initialized, meaning that an object of the type is at least partly
1857 -- initialized (in particular in the record case, that at least one
1858 -- component has an initialization expression). Note that initialization
1859 -- resulting from the use of pragma Normalize_Scalars does not count.
1860 -- Include_Implicit controls whether implicit initialization of access
1861 -- values to null, and of discriminant values, is counted as making the
1862 -- type be partially initialized. For the default setting of True, these
1863 -- implicit cases do count, and discriminated types or types containing
1864 -- access values not explicitly initialized will return True. Otherwise
1865 -- if Include_Implicit is False, these cases do not count as making the
1866 -- type be partially initialized.
1868 function Is_Potentially_Unevaluated
(N
: Node_Id
) return Boolean;
1869 -- Predicate to implement definition given in RM 6.1.1 (20/3)
1871 function Is_Potentially_Persistent_Type
(T
: Entity_Id
) return Boolean;
1872 -- Determines if type T is a potentially persistent type. A potentially
1873 -- persistent type is defined (recursively) as a scalar type, an untagged
1874 -- record whose components are all of a potentially persistent type, or an
1875 -- array with all static constraints whose component type is potentially
1876 -- persistent. A private type is potentially persistent if the full type
1877 -- is potentially persistent.
1879 function Is_Predefined_Dispatching_Operation
(E
: Entity_Id
) return Boolean;
1880 -- Ada 2005 (AI-251): Determines if E is a predefined primitive operation
1882 function Is_Predefined_Interface_Primitive
(E
: Entity_Id
) return Boolean;
1883 -- Ada 2005 (AI-345): Returns True if E is one of the predefined primitives
1884 -- required to implement interfaces.
1886 function Is_Predefined_Internal_Operation
(E
: Entity_Id
) return Boolean;
1887 -- Similar to the previous one, but excludes stream operations, because
1888 -- these may be overridden, and need extra formals, like user-defined
1891 function Is_Preelaborable_Aggregate
(Aggr
: Node_Id
) return Boolean;
1892 -- Determine whether aggregate Aggr violates the restrictions of
1893 -- preelaborable constructs as defined in ARM 10.2.1(5-9).
1895 function Is_Preelaborable_Construct
(N
: Node_Id
) return Boolean;
1896 -- Determine whether arbitrary node N violates the restrictions of
1897 -- preelaborable constructs as defined in ARM 10.2.1(5-9). Routine
1898 -- Is_Non_Preelaborable_Construct takes into account the syntactic
1899 -- and semantic properties of N for a more accurate diagnostic.
1901 function Is_Protected_Self_Reference
(N
: Node_Id
) return Boolean;
1902 -- Return True if node N denotes a protected type name which represents
1903 -- the current instance of a protected object according to RM 9.4(21/2).
1905 function Is_RCI_Pkg_Spec_Or_Body
(Cunit
: Node_Id
) return Boolean;
1906 -- Return True if a compilation unit is the specification or the
1907 -- body of a remote call interface package.
1909 function Is_Remote_Access_To_Class_Wide_Type
(E
: Entity_Id
) return Boolean;
1910 -- Return True if E is a remote access-to-class-wide type
1912 function Is_Remote_Access_To_Subprogram_Type
(E
: Entity_Id
) return Boolean;
1913 -- Return True if E is a remote access to subprogram type
1915 function Is_Remote_Call
(N
: Node_Id
) return Boolean;
1916 -- Return True if N denotes a potentially remote call
1918 function Is_Renamed_Entry
(Proc_Nam
: Entity_Id
) return Boolean;
1919 -- Return True if Proc_Nam is a procedure renaming of an entry
1921 function Is_Renaming_Declaration
(N
: Node_Id
) return Boolean;
1922 -- Determine whether arbitrary node N denotes a renaming declaration
1924 function Is_Reversible_Iterator
(Typ
: Entity_Id
) return Boolean;
1925 -- AI05-0139-2: Check whether Typ is derived from the predefined interface
1926 -- Ada.Iterator_Interfaces.Reversible_Iterator.
1928 function Is_Selector_Name
(N
: Node_Id
) return Boolean;
1929 -- Given an N_Identifier node N, determines if it is a Selector_Name.
1930 -- As described in Sinfo, Selector_Names are special because they
1931 -- represent use of the N_Identifier node for a true identifier, when
1932 -- normally such nodes represent a direct name.
1934 function Is_Single_Concurrent_Object
(Id
: Entity_Id
) return Boolean;
1935 -- Determine whether arbitrary entity Id denotes the anonymous object
1936 -- created for a single protected or single task type.
1938 function Is_Single_Concurrent_Type
(Id
: Entity_Id
) return Boolean;
1939 -- Determine whether arbitrary entity Id denotes a single protected or
1940 -- single task type.
1942 function Is_Single_Concurrent_Type_Declaration
(N
: Node_Id
) return Boolean;
1943 -- Determine whether arbitrary node N denotes the declaration of a single
1944 -- protected type or single task type.
1946 function Is_Single_Precision_Floating_Point_Type
1947 (E
: Entity_Id
) return Boolean;
1948 -- Return whether E is a single precision floating point type,
1949 -- characterized by:
1950 -- . machine_radix = 2
1951 -- . machine_mantissa = 24
1952 -- . machine_emax = 2**7
1953 -- . machine_emin = 3 - machine_emax
1955 function Is_Single_Protected_Object
(Id
: Entity_Id
) return Boolean;
1956 -- Determine whether arbitrary entity Id denotes the anonymous object
1957 -- created for a single protected type.
1959 function Is_Single_Task_Object
(Id
: Entity_Id
) return Boolean;
1960 -- Determine whether arbitrary entity Id denotes the anonymous object
1961 -- created for a single task type.
1963 function Is_SPARK_05_Initialization_Expr
(N
: Node_Id
) return Boolean;
1964 -- Determines if the tree referenced by N represents an initialization
1965 -- expression in SPARK 2005, suitable for initializing an object in an
1966 -- object declaration.
1968 function Is_SPARK_05_Object_Reference
(N
: Node_Id
) return Boolean;
1969 -- Determines if the tree referenced by N represents an object in SPARK
1970 -- 2005. This differs from Is_Object_Reference in that only variables,
1971 -- constants, formal parameters, and selected_components of those are
1972 -- valid objects in SPARK 2005.
1974 function Is_Specific_Tagged_Type
(Typ
: Entity_Id
) return Boolean;
1975 -- Determine whether an arbitrary [private] type is specifically tagged
1977 function Is_Statement
(N
: Node_Id
) return Boolean;
1978 pragma Inline
(Is_Statement
);
1979 -- Check if the node N is a statement node. Note that this includes
1980 -- the case of procedure call statements (unlike the direct use of
1981 -- the N_Statement_Other_Than_Procedure_Call subtype from Sinfo).
1982 -- Note that a label is *not* a statement, and will return False.
1984 function Is_Subprogram_Contract_Annotation
(Item
: Node_Id
) return Boolean;
1985 -- Determine whether aspect specification or pragma Item is one of the
1986 -- following subprogram contract annotations:
1989 -- Extensions_Visible
2002 function Is_Subprogram_Stub_Without_Prior_Declaration
2003 (N
: Node_Id
) return Boolean;
2004 -- Given an N_Subprogram_Body_Stub node N, return True if N is a subprogram
2005 -- stub with no prior subprogram declaration.
2007 function Is_Suitable_Primitive
(Subp_Id
: Entity_Id
) return Boolean;
2008 -- Determine whether arbitrary subprogram Subp_Id may act as a primitive of
2009 -- an arbitrary tagged type.
2011 function Is_Suspension_Object
(Id
: Entity_Id
) return Boolean;
2012 -- Determine whether arbitrary entity Id denotes Suspension_Object defined
2013 -- in Ada.Synchronous_Task_Control.
2015 function Is_Synchronized_Object
(Id
: Entity_Id
) return Boolean;
2016 -- Determine whether entity Id denotes an object and if it does, whether
2017 -- this object is synchronized as specified in SPARK RM 9.1. To qualify as
2018 -- such, the object must be
2019 -- * Of a type that yields a synchronized object
2020 -- * An atomic object with enabled Async_Writers
2022 -- * A variable subject to pragma Constant_After_Elaboration
2024 function Is_Synchronized_Tagged_Type
(E
: Entity_Id
) return Boolean;
2025 -- Returns True if E is a synchronized tagged type (AARM 3.9.4 (6/2))
2027 function Is_Transfer
(N
: Node_Id
) return Boolean;
2028 -- Returns True if the node N is a statement which is known to cause an
2029 -- unconditional transfer of control at run time, i.e. the following
2030 -- statement definitely will not be executed.
2032 function Is_True
(U
: Uint
) return Boolean;
2033 pragma Inline
(Is_True
);
2034 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
2035 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
2036 -- if it is True (i.e. non-zero).
2038 function Is_Unchecked_Conversion_Instance
(Id
: Entity_Id
) return Boolean;
2039 -- Determine whether an arbitrary entity denotes an instance of function
2040 -- Ada.Unchecked_Conversion.
2042 function Is_Universal_Numeric_Type
(T
: Entity_Id
) return Boolean;
2043 pragma Inline
(Is_Universal_Numeric_Type
);
2044 -- True if T is Universal_Integer or Universal_Real
2046 function Is_User_Defined_Equality
(Id
: Entity_Id
) return Boolean;
2047 -- Determine whether an entity denotes a user-defined equality
2049 function Is_Validation_Variable_Reference
(N
: Node_Id
) return Boolean;
2050 -- Determine whether N denotes a reference to a variable which captures the
2051 -- value of an object for validation purposes.
2053 function Is_Variable_Size_Array
(E
: Entity_Id
) return Boolean;
2054 -- Returns true if E has variable size components
2056 function Is_Variable_Size_Record
(E
: Entity_Id
) return Boolean;
2057 -- Returns true if E has variable size components
2059 function Is_Variable
2061 Use_Original_Node
: Boolean := True) return Boolean;
2062 -- Determines if the tree referenced by N represents a variable, i.e. can
2063 -- appear on the left side of an assignment. There is one situation (formal
2064 -- parameters) in which untagged type conversions are also considered
2065 -- variables, but Is_Variable returns False for such cases, since it has
2066 -- no knowledge of the context. Note that this is the point at which
2067 -- Assignment_OK is checked, and True is returned for any tree thus marked.
2068 -- Use_Original_Node is used to perform the test on Original_Node (N). By
2069 -- default is True since this routine is commonly invoked as part of the
2070 -- semantic analysis and it must not be disturbed by the rewriten nodes.
2072 function Is_Visibly_Controlled
(T
: Entity_Id
) return Boolean;
2073 -- Check whether T is derived from a visibly controlled type. This is true
2074 -- if the root type is declared in Ada.Finalization. If T is derived
2075 -- instead from a private type whose full view is controlled, an explicit
2076 -- Initialize/Adjust/Finalize subprogram does not override the inherited
2079 function Is_Volatile_Function
(Func_Id
: Entity_Id
) return Boolean;
2080 -- Determine whether [generic] function Func_Id is subject to enabled
2081 -- pragma Volatile_Function. Protected functions are treated as volatile
2082 -- (SPARK RM 7.1.2).
2084 function Is_Volatile_Object
(N
: Node_Id
) return Boolean;
2085 -- Determines if the given node denotes an volatile object in the sense of
2086 -- the legality checks described in RM C.6(12). Note that the test here is
2087 -- for something actually declared as volatile, not for an object that gets
2088 -- treated as volatile (see Einfo.Treat_As_Volatile).
2091 with procedure Handle_Parameter
(Formal
: Entity_Id
; Actual
: Node_Id
);
2092 procedure Iterate_Call_Parameters
(Call
: Node_Id
);
2093 -- Calls Handle_Parameter for each pair of formal and actual parameters of
2094 -- a function, procedure, or entry call.
2096 function Itype_Has_Declaration
(Id
: Entity_Id
) return Boolean;
2097 -- Applies to Itypes. True if the Itype is attached to a declaration for
2098 -- the type through its Parent field, which may or not be present in the
2101 procedure Kill_Current_Values
(Last_Assignment_Only
: Boolean := False);
2102 -- This procedure is called to clear all constant indications from all
2103 -- entities in the current scope and in any parent scopes if the current
2104 -- scope is a block or a package (and that recursion continues to the top
2105 -- scope that is not a block or a package). This is used when the
2106 -- sequential flow-of-control assumption is violated (occurrence of a
2107 -- label, head of a loop, or start of an exception handler). The effect of
2108 -- the call is to clear the Current_Value field (but we do not need to
2109 -- clear the Is_True_Constant flag, since that only gets reset if there
2110 -- really is an assignment somewhere in the entity scope). This procedure
2111 -- also calls Kill_All_Checks, since this is a special case of needing to
2112 -- forget saved values. This procedure also clears the Is_Known_Null and
2113 -- Is_Known_Non_Null and Is_Known_Valid flags in variables, constants or
2114 -- parameters since these are also not known to be trustable any more.
2116 -- The Last_Assignment_Only flag is set True to clear only Last_Assignment
2117 -- fields and leave other fields unchanged. This is used when we encounter
2118 -- an unconditional flow of control change (return, goto, raise). In such
2119 -- cases we don't need to clear the current values, since it may be that
2120 -- the flow of control change occurs in a conditional context, and if it
2121 -- is not taken, then it is just fine to keep the current values. But the
2122 -- Last_Assignment field is different, if we have a sequence assign-to-v,
2123 -- conditional-return, assign-to-v, we do not want to complain that the
2124 -- second assignment clobbers the first.
2126 procedure Kill_Current_Values
2128 Last_Assignment_Only
: Boolean := False);
2129 -- This performs the same processing as described above for the form with
2130 -- no argument, but for the specific entity given. The call has no effect
2131 -- if the entity Ent is not for an object. Last_Assignment_Only has the
2132 -- same meaning as for the call with no Ent.
2134 procedure Kill_Size_Check_Code
(E
: Entity_Id
);
2135 -- Called when an address clause or pragma Import is applied to an entity.
2136 -- If the entity is a variable or a constant, and size check code is
2137 -- present, this size check code is killed, since the object will not be
2138 -- allocated by the program.
2140 function Known_Non_Null
(N
: Node_Id
) return Boolean;
2141 -- Given a node N for a subexpression of an access type, determines if
2142 -- this subexpression yields a value that is known at compile time to
2143 -- be non-null and returns True if so. Returns False otherwise. It is
2144 -- an error to call this function if N is not of an access type.
2146 function Known_Null
(N
: Node_Id
) return Boolean;
2147 -- Given a node N for a subexpression of an access type, determines if this
2148 -- subexpression yields a value that is known at compile time to be null
2149 -- and returns True if so. Returns False otherwise. It is an error to call
2150 -- this function if N is not of an access type.
2152 function Known_To_Be_Assigned
(N
: Node_Id
) return Boolean;
2153 -- The node N is an entity reference. This function determines whether the
2154 -- reference is for sure an assignment of the entity, returning True if
2155 -- so. This differs from May_Be_Lvalue in that it defaults in the other
2156 -- direction. Cases which may possibly be assignments but are not known to
2157 -- be may return True from May_Be_Lvalue, but False from this function.
2159 function Last_Source_Statement
(HSS
: Node_Id
) return Node_Id
;
2160 -- HSS is a handled statement sequence. This function returns the last
2161 -- statement in Statements (HSS) that has Comes_From_Source set. If no
2162 -- such statement exists, Empty is returned.
2164 procedure Mark_Coextensions
(Context_Nod
: Node_Id
; Root_Nod
: Node_Id
);
2165 -- Given a node which designates the context of analysis and an origin in
2166 -- the tree, traverse from Root_Nod and mark all allocators as either
2167 -- dynamic or static depending on Context_Nod. Any incorrect marking is
2168 -- cleaned up during resolution.
2170 procedure Mark_Elaboration_Attributes
2171 (N_Id
: Node_Or_Entity_Id
;
2172 Checks
: Boolean := False;
2173 Level
: Boolean := False;
2174 Modes
: Boolean := False;
2175 Warnings
: Boolean := False);
2176 -- Preserve relevant elaboration-related properties of the context in
2177 -- arbitrary entity or node N_Id. The flags control the properties as
2180 -- Checks - Save the status of Elaboration_Check
2181 -- Level - Save the declaration level of N_Id (if appicable)
2182 -- Modes - Save the Ghost and SPARK modes in effect (if applicable)
2183 -- Warnings - Save the status of Elab_Warnings
2185 function Matching_Static_Array_Bounds
2187 R_Typ
: Node_Id
) return Boolean;
2188 -- L_Typ and R_Typ are two array types. Returns True when they have the
2189 -- same number of dimensions, and the same static bounds for each index
2192 function May_Be_Lvalue
(N
: Node_Id
) return Boolean;
2193 -- Determines if N could be an lvalue (e.g. an assignment left hand side).
2194 -- An lvalue is defined as any expression which appears in a context where
2195 -- a name is required by the syntax, and the identity, rather than merely
2196 -- the value of the node is needed (for example, the prefix of an Access
2197 -- attribute is in this category). Note that, as implied by the name, this
2198 -- test is conservative. If it cannot be sure that N is NOT an lvalue, then
2199 -- it returns True. It tries hard to get the answer right, but it is hard
2200 -- to guarantee this in all cases. Note that it is more possible to give
2201 -- correct answer if the tree is fully analyzed.
2203 function Might_Raise
(N
: Node_Id
) return Boolean;
2204 -- True if evaluation of N might raise an exception. This is conservative;
2205 -- if we're not sure, we return True. If N is a subprogram body, this is
2206 -- about whether execution of that body can raise.
2208 function Nearest_Enclosing_Instance
(E
: Entity_Id
) return Entity_Id
;
2209 -- Return the entity of the nearest enclosing instance which encapsulates
2210 -- entity E. If no such instance exits, return Empty.
2212 function Needs_One_Actual
(E
: Entity_Id
) return Boolean;
2213 -- Returns True if a function has defaults for all but its first formal,
2214 -- which is a controlling formal. Used in Ada 2005 mode to solve the
2215 -- syntactic ambiguity that results from an indexing of a function call
2216 -- that returns an array, so that Obj.F (X, Y) may mean F (Ob) (X, Y).
2218 function Needs_Simple_Initialization
2220 Consider_IS
: Boolean := True) return Boolean;
2221 -- Certain types need initialization even though there is no specific
2222 -- initialization routine:
2223 -- Access types (which need initializing to null)
2224 -- All scalar types if Normalize_Scalars mode set
2225 -- Descendants of standard string types if Normalize_Scalars mode set
2226 -- Scalar types having a Default_Value attribute
2227 -- Regarding Initialize_Scalars mode, this is ignored if Consider_IS is
2228 -- set to False, but if Consider_IS is set to True, then the cases above
2229 -- mentioning Normalize_Scalars also apply for Initialize_Scalars mode.
2231 function Needs_Variable_Reference_Marker
2233 Calls_OK
: Boolean) return Boolean;
2234 -- Determine whether arbitrary node N denotes a reference to a variable
2235 -- which is suitable for SPARK elaboration checks. Flag Calls_OK should
2236 -- be set when the reference is allowed to appear within calls.
2238 function New_Copy_List_Tree
(List
: List_Id
) return List_Id
;
2239 -- Copy recursively an analyzed list of nodes. Uses New_Copy_Tree defined
2240 -- below. As for New_Copy_Tree, it is illegal to attempt to copy extended
2241 -- nodes (entities) either directly or indirectly using this function.
2243 function New_Copy_Tree
2245 Map
: Elist_Id
:= No_Elist
;
2246 New_Sloc
: Source_Ptr
:= No_Location
;
2247 New_Scope
: Entity_Id
:= Empty
;
2248 Scopes_In_EWA_OK
: Boolean := False) return Node_Id
;
2249 -- Perform a deep copy of the subtree rooted at Source. Entities, itypes,
2250 -- and nodes are handled separately as follows:
2252 -- * A node is replicated by first creating a shallow copy, then copying
2253 -- its syntactic fields, where all Parent pointers of the fields are
2254 -- updated to refer to the copy. In addition, the following semantic
2255 -- fields are recreated after the replication takes place.
2257 -- First_Named_Actual
2258 -- First_Real_Statement
2259 -- Next_Named_Actual
2261 -- If applicable, the Etype field (if any) is updated to refer to a
2262 -- local itype or type (see below).
2264 -- * An entity defined within an N_Expression_With_Actions node in the
2265 -- subtree is given a new entity, and all references to the original
2266 -- entity are updated to refer to the new entity. In addition, the
2267 -- following semantic fields are replicated and/or updated to refer
2268 -- to a local entity or itype.
2270 -- Discriminant_Constraint
2274 -- Packed_Array_Impl_Type
2278 -- Note that currently no other expression can define entities.
2280 -- * An itype whose Associated_Node_For_Itype node is in the subtree
2281 -- is given a new entity, and all references to the original itype
2282 -- are updated to refer to the new itype. In addition, the following
2283 -- semantic fields are replicated and/or updated to refer to a local
2286 -- Discriminant_Constraint
2290 -- Packed_Array_Impl_Type
2294 -- The Associated_Node_For_Itype is updated to refer to a replicated
2297 -- The routine can replicate both analyzed and unanalyzed trees. Copying an
2298 -- Empty or Error node yields the same node.
2300 -- Parameter Map may be used to specify a set of mappings between entities.
2301 -- These mappings are then taken into account when replicating entities.
2302 -- The format of Map must be as follows:
2305 -- new entity to replace references to entity 1
2307 -- new entity to replace references to entity 2
2310 -- Map and its contents are left unchanged.
2312 -- Parameter New_Sloc may be used to specify a new source location for all
2313 -- replicated entities, itypes, and nodes. The Comes_From_Source indicator
2314 -- is defaulted if a new source location is provided.
2316 -- Parameter New_Scope may be used to specify a new scope for all copied
2317 -- entities and itypes.
2319 -- Parameter Scopes_In_EWA_OK may be used to force the replication of both
2320 -- scoping entities and non-scoping entities found within expression with
2323 function New_External_Entity
2324 (Kind
: Entity_Kind
;
2325 Scope_Id
: Entity_Id
;
2326 Sloc_Value
: Source_Ptr
;
2327 Related_Id
: Entity_Id
;
2329 Suffix_Index
: Int
:= 0;
2330 Prefix
: Character := ' ') return Entity_Id
;
2331 -- This function creates an N_Defining_Identifier node for an internal
2332 -- created entity, such as an implicit type or subtype, or a record
2333 -- initialization procedure. The entity name is constructed with a call
2334 -- to New_External_Name (Related_Id, Suffix, Suffix_Index, Prefix), so
2335 -- that the generated name may be referenced as a public entry, and the
2336 -- Is_Public flag is set if needed (using Set_Public_Status). If the
2337 -- entity is for a type or subtype, the size/align fields are initialized
2338 -- to unknown (Uint_0).
2340 function New_Internal_Entity
2341 (Kind
: Entity_Kind
;
2342 Scope_Id
: Entity_Id
;
2343 Sloc_Value
: Source_Ptr
;
2344 Id_Char
: Character) return Entity_Id
;
2345 -- This function is similar to New_External_Entity, except that the
2346 -- name is constructed by New_Internal_Name (Id_Char). This is used
2347 -- when the resulting entity does not have to be referenced as a
2348 -- public entity (and in this case Is_Public is not set).
2350 procedure Next_Actual
(Actual_Id
: in out Node_Id
);
2351 pragma Inline
(Next_Actual
);
2352 -- Next_Actual (N) is equivalent to N := Next_Actual (N). Note that we
2353 -- inline this procedural form, but not the functional form that follows.
2355 function Next_Actual
(Actual_Id
: Node_Id
) return Node_Id
;
2356 -- Find next actual parameter in declaration order. As described for
2357 -- First_Actual, this is the next actual in the declaration order, not
2358 -- the call order, so this does not correspond to simply taking the
2359 -- next entry of the Parameter_Associations list. The argument is an
2360 -- actual previously returned by a call to First_Actual or Next_Actual.
2361 -- Note that the result produced is always an expression, not a parameter
2362 -- association node, even if named notation was used.
2364 procedure Next_Global
(Node
: in out Node_Id
);
2365 pragma Inline
(Next_Actual
);
2366 -- Next_Global (N) is equivalent to N := Next_Global (N). Note that we
2367 -- inline this procedural form, but not the functional form that follows.
2369 function Next_Global
(Node
: Node_Id
) return Node_Id
;
2370 -- Node is a global item from a list, obtained through calling First_Global
2371 -- and possibly Next_Global a number of times. Returns the next global item
2372 -- with the same mode.
2374 function No_Heap_Finalization
(Typ
: Entity_Id
) return Boolean;
2375 -- Determine whether type Typ is subject to pragma No_Heap_Finalization
2377 procedure Normalize_Actuals
2381 Success
: out Boolean);
2382 -- Reorders lists of actuals according to names of formals, value returned
2383 -- in Success indicates success of reordering. For more details, see body.
2384 -- Errors are reported only if Report is set to True.
2386 procedure Note_Possible_Modification
(N
: Node_Id
; Sure
: Boolean);
2387 -- This routine is called if the sub-expression N maybe the target of
2388 -- an assignment (e.g. it is the left side of an assignment, used as
2389 -- an out parameters, or used as prefixes of access attributes). It
2390 -- sets May_Be_Modified in the associated entity if there is one,
2391 -- taking into account the rule that in the case of renamed objects,
2392 -- it is the flag in the renamed object that must be set.
2394 -- The parameter Sure is set True if the modification is sure to occur
2395 -- (e.g. target of assignment, or out parameter), and to False if the
2396 -- modification is only potential (e.g. address of entity taken).
2398 function Null_To_Null_Address_Convert_OK
2400 Typ
: Entity_Id
:= Empty
) return Boolean;
2401 -- Return True if we are compiling in relaxed RM semantics mode and:
2402 -- 1) N is a N_Null node and Typ is a descendant of System.Address, or
2403 -- 2) N is a comparison operator, one of the operands is null, and the
2404 -- type of the other operand is a descendant of System.Address.
2406 function Number_Of_Elements_In_Array
(T
: Entity_Id
) return Int
;
2407 -- Returns the number of elements in the array T if the index bounds of T
2408 -- is known at compile time. If the bounds are not known at compile time,
2409 -- the function returns the value zero.
2411 function Object_Access_Level
(Obj
: Node_Id
) return Uint
;
2412 -- Return the accessibility level of the view of the object Obj. For
2413 -- convenience, qualified expressions applied to object names are also
2414 -- allowed as actuals for this function.
2416 function Original_Aspect_Pragma_Name
(N
: Node_Id
) return Name_Id
;
2417 -- Retrieve the name of aspect or pragma N, taking into account a possible
2418 -- rewrite and whether the pragma is generated from an aspect as the names
2419 -- may be different. The routine also deals with 'Class in which case it
2420 -- returns the following values:
2422 -- Invariant -> Name_uInvariant
2423 -- Post'Class -> Name_uPost
2424 -- Pre'Class -> Name_uPre
2425 -- Type_Invariant -> Name_uType_Invariant
2426 -- Type_Invariant'Class -> Name_uType_Invariant
2428 function Original_Corresponding_Operation
(S
: Entity_Id
) return Entity_Id
;
2429 -- [Ada 2012: AI05-0125-1]: If S is an inherited dispatching primitive S2,
2430 -- or overrides an inherited dispatching primitive S2, the original
2431 -- corresponding operation of S is the original corresponding operation of
2432 -- S2. Otherwise, it is S itself.
2434 procedure Output_Entity
(Id
: Entity_Id
);
2435 -- Print entity Id to standard output. The name of the entity appears in
2436 -- fully qualified form.
2438 -- WARNING: this routine should be used in debugging scenarios such as
2439 -- tracking down undefined symbols as it is fairly low level.
2441 procedure Output_Name
(Nam
: Name_Id
; Scop
: Entity_Id
:= Current_Scope
);
2442 -- Print name Nam to standard output. The name appears in fully qualified
2443 -- form assuming it appears in scope Scop. Note that this may not reflect
2444 -- the final qualification as the entity which carries the name may be
2445 -- relocated to a different scope.
2447 -- WARNING: this routine should be used in debugging scenarios such as
2448 -- tracking down undefined symbols as it is fairly low level.
2450 function Policy_In_Effect
(Policy
: Name_Id
) return Name_Id
;
2451 -- Given a policy, return the policy identifier associated with it. If no
2452 -- such policy is in effect, the value returned is No_Name.
2454 function Predicate_Tests_On_Arguments
(Subp
: Entity_Id
) return Boolean;
2455 -- Subp is the entity for a subprogram call. This function returns True if
2456 -- predicate tests are required for the arguments in this call (this is the
2457 -- normal case). It returns False for special cases where these predicate
2458 -- tests should be skipped (see body for details).
2460 function Primitive_Names_Match
(E1
, E2
: Entity_Id
) return Boolean;
2461 -- Returns True if the names of both entities correspond with matching
2462 -- primitives. This routine includes support for the case in which one
2463 -- or both entities correspond with entities built by Derive_Subprogram
2464 -- with a special name to avoid being overridden (i.e. return true in case
2465 -- of entities with names "nameP" and "name" or vice versa).
2467 function Private_Component
(Type_Id
: Entity_Id
) return Entity_Id
;
2468 -- Returns some private component (if any) of the given Type_Id.
2469 -- Used to enforce the rules on visibility of operations on composite
2470 -- types, that depend on the full view of the component type. For a
2471 -- record type there may be several such components, we just return
2474 procedure Process_End_Label
2478 -- N is a node whose End_Label is to be processed, generating all
2479 -- appropriate cross-reference entries, and performing style checks
2480 -- for any identifier references in the end label. Typ is either
2481 -- 'e' or 't indicating the type of the cross-reference entity
2482 -- (e for spec, t for body, see Lib.Xref spec for details). The
2483 -- parameter Ent gives the entity to which the End_Label refers,
2484 -- and to which cross-references are to be generated.
2486 procedure Propagate_Concurrent_Flags
2488 Comp_Typ
: Entity_Id
);
2489 -- Set Has_Task, Has_Protected and Has_Timing_Event on Typ when the flags
2490 -- are set on Comp_Typ. This follows the definition of these flags which
2491 -- are set (recursively) on any composite type which has a component marked
2492 -- by one of these flags. This procedure can only set flags for Typ, and
2493 -- never clear them. Comp_Typ is the type of a component or a parent.
2495 procedure Propagate_DIC_Attributes
2497 From_Typ
: Entity_Id
);
2498 -- Inherit all Default_Initial_Condition-related attributes from type
2499 -- From_Typ. Typ is the destination type.
2501 procedure Propagate_Invariant_Attributes
2503 From_Typ
: Entity_Id
);
2504 -- Inherit all invariant-related attributes form type From_Typ. Typ is the
2505 -- destination type.
2507 procedure Record_Possible_Part_Of_Reference
2508 (Var_Id
: Entity_Id
;
2510 -- Save reference Ref to variable Var_Id when the variable is subject to
2511 -- pragma Part_Of. If the variable is known to be a constituent of a single
2512 -- protected/task type, the legality of the reference is verified and the
2513 -- save does not take place.
2515 function Referenced
(Id
: Entity_Id
; Expr
: Node_Id
) return Boolean;
2516 -- Determine whether entity Id is referenced within expression Expr
2518 function References_Generic_Formal_Type
(N
: Node_Id
) return Boolean;
2519 -- Returns True if the expression Expr contains any references to a generic
2520 -- type. This can only happen within a generic template.
2522 procedure Remove_Entity_And_Homonym
(Id
: Entity_Id
);
2523 -- Remove arbitrary entity Id from both the homonym and scope chains. Use
2524 -- Remove_Overloaded_Entity for overloadable entities. Note: the removal
2525 -- performed by this routine does not affect the visibility of existing
2528 procedure Remove_Homonym
(Id
: Entity_Id
);
2529 -- Removes entity Id from the homonym chain
2531 procedure Remove_Overloaded_Entity
(Id
: Entity_Id
);
2532 -- Remove arbitrary entity Id from the homonym chain, the scope chain and
2533 -- the primitive operations list of the associated controlling type. Use
2534 -- Remove_Entity for non-overloadable entities. Note: the removal performed
2535 -- by this routine does not affect the visibility of existing homonyms.
2537 function Remove_Suffix
(E
: Entity_Id
; Suffix
: Character) return Name_Id
;
2538 -- Returns the name of E without Suffix
2540 procedure Replace_Null_By_Null_Address
(N
: Node_Id
);
2541 -- N is N_Null or a binary comparison operator, we are compiling in relaxed
2542 -- RM semantics mode, and one of the operands is null. Replace null with
2543 -- System.Null_Address.
2545 function Rep_To_Pos_Flag
(E
: Entity_Id
; Loc
: Source_Ptr
) return Node_Id
;
2546 -- This is used to construct the second argument in a call to Rep_To_Pos
2547 -- which is Standard_True if range checks are enabled (E is an entity to
2548 -- which the Range_Checks_Suppressed test is applied), and Standard_False
2549 -- if range checks are suppressed. Loc is the location for the node that
2550 -- is returned (which is a New_Occurrence of the appropriate entity).
2552 -- Note: one might think that it would be fine to always use True and
2553 -- to ignore the suppress in this case, but it is generally better to
2554 -- believe a request to suppress exceptions if possible, and further
2555 -- more there is at least one case in the generated code (the code for
2556 -- array assignment in a loop) that depends on this suppression.
2558 procedure Require_Entity
(N
: Node_Id
);
2559 -- N is a node which should have an entity value if it is an entity name.
2560 -- If not, then check if there were previous errors. If so, just fill
2561 -- in with Any_Id and ignore. Otherwise signal a program error exception.
2562 -- This is used as a defense mechanism against ill-formed trees caused by
2563 -- previous errors (particularly in -gnatq mode).
2565 function Requires_Transient_Scope
(Id
: Entity_Id
) return Boolean;
2566 -- Id is a type entity. The result is True when temporaries of this type
2567 -- need to be wrapped in a transient scope to be reclaimed properly when a
2568 -- secondary stack is in use. Examples of types requiring such wrapping are
2569 -- controlled types and variable-sized types including unconstrained
2572 procedure Reset_Analyzed_Flags
(N
: Node_Id
);
2573 -- Reset the Analyzed flags in all nodes of the tree whose root is N
2575 procedure Restore_SPARK_Mode
(Mode
: SPARK_Mode_Type
; Prag
: Node_Id
);
2576 -- Set the current SPARK_Mode to Mode and SPARK_Mode_Pragma to Prag. This
2577 -- routine must be used in tandem with Set_SPARK_Mode.
2579 function Returns_Unconstrained_Type
(Subp
: Entity_Id
) return Boolean;
2580 -- Return true if Subp is a function that returns an unconstrained type
2582 function Root_Type_Of_Full_View
(T
: Entity_Id
) return Entity_Id
;
2583 -- Similar to attribute Root_Type, but this version always follows the
2584 -- Full_View of a private type (if available) while searching for the
2585 -- ultimate derivation ancestor.
2587 function Safe_To_Capture_Value
2590 Cond
: Boolean := False) return Boolean;
2591 -- The caller is interested in capturing a value (either the current value,
2592 -- or an indication that the value is non-null) for the given entity Ent.
2593 -- This value can only be captured if sequential execution semantics can be
2594 -- properly guaranteed so that a subsequent reference will indeed be sure
2595 -- that this current value indication is correct. The node N is the
2596 -- construct which resulted in the possible capture of the value (this
2597 -- is used to check if we are in a conditional).
2599 -- Cond is used to skip the test for being inside a conditional. It is used
2600 -- in the case of capturing values from if/while tests, which already do a
2601 -- proper job of handling scoping issues without this help.
2603 -- The only entities whose values can be captured are OUT and IN OUT formal
2604 -- parameters, and variables unless Cond is True, in which case we also
2605 -- allow IN formals, loop parameters and constants, where we cannot ever
2606 -- capture actual value information, but we can capture conditional tests.
2608 function Same_Name
(N1
, N2
: Node_Id
) return Boolean;
2609 -- Determine if two (possibly expanded) names are the same name. This is
2610 -- a purely syntactic test, and N1 and N2 need not be analyzed.
2612 function Same_Object
(Node1
, Node2
: Node_Id
) return Boolean;
2613 -- Determine if Node1 and Node2 are known to designate the same object.
2614 -- This is a semantic test and both nodes must be fully analyzed. A result
2615 -- of True is decisively correct. A result of False does not necessarily
2616 -- mean that different objects are designated, just that this could not
2617 -- be reliably determined at compile time.
2619 function Same_Type
(T1
, T2
: Entity_Id
) return Boolean;
2620 -- Determines if T1 and T2 represent exactly the same type. Two types
2621 -- are the same if they are identical, or if one is an unconstrained
2622 -- subtype of the other, or they are both common subtypes of the same
2623 -- type with identical constraints. The result returned is conservative.
2624 -- It is True if the types are known to be the same, but a result of
2625 -- False is indecisive (e.g. the compiler may not be able to tell that
2626 -- two constraints are identical).
2628 function Same_Value
(Node1
, Node2
: Node_Id
) return Boolean;
2629 -- Determines if Node1 and Node2 are known to be the same value, which is
2630 -- true if they are both compile time known values and have the same value,
2631 -- or if they are the same object (in the sense of function Same_Object).
2632 -- A result of False does not necessarily mean they have different values,
2633 -- just that it is not possible to determine they have the same value.
2635 function Scalar_Part_Present
(Typ
: Entity_Id
) return Boolean;
2636 -- Determine whether arbitrary type Typ is a scalar type, or contains at
2637 -- least one scalar subcomponent.
2639 function Scope_Within
2641 Outer
: Entity_Id
) return Boolean;
2642 -- Determine whether scope Inner appears within scope Outer. Note that
2643 -- scopes are partially ordered, so Scope_Within (A, B) and Scope_Within
2644 -- (B, A) may both return False.
2646 function Scope_Within_Or_Same
2648 Outer
: Entity_Id
) return Boolean;
2649 -- Determine whether scope Inner appears within scope Outer or both renote
2650 -- the same scope. Note that scopes are partially ordered, so Scope_Within
2651 -- (A, B) and Scope_Within (B, A) may both return False.
2653 procedure Set_Convention
(E
: Entity_Id
; Val
: Convention_Id
);
2654 -- Same as Basic_Set_Convention, but with an extra check for access types.
2655 -- In particular, if E is an access-to-subprogram type, and Val is a
2656 -- foreign convention, then we set Can_Use_Internal_Rep to False on E.
2657 -- Also, if the Etype of E is set and is an anonymous access type with
2658 -- no convention set, this anonymous type inherits the convention of E.
2660 procedure Set_Current_Entity
(E
: Entity_Id
);
2661 pragma Inline
(Set_Current_Entity
);
2662 -- Establish the entity E as the currently visible definition of its
2663 -- associated name (i.e. the Node_Id associated with its name).
2665 procedure Set_Debug_Info_Needed
(T
: Entity_Id
);
2666 -- Sets the Debug_Info_Needed flag on entity T , and also on any entities
2667 -- that are needed by T (for an object, the type of the object is needed,
2668 -- and for a type, various subsidiary types are needed -- see body for
2669 -- details). Never has any effect on T if the Debug_Info_Off flag is set.
2670 -- This routine should always be used instead of Set_Needs_Debug_Info to
2671 -- ensure that subsidiary entities are properly handled.
2673 procedure Set_Entity_With_Checks
(N
: Node_Id
; Val
: Entity_Id
);
2674 -- This procedure has the same calling sequence as Set_Entity, but it
2675 -- performs additional checks as follows:
2677 -- If Style_Check is set, then it calls a style checking routine which
2678 -- can check identifier spelling style. This procedure also takes care
2679 -- of checking the restriction No_Implementation_Identifiers.
2681 -- If restriction No_Abort_Statements is set, then it checks that the
2682 -- entity is not Ada.Task_Identification.Abort_Task.
2684 -- If restriction No_Dynamic_Attachment is set, then it checks that the
2685 -- entity is not one of the restricted names for this restriction.
2687 -- If restriction No_Long_Long_Integers is set, then it checks that the
2688 -- entity is not Standard.Long_Long_Integer.
2690 -- If restriction No_Implementation_Identifiers is set, then it checks
2691 -- that the entity is not implementation defined.
2693 procedure Set_Invalid_Scalar_Value
2694 (Scal_Typ
: Float_Scalar_Id
;
2696 -- Associate invalid value Value with scalar type Scal_Typ as specified by
2697 -- pragma Initialize_Scalars.
2699 procedure Set_Invalid_Scalar_Value
2700 (Scal_Typ
: Integer_Scalar_Id
;
2702 -- Associate invalid value Value with scalar type Scal_Typ as specified by
2703 -- pragma Initialize_Scalars.
2705 procedure Set_Name_Entity_Id
(Id
: Name_Id
; Val
: Entity_Id
);
2706 pragma Inline
(Set_Name_Entity_Id
);
2707 -- Sets the Entity_Id value associated with the given name, which is the
2708 -- Id of the innermost visible entity with the given name. See the body
2709 -- of package Sem_Ch8 for further details on the handling of visibility.
2711 procedure Set_Next_Actual
(Ass1_Id
: Node_Id
; Ass2_Id
: Node_Id
);
2712 -- The arguments may be parameter associations, whose descendants
2713 -- are the optional formal name and the actual parameter. Positional
2714 -- parameters are already members of a list, and do not need to be
2715 -- chained separately. See also First_Actual and Next_Actual.
2717 procedure Set_Optimize_Alignment_Flags
(E
: Entity_Id
);
2718 pragma Inline
(Set_Optimize_Alignment_Flags
);
2719 -- Sets Optimize_Alignment_Space/Time flags in E from current settings
2721 procedure Set_Public_Status
(Id
: Entity_Id
);
2722 -- If an entity (visible or otherwise) is defined in a library
2723 -- package, or a package that is itself public, then this subprogram
2724 -- labels the entity public as well.
2726 procedure Set_Referenced_Modified
(N
: Node_Id
; Out_Param
: Boolean);
2727 -- N is the node for either a left hand side (Out_Param set to False),
2728 -- or an Out or In_Out parameter (Out_Param set to True). If there is
2729 -- an assignable entity being referenced, then the appropriate flag
2730 -- (Referenced_As_LHS if Out_Param is False, Referenced_As_Out_Parameter
2731 -- if Out_Param is True) is set True, and the other flag set False.
2733 procedure Set_Rep_Info
(T1
: Entity_Id
; T2
: Entity_Id
);
2734 pragma Inline
(Set_Rep_Info
);
2735 -- Copies the Is_Atomic, Is_Independent and Is_Volatile_Full_Access flags
2736 -- from sub(type) entity T2 to (sub)type entity T1, as well as Is_Volatile
2737 -- if T1 is a base type.
2739 procedure Set_Scope_Is_Transient
(V
: Boolean := True);
2740 -- Set the flag Is_Transient of the current scope
2742 procedure Set_Size_Info
(T1
, T2
: Entity_Id
);
2743 pragma Inline
(Set_Size_Info
);
2744 -- Copies the Esize field and Has_Biased_Representation flag from sub(type)
2745 -- entity T2 to (sub)type entity T1. Also copies the Is_Unsigned_Type flag
2746 -- in the fixed-point and discrete cases, and also copies the alignment
2747 -- value from T2 to T1. It does NOT copy the RM_Size field, which must be
2748 -- separately set if this is required to be copied also.
2750 procedure Set_SPARK_Mode
(Context
: Entity_Id
);
2751 -- Establish the SPARK_Mode and SPARK_Mode_Pragma (if any) of a package or
2752 -- a subprogram denoted by Context. This routine must be used in tandem
2753 -- with Restore_SPARK_Mode.
2755 function Scope_Is_Transient
return Boolean;
2756 -- True if the current scope is transient
2758 function Should_Ignore_Pragma_Par
(Prag_Name
: Name_Id
) return Boolean;
2759 function Should_Ignore_Pragma_Sem
(N
: Node_Id
) return Boolean;
2760 -- True if we should ignore pragmas with the specified name. In particular,
2761 -- this returns True if pragma Ignore_Pragma applies, and we are not in a
2762 -- predefined unit. The _Par version should be called only from the parser;
2763 -- the _Sem version should be called only during semantic analysis.
2765 function Static_Boolean
(N
: Node_Id
) return Uint
;
2766 -- This function analyzes the given expression node and then resolves it
2767 -- as Standard.Boolean. If the result is static, then Uint_1 or Uint_0 is
2768 -- returned corresponding to the value, otherwise an error message is
2769 -- output and No_Uint is returned.
2771 function Static_Integer
(N
: Node_Id
) return Uint
;
2772 -- This function analyzes the given expression node and then resolves it
2773 -- as any integer type. If the result is static, then the value of the
2774 -- universal expression is returned, otherwise an error message is output
2775 -- and a value of No_Uint is returned.
2777 function Statically_Different
(E1
, E2
: Node_Id
) return Boolean;
2778 -- Return True if it can be statically determined that the Expressions
2779 -- E1 and E2 refer to different objects
2781 function Subject_To_Loop_Entry_Attributes
(N
: Node_Id
) return Boolean;
2782 -- Determine whether node N is a loop statement subject to at least one
2783 -- 'Loop_Entry attribute.
2785 function Subprogram_Access_Level
(Subp
: Entity_Id
) return Uint
;
2786 -- Return the accessibility level of the view denoted by Subp
2788 function Support_Atomic_Primitives
(Typ
: Entity_Id
) return Boolean;
2789 -- Return True if Typ supports the GCC built-in atomic operations (i.e. if
2790 -- Typ is properly sized and aligned).
2792 procedure Trace_Scope
(N
: Node_Id
; E
: Entity_Id
; Msg
: String);
2793 -- Print debugging information on entry to each unit being analyzed
2795 procedure Transfer_Entities
(From
: Entity_Id
; To
: Entity_Id
);
2796 -- Move a list of entities from one scope to another, and recompute
2797 -- Is_Public based upon the new scope.
2799 function Type_Access_Level
(Typ
: Entity_Id
) return Uint
;
2800 -- Return the accessibility level of Typ
2802 function Type_Without_Stream_Operation
2804 Op
: TSS_Name_Type
:= TSS_Null
) return Entity_Id
;
2805 -- AI05-0161: In Ada 2012, if the restriction No_Default_Stream_Attributes
2806 -- is active then we cannot generate stream subprograms for composite types
2807 -- with elementary subcomponents that lack user-defined stream subprograms.
2808 -- This predicate determines whether a type has such an elementary
2809 -- subcomponent. If Op is TSS_Null, a type that lacks either Read or Write
2810 -- prevents the construction of a composite stream operation. If Op is
2811 -- specified we check only for the given stream operation.
2813 function Ultimate_Prefix
(N
: Node_Id
) return Node_Id
;
2814 -- Obtain the "outermost" prefix of arbitrary node N. Return N if no such
2817 function Unique_Defining_Entity
(N
: Node_Id
) return Entity_Id
;
2818 -- Return the entity that represents declaration N, so that different
2819 -- views of the same entity have the same unique defining entity:
2820 -- * private view and full view of a deferred constant
2822 -- * entry spec and entry body
2824 -- * formal parameter on spec and body
2825 -- --> formal parameter on spec
2826 -- * package spec, body, and body stub
2828 -- * protected type, protected body, and protected body stub
2829 -- --> protected type (full view if private)
2830 -- * subprogram spec, body, and body stub
2831 -- --> subprogram spec
2832 -- * task type, task body, and task body stub
2833 -- --> task type (full view if private)
2834 -- * private or incomplete view and full view of a type
2836 -- In other cases, return the defining entity for N.
2838 function Unique_Entity
(E
: Entity_Id
) return Entity_Id
;
2839 -- Return the unique entity for entity E, which would be returned by
2840 -- Unique_Defining_Entity if applied to the enclosing declaration of E.
2842 function Unique_Name
(E
: Entity_Id
) return String;
2843 -- Return a unique name for entity E, which could be used to identify E
2844 -- across compilation units.
2846 function Unit_Is_Visible
(U
: Entity_Id
) return Boolean;
2847 -- Determine whether a compilation unit is visible in the current context,
2848 -- because there is a with_clause that makes the unit available. Used to
2849 -- provide better messages on common visiblity errors on operators.
2851 function Universal_Interpretation
(Opnd
: Node_Id
) return Entity_Id
;
2852 -- Yields Universal_Integer or Universal_Real if this is a candidate
2854 function Unqualify
(Expr
: Node_Id
) return Node_Id
;
2855 pragma Inline
(Unqualify
);
2856 -- Removes any qualifications from Expr. For example, for T1'(T2'(X)), this
2857 -- returns X. If Expr is not a qualified expression, returns Expr.
2859 function Unqual_Conv
(Expr
: Node_Id
) return Node_Id
;
2860 pragma Inline
(Unqual_Conv
);
2861 -- Similar to Unqualify, but removes qualified expressions, type
2862 -- conversions, and unchecked conversions.
2864 function Validated_View
(Typ
: Entity_Id
) return Entity_Id
;
2865 -- Obtain the "validated view" of arbitrary type Typ which is suitable
2866 -- for verification by attributes 'Valid and 'Valid_Scalars. This view
2867 -- is the type itself or its full view while stripping away concurrency,
2868 -- derivations, and privacy.
2870 function Visible_Ancestors
(Typ
: Entity_Id
) return Elist_Id
;
2871 -- [Ada 2012:AI-0125-1]: Collect all the visible parents and progenitors
2872 -- of a type extension or private extension declaration. If the full-view
2873 -- of private parents and progenitors is available then it is used to
2874 -- generate the list of visible ancestors; otherwise their partial
2875 -- view is added to the resulting list.
2877 function Within_Init_Proc
return Boolean;
2878 -- Determines if Current_Scope is within an init proc
2880 function Within_Protected_Type
(E
: Entity_Id
) return Boolean;
2881 -- Returns True if entity E is declared within a protected type
2883 function Within_Scope
(E
: Entity_Id
; S
: Entity_Id
) return Boolean;
2884 -- Returns True if entity E is declared within scope S
2886 function Within_Subprogram_Call
(N
: Node_Id
) return Boolean;
2887 -- Determine whether arbitrary node N appears in an entry, function, or
2890 procedure Wrong_Type
(Expr
: Node_Id
; Expected_Type
: Entity_Id
);
2891 -- Output error message for incorrectly typed expression. Expr is the node
2892 -- for the incorrectly typed construct (Etype (Expr) is the type found),
2893 -- and Expected_Type is the entity for the expected type. Note that Expr
2894 -- does not have to be a subexpression, anything with an Etype field may
2897 function Yields_Synchronized_Object
(Typ
: Entity_Id
) return Boolean;
2898 -- Determine whether type Typ "yields synchronized object" as specified by
2899 -- SPARK RM 9.1. To qualify as such, a type must be
2900 -- * An array type whose element type yields a synchronized object
2901 -- * A descendant of type Ada.Synchronous_Task_Control.Suspension_Object
2902 -- * A protected type
2903 -- * A record type or type extension without defaulted discriminants
2904 -- whose components are of a type that yields a synchronized object.
2905 -- * A synchronized interface type
2908 function Yields_Universal_Type
(N
: Node_Id
) return Boolean;
2909 -- Determine whether unanalyzed node N yields a universal type