1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2013, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 -- 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
;
31 with Snames
; use Snames
;
32 with Types
; use Types
;
33 with Uintp
; use Uintp
;
34 with Urealp
; use Urealp
;
38 function Abstract_Interface_List
(Typ
: Entity_Id
) return List_Id
;
39 -- Given a type that implements interfaces look for its associated
40 -- definition node and return its list of interfaces.
42 procedure Add_Access_Type_To_Process
(E
: Entity_Id
; A
: Entity_Id
);
43 -- Add A to the list of access types to process when expanding the
46 procedure Add_Contract_Item
(Item
: Node_Id
; Subp_Id
: Entity_Id
);
47 -- Add a contract item (pragma Precondition, Postcondition, Test_Case,
48 -- Contract_Cases, Global, Depends) to the contract of a subprogram. Item
49 -- denotes a pragma and Subp_Id is the related subprogram.
51 procedure Add_Global_Declaration
(N
: Node_Id
);
52 -- These procedures adds a declaration N at the library level, to be
53 -- elaborated before any other code in the unit. It is used for example
54 -- for the entity that marks whether a unit has been elaborated. The
55 -- declaration is added to the Declarations list of the Aux_Decls_Node
56 -- for the current unit. The declarations are added in the current scope,
57 -- so the caller should push a new scope as required before the call.
59 function Addressable
(V
: Uint
) return Boolean;
60 function Addressable
(V
: Int
) return Boolean;
61 pragma Inline
(Addressable
);
62 -- Returns True if the value of V is the word size of an addressable
63 -- factor of the word size (typically 8, 16, 32 or 64).
65 function Alignment_In_Bits
(E
: Entity_Id
) return Uint
;
66 -- If the alignment of the type or object E is currently known to the
67 -- compiler, then this function returns the alignment value in bits.
68 -- Otherwise Uint_0 is returned, indicating that the alignment of the
69 -- entity is not yet known to the compiler.
71 procedure Append_Inherited_Subprogram
(S
: Entity_Id
);
72 -- If the parent of the operation is declared in the visible part of
73 -- the current scope, the inherited operation is visible even though the
74 -- derived type that inherits the operation may be completed in the private
75 -- part of the current package.
77 procedure Apply_Compile_Time_Constraint_Error
80 Reason
: RT_Exception_Code
;
81 Ent
: Entity_Id
:= Empty
;
82 Typ
: Entity_Id
:= Empty
;
83 Loc
: Source_Ptr
:= No_Location
;
84 Rep
: Boolean := True;
85 Warn
: Boolean := False);
86 -- N is a subexpression which will raise constraint error when evaluated
87 -- at runtime. Msg is a message that explains the reason for raising the
88 -- exception. The last character is ? if the message is always a warning,
89 -- even in Ada 95, and is not a ? if the message represents an illegality
90 -- (because of violation of static expression rules) in Ada 95 (but not
91 -- in Ada 83). Typically this routine posts all messages at the Sloc of
92 -- node N. However, if Loc /= No_Location, Loc is the Sloc used to output
93 -- the message. After posting the appropriate message, and if the flag
94 -- Rep is set, this routine replaces the expression with an appropriate
95 -- N_Raise_Constraint_Error node using the given Reason code. This node
96 -- is then marked as being static if the original node is static, but
97 -- sets the flag Raises_Constraint_Error, preventing further evaluation.
98 -- The error message may contain a } or & insertion character. This
99 -- normally references Etype (N), unless the Ent argument is given
100 -- explicitly, in which case it is used instead. The type of the raise
101 -- node that is built is normally Etype (N), but if the Typ parameter
102 -- is present, this is used instead. Warn is normally False. If it is
103 -- True then the message is treated as a warning even though it does
104 -- not end with a ? (this is used when the caller wants to parameterize
105 -- whether an error or warning is given.
107 function Available_Full_View_Of_Component
(T
: Entity_Id
) return Boolean;
108 -- If at the point of declaration an array type has a private or limited
109 -- component, several array operations are not avaiable on the type, and
110 -- the array type is flagged accordingly. If in the immediate scope of
111 -- the array type the component becomes non-private or non-limited, these
112 -- operations become avaiable. This can happen if the scopes of both types
113 -- are open, and the scope of the array is not outside the scope of the
116 procedure Bad_Attribute
119 Warn
: Boolean := False);
120 -- Called when node N is expected to contain a valid attribute name, and
121 -- Nam is found instead. If Warn is set True this is a warning, else this
124 procedure Bad_Predicated_Subtype_Use
128 Suggest_Static
: Boolean := False);
129 -- This is called when Typ, a predicated subtype, is used in a context
130 -- which does not allow the use of a predicated subtype. Msg is passed to
131 -- Error_Msg_FE to output an appropriate message using N as the location,
132 -- and Typ as the entity. The caller must set up any insertions other than
133 -- the & for the type itself. Note that if Typ is a generic actual type,
134 -- then the message will be output as a warning, and a raise Program_Error
135 -- is inserted using Insert_Action with node N as the insertion point. Node
136 -- N also supplies the source location for construction of the raise node.
137 -- If Typ does not have any predicates, the call has no effect. Set flag
138 -- Suggest_Static when the context warrants an advice on how to avoid the
141 function Build_Actual_Subtype
143 N
: Node_Or_Entity_Id
) return Node_Id
;
144 -- Build an anonymous subtype for an entity or expression, using the
145 -- bounds of the entity or the discriminants of the enclosing record.
146 -- T is the type for which the actual subtype is required, and N is either
147 -- a defining identifier, or any subexpression.
149 function Build_Actual_Subtype_Of_Component
151 N
: Node_Id
) return Node_Id
;
152 -- Determine whether a selected component has a type that depends on
153 -- discriminants, and build actual subtype for it if so.
155 function Build_Default_Subtype
157 N
: Node_Id
) return Entity_Id
;
158 -- If T is an unconstrained type with defaulted discriminants, build a
159 -- subtype constrained by the default values, insert the subtype
160 -- declaration in the tree before N, and return the entity of that
161 -- subtype. Otherwise, simply return T.
163 function Build_Discriminal_Subtype_Of_Component
164 (T
: Entity_Id
) return Node_Id
;
165 -- Determine whether a record component has a type that depends on
166 -- discriminants, and build actual subtype for it if so.
168 procedure Build_Elaboration_Entity
(N
: Node_Id
; Spec_Id
: Entity_Id
);
169 -- Given a compilation unit node N, allocate an elaboration counter for
170 -- the compilation unit, and install it in the Elaboration_Entity field
171 -- of Spec_Id, the entity for the compilation unit.
173 procedure Build_Explicit_Dereference
176 -- AI05-139: Names with implicit dereference. If the expression N is a
177 -- reference type and the context imposes the corresponding designated
178 -- type, convert N into N.Disc.all. Such expressions are always over-
179 -- loaded with both interpretations, and the dereference interpretation
180 -- carries the name of the reference discriminant.
182 function Cannot_Raise_Constraint_Error
(Expr
: Node_Id
) return Boolean;
183 -- Returns True if the expression cannot possibly raise Constraint_Error.
184 -- The response is conservative in the sense that a result of False does
185 -- not necessarily mean that CE could be raised, but a response of True
186 -- means that for sure CE cannot be raised.
188 procedure Check_Dynamically_Tagged_Expression
191 Related_Nod
: Node_Id
);
192 -- Check wrong use of dynamically tagged expression
194 procedure Check_Expression_Against_Static_Predicate
197 -- Determine whether an arbitrary expression satisfies the static predicate
198 -- of a type. The routine does nothing if Expr is not known at compile time
199 -- or Typ lacks a static predicate, otherwise it may emit a warning if the
200 -- expression is prohibited by the predicate.
202 procedure Check_Fully_Declared
(T
: Entity_Id
; N
: Node_Id
);
203 -- Verify that the full declaration of type T has been seen. If not, place
204 -- error message on node N. Used in object declarations, type conversions
205 -- and qualified expressions.
207 procedure Check_Function_Writable_Actuals
(N
: Node_Id
);
208 -- (Ada 2012): If the construct N has two or more direct constituents that
209 -- are names or expressions whose evaluation may occur in an arbitrary
210 -- order, at least one of which contains a function call with an in out or
211 -- out parameter, then the construct is legal only if: for each name that
212 -- is passed as a parameter of mode in out or out to some inner function
213 -- call C2 (not including the construct N itself), there is no other name
214 -- anywhere within a direct constituent of the construct C other than
215 -- the one containing C2, that is known to refer to the same object (RM
218 procedure Check_Implicit_Dereference
(Nam
: Node_Id
; Typ
: Entity_Id
);
219 -- AI05-139-2: Accessors and iterators for containers. This procedure
220 -- checks whether T is a reference type, and if so it adds an interprettion
221 -- to Expr whose type is the designated type of the reference_discriminant.
223 procedure Check_Internal_Protected_Use
(N
: Node_Id
; Nam
: Entity_Id
);
224 -- Within a protected function, the current object is a constant, and
225 -- internal calls to a procedure or entry are illegal. Similarly, other
226 -- uses of a protected procedure in a renaming or a generic instantiation
227 -- in the context of a protected function are illegal (AI05-0225).
229 procedure Check_Later_Vs_Basic_Declarations
231 During_Parsing
: Boolean);
232 -- If During_Parsing is True, check for misplacement of later vs basic
233 -- declarations in Ada 83. If During_Parsing is False, and the SPARK
234 -- restriction is set, do the same: although SPARK 95 removes the
235 -- distinction between initial and later declarative items, the distinction
236 -- remains in the Examiner (JB01-005). Note that the Examiner does not
237 -- count package declarations in later declarative items.
239 procedure Check_Nested_Access
(Ent
: Entity_Id
);
240 -- Check whether Ent denotes an entity declared in an uplevel scope, which
241 -- is accessed inside a nested procedure, and set Has_Up_Level_Access flag
242 -- accordingly. This is currently only enabled for VM_Target /= No_VM.
244 procedure Check_No_Hidden_State
(Id
: Entity_Id
);
245 -- Determine whether object or state Id introduces a hidden state. If this
246 -- is the case, emit an error.
248 procedure Check_Potentially_Blocking_Operation
(N
: Node_Id
);
249 -- N is one of the statement forms that is a potentially blocking
250 -- operation. If it appears within a protected action, emit warning.
252 procedure Check_Unprotected_Access
255 -- Check whether the expression is a pointer to a protected component,
256 -- and the context is external to the protected operation, to warn against
257 -- a possible unlocked access to data.
259 procedure Check_VMS
(Construct
: Node_Id
);
260 -- Check that this the target is OpenVMS, and if so, return with no effect,
261 -- otherwise post an error noting this can only be used with OpenVMS ports.
262 -- The argument is the construct in question and is used to post the error
265 procedure Collect_Interfaces
267 Ifaces_List
: out Elist_Id
;
268 Exclude_Parents
: Boolean := False;
269 Use_Full_View
: Boolean := True);
270 -- Ada 2005 (AI-251): Collect whole list of abstract interfaces that are
271 -- directly or indirectly implemented by T. Exclude_Parents is used to
272 -- avoid the addition of inherited interfaces to the generated list.
273 -- Use_Full_View is used to collect the interfaces using the full-view
276 procedure Collect_Interface_Components
277 (Tagged_Type
: Entity_Id
;
278 Components_List
: out Elist_Id
);
279 -- Ada 2005 (AI-251): Collect all the tag components associated with the
280 -- secondary dispatch tables of a tagged type.
282 procedure Collect_Interfaces_Info
284 Ifaces_List
: out Elist_Id
;
285 Components_List
: out Elist_Id
;
286 Tags_List
: out Elist_Id
);
287 -- Ada 2005 (AI-251): Collect all the interfaces associated with T plus
288 -- the record component and tag associated with each of these interfaces.
289 -- On exit Ifaces_List, Components_List and Tags_List have the same number
290 -- of elements, and elements at the same position on these tables provide
291 -- information on the same interface type.
293 procedure Collect_Parents
296 Use_Full_View
: Boolean := True);
297 -- Collect all the parents of Typ. Use_Full_View is used to collect them
298 -- using the full-view of private parents (if available).
300 function Collect_Primitive_Operations
(T
: Entity_Id
) return Elist_Id
;
301 -- Called upon type derivation and extension. We scan the declarative part
302 -- in which the type appears, and collect subprograms that have one
303 -- subsidiary subtype of the type. These subprograms can only appear after
306 function Compile_Time_Constraint_Error
309 Ent
: Entity_Id
:= Empty
;
310 Loc
: Source_Ptr
:= No_Location
;
311 Warn
: Boolean := False) return Node_Id
;
312 -- This is similar to Apply_Compile_Time_Constraint_Error in that it
313 -- generates a warning (or error) message in the same manner, but it does
314 -- not replace any nodes. For convenience, the function always returns its
315 -- first argument. The message is a warning if the message ends with ?, or
316 -- we are operating in Ada 83 mode, or the Warn parameter is set to True.
318 procedure Conditional_Delay
(New_Ent
, Old_Ent
: Entity_Id
);
319 -- Sets the Has_Delayed_Freeze flag of New if the Delayed_Freeze flag of
320 -- Old is set and Old has no yet been Frozen (i.e. Is_Frozen is false).
322 function Copy_Parameter_List
(Subp_Id
: Entity_Id
) return List_Id
;
323 -- Utility to create a parameter profile for a new subprogram spec, when
324 -- the subprogram has a body that acts as spec. This is done for some cases
325 -- of inlining, and for private protected ops. Also used to create bodies
326 -- for stubbed subprograms.
328 function Copy_Component_List
330 Loc
: Source_Ptr
) return List_Id
;
331 -- Copy components from record type R_Typ that come from source. Used to
332 -- create a new compatible record type. Loc is the source location assigned
333 -- to the created nodes.
335 function Corresponding_Generic_Type
(T
: Entity_Id
) return Entity_Id
;
336 -- If a type is a generic actual type, return the corresponding formal in
337 -- the generic parent unit. There is no direct link in the tree for this
338 -- attribute, except in the case of formal private and derived types.
339 -- Possible optimization???
341 function Current_Entity
(N
: Node_Id
) return Entity_Id
;
342 pragma Inline
(Current_Entity
);
343 -- Find the currently visible definition for a given identifier, that is to
344 -- say the first entry in the visibility chain for the Chars of N.
346 function Current_Entity_In_Scope
(N
: Node_Id
) return Entity_Id
;
347 -- Find whether there is a previous definition for identifier N in the
348 -- current scope. Because declarations for a scope are not necessarily
349 -- contiguous (e.g. for packages) the first entry on the visibility chain
350 -- for N is not necessarily in the current scope.
352 function Current_Scope
return Entity_Id
;
353 -- Get entity representing current scope
355 function Current_Subprogram
return Entity_Id
;
356 -- Returns current enclosing subprogram. If Current_Scope is a subprogram,
357 -- then that is what is returned, otherwise the Enclosing_Subprogram of the
358 -- Current_Scope is returned. The returned value is Empty if this is called
359 -- from a library package which is not within any subprogram.
361 function Deepest_Type_Access_Level
(Typ
: Entity_Id
) return Uint
;
362 -- Same as Type_Access_Level, except that if the type is the type of an Ada
363 -- 2012 stand-alone object of an anonymous access type, then return the
364 -- static accesssibility level of the object. In that case, the dynamic
365 -- accessibility level of the object may take on values in a range. The low
366 -- bound of of that range is returned by Type_Access_Level; this function
367 -- yields the high bound of that range. Also differs from Type_Access_Level
368 -- in the case of a descendant of a generic formal type (returns Int'Last
371 function Defining_Entity
(N
: Node_Id
) return Entity_Id
;
372 -- Given a declaration N, returns the associated defining entity. If the
373 -- declaration has a specification, the entity is obtained from the
374 -- specification. If the declaration has a defining unit name, then the
375 -- defining entity is obtained from the defining unit name ignoring any
376 -- child unit prefixes.
378 function Denotes_Discriminant
380 Check_Concurrent
: Boolean := False) return Boolean;
381 -- Returns True if node N is an Entity_Name node for a discriminant. If the
382 -- flag Check_Concurrent is true, function also returns true when N denotes
383 -- the discriminal of the discriminant of a concurrent type. This is needed
384 -- to disable some optimizations on private components of protected types,
385 -- and constraint checks on entry families constrained by discriminants.
387 function Denotes_Same_Object
(A1
, A2
: Node_Id
) return Boolean;
388 -- Detect suspicious overlapping between actuals in a call, when both are
389 -- writable (RM 2012 6.4.1(6.4/3))
391 function Denotes_Same_Prefix
(A1
, A2
: Node_Id
) return Boolean;
392 -- Functions to detect suspicious overlapping between actuals in a call,
393 -- when one of them is writable. The predicates are those proposed in
394 -- AI05-0144, to detect dangerous order dependence in complex calls.
395 -- I would add a parameter Warn which enables more extensive testing of
396 -- cases as we find appropriate when we are only warning ??? Or perhaps
397 -- return an indication of (Error, Warn, OK) ???
399 function Denotes_Variable
(N
: Node_Id
) return Boolean;
400 -- Returns True if node N denotes a single variable without parentheses
402 function Depends_On_Discriminant
(N
: Node_Id
) return Boolean;
403 -- Returns True if N denotes a discriminant or if N is a range, a subtype
404 -- indication or a scalar subtype where one of the bounds is a
407 function Designate_Same_Unit
409 Name2
: Node_Id
) return Boolean;
410 -- Return true if Name1 and Name2 designate the same unit name; each of
411 -- these names is supposed to be a selected component name, an expanded
412 -- name, a defining program unit name or an identifier.
414 function Dynamic_Accessibility_Level
(Expr
: Node_Id
) return Node_Id
;
415 -- Expr should be an expression of an access type. Builds an integer
416 -- literal except in cases involving anonymous access types where
417 -- accessibility levels are tracked at runtime (access parameters and Ada
418 -- 2012 stand-alone objects).
420 function Effective_Extra_Accessibility
(Id
: Entity_Id
) return Entity_Id
;
421 -- Same as Einfo.Extra_Accessibility except thtat object renames
422 -- are looked through.
424 function Enclosing_Comp_Unit_Node
(N
: Node_Id
) return Node_Id
;
425 -- Returns the enclosing N_Compilation_Unit Node that is the root of a
426 -- subtree containing N.
428 function Enclosing_CPP_Parent
(Typ
: Entity_Id
) return Entity_Id
;
429 -- Returns the closest ancestor of Typ that is a CPP type.
431 function Enclosing_Generic_Body
432 (N
: Node_Id
) return Node_Id
;
433 -- Returns the Node_Id associated with the innermost enclosing generic
434 -- body, if any. If none, then returns Empty.
436 function Enclosing_Generic_Unit
437 (N
: Node_Id
) return Node_Id
;
438 -- Returns the Node_Id associated with the innermost enclosing generic
439 -- unit, if any. If none, then returns Empty.
441 function Enclosing_Lib_Unit_Entity
442 (E
: Entity_Id
:= Current_Scope
) return Entity_Id
;
443 -- Returns the entity of enclosing library unit node which is the
444 -- root of the current scope (which must not be Standard_Standard, and the
445 -- caller is responsible for ensuring this condition) or other specified
448 function Enclosing_Package
(E
: Entity_Id
) return Entity_Id
;
449 -- Utility function to return the Ada entity of the package enclosing
450 -- the entity E, if any. Returns Empty if no enclosing package.
452 function Enclosing_Subprogram
(E
: Entity_Id
) return Entity_Id
;
453 -- Utility function to return the Ada entity of the subprogram enclosing
454 -- the entity E, if any. Returns Empty if no enclosing subprogram.
456 procedure Ensure_Freeze_Node
(E
: Entity_Id
);
457 -- Make sure a freeze node is allocated for entity E. If necessary, build
458 -- and initialize a new freeze node and set Has_Delayed_Freeze True for E.
460 procedure Enter_Name
(Def_Id
: Entity_Id
);
461 -- Insert new name in symbol table of current scope with check for
462 -- duplications (error message is issued if a conflict is found).
463 -- Note: Enter_Name is not used for overloadable entities, instead these
464 -- are entered using Sem_Ch6.Enter_Overloadable_Entity.
466 procedure Explain_Limited_Type
(T
: Entity_Id
; N
: Node_Id
);
467 -- This procedure is called after issuing a message complaining about an
468 -- inappropriate use of limited type T. If useful, it adds additional
469 -- continuation lines to the message explaining why type T is limited.
470 -- Messages are placed at node N.
472 procedure Find_Actual
474 Formal
: out Entity_Id
;
476 -- Determines if the node N is an actual parameter of a function of a
477 -- procedure call. If so, then Formal points to the entity for the formal
478 -- (Ekind is E_In_Parameter, E_Out_Parameter, or E_In_Out_Parameter) and
479 -- Call is set to the node for the corresponding call. If the node N is not
480 -- an actual parameter then Formal and Call are set to Empty.
482 function Find_Corresponding_Discriminant
484 Typ
: Entity_Id
) return Entity_Id
;
485 -- Because discriminants may have different names in a generic unit and in
486 -- an instance, they are resolved positionally when possible. A reference
487 -- to a discriminant carries the discriminant that it denotes when it is
488 -- analyzed. Subsequent uses of this id on a different type denotes the
489 -- discriminant at the same position in this new type.
491 function Find_Loop_In_Conditional_Block
(N
: Node_Id
) return Node_Id
;
492 -- Find the nested loop statement in a conditional block. Loops subject to
493 -- attribute 'Loop_Entry are transformed into blocks. Parts of the original
494 -- loop are nested within the block.
496 procedure Find_Overlaid_Entity
500 -- The node N should be an address representation clause. Determines if
501 -- the target expression is the address of an entity with an optional
502 -- offset. If so, set Ent to the entity and, if there is an offset, set
503 -- Off to True, otherwise to False. If N is not an address representation
504 -- clause, or if it is not possible to determine that the address is of
505 -- this form, then set Ent to Empty.
507 function Find_Parameter_Type
(Param
: Node_Id
) return Entity_Id
;
508 -- Return the type of formal parameter Param as determined by its
511 function Find_Static_Alternative
(N
: Node_Id
) return Node_Id
;
512 -- N is a case statement whose expression is a compile-time value.
513 -- Determine the alternative chosen, so that the code of non-selected
514 -- alternatives, and the warnings that may apply to them, are removed.
516 function Find_Body_Discriminal
517 (Spec_Discriminant
: Entity_Id
) return Entity_Id
;
518 -- Given a discriminant of the record type that implements a task or
519 -- protected type, return the discriminal of the corresponding discriminant
520 -- of the actual concurrent type.
522 function First_Actual
(Node
: Node_Id
) return Node_Id
;
523 -- Node is an N_Function_Call or N_Procedure_Call_Statement node. The
524 -- result returned is the first actual parameter in declaration order
525 -- (not the order of parameters as they appeared in the source, which
526 -- can be quite different as a result of the use of named parameters).
527 -- Empty is returned for a call with no parameters. The procedure for
528 -- iterating through the actuals in declaration order is to use this
529 -- function to find the first actual, and then use Next_Actual to obtain
530 -- the next actual in declaration order. Note that the value returned
531 -- is always the expression (not the N_Parameter_Association nodes,
532 -- even if named association is used).
534 procedure Gather_Components
537 Governed_By
: List_Id
;
539 Report_Errors
: out Boolean);
540 -- The purpose of this procedure is to gather the valid components in a
541 -- record type according to the values of its discriminants, in order to
542 -- validate the components of a record aggregate.
544 -- Typ is the type of the aggregate when its constrained discriminants
545 -- need to be collected, otherwise it is Empty.
547 -- Comp_List is an N_Component_List node.
549 -- Governed_By is a list of N_Component_Association nodes, where each
550 -- choice list contains the name of a discriminant and the expression
551 -- field gives its value. The values of the discriminants governing
552 -- the (possibly nested) variant parts in Comp_List are found in this
553 -- Component_Association List.
555 -- Into is the list where the valid components are appended. Note that
556 -- Into need not be an Empty list. If it's not, components are attached
559 -- Report_Errors is set to True if the values of the discriminants are
562 -- This procedure is also used when building a record subtype. If the
563 -- discriminant constraint of the subtype is static, the components of the
564 -- subtype are only those of the variants selected by the values of the
565 -- discriminants. Otherwise all components of the parent must be included
566 -- in the subtype for semantic analysis.
568 function Get_Actual_Subtype
(N
: Node_Id
) return Entity_Id
;
569 -- Given a node for an expression, obtain the actual subtype of the
570 -- expression. In the case of a parameter where the formal is an
571 -- unconstrained array or discriminated type, this will be the previously
572 -- constructed subtype of the actual. Note that this is not quite the
573 -- "Actual Subtype" of the RM, since it is always a constrained type, i.e.
574 -- it is the subtype of the value of the actual. The actual subtype is also
575 -- returned in other cases where it has already been constructed for an
576 -- object. Otherwise the expression type is returned unchanged, except for
577 -- the case of an unconstrained array type, where an actual subtype is
578 -- created, using Insert_Actions if necessary to insert any associated
581 function Get_Actual_Subtype_If_Available
(N
: Node_Id
) return Entity_Id
;
582 -- This is like Get_Actual_Subtype, except that it never constructs an
583 -- actual subtype. If an actual subtype is already available, i.e. the
584 -- Actual_Subtype field of the corresponding entity is set, then it is
585 -- returned. Otherwise the Etype of the node is returned.
587 function Get_Body_From_Stub
(N
: Node_Id
) return Node_Id
;
588 -- Return the body node for a stub (subprogram or package)
590 function Get_Default_External_Name
(E
: Node_Or_Entity_Id
) return Node_Id
;
591 -- This is used to construct the string literal node representing a
592 -- default external name, i.e. one that is constructed from the name of an
593 -- entity, or (in the case of extended DEC import/export pragmas, an
594 -- identifier provided as the external name. Letters in the name are
595 -- according to the setting of Opt.External_Name_Default_Casing.
597 function Get_Enclosing_Object
(N
: Node_Id
) return Entity_Id
;
598 -- If expression N references a part of an object, return this object.
599 -- Otherwise return Empty. Expression N should have been resolved already.
601 function Get_Ensures_From_CTC_Pragma
(N
: Node_Id
) return Node_Id
;
602 -- Return the Ensures component of Test_Case pragma N, or Empty otherwise
603 -- Bad name now that this no longer applies to Contract_Case ???
605 function Get_Generic_Entity
(N
: Node_Id
) return Entity_Id
;
606 -- Returns the true generic entity in an instantiation. If the name in the
607 -- instantiation is a renaming, the function returns the renamed generic.
609 function Get_Incomplete_View_Of_Ancestor
(E
: Entity_Id
) return Entity_Id
;
610 -- Implements the notion introduced ever-so briefly in RM 7.3.1 (5.2/3):
611 -- in a child unit a derived type is within the derivation class of an
612 -- ancestor declared in a parent unit, even if there is an intermediate
613 -- derivation that does not see the full view of that ancestor.
615 procedure Get_Index_Bounds
(N
: Node_Id
; L
, H
: out Node_Id
);
616 -- This procedure assigns to L and H respectively the values of the low and
617 -- high bounds of node N, which must be a range, subtype indication, or the
618 -- name of a scalar subtype. The result in L, H may be set to Error if
619 -- there was an earlier error in the range.
621 function Get_Enum_Lit_From_Pos
624 Loc
: Source_Ptr
) return Node_Id
;
625 -- This function returns an identifier denoting the E_Enumeration_Literal
626 -- entity for the specified value from the enumeration type or subtype T.
627 -- The second argument is the Pos value, which is assumed to be in range.
628 -- The third argument supplies a source location for constructed nodes
629 -- returned by this function.
631 procedure Get_Library_Unit_Name_String
(Decl_Node
: Node_Id
);
632 -- Retrieve the fully expanded name of the library unit declared by
633 -- Decl_Node into the name buffer.
635 function Get_Name_Entity_Id
(Id
: Name_Id
) return Entity_Id
;
636 pragma Inline
(Get_Name_Entity_Id
);
637 -- An entity value is associated with each name in the name table. The
638 -- Get_Name_Entity_Id function fetches the Entity_Id of this entity, which
639 -- is the innermost visible entity with the given name. See the body of
640 -- Sem_Ch8 for further details on handling of entity visibility.
642 function Get_Name_From_CTC_Pragma
(N
: Node_Id
) return String_Id
;
643 -- Return the Name component of Test_Case pragma N
644 -- Bad name now that this no longer applies to Contract_Case ???
646 function Get_Pragma_Id
(N
: Node_Id
) return Pragma_Id
;
647 pragma Inline
(Get_Pragma_Id
);
648 -- Obtains the Pragma_Id from the Chars field of Pragma_Identifier (N)
650 function Get_Referenced_Object
(N
: Node_Id
) return Node_Id
;
651 -- Given a node, return the renamed object if the node represents a renamed
652 -- object, otherwise return the node unchanged. The node may represent an
653 -- arbitrary expression.
655 function Get_Renamed_Entity
(E
: Entity_Id
) return Entity_Id
;
656 -- Given an entity for an exception, package, subprogram or generic unit,
657 -- returns the ultimately renamed entity if this is a renaming. If this is
658 -- not a renamed entity, returns its argument. It is an error to call this
659 -- with any other kind of entity.
661 function Get_Requires_From_CTC_Pragma
(N
: Node_Id
) return Node_Id
;
662 -- Return the Requires component of Test_Case pragma N, or Empty otherwise
663 -- Bad name now that this no longer applies to Contract_Case ???
665 function Get_Subprogram_Entity
(Nod
: Node_Id
) return Entity_Id
;
666 -- Nod is either a procedure call statement, or a function call, or an
667 -- accept statement node. This procedure finds the Entity_Id of the related
668 -- subprogram or entry and returns it, or if no subprogram can be found,
671 function Get_Subprogram_Body
(E
: Entity_Id
) return Node_Id
;
672 -- Given the entity for a subprogram (E_Function or E_Procedure), return
673 -- the corresponding N_Subprogram_Body node. If the corresponding body
674 -- is missing (as for an imported subprogram), return Empty.
676 function Get_Task_Body_Procedure
(E
: Entity_Id
) return Node_Id
;
677 pragma Inline
(Get_Task_Body_Procedure
);
678 -- Given an entity for a task type or subtype, retrieves the
679 -- Task_Body_Procedure field from the corresponding task type declaration.
681 function Has_Access_Values
(T
: Entity_Id
) return Boolean;
682 -- Returns true if type or subtype T is an access type, or has a component
683 -- (at any recursive level) that is an access type. This is a conservative
684 -- predicate, if it is not known whether or not T contains access values
685 -- (happens for generic formals in some cases), then False is returned.
686 -- Note that tagged types return False. Even though the tag is implemented
687 -- as an access type internally, this function tests only for access types
688 -- known to the programmer. See also Has_Tagged_Component.
690 type Alignment_Result
is (Known_Compatible
, Unknown
, Known_Incompatible
);
691 -- Result of Has_Compatible_Alignment test, description found below. Note
692 -- that the values are arranged in increasing order of problematicness.
694 function Has_Compatible_Alignment
696 Expr
: Node_Id
) return Alignment_Result
;
697 -- Obj is an object entity, and expr is a node for an object reference. If
698 -- the alignment of the object referenced by Expr is known to be compatible
699 -- with the alignment of Obj (i.e. is larger or the same), then the result
700 -- is Known_Compatible. If the alignment of the object referenced by Expr
701 -- is known to be less than the alignment of Obj, then Known_Incompatible
702 -- is returned. If neither condition can be reliably established at compile
703 -- time, then Unknown is returned. This is used to determine if alignment
704 -- checks are required for address clauses, and also whether copies must
705 -- be made when objects are passed by reference.
707 -- Note: Known_Incompatible does not mean that at run time the alignment
708 -- of Expr is known to be wrong for Obj, just that it can be determined
709 -- that alignments have been explicitly or implicitly specified which are
710 -- incompatible (whereas Unknown means that even this is not known). The
711 -- appropriate reaction of a caller to Known_Incompatible is to treat it as
712 -- Unknown, but issue a warning that there may be an alignment error.
714 function Has_Declarations
(N
: Node_Id
) return Boolean;
715 -- Determines if the node can have declarations
717 function Has_Denormals
(E
: Entity_Id
) return Boolean;
718 -- Determines if the floating-point type E supports denormal numbers.
719 -- Returns False if E is not a floating-point type.
721 function Has_Discriminant_Dependent_Constraint
722 (Comp
: Entity_Id
) return Boolean;
723 -- Returns True if and only if Comp has a constrained subtype that depends
724 -- on a discriminant.
726 function Has_Infinities
(E
: Entity_Id
) return Boolean;
727 -- Determines if the range of the floating-point type E includes
728 -- infinities. Returns False if E is not a floating-point type.
730 function Has_Interfaces
732 Use_Full_View
: Boolean := True) return Boolean;
733 -- Where T is a concurrent type or a record type, returns true if T covers
734 -- any abstract interface types. In case of private types the argument
735 -- Use_Full_View controls if the check is done using its full view (if
738 function Has_Null_Exclusion
(N
: Node_Id
) return Boolean;
739 -- Determine whether node N has a null exclusion
741 function Has_Overriding_Initialize
(T
: Entity_Id
) return Boolean;
742 -- Predicate to determine whether a controlled type has a user-defined
743 -- Initialize primitive (and, in Ada 2012, whether that primitive is
744 -- non-null), which causes the type to not have preelaborable
747 function Has_Preelaborable_Initialization
(E
: Entity_Id
) return Boolean;
748 -- Return True iff type E has preelaborable initialization as defined in
749 -- Ada 2005 (see AI-161 for details of the definition of this attribute).
751 function Has_Private_Component
(Type_Id
: Entity_Id
) return Boolean;
752 -- Check if a type has a (sub)component of a private type that has not
753 -- yet received a full declaration.
755 function Has_Signed_Zeros
(E
: Entity_Id
) return Boolean;
756 -- Determines if the floating-point type E supports signed zeros.
757 -- Returns False if E is not a floating-point type.
759 function Has_Static_Array_Bounds
(Typ
: Node_Id
) return Boolean;
760 -- Return whether an array type has static bounds
762 function Has_Stream
(T
: Entity_Id
) return Boolean;
763 -- Tests if type T is derived from Ada.Streams.Root_Stream_Type, or in the
764 -- case of a composite type, has a component for which this predicate is
765 -- True, and if so returns True. Otherwise a result of False means that
766 -- there is no Stream type in sight. For a private type, the test is
767 -- applied to the underlying type (or returns False if there is no
770 function Has_Suffix
(E
: Entity_Id
; Suffix
: Character) return Boolean;
771 -- Returns true if the last character of E is Suffix. Used in Assertions.
773 function Add_Suffix
(E
: Entity_Id
; Suffix
: Character) return Name_Id
;
774 -- Returns the name of E adding Suffix
776 function Remove_Suffix
(E
: Entity_Id
; Suffix
: Character) return Name_Id
;
777 -- Returns the name of E without Suffix
779 function Has_Tagged_Component
(Typ
: Entity_Id
) return Boolean;
780 -- Returns True if Typ is a composite type (array or record) which is
781 -- either itself a tagged type, or has a component (recursively) which is
782 -- a tagged type. Returns False for non-composite type, or if no tagged
783 -- component is present. This function is used to check if "=" has to be
784 -- expanded into a bunch component comparisons.
786 function Implementation_Kind
(Subp
: Entity_Id
) return Name_Id
;
787 -- Subp is a subprogram marked with pragma Implemented. Return the specific
788 -- implementation requirement which the pragma imposes. The return value is
789 -- either Name_By_Any, Name_By_Entry or Name_By_Protected_Procedure.
791 function Implements_Interface
792 (Typ_Ent
: Entity_Id
;
793 Iface_Ent
: Entity_Id
;
794 Exclude_Parents
: Boolean := False) return Boolean;
795 -- Returns true if the Typ_Ent implements interface Iface_Ent
797 function In_Instance
return Boolean;
798 -- Returns True if the current scope is within a generic instance
800 function In_Instance_Body
return Boolean;
801 -- Returns True if current scope is within the body of an instance, where
802 -- several semantic checks (e.g. accessibility checks) are relaxed.
804 function In_Instance_Not_Visible
return Boolean;
805 -- Returns True if current scope is with the private part or the body of
806 -- an instance. Other semantic checks are suppressed in this context.
808 function In_Instance_Visible_Part
return Boolean;
809 -- Returns True if current scope is within the visible part of a package
810 -- instance, where several additional semantic checks apply.
812 function In_Package_Body
return Boolean;
813 -- Returns True if current scope is within a package body
815 function In_Parameter_Specification
(N
: Node_Id
) return Boolean;
816 -- Returns True if node N belongs to a parameter specification
818 function In_Reverse_Storage_Order_Object
(N
: Node_Id
) return Boolean;
819 -- Returns True if N denotes a component or subcomponent in a record or
820 -- array that has Reverse_Storage_Order.
822 function In_Subprogram_Or_Concurrent_Unit
return Boolean;
823 -- Determines if the current scope is within a subprogram compilation unit
824 -- (inside a subprogram declaration, subprogram body, or generic
825 -- subprogram declaration) or within a task or protected body. The test is
826 -- for appearing anywhere within such a construct (that is it does not need
827 -- to be directly within).
829 function In_Visible_Part
(Scope_Id
: Entity_Id
) return Boolean;
830 -- Determine whether a declaration occurs within the visible part of a
831 -- package specification. The package must be on the scope stack, and the
832 -- corresponding private part must not.
834 function Incomplete_Or_Private_View
(Typ
: Entity_Id
) return Entity_Id
;
835 -- Given the entity of a type, retrieve the incomplete or private view of
836 -- the same type. Note that Typ may not have a partial view to begin with,
837 -- in that case the function returns Empty.
839 procedure Insert_Explicit_Dereference
(N
: Node_Id
);
840 -- In a context that requires a composite or subprogram type and where a
841 -- prefix is an access type, rewrite the access type node N (which is the
842 -- prefix, e.g. of an indexed component) as an explicit dereference.
844 procedure Inspect_Deferred_Constant_Completion
(Decls
: List_Id
);
845 -- Examine all deferred constants in the declaration list Decls and check
846 -- whether they have been completed by a full constant declaration or an
847 -- Import pragma. Emit the error message if that is not the case.
849 function Is_Actual_Out_Parameter
(N
: Node_Id
) return Boolean;
850 -- Determines if N is an actual parameter of out mode in a subprogram call
852 function Is_Actual_Parameter
(N
: Node_Id
) return Boolean;
853 -- Determines if N is an actual parameter in a subprogram call
855 function Is_Actual_Tagged_Parameter
(N
: Node_Id
) return Boolean;
856 -- Determines if N is an actual parameter of a formal of tagged type in a
859 function Is_Aliased_View
(Obj
: Node_Id
) return Boolean;
860 -- Determine if Obj is an aliased view, i.e. the name of an object to which
861 -- 'Access or 'Unchecked_Access can apply. Note that this routine uses the
862 -- rules of the language, it does not take into account the restriction
863 -- No_Implicit_Aliasing, so it can return True if the restriction is active
864 -- and Obj violates the restriction. The caller is responsible for calling
865 -- Restrict.Check_No_Implicit_Aliasing if True is returned, but there is a
866 -- requirement for obeying the restriction in the call context.
868 function Is_Ancestor_Package
870 E2
: Entity_Id
) return Boolean;
871 -- Determine whether package E1 is an ancestor of E2
873 function Is_Atomic_Object
(N
: Node_Id
) return Boolean;
874 -- Determines if the given node denotes an atomic object in the sense of
875 -- the legality checks described in RM C.6(12).
877 function Is_Body_Or_Package_Declaration
(N
: Node_Id
) return Boolean;
878 -- Determine whether node N denotes a body or a package declaration
880 function Is_Bounded_String
(T
: Entity_Id
) return Boolean;
881 -- True if T is a bounded string type. Used to make sure "=" composes
882 -- properly for bounded string types.
884 function Is_Constant_Bound
(Exp
: Node_Id
) return Boolean;
885 -- Exp is the expression for an array bound. Determines whether the
886 -- bound is a compile-time known value, or a constant entity, or an
887 -- enumeration literal, or an expression composed of constant-bound
888 -- subexpressions which are evaluated by means of standard operators.
890 function Is_Controlling_Limited_Procedure
891 (Proc_Nam
: Entity_Id
) return Boolean;
892 -- Ada 2005 (AI-345): Determine whether Proc_Nam is a primitive procedure
893 -- of a limited interface with a controlling first parameter.
895 function Is_CPP_Constructor_Call
(N
: Node_Id
) return Boolean;
896 -- Returns True if N is a call to a CPP constructor
898 function Is_Dependent_Component_Of_Mutable_Object
899 (Object
: Node_Id
) return Boolean;
900 -- Returns True if Object is the name of a subcomponent that depends on
901 -- discriminants of a variable whose nominal subtype is unconstrained and
902 -- not indefinite, and the variable is not aliased. Otherwise returns
903 -- False. The nodes passed to this function are assumed to denote objects.
905 function Is_Dereferenced
(N
: Node_Id
) return Boolean;
906 -- N is a subexpression node of an access type. This function returns true
907 -- if N appears as the prefix of a node that does a dereference of the
908 -- access value (selected/indexed component, explicit dereference or a
909 -- slice), and false otherwise.
911 function Is_Descendent_Of
(T1
: Entity_Id
; T2
: Entity_Id
) return Boolean;
912 -- Returns True if type T1 is a descendent of type T2, and false otherwise.
913 -- This is the RM definition, a type is a descendent of another type if it
914 -- is the same type or is derived from a descendent of the other type.
916 function Is_Concurrent_Interface
(T
: Entity_Id
) return Boolean;
917 -- First determine whether type T is an interface and then check whether
918 -- it is of protected, synchronized or task kind.
920 function Is_Expression_Function
(Subp
: Entity_Id
) return Boolean;
921 -- Predicate to determine whether a scope entity comes from a rewritten
922 -- expression function call, and should be inlined unconditionally. Also
923 -- used to determine that such a call does not constitute a freeze point.
925 function Is_False
(U
: Uint
) return Boolean;
926 pragma Inline
(Is_False
);
927 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
928 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
929 -- if it is False (i.e. zero).
931 function Is_Fixed_Model_Number
(U
: Ureal
; T
: Entity_Id
) return Boolean;
932 -- Returns True iff the number U is a model number of the fixed-point type
933 -- T, i.e. if it is an exact multiple of Small.
935 function Is_Fully_Initialized_Type
(Typ
: Entity_Id
) return Boolean;
936 -- Typ is a type entity. This function returns true if this type is fully
937 -- initialized, meaning that an object of the type is fully initialized.
938 -- Note that initialization resulting from use of pragma Normalized_Scalars
939 -- does not count. Note that this is only used for the purpose of issuing
940 -- warnings for objects that are potentially referenced uninitialized. This
941 -- means that the result returned is not crucial, but should err on the
942 -- side of thinking things are fully initialized if it does not know.
944 function Is_Inherited_Operation
(E
: Entity_Id
) return Boolean;
945 -- E is a subprogram. Return True is E is an implicit operation inherited
946 -- by a derived type declaration.
948 function Is_Inherited_Operation_For_Type
950 Typ
: Entity_Id
) return Boolean;
951 -- E is a subprogram. Return True is E is an implicit operation inherited
952 -- by the derived type declaration for type Typ.
954 function Is_Iterator
(Typ
: Entity_Id
) return Boolean;
955 -- AI05-0139-2: Check whether Typ is one of the predefined interfaces in
956 -- Ada.Iterator_Interfaces, or it is derived from one.
958 function Is_LHS
(N
: Node_Id
) return Boolean;
959 -- Returns True iff N is used as Name in an assignment statement
961 function Is_Library_Level_Entity
(E
: Entity_Id
) return Boolean;
962 -- A library-level declaration is one that is accessible from Standard,
963 -- i.e. a library unit or an entity declared in a library package.
965 function Is_Limited_Class_Wide_Type
(Typ
: Entity_Id
) return Boolean;
966 -- Determine whether a given type is a limited class-wide type, in which
967 -- case it needs a Master_Id, because extensions of its designated type
968 -- may include task components. A class-wide type that comes from a
969 -- limited view must be treated in the same way.
971 function Is_Local_Variable_Reference
(Expr
: Node_Id
) return Boolean;
972 -- Determines whether Expr is a reference to a variable or IN OUT mode
973 -- parameter of the current enclosing subprogram.
974 -- Why are OUT parameters not considered here ???
976 function Is_Object_Reference
(N
: Node_Id
) return Boolean;
977 -- Determines if the tree referenced by N represents an object. Both
978 -- variable and constant objects return True (compare Is_Variable).
980 function Is_OK_Variable_For_Out_Formal
(AV
: Node_Id
) return Boolean;
981 -- Used to test if AV is an acceptable formal for an OUT or IN OUT formal.
982 -- Note that the Is_Variable function is not quite the right test because
983 -- this is a case in which conversions whose expression is a variable (in
984 -- the Is_Variable sense) with a non-tagged type target are considered view
985 -- conversions and hence variables.
987 function Is_Partially_Initialized_Type
989 Include_Implicit
: Boolean := True) return Boolean;
990 -- Typ is a type entity. This function returns true if this type is partly
991 -- initialized, meaning that an object of the type is at least partly
992 -- initialized (in particular in the record case, that at least one
993 -- component has an initialization expression). Note that initialization
994 -- resulting from the use of pragma Normalized_Scalars does not count.
995 -- Include_Implicit controls whether implicit initialization of access
996 -- values to null, and of discriminant values, is counted as making the
997 -- type be partially initialized. For the default setting of True, these
998 -- implicit cases do count, and discriminated types or types containing
999 -- access values not explicitly initialized will return True. Otherwise
1000 -- if Include_Implicit is False, these cases do not count as making the
1001 -- type be partially initialized.
1003 function Is_Potentially_Persistent_Type
(T
: Entity_Id
) return Boolean;
1004 -- Determines if type T is a potentially persistent type. A potentially
1005 -- persistent type is defined (recursively) as a scalar type, a non-tagged
1006 -- record whose components are all of a potentially persistent type, or an
1007 -- array with all static constraints whose component type is potentially
1008 -- persistent. A private type is potentially persistent if the full type
1009 -- is potentially persistent.
1011 function Is_Protected_Self_Reference
(N
: Node_Id
) return Boolean;
1012 -- Return True if node N denotes a protected type name which represents
1013 -- the current instance of a protected object according to RM 9.4(21/2).
1015 function Is_RCI_Pkg_Spec_Or_Body
(Cunit
: Node_Id
) return Boolean;
1016 -- Return True if a compilation unit is the specification or the
1017 -- body of a remote call interface package.
1019 function Is_Remote_Access_To_Class_Wide_Type
(E
: Entity_Id
) return Boolean;
1020 -- Return True if E is a remote access-to-class-wide type
1022 function Is_Remote_Access_To_Subprogram_Type
(E
: Entity_Id
) return Boolean;
1023 -- Return True if E is a remote access to subprogram type
1025 function Is_Remote_Call
(N
: Node_Id
) return Boolean;
1026 -- Return True if N denotes a potentially remote call
1028 function Is_Renamed_Entry
(Proc_Nam
: Entity_Id
) return Boolean;
1029 -- Return True if Proc_Nam is a procedure renaming of an entry
1031 function Is_Reversible_Iterator
(Typ
: Entity_Id
) return Boolean;
1032 -- AI05-0139-2: Check whether Typ is derived from the predefined interface
1033 -- Ada.Iterator_Interfaces.Reversible_Iterator.
1035 function Is_Selector_Name
(N
: Node_Id
) return Boolean;
1036 -- Given an N_Identifier node N, determines if it is a Selector_Name.
1037 -- As described in Sinfo, Selector_Names are special because they
1038 -- represent use of the N_Identifier node for a true identifier, when
1039 -- normally such nodes represent a direct name.
1041 function Is_SPARK_Initialization_Expr
(N
: Node_Id
) return Boolean;
1042 -- Determines if the tree referenced by N represents an initialization
1043 -- expression in SPARK, suitable for initializing an object in an object
1046 function Is_SPARK_Object_Reference
(N
: Node_Id
) return Boolean;
1047 -- Determines if the tree referenced by N represents an object in SPARK
1049 function Is_Statement
(N
: Node_Id
) return Boolean;
1050 pragma Inline
(Is_Statement
);
1051 -- Check if the node N is a statement node. Note that this includes
1052 -- the case of procedure call statements (unlike the direct use of
1053 -- the N_Statement_Other_Than_Procedure_Call subtype from Sinfo).
1054 -- Note that a label is *not* a statement, and will return False.
1056 function Is_Subprogram_Stub_Without_Prior_Declaration
1057 (N
: Node_Id
) return Boolean;
1058 -- Return True if N is a subprogram stub with no prior subprogram
1061 function Is_Synchronized_Tagged_Type
(E
: Entity_Id
) return Boolean;
1062 -- Returns True if E is a synchronized tagged type (AARM 3.9.4 (6/2))
1064 function Is_Transfer
(N
: Node_Id
) return Boolean;
1065 -- Returns True if the node N is a statement which is known to cause an
1066 -- unconditional transfer of control at runtime, i.e. the following
1067 -- statement definitely will not be executed.
1069 function Is_True
(U
: Uint
) return Boolean;
1070 pragma Inline
(Is_True
);
1071 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
1072 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
1073 -- if it is True (i.e. non-zero).
1075 function Is_Universal_Numeric_Type
(T
: Entity_Id
) return Boolean;
1076 pragma Inline
(Is_Universal_Numeric_Type
);
1077 -- True if T is Universal_Integer or Universal_Real
1079 function Is_Value_Type
(T
: Entity_Id
) return Boolean;
1080 -- Returns true if type T represents a value type. This is only relevant to
1081 -- CIL, will always return false for other targets. A value type is a CIL
1082 -- object that is accessed directly, as opposed to the other CIL objects
1083 -- that are accessed through managed pointers.
1085 function Is_Variable_Size_Array
(E
: Entity_Id
) return Boolean;
1086 -- Returns true if E has variable size components
1088 function Is_Variable_Size_Record
(E
: Entity_Id
) return Boolean;
1089 -- Returns true if E has variable size components
1091 function Is_VMS_Operator
(Op
: Entity_Id
) return Boolean;
1092 -- Determine whether an operator is one of the intrinsics defined
1093 -- in the DEC system extension.
1095 function Is_Delegate
(T
: Entity_Id
) return Boolean;
1096 -- Returns true if type T represents a delegate. A Delegate is the CIL
1097 -- object used to represent access-to-subprogram types. This is only
1098 -- relevant to CIL, will always return false for other targets.
1100 function Is_Variable
1102 Use_Original_Node
: Boolean := True) return Boolean;
1103 -- Determines if the tree referenced by N represents a variable, i.e. can
1104 -- appear on the left side of an assignment. There is one situation (formal
1105 -- parameters) in which non-tagged type conversions are also considered
1106 -- variables, but Is_Variable returns False for such cases, since it has
1107 -- no knowledge of the context. Note that this is the point at which
1108 -- Assignment_OK is checked, and True is returned for any tree thus marked.
1109 -- Use_Original_Node is used to perform the test on Original_Node (N). By
1110 -- default is True since this routine is commonly invoked as part of the
1111 -- semantic analysis and it must not be disturbed by the rewriten nodes.
1113 function Is_Visibly_Controlled
(T
: Entity_Id
) return Boolean;
1114 -- Check whether T is derived from a visibly controlled type. This is true
1115 -- if the root type is declared in Ada.Finalization. If T is derived
1116 -- instead from a private type whose full view is controlled, an explicit
1117 -- Initialize/Adjust/Finalize subprogram does not override the inherited
1120 function Is_Volatile_Object
(N
: Node_Id
) return Boolean;
1121 -- Determines if the given node denotes an volatile object in the sense of
1122 -- the legality checks described in RM C.6(12). Note that the test here is
1123 -- for something actually declared as volatile, not for an object that gets
1124 -- treated as volatile (see Einfo.Treat_As_Volatile).
1126 function Itype_Has_Declaration
(Id
: Entity_Id
) return Boolean;
1127 -- Applies to Itypes. True if the Itype is attached to a declaration for
1128 -- the type through its Parent field, which may or not be present in the
1131 procedure Kill_Current_Values
(Last_Assignment_Only
: Boolean := False);
1132 -- This procedure is called to clear all constant indications from all
1133 -- entities in the current scope and in any parent scopes if the current
1134 -- scope is a block or a package (and that recursion continues to the top
1135 -- scope that is not a block or a package). This is used when the
1136 -- sequential flow-of-control assumption is violated (occurrence of a
1137 -- label, head of a loop, or start of an exception handler). The effect of
1138 -- the call is to clear the Current_Value field (but we do not need to
1139 -- clear the Is_True_Constant flag, since that only gets reset if there
1140 -- really is an assignment somewhere in the entity scope). This procedure
1141 -- also calls Kill_All_Checks, since this is a special case of needing to
1142 -- forget saved values. This procedure also clears the Is_Known_Null and
1143 -- Is_Known_Non_Null and Is_Known_Valid flags in variables, constants or
1144 -- parameters since these are also not known to be trustable any more.
1146 -- The Last_Assignment_Only flag is set True to clear only Last_Assignment
1147 -- fields and leave other fields unchanged. This is used when we encounter
1148 -- an unconditional flow of control change (return, goto, raise). In such
1149 -- cases we don't need to clear the current values, since it may be that
1150 -- the flow of control change occurs in a conditional context, and if it
1151 -- is not taken, then it is just fine to keep the current values. But the
1152 -- Last_Assignment field is different, if we have a sequence assign-to-v,
1153 -- conditional-return, assign-to-v, we do not want to complain that the
1154 -- second assignment clobbers the first.
1156 procedure Kill_Current_Values
1158 Last_Assignment_Only
: Boolean := False);
1159 -- This performs the same processing as described above for the form with
1160 -- no argument, but for the specific entity given. The call has no effect
1161 -- if the entity Ent is not for an object. Last_Assignment_Only has the
1162 -- same meaning as for the call with no Ent.
1164 procedure Kill_Size_Check_Code
(E
: Entity_Id
);
1165 -- Called when an address clause or pragma Import is applied to an entity.
1166 -- If the entity is a variable or a constant, and size check code is
1167 -- present, this size check code is killed, since the object will not be
1168 -- allocated by the program.
1170 function Known_To_Be_Assigned
(N
: Node_Id
) return Boolean;
1171 -- The node N is an entity reference. This function determines whether the
1172 -- reference is for sure an assignment of the entity, returning True if
1173 -- so. This differs from May_Be_Lvalue in that it defaults in the other
1174 -- direction. Cases which may possibly be assignments but are not known to
1175 -- be may return True from May_Be_Lvalue, but False from this function.
1177 function Last_Source_Statement
(HSS
: Node_Id
) return Node_Id
;
1178 -- HSS is a handled statement sequence. This function returns the last
1179 -- statement in Statements (HSS) that has Comes_From_Source set. If no
1180 -- such statement exists, Empty is returned.
1182 function Matching_Static_Array_Bounds
1184 R_Typ
: Node_Id
) return Boolean;
1185 -- L_Typ and R_Typ are two array types. Returns True when they have the
1186 -- same number of dimensions, and the same static bounds for each index
1189 procedure Mark_Coextensions
(Context_Nod
: Node_Id
; Root_Nod
: Node_Id
);
1190 -- Given a node which designates the context of analysis and an origin in
1191 -- the tree, traverse from Root_Nod and mark all allocators as either
1192 -- dynamic or static depending on Context_Nod. Any erroneous marking is
1193 -- cleaned up during resolution.
1195 function May_Be_Lvalue
(N
: Node_Id
) return Boolean;
1196 -- Determines if N could be an lvalue (e.g. an assignment left hand side).
1197 -- An lvalue is defined as any expression which appears in a context where
1198 -- a name is required by the syntax, and the identity, rather than merely
1199 -- the value of the node is needed (for example, the prefix of an Access
1200 -- attribute is in this category). Note that, as implied by the name, this
1201 -- test is conservative. If it cannot be sure that N is NOT an lvalue, then
1202 -- it returns True. It tries hard to get the answer right, but it is hard
1203 -- to guarantee this in all cases. Note that it is more possible to give
1204 -- correct answer if the tree is fully analyzed.
1206 function Must_Inline
(Subp
: Entity_Id
) return Boolean;
1207 -- Return true if Subp must be inlined by the frontend
1209 function Needs_One_Actual
(E
: Entity_Id
) return Boolean;
1210 -- Returns True if a function has defaults for all but its first
1211 -- formal. Used in Ada 2005 mode to solve the syntactic ambiguity that
1212 -- results from an indexing of a function call written in prefix form.
1214 function New_Copy_List_Tree
(List
: List_Id
) return List_Id
;
1215 -- Copy recursively an analyzed list of nodes. Uses New_Copy_Tree defined
1216 -- below. As for New_Copy_Tree, it is illegal to attempt to copy extended
1217 -- nodes (entities) either directly or indirectly using this function.
1219 function New_Copy_Tree
1221 Map
: Elist_Id
:= No_Elist
;
1222 New_Sloc
: Source_Ptr
:= No_Location
;
1223 New_Scope
: Entity_Id
:= Empty
) return Node_Id
;
1224 -- Given a node that is the root of a subtree, Copy_Tree copies the entire
1225 -- syntactic subtree, including recursively any descendents whose parent
1226 -- field references a copied node (descendents not linked to a copied node
1227 -- by the parent field are not copied, instead the copied tree references
1228 -- the same descendent as the original in this case, which is appropriate
1229 -- for non-syntactic fields such as Etype). The parent pointers in the
1230 -- copy are properly set. Copy_Tree (Empty/Error) returns Empty/Error.
1231 -- The one exception to the rule of not copying semantic fields is that
1232 -- any implicit types attached to the subtree are duplicated, so that
1233 -- the copy contains a distinct set of implicit type entities. Thus this
1234 -- function is used when it is necessary to duplicate an analyzed tree,
1235 -- declared in the same or some other compilation unit. This function is
1236 -- declared here rather than in atree because it uses semantic information
1237 -- in particular concerning the structure of itypes and the generation of
1240 -- The Map argument, if set to a non-empty Elist, specifies a set of
1241 -- mappings to be applied to entities in the tree. The map has the form:
1244 -- new entity to replace references to entity 1
1246 -- new entity to replace references to entity 2
1249 -- The call destroys the contents of Map in this case
1251 -- The parameter New_Sloc, if set to a value other than No_Location, is
1252 -- used as the Sloc value for all nodes in the new copy. If New_Sloc is
1253 -- set to its default value No_Location, then the Sloc values of the
1254 -- nodes in the copy are simply copied from the corresponding original.
1256 -- The Comes_From_Source indication is unchanged if New_Sloc is set to
1257 -- the default No_Location value, but is reset if New_Sloc is given, since
1258 -- in this case the result clearly is neither a source node or an exact
1259 -- copy of a source node.
1261 -- The parameter New_Scope, if set to a value other than Empty, is the
1262 -- value to use as the Scope for any Itypes that are copied. The most
1263 -- typical value for this parameter, if given, is Current_Scope.
1265 function New_External_Entity
1266 (Kind
: Entity_Kind
;
1267 Scope_Id
: Entity_Id
;
1268 Sloc_Value
: Source_Ptr
;
1269 Related_Id
: Entity_Id
;
1271 Suffix_Index
: Nat
:= 0;
1272 Prefix
: Character := ' ') return Entity_Id
;
1273 -- This function creates an N_Defining_Identifier node for an internal
1274 -- created entity, such as an implicit type or subtype, or a record
1275 -- initialization procedure. The entity name is constructed with a call
1276 -- to New_External_Name (Related_Id, Suffix, Suffix_Index, Prefix), so
1277 -- that the generated name may be referenced as a public entry, and the
1278 -- Is_Public flag is set if needed (using Set_Public_Status). If the
1279 -- entity is for a type or subtype, the size/align fields are initialized
1280 -- to unknown (Uint_0).
1282 function New_Internal_Entity
1283 (Kind
: Entity_Kind
;
1284 Scope_Id
: Entity_Id
;
1285 Sloc_Value
: Source_Ptr
;
1286 Id_Char
: Character) return Entity_Id
;
1287 -- This function is similar to New_External_Entity, except that the
1288 -- name is constructed by New_Internal_Name (Id_Char). This is used
1289 -- when the resulting entity does not have to be referenced as a
1290 -- public entity (and in this case Is_Public is not set).
1292 procedure Next_Actual
(Actual_Id
: in out Node_Id
);
1293 pragma Inline
(Next_Actual
);
1294 -- Next_Actual (N) is equivalent to N := Next_Actual (N). Note that we
1295 -- inline this procedural form, but not the functional form that follows.
1297 function Next_Actual
(Actual_Id
: Node_Id
) return Node_Id
;
1298 -- Find next actual parameter in declaration order. As described for
1299 -- First_Actual, this is the next actual in the declaration order, not
1300 -- the call order, so this does not correspond to simply taking the
1301 -- next entry of the Parameter_Associations list. The argument is an
1302 -- actual previously returned by a call to First_Actual or Next_Actual.
1303 -- Note that the result produced is always an expression, not a parameter
1304 -- association node, even if named notation was used.
1306 function No_Scalar_Parts
(T
: Entity_Id
) return Boolean;
1307 -- Tests if type T can be determined at compile time to have no scalar
1308 -- parts in the sense of the Valid_Scalars attribute. Returns True if
1309 -- this is the case, meaning that the result of Valid_Scalars is True.
1311 procedure Normalize_Actuals
1315 Success
: out Boolean);
1316 -- Reorders lists of actuals according to names of formals, value returned
1317 -- in Success indicates success of reordering. For more details, see body.
1318 -- Errors are reported only if Report is set to True.
1320 procedure Note_Possible_Modification
(N
: Node_Id
; Sure
: Boolean);
1321 -- This routine is called if the sub-expression N maybe the target of
1322 -- an assignment (e.g. it is the left side of an assignment, used as
1323 -- an out parameters, or used as prefixes of access attributes). It
1324 -- sets May_Be_Modified in the associated entity if there is one,
1325 -- taking into account the rule that in the case of renamed objects,
1326 -- it is the flag in the renamed object that must be set.
1328 -- The parameter Sure is set True if the modification is sure to occur
1329 -- (e.g. target of assignment, or out parameter), and to False if the
1330 -- modification is only potential (e.g. address of entity taken).
1332 function Original_Corresponding_Operation
(S
: Entity_Id
) return Entity_Id
;
1333 -- [Ada 2012: AI05-0125-1]: If S is an inherited dispatching primitive S2,
1334 -- or overrides an inherited dispatching primitive S2, the original
1335 -- corresponding operation of S is the original corresponding operation of
1336 -- S2. Otherwise, it is S itself.
1338 function Object_Access_Level
(Obj
: Node_Id
) return Uint
;
1339 -- Return the accessibility level of the view of the object Obj. For
1340 -- convenience, qualified expressions applied to object names are also
1341 -- allowed as actuals for this function.
1343 function Primitive_Names_Match
(E1
, E2
: Entity_Id
) return Boolean;
1344 -- Returns True if the names of both entities correspond with matching
1345 -- primitives. This routine includes support for the case in which one
1346 -- or both entities correspond with entities built by Derive_Subprogram
1347 -- with a special name to avoid being overridden (i.e. return true in case
1348 -- of entities with names "nameP" and "name" or vice versa).
1350 function Private_Component
(Type_Id
: Entity_Id
) return Entity_Id
;
1351 -- Returns some private component (if any) of the given Type_Id.
1352 -- Used to enforce the rules on visibility of operations on composite
1353 -- types, that depend on the full view of the component type. For a
1354 -- record type there may be several such components, we just return
1357 procedure Process_End_Label
1361 -- N is a node whose End_Label is to be processed, generating all
1362 -- appropriate cross-reference entries, and performing style checks
1363 -- for any identifier references in the end label. Typ is either
1364 -- 'e' or 't indicating the type of the cross-reference entity
1365 -- (e for spec, t for body, see Lib.Xref spec for details). The
1366 -- parameter Ent gives the entity to which the End_Label refers,
1367 -- and to which cross-references are to be generated.
1369 function Referenced
(Id
: Entity_Id
; Expr
: Node_Id
) return Boolean;
1370 -- Determine whether entity Id is referenced within expression Expr
1372 function References_Generic_Formal_Type
(N
: Node_Id
) return Boolean;
1373 -- Returns True if the expression Expr contains any references to a
1374 -- generic type. This can only happen within a generic template.
1376 procedure Remove_Homonym
(E
: Entity_Id
);
1377 -- Removes E from the homonym chain
1379 function Rep_To_Pos_Flag
(E
: Entity_Id
; Loc
: Source_Ptr
) return Node_Id
;
1380 -- This is used to construct the second argument in a call to Rep_To_Pos
1381 -- which is Standard_True if range checks are enabled (E is an entity to
1382 -- which the Range_Checks_Suppressed test is applied), and Standard_False
1383 -- if range checks are suppressed. Loc is the location for the node that
1384 -- is returned (which is a New_Occurrence of the appropriate entity).
1386 -- Note: one might think that it would be fine to always use True and
1387 -- to ignore the suppress in this case, but it is generally better to
1388 -- believe a request to suppress exceptions if possible, and further
1389 -- more there is at least one case in the generated code (the code for
1390 -- array assignment in a loop) that depends on this suppression.
1392 procedure Require_Entity
(N
: Node_Id
);
1393 -- N is a node which should have an entity value if it is an entity name.
1394 -- If not, then check if there were previous errors. If so, just fill
1395 -- in with Any_Id and ignore. Otherwise signal a program error exception.
1396 -- This is used as a defense mechanism against ill-formed trees caused by
1397 -- previous errors (particularly in -gnatq mode).
1399 function Requires_Transient_Scope
(Id
: Entity_Id
) return Boolean;
1400 -- Id is a type entity. The result is True when temporaries of this type
1401 -- need to be wrapped in a transient scope to be reclaimed properly when a
1402 -- secondary stack is in use. Examples of types requiring such wrapping are
1403 -- controlled types and variable-sized types including unconstrained
1406 procedure Reset_Analyzed_Flags
(N
: Node_Id
);
1407 -- Reset the Analyzed flags in all nodes of the tree whose root is N
1409 function Returns_Unconstrained_Type
(Subp
: Entity_Id
) return Boolean;
1410 -- Return true if Subp is a function that returns an unconstrained type
1412 function Safe_To_Capture_Value
1415 Cond
: Boolean := False) return Boolean;
1416 -- The caller is interested in capturing a value (either the current value,
1417 -- or an indication that the value is non-null) for the given entity Ent.
1418 -- This value can only be captured if sequential execution semantics can be
1419 -- properly guaranteed so that a subsequent reference will indeed be sure
1420 -- that this current value indication is correct. The node N is the
1421 -- construct which resulted in the possible capture of the value (this
1422 -- is used to check if we are in a conditional).
1424 -- Cond is used to skip the test for being inside a conditional. It is used
1425 -- in the case of capturing values from if/while tests, which already do a
1426 -- proper job of handling scoping issues without this help.
1428 -- The only entities whose values can be captured are OUT and IN OUT formal
1429 -- parameters, and variables unless Cond is True, in which case we also
1430 -- allow IN formals, loop parameters and constants, where we cannot ever
1431 -- capture actual value information, but we can capture conditional tests.
1433 function Same_Name
(N1
, N2
: Node_Id
) return Boolean;
1434 -- Determine if two (possibly expanded) names are the same name. This is
1435 -- a purely syntactic test, and N1 and N2 need not be analyzed.
1437 function Same_Object
(Node1
, Node2
: Node_Id
) return Boolean;
1438 -- Determine if Node1 and Node2 are known to designate the same object.
1439 -- This is a semantic test and both nodes must be fully analyzed. A result
1440 -- of True is decisively correct. A result of False does not necessarily
1441 -- mean that different objects are designated, just that this could not
1442 -- be reliably determined at compile time.
1444 function Same_Type
(T1
, T2
: Entity_Id
) return Boolean;
1445 -- Determines if T1 and T2 represent exactly the same type. Two types
1446 -- are the same if they are identical, or if one is an unconstrained
1447 -- subtype of the other, or they are both common subtypes of the same
1448 -- type with identical constraints. The result returned is conservative.
1449 -- It is True if the types are known to be the same, but a result of
1450 -- False is indecisive (e.g. the compiler may not be able to tell that
1451 -- two constraints are identical).
1453 function Same_Value
(Node1
, Node2
: Node_Id
) return Boolean;
1454 -- Determines if Node1 and Node2 are known to be the same value, which is
1455 -- true if they are both compile time known values and have the same value,
1456 -- or if they are the same object (in the sense of function Same_Object).
1457 -- A result of False does not necessarily mean they have different values,
1458 -- just that it is not possible to determine they have the same value.
1460 function Scope_Within_Or_Same
(Scope1
, Scope2
: Entity_Id
) return Boolean;
1461 -- Determines if the entity Scope1 is the same as Scope2, or if it is
1462 -- inside it, where both entities represent scopes. Note that scopes
1463 -- are only partially ordered, so Scope_Within_Or_Same (A,B) and
1464 -- Scope_Within_Or_Same (B,A) can both be False for a given pair A,B.
1466 function Scope_Within
(Scope1
, Scope2
: Entity_Id
) return Boolean;
1467 -- Like Scope_Within_Or_Same, except that this function returns
1468 -- False in the case where Scope1 and Scope2 are the same scope.
1470 procedure Set_Convention
(E
: Entity_Id
; Val
: Convention_Id
);
1471 -- Same as Basic_Set_Convention, but with an extra check for access types.
1472 -- In particular, if E is an access-to-subprogram type, and Val is a
1473 -- foreign convention, then we set Can_Use_Internal_Rep to False on E.
1475 procedure Set_Current_Entity
(E
: Entity_Id
);
1476 pragma Inline
(Set_Current_Entity
);
1477 -- Establish the entity E as the currently visible definition of its
1478 -- associated name (i.e. the Node_Id associated with its name).
1480 procedure Set_Debug_Info_Needed
(T
: Entity_Id
);
1481 -- Sets the Debug_Info_Needed flag on entity T , and also on any entities
1482 -- that are needed by T (for an object, the type of the object is needed,
1483 -- and for a type, various subsidiary types are needed -- see body for
1484 -- details). Never has any effect on T if the Debug_Info_Off flag is set.
1485 -- This routine should always be used instead of Set_Needs_Debug_Info to
1486 -- ensure that subsidiary entities are properly handled.
1488 procedure Set_Entity_With_Style_Check
(N
: Node_Id
; Val
: Entity_Id
);
1489 -- This procedure has the same calling sequence as Set_Entity, but
1490 -- if Style_Check is set, then it calls a style checking routine which
1491 -- can check identifier spelling style. This procedure also takes care
1492 -- of checking the restriction No_Implementation_Identifiers.
1494 procedure Set_Name_Entity_Id
(Id
: Name_Id
; Val
: Entity_Id
);
1495 pragma Inline
(Set_Name_Entity_Id
);
1496 -- Sets the Entity_Id value associated with the given name, which is the
1497 -- Id of the innermost visible entity with the given name. See the body
1498 -- of package Sem_Ch8 for further details on the handling of visibility.
1500 procedure Set_Next_Actual
(Ass1_Id
: Node_Id
; Ass2_Id
: Node_Id
);
1501 -- The arguments may be parameter associations, whose descendants
1502 -- are the optional formal name and the actual parameter. Positional
1503 -- parameters are already members of a list, and do not need to be
1504 -- chained separately. See also First_Actual and Next_Actual.
1506 procedure Set_Optimize_Alignment_Flags
(E
: Entity_Id
);
1507 pragma Inline
(Set_Optimize_Alignment_Flags
);
1508 -- Sets Optimize_Alignment_Space/Time flags in E from current settings
1510 procedure Set_Public_Status
(Id
: Entity_Id
);
1511 -- If an entity (visible or otherwise) is defined in a library
1512 -- package, or a package that is itself public, then this subprogram
1513 -- labels the entity public as well.
1515 procedure Set_Referenced_Modified
(N
: Node_Id
; Out_Param
: Boolean);
1516 -- N is the node for either a left hand side (Out_Param set to False),
1517 -- or an Out or In_Out parameter (Out_Param set to True). If there is
1518 -- an assignable entity being referenced, then the appropriate flag
1519 -- (Referenced_As_LHS if Out_Param is False, Referenced_As_Out_Parameter
1520 -- if Out_Param is True) is set True, and the other flag set False.
1522 procedure Set_Scope_Is_Transient
(V
: Boolean := True);
1523 -- Set the flag Is_Transient of the current scope
1525 procedure Set_Size_Info
(T1
, T2
: Entity_Id
);
1526 pragma Inline
(Set_Size_Info
);
1527 -- Copies the Esize field and Has_Biased_Representation flag from sub(type)
1528 -- entity T2 to (sub)type entity T1. Also copies the Is_Unsigned_Type flag
1529 -- in the fixed-point and discrete cases, and also copies the alignment
1530 -- value from T2 to T1. It does NOT copy the RM_Size field, which must be
1531 -- separately set if this is required to be copied also.
1533 function Scope_Is_Transient
return Boolean;
1534 -- True if the current scope is transient
1536 function Static_Boolean
(N
: Node_Id
) return Uint
;
1537 -- This function analyzes the given expression node and then resolves it
1538 -- as Standard.Boolean. If the result is static, then Uint_1 or Uint_0 is
1539 -- returned corresponding to the value, otherwise an error message is
1540 -- output and No_Uint is returned.
1542 function Static_Integer
(N
: Node_Id
) return Uint
;
1543 -- This function analyzes the given expression node and then resolves it
1544 -- as any integer type. If the result is static, then the value of the
1545 -- universal expression is returned, otherwise an error message is output
1546 -- and a value of No_Uint is returned.
1548 function Statically_Different
(E1
, E2
: Node_Id
) return Boolean;
1549 -- Return True if it can be statically determined that the Expressions
1550 -- E1 and E2 refer to different objects
1552 function Subject_To_Loop_Entry_Attributes
(N
: Node_Id
) return Boolean;
1553 -- Determine whether node N is a loop statement subject to at least one
1554 -- 'Loop_Entry attribute.
1556 function Subprogram_Access_Level
(Subp
: Entity_Id
) return Uint
;
1557 -- Return the accessibility level of the view denoted by Subp
1559 function Support_Atomic_Primitives
(Typ
: Entity_Id
) return Boolean;
1560 -- Return True if Typ supports the GCC built-in atomic operations (i.e. if
1561 -- Typ is properly sized and aligned).
1563 procedure Trace_Scope
(N
: Node_Id
; E
: Entity_Id
; Msg
: String);
1564 -- Print debugging information on entry to each unit being analyzed
1566 procedure Transfer_Entities
(From
: Entity_Id
; To
: Entity_Id
);
1567 -- Move a list of entities from one scope to another, and recompute
1568 -- Is_Public based upon the new scope.
1570 function Type_Access_Level
(Typ
: Entity_Id
) return Uint
;
1571 -- Return the accessibility level of Typ
1573 function Type_Without_Stream_Operation
1575 Op
: TSS_Name_Type
:= TSS_Null
) return Entity_Id
;
1576 -- AI05-0161: In Ada 2012, if the restriction No_Default_Stream_Attributes
1577 -- is active then we cannot generate stream subprograms for composite types
1578 -- with elementary subcomponents that lack user-defined stream subprograms.
1579 -- This predicate determines whether a type has such an elementary
1580 -- subcomponent. If Op is TSS_Null, a type that lacks either Read or Write
1581 -- prevents the construction of a composite stream operation. If Op is
1582 -- specified we check only for the given stream operation.
1584 function Unique_Defining_Entity
(N
: Node_Id
) return Entity_Id
;
1585 -- Return the entity which represents declaration N, so that different
1586 -- views of the same entity have the same unique defining entity:
1587 -- * package spec and body;
1588 -- * subprogram declaration, subprogram stub and subprogram body;
1589 -- * private view and full view of a type;
1590 -- * private view and full view of a deferred constant.
1591 -- In other cases, return the defining entity for N.
1593 function Unique_Entity
(E
: Entity_Id
) return Entity_Id
;
1594 -- Return the unique entity for entity E, which would be returned by
1595 -- Unique_Defining_Entity if applied to the enclosing declaration of E.
1597 function Unique_Name
(E
: Entity_Id
) return String;
1598 -- Return a unique name for entity E, which could be used to identify E
1599 -- across compilation units.
1601 function Unit_Is_Visible
(U
: Entity_Id
) return Boolean;
1602 -- Determine whether a compilation unit is visible in the current context,
1603 -- because there is a with_clause that makes the unit available. Used to
1604 -- provide better messages on common visiblity errors on operators.
1606 function Universal_Interpretation
(Opnd
: Node_Id
) return Entity_Id
;
1607 -- Yields Universal_Integer or Universal_Real if this is a candidate
1609 function Unqualify
(Expr
: Node_Id
) return Node_Id
;
1610 pragma Inline
(Unqualify
);
1611 -- Removes any qualifications from Expr. For example, for T1'(T2'(X)), this
1612 -- returns X. If Expr is not a qualified expression, returns Expr.
1614 function Visible_Ancestors
(Typ
: Entity_Id
) return Elist_Id
;
1615 -- [Ada 2012:AI-0125-1]: Collect all the visible parents and progenitors
1616 -- of a type extension or private extension declaration. If the full-view
1617 -- of private parents and progenitors is available then it is used to
1618 -- generate the list of visible ancestors; otherwise their partial
1619 -- view is added to the resulting list.
1621 function Within_Init_Proc
return Boolean;
1622 -- Determines if Current_Scope is within an init proc
1624 procedure Wrong_Type
(Expr
: Node_Id
; Expected_Type
: Entity_Id
);
1625 -- Output error message for incorrectly typed expression. Expr is the node
1626 -- for the incorrectly typed construct (Etype (Expr) is the type found),
1627 -- and Expected_Type is the entity for the expected type. Note that Expr
1628 -- does not have to be a subexpression, anything with an Etype field may