| blob | ff9c1697f94b1a37f183dc52f7f56ba4e4dbc110 |
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S E M _ U T I L --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2014, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 -- Package containing utility procedures used throughout the semantics
40 -- Given a type that implements interfaces look for its associated
41 -- definition node and return its list of interfaces.
44 -- Add A to the list of access types to process when expanding the
45 -- freeze node of E.
48 -- Given a block statement N, generate an internal E_Block label and make
49 -- it the identifier of the block. Id denotes the generated entity. If the
50 -- block already has an identifier, Id returns the entity of its label.
53 -- Add pragma Prag to the contract of an entry, a package [body], a
54 -- subprogram [body] or variable denoted by Id. The following are valid
55 -- pragmas:
56 -- Abstract_States
57 -- Async_Readers
58 -- Async_Writers
59 -- Contract_Cases
60 -- Depends
61 -- Effective_Reads
62 -- Effective_Writes
63 -- Extensions_Visible
64 -- Global
65 -- Initial_Condition
66 -- Initializes
67 -- Part_Of
68 -- Postcondition
69 -- Precondition
70 -- Refined_Depends
71 -- Refined_Global
72 -- Refined_Post
73 -- Refined_States
74 -- Test_Case
77 -- These procedures adds a declaration N at the library level, to be
78 -- elaborated before any other code in the unit. It is used for example
79 -- for the entity that marks whether a unit has been elaborated. The
80 -- declaration is added to the Declarations list of the Aux_Decls_Node
81 -- for the current unit. The declarations are added in the current scope,
82 -- so the caller should push a new scope as required before the call.
85 -- Given two types, returns True if we are in Allow_Integer_Address mode
86 -- and one of the types is (a descendent of) System.Address (and this type
87 -- is private), and the other type is any integer type.
92 -- Returns True if the value of V is the word size or an addressable factor
93 -- of the word size (typically 8, 16, 32 or 64).
95 procedure Aggregate_Constraint_Checks
98 -- Checks expression Exp against subtype Check_Typ. If Exp is an aggregate
99 -- and Check_Typ a constrained record type with discriminants, we generate
100 -- the appropriate discriminant checks. If Exp is an array aggregate then
101 -- emit the appropriate length checks. If Exp is a scalar type, or a string
102 -- literal, Exp is changed into Check_Typ'(Exp) to ensure that range checks
103 -- are performed at run time. Also used for expressions in the argument of
104 -- 'Update, which shares some of the features of an aggregate.
107 -- If the alignment of the type or object E is currently known to the
108 -- compiler, then this function returns the alignment value in bits.
109 -- Otherwise Uint_0 is returned, indicating that the alignment of the
110 -- entity is not yet known to the compiler.
113 -- If the parent of the operation is declared in the visible part of
114 -- the current scope, the inherited operation is visible even though the
115 -- derived type that inherits the operation may be completed in the private
116 -- part of the current package.
118 procedure Apply_Compile_Time_Constraint_Error
127 -- N is a subexpression which will raise constraint error when evaluated
128 -- at runtime. Msg is a message that explains the reason for raising the
129 -- exception. The last character is ? if the message is always a warning,
130 -- even in Ada 95, and is not a ? if the message represents an illegality
131 -- (because of violation of static expression rules) in Ada 95 (but not
132 -- in Ada 83). Typically this routine posts all messages at the Sloc of
133 -- node N. However, if Loc /= No_Location, Loc is the Sloc used to output
134 -- the message. After posting the appropriate message, and if the flag
135 -- Rep is set, this routine replaces the expression with an appropriate
136 -- N_Raise_Constraint_Error node using the given Reason code. This node
137 -- is then marked as being static if the original node is static, but
138 -- sets the flag Raises_Constraint_Error, preventing further evaluation.
139 -- The error message may contain a } or & insertion character. This
140 -- normally references Etype (N), unless the Ent argument is given
141 -- explicitly, in which case it is used instead. The type of the raise
142 -- node that is built is normally Etype (N), but if the Typ parameter
143 -- is present, this is used instead. Warn is normally False. If it is
144 -- True then the message is treated as a warning even though it does
145 -- not end with a ? (this is used when the caller wants to parameterize
146 -- whether an error or warning is given).
149 -- Given the entity of an abstract state or a variable, determine whether
150 -- Id is subject to external property Async_Readers and if it is, the
151 -- related expression evaluates to True.
154 -- Given the entity of an abstract state or a variable, determine whether
155 -- Id is subject to external property Async_Writers and if it is, the
156 -- related expression evaluates to True.
159 -- If at the point of declaration an array type has a private or limited
160 -- component, several array operations are not avaiable on the type, and
161 -- the array type is flagged accordingly. If in the immediate scope of
162 -- the array type the component becomes non-private or non-limited, these
163 -- operations become avaiable. This can happen if the scopes of both types
164 -- are open, and the scope of the array is not outside the scope of the
165 -- component.
167 procedure Bad_Attribute
171 -- Called when node N is expected to contain a valid attribute name, and
172 -- Nam is found instead. If Warn is set True this is a warning, else this
173 -- is an error.
175 procedure Bad_Predicated_Subtype_Use
180 -- This is called when Typ, a predicated subtype, is used in a context
181 -- which does not allow the use of a predicated subtype. Msg is passed to
182 -- Error_Msg_FE to output an appropriate message using N as the location,
183 -- and Typ as the entity. The caller must set up any insertions other than
184 -- the & for the type itself. Note that if Typ is a generic actual type,
185 -- then the message will be output as a warning, and a raise Program_Error
186 -- is inserted using Insert_Action with node N as the insertion point. Node
187 -- N also supplies the source location for construction of the raise node.
188 -- If Typ does not have any predicates, the call has no effect. Set flag
189 -- Suggest_Static when the context warrants an advice on how to avoid the
190 -- use error.
192 function Bad_Unordered_Enumeration_Reference
195 -- Node N contains a potentially dubious reference to type T, either an
196 -- explicit comparison, or an explicit range. This function returns True
197 -- if the type T is an enumeration type for which No pragma Order has been
198 -- given, and the reference N is not in the same extended source unit as
199 -- the declaration of T.
201 function Build_Actual_Subtype
204 -- Build an anonymous subtype for an entity or expression, using the
205 -- bounds of the entity or the discriminants of the enclosing record.
206 -- T is the type for which the actual subtype is required, and N is either
207 -- a defining identifier, or any subexpression.
209 function Build_Actual_Subtype_Of_Component
212 -- Determine whether a selected component has a type that depends on
213 -- discriminants, and build actual subtype for it if so.
215 function Build_Default_Init_Cond_Call
219 -- Build a call to the default initial condition procedure of type Typ with
220 -- Obj_Id as the actual parameter.
223 -- Inspect the contents of private declarations Priv_Decls and build the
224 -- bodies the default initial condition procedures for all types subject
225 -- to pragma Default_Initial_Condition.
228 -- If private type Typ is subject to pragma Default_Initial_Condition,
229 -- build the declaration of the procedure which verifies the assumption
230 -- of the pragma at runtime. The declaration is inserted after the related
231 -- pragma.
233 function Build_Default_Subtype
236 -- If T is an unconstrained type with defaulted discriminants, build a
237 -- subtype constrained by the default values, insert the subtype
238 -- declaration in the tree before N, and return the entity of that
239 -- subtype. Otherwise, simply return T.
241 function Build_Discriminal_Subtype_Of_Component
243 -- Determine whether a record component has a type that depends on
244 -- discriminants, and build actual subtype for it if so.
247 -- Given a compilation unit node N, allocate an elaboration counter for
248 -- the compilation unit, and install it in the Elaboration_Entity field
249 -- of Spec_Id, the entity for the compilation unit.
251 procedure Build_Explicit_Dereference
254 -- AI05-139: Names with implicit dereference. If the expression N is a
255 -- reference type and the context imposes the corresponding designated
256 -- type, convert N into N.Disc.all. Such expressions are always over-
257 -- loaded with both interpretations, and the dereference interpretation
258 -- carries the name of the reference discriminant.
261 -- Returns True if the expression cannot possibly raise Constraint_Error.
262 -- The response is conservative in the sense that a result of False does
263 -- not necessarily mean that CE could be raised, but a response of True
264 -- means that for sure CE cannot be raised.
266 procedure Check_Dynamically_Tagged_Expression
270 -- Check wrong use of dynamically tagged expression
273 -- Verify that the full declaration of type T has been seen. If not, place
274 -- error message on node N. Used in object declarations, type conversions
275 -- and qualified expressions.
278 -- (Ada 2012): If the construct N has two or more direct constituents that
279 -- are names or expressions whose evaluation may occur in an arbitrary
280 -- order, at least one of which contains a function call with an in out or
281 -- out parameter, then the construct is legal only if: for each name that
282 -- is passed as a parameter of mode in out or out to some inner function
283 -- call C2 (not including the construct N itself), there is no other name
284 -- anywhere within a direct constituent of the construct C other than
285 -- the one containing C2, that is known to refer to the same object (RM
286 -- 6.4.1(6.17/3)).
288 procedure Check_Ghost_Completion
291 -- Verify that the Ghost policy of a full view or a completion is the same
292 -- as the Ghost policy of the partial view. Emit an error if this is not
293 -- the case.
296 -- Verify that the parent type and all progenitors of derived type or type
297 -- extension Typ are Ghost. If this is not the case, issue an error.
300 -- AI05-139-2: Accessors and iterators for containers. This procedure
301 -- checks whether T is a reference type, and if so it adds an interprettion
302 -- to N whose type is the designated type of the reference_discriminant.
303 -- If N is a generalized indexing operation, the interpretation is added
304 -- both to the corresponding function call, and to the indexing node.
307 -- Within a protected function, the current object is a constant, and
308 -- internal calls to a procedure or entry are illegal. Similarly, other
309 -- uses of a protected procedure in a renaming or a generic instantiation
310 -- in the context of a protected function are illegal (AI05-0225).
312 procedure Check_Later_Vs_Basic_Declarations
315 -- If During_Parsing is True, check for misplacement of later vs basic
316 -- declarations in Ada 83. If During_Parsing is False, and the SPARK
317 -- restriction is set, do the same: although SPARK 95 removes the
318 -- distinction between initial and later declarative items, the distinction
319 -- remains in the Examiner (JB01-005). Note that the Examiner does not
320 -- count package declarations in later declarative items.
323 -- Check whether Ent denotes an entity declared in an uplevel scope, which
324 -- is accessed inside a nested procedure, and set Has_Up_Level_Access flag
325 -- accordingly. This is currently only enabled for VM_Target /= No_VM.
328 -- Determine whether object or state Id introduces a hidden state. If this
329 -- is the case, emit an error.
332 -- N is one of the statement forms that is a potentially blocking
333 -- operation. If it appears within a protected action, emit warning.
335 procedure Check_Result_And_Post_State
338 -- Determine whether pragma Prag mentions attribute 'Result and whether
339 -- the pragma contains an expression that evaluates differently in pre-
340 -- and post-state. Prag is a [refined] postcondition or a contract-cases
341 -- pragma. Result_Seen is set when the pragma mentions attribute 'Result.
343 procedure Check_Unprotected_Access
346 -- Check whether the expression is a pointer to a protected component,
347 -- and the context is external to the protected operation, to warn against
348 -- a possible unlocked access to data.
350 procedure Collect_Interfaces
355 -- Ada 2005 (AI-251): Collect whole list of abstract interfaces that are
356 -- directly or indirectly implemented by T. Exclude_Parents is used to
357 -- avoid the addition of inherited interfaces to the generated list.
358 -- Use_Full_View is used to collect the interfaces using the full-view
359 -- (if available).
361 procedure Collect_Interface_Components
364 -- Ada 2005 (AI-251): Collect all the tag components associated with the
365 -- secondary dispatch tables of a tagged type.
367 procedure Collect_Interfaces_Info
372 -- Ada 2005 (AI-251): Collect all the interfaces associated with T plus
373 -- the record component and tag associated with each of these interfaces.
374 -- On exit Ifaces_List, Components_List and Tags_List have the same number
375 -- of elements, and elements at the same position on these tables provide
376 -- information on the same interface type.
378 procedure Collect_Parents
382 -- Collect all the parents of Typ. Use_Full_View is used to collect them
383 -- using the full-view of private parents (if available).
386 -- Called upon type derivation and extension. We scan the declarative part
387 -- in which the type appears, and collect subprograms that have one
388 -- subsidiary subtype of the type. These subprograms can only appear after
389 -- the type itself.
391 function Compile_Time_Constraint_Error
397 -- This is similar to Apply_Compile_Time_Constraint_Error in that it
398 -- generates a warning (or error) message in the same manner, but it does
399 -- not replace any nodes. For convenience, the function always returns its
400 -- first argument. The message is a warning if the message ends with ?, or
401 -- we are operating in Ada 83 mode, or the Warn parameter is set to True.
404 -- Sets the Has_Delayed_Freeze flag of New if the Delayed_Freeze flag of
405 -- Old is set and Old has no yet been Frozen (i.e. Is_Frozen is false).
408 -- Determine whether pragma Prag contains a reference to the entity of an
409 -- abstract state with a visible refinement. Prag must denote one of the
410 -- following pragmas:
411 -- Depends
412 -- Global
415 -- Utility to create a parameter profile for a new subprogram spec, when
416 -- the subprogram has a body that acts as spec. This is done for some cases
417 -- of inlining, and for private protected ops. Also used to create bodies
418 -- for stubbed subprograms.
420 function Copy_Component_List
423 -- Copy components from record type R_Typ that come from source. Used to
424 -- create a new compatible record type. Loc is the source location assigned
425 -- to the created nodes.
428 -- If a type is a generic actual type, return the corresponding formal in
429 -- the generic parent unit. There is no direct link in the tree for this
430 -- attribute, except in the case of formal private and derived types.
431 -- Possible optimization???
435 -- Find the currently visible definition for a given identifier, that is to
436 -- say the first entry in the visibility chain for the Chars of N.
439 -- Find whether there is a previous definition for identifier N in the
440 -- current scope. Because declarations for a scope are not necessarily
441 -- contiguous (e.g. for packages) the first entry on the visibility chain
442 -- for N is not necessarily in the current scope.
445 -- Get entity representing current scope
448 -- Returns current enclosing subprogram. If Current_Scope is a subprogram,
449 -- then that is what is returned, otherwise the Enclosing_Subprogram of the
450 -- Current_Scope is returned. The returned value is Empty if this is called
451 -- from a library package which is not within any subprogram.
454 -- Same as Type_Access_Level, except that if the type is the type of an Ada
455 -- 2012 stand-alone object of an anonymous access type, then return the
456 -- static accesssibility level of the object. In that case, the dynamic
457 -- accessibility level of the object may take on values in a range. The low
458 -- bound of of that range is returned by Type_Access_Level; this function
459 -- yields the high bound of that range. Also differs from Type_Access_Level
460 -- in the case of a descendant of a generic formal type (returns Int'Last
461 -- instead of 0).
464 -- Given a declaration N, returns the associated defining entity. If the
465 -- declaration has a specification, the entity is obtained from the
466 -- specification. If the declaration has a defining unit name, then the
467 -- defining entity is obtained from the defining unit name ignoring any
468 -- child unit prefixes.
469 --
470 -- Iterator loops also have a defining entity, which holds the list of
471 -- local entities declared during loop expansion. These entities need
472 -- debugging information, generated through QUalify_Entity_Names, and
473 -- the loop declaration must be placed in the table Name_Qualify_Units.
475 function Denotes_Discriminant
478 -- Returns True if node N is an Entity_Name node for a discriminant. If the
479 -- flag Check_Concurrent is true, function also returns true when N denotes
480 -- the discriminal of the discriminant of a concurrent type. This is needed
481 -- to disable some optimizations on private components of protected types,
482 -- and constraint checks on entry families constrained by discriminants.
485 -- Detect suspicious overlapping between actuals in a call, when both are
486 -- writable (RM 2012 6.4.1(6.4/3))
489 -- Functions to detect suspicious overlapping between actuals in a call,
490 -- when one of them is writable. The predicates are those proposed in
491 -- AI05-0144, to detect dangerous order dependence in complex calls.
492 -- I would add a parameter Warn which enables more extensive testing of
493 -- cases as we find appropriate when we are only warning ??? Or perhaps
494 -- return an indication of (Error, Warn, OK) ???
497 -- Returns True if node N denotes a single variable without parentheses
500 -- Returns True if N denotes a discriminant or if N is a range, a subtype
501 -- indication or a scalar subtype where one of the bounds is a
502 -- discriminant.
504 function Designate_Same_Unit
507 -- Return true if Name1 and Name2 designate the same unit name; each of
508 -- these names is supposed to be a selected component name, an expanded
509 -- name, a defining program unit name or an identifier.
512 -- Expr should be an expression of an access type. Builds an integer
513 -- literal except in cases involving anonymous access types where
514 -- accessibility levels are tracked at runtime (access parameters and Ada
515 -- 2012 stand-alone objects).
518 -- Same as Einfo.Extra_Accessibility except thtat object renames
519 -- are looked through.
522 -- Given the entity of an abstract state or a variable, determine whether
523 -- Id is subject to external property Effective_Reads and if it is, the
524 -- related expression evaluates to True.
527 -- Given the entity of an abstract state or a variable, determine whether
528 -- Id is subject to external property Effective_Writes and if it is, the
529 -- related expression evaluates to True.
532 -- Returns the enclosing N_Compilation_Unit Node that is the root of a
533 -- subtree containing N.
536 -- Returns the closest ancestor of Typ that is a CPP type.
538 function Enclosing_Generic_Body
540 -- Returns the Node_Id associated with the innermost enclosing generic
541 -- body, if any. If none, then returns Empty.
543 function Enclosing_Generic_Unit
545 -- Returns the Node_Id associated with the innermost enclosing generic
546 -- unit, if any. If none, then returns Empty.
548 function Enclosing_Lib_Unit_Entity
550 -- Returns the entity of enclosing library unit node which is the
551 -- root of the current scope (which must not be Standard_Standard, and the
552 -- caller is responsible for ensuring this condition) or other specified
553 -- entity.
556 -- Utility function to return the Ada entity of the package enclosing
557 -- the entity E, if any. Returns Empty if no enclosing package.
560 -- Utility function to return the Ada entity of the subprogram enclosing
561 -- the entity E, if any. Returns Empty if no enclosing subprogram.
564 -- Make sure a freeze node is allocated for entity E. If necessary, build
565 -- and initialize a new freeze node and set Has_Delayed_Freeze True for E.
568 -- Insert new name in symbol table of current scope with check for
569 -- duplications (error message is issued if a conflict is found).
570 -- Note: Enter_Name is not used for overloadable entities, instead these
571 -- are entered using Sem_Ch6.Enter_Overloadable_Entity.
574 -- Return the entity of N or Empty. If N is a renaming, return the entity
575 -- of the root renamed object.
578 -- This procedure is called after issuing a message complaining about an
579 -- inappropriate use of limited type T. If useful, it adds additional
580 -- continuation lines to the message explaining why type T is limited.
581 -- Messages are placed at node N.
585 -- Extensions_Visible does not yield a mode when SPARK_Mode is off. This
586 -- value acts as a default in a non-SPARK compilation.
588 Extensions_Visible_False,
589 -- A value of "False" signifies that Extensions_Visible is either
590 -- missing or the pragma is present and the value of its Boolean
591 -- expression is False.
593 Extensions_Visible_True);
594 -- A value of "True" signifies that Extensions_Visible is present and
595 -- the value of its Boolean expression is True.
597 function Extensions_Visible_Status
599 -- Given the entity of a subprogram or formal parameter subject to pragma
600 -- Extensions_Visible, return the Boolean value denoted by the expression
601 -- of the pragma.
603 procedure Find_Actual
607 -- Determines if the node N is an actual parameter of a function of a
608 -- procedure call. If so, then Formal points to the entity for the formal
609 -- (Ekind is E_In_Parameter, E_Out_Parameter, or E_In_Out_Parameter) and
610 -- Call is set to the node for the corresponding call. If the node N is not
611 -- an actual parameter then Formal and Call are set to Empty.
614 -- Find specific type of a class-wide type, and handle the case of an
615 -- incomplete type coming either from a limited_with clause or from an
616 -- incomplete type declaration. If resulting type is private return its
617 -- full view.
619 function Find_Body_Discriminal
621 -- Given a discriminant of the record type that implements a task or
622 -- protected type, return the discriminal of the corresponding discriminant
623 -- of the actual concurrent type.
625 function Find_Corresponding_Discriminant
628 -- Because discriminants may have different names in a generic unit and in
629 -- an instance, they are resolved positionally when possible. A reference
630 -- to a discriminant carries the discriminant that it denotes when it is
631 -- analyzed. Subsequent uses of this id on a different type denotes the
632 -- discriminant at the same position in this new type.
635 -- Given an arbitrary entity, try to find the nearest enclosing iterator
636 -- loop. If such a loop is found, return the entity of its identifier (the
637 -- E_Loop scope), otherwise return Empty.
640 -- Find the nested loop statement in a conditional block. Loops subject to
641 -- attribute 'Loop_Entry are transformed into blocks. Parts of the original
642 -- loop are nested within the block.
644 procedure Find_Overlaid_Entity
648 -- The node N should be an address representation clause. Determines if
649 -- the target expression is the address of an entity with an optional
650 -- offset. If so, set Ent to the entity and, if there is an offset, set
651 -- Off to True, otherwise to False. If N is not an address representation
652 -- clause, or if it is not possible to determine that the address is of
653 -- this form, then set Ent to Empty.
656 -- Return the type of formal parameter Param as determined by its
657 -- specification.
659 -- The following type describes the placement of an arbitrary entity with
660 -- respect to SPARK visible / hidden state space.
664 -- An entity is not in the visible, private or body state space when
665 -- the immediate enclosing construct is not a package.
667 Visible_State_Space,
668 -- An entity is in the visible state space when it appears immediately
669 -- within the visible declarations of a package or when it appears in
670 -- the visible state space of a nested package which in turn is declared
671 -- in the visible declarations of an enclosing package:
673 -- package Pack is
674 -- Visible_Variable : ...
675 -- package Nested
676 -- with Abstract_State => Visible_State
677 -- is
678 -- Visible_Nested_Variable : ...
679 -- end Nested;
680 -- end Pack;
682 -- Entities associated with a package instantiation inherit the state
683 -- space from the instance placement:
685 -- generic
686 -- package Gen is
687 -- Generic_Variable : ...
688 -- end Gen;
690 -- with Gen;
691 -- package Pack is
692 -- package Inst is new Gen;
693 -- -- Generic_Variable is in the visible state space of Pack
694 -- end Pack;
696 Private_State_Space,
697 -- An entity is in the private state space when it appears immediately
698 -- within the private declarations of a package or when it appears in
699 -- the visible state space of a nested package which in turn is declared
700 -- in the private declarations of an enclosing package:
702 -- package Pack is
703 -- private
704 -- Private_Variable : ...
705 -- package Nested
706 -- with Abstract_State => Private_State
707 -- is
708 -- Private_Nested_Variable : ...
709 -- end Nested;
710 -- end Pack;
712 -- The same placement principle applies to package instantiations
714 Body_State_Space);
715 -- An entity is in the body state space when it appears immediately
716 -- within the declarations of a package body or when it appears in the
717 -- visible state space of a nested package which in turn is declared in
718 -- the declarations of an enclosing package body:
720 -- package body Pack is
721 -- Body_Variable : ...
722 -- package Nested
723 -- with Abstract_State => Body_State
724 -- is
725 -- Body_Nested_Variable : ...
726 -- end Nested;
727 -- end Pack;
729 -- The same placement principle applies to package instantiations
731 procedure Find_Placement_In_State_Space
735 -- Determine the state space placement of an item. Item_Id denotes the
736 -- entity of an abstract state, variable or package instantiation.
737 -- Placement captures the precise placement of the item in the enclosing
738 -- state space. If the state space is that of a package, Pack_Id denotes
739 -- its entity, otherwise Pack_Id is Empty.
742 -- N is a case statement whose expression is a compile-time value.
743 -- Determine the alternative chosen, so that the code of non-selected
744 -- alternatives, and the warnings that may apply to them, are removed.
747 -- Node is an N_Function_Call or N_Procedure_Call_Statement node. The
748 -- result returned is the first actual parameter in declaration order
749 -- (not the order of parameters as they appeared in the source, which
750 -- can be quite different as a result of the use of named parameters).
751 -- Empty is returned for a call with no parameters. The procedure for
752 -- iterating through the actuals in declaration order is to use this
753 -- function to find the first actual, and then use Next_Actual to obtain
754 -- the next actual in declaration order. Note that the value returned
755 -- is always the expression (not the N_Parameter_Association nodes,
756 -- even if named association is used).
758 procedure Gather_Components
764 -- The purpose of this procedure is to gather the valid components in a
765 -- record type according to the values of its discriminants, in order to
766 -- validate the components of a record aggregate.
767 --
768 -- Typ is the type of the aggregate when its constrained discriminants
769 -- need to be collected, otherwise it is Empty.
770 --
771 -- Comp_List is an N_Component_List node.
772 --
773 -- Governed_By is a list of N_Component_Association nodes, where each
774 -- choice list contains the name of a discriminant and the expression
775 -- field gives its value. The values of the discriminants governing
776 -- the (possibly nested) variant parts in Comp_List are found in this
777 -- Component_Association List.
778 --
779 -- Into is the list where the valid components are appended. Note that
780 -- Into need not be an Empty list. If it's not, components are attached
781 -- to its tail.
782 --
783 -- Report_Errors is set to True if the values of the discriminants are
784 -- non-static.
785 --
786 -- This procedure is also used when building a record subtype. If the
787 -- discriminant constraint of the subtype is static, the components of the
788 -- subtype are only those of the variants selected by the values of the
789 -- discriminants. Otherwise all components of the parent must be included
790 -- in the subtype for semantic analysis.
793 -- Given a node for an expression, obtain the actual subtype of the
794 -- expression. In the case of a parameter where the formal is an
795 -- unconstrained array or discriminated type, this will be the previously
796 -- constructed subtype of the actual. Note that this is not quite the
797 -- "Actual Subtype" of the RM, since it is always a constrained type, i.e.
798 -- it is the subtype of the value of the actual. The actual subtype is also
799 -- returned in other cases where it has already been constructed for an
800 -- object. Otherwise the expression type is returned unchanged, except for
801 -- the case of an unconstrained array type, where an actual subtype is
802 -- created, using Insert_Actions if necessary to insert any associated
803 -- actions.
806 -- This is like Get_Actual_Subtype, except that it never constructs an
807 -- actual subtype. If an actual subtype is already available, i.e. the
808 -- Actual_Subtype field of the corresponding entity is set, then it is
809 -- returned. Otherwise the Etype of the node is returned.
812 -- Return the body node for a stub (subprogram or package)
814 function Get_Cursor_Type
817 -- Find Cursor type in scope of formal container Typ, by locating primitive
818 -- operation First. For use in resolving the other primitive operations
819 -- of an Iterable type and expanding loops and quantified expressions
820 -- over formal containers.
823 -- This is used to construct the string literal node representing a
824 -- default external name, i.e. one that is constructed from the name of an
825 -- entity, or (in the case of extended DEC import/export pragmas, an
826 -- identifier provided as the external name. Letters in the name are
827 -- according to the setting of Opt.External_Name_Default_Casing.
830 -- If expression N references a part of an object, return this object.
831 -- Otherwise return Empty. Expression N should have been resolved already.
834 -- Return the Ensures component of Test_Case pragma N, or Empty otherwise
835 -- Bad name now that this no longer applies to Contract_Case ???
838 -- Returns the true generic entity in an instantiation. If the name in the
839 -- instantiation is a renaming, the function returns the renamed generic.
842 -- Implements the notion introduced ever-so briefly in RM 7.3.1 (5.2/3):
843 -- in a child unit a derived type is within the derivation class of an
844 -- ancestor declared in a parent unit, even if there is an intermediate
845 -- derivation that does not see the full view of that ancestor.
848 -- This procedure assigns to L and H respectively the values of the low and
849 -- high bounds of node N, which must be a range, subtype indication, or the
850 -- name of a scalar subtype. The result in L, H may be set to Error if
851 -- there was an earlier error in the range.
853 function Get_Enum_Lit_From_Pos
857 -- This function returns an identifier denoting the E_Enumeration_Literal
858 -- entity for the specified value from the enumeration type or subtype T.
859 -- The second argument is the Pos value, which is assumed to be in range.
860 -- The third argument supplies a source location for constructed nodes
861 -- returned by this function.
863 function Get_Iterable_Type_Primitive
866 -- Retrieve one of the primitives First, Next, Has_Element, Element from
867 -- the value of the Iterable aspect of a formal type.
870 -- Retrieve the fully expanded name of the library unit declared by
871 -- Decl_Node into the name buffer.
875 -- An entity value is associated with each name in the name table. The
876 -- Get_Name_Entity_Id function fetches the Entity_Id of this entity, which
877 -- is the innermost visible entity with the given name. See the body of
878 -- Sem_Ch8 for further details on handling of entity visibility.
881 -- Return the Name component of Test_Case pragma N
882 -- Bad name now that this no longer applies to Contract_Case ???
885 -- Get defining entity of parent unit of a child unit. In most cases this
886 -- is the defining entity of the unit, but for a child instance whose
887 -- parent needs a body for inlining, the instantiation node of the parent
888 -- has not yet been rewritten as a package declaration, and the entity has
889 -- to be retrieved from the Instance_Spec of the unit.
893 -- Obtains the Pragma_Id from the Chars field of Pragma_Identifier (N)
896 -- Recursive routine to analyze reason argument for pragma Warnings. The
897 -- value of the reason argument is appended to the current string using
898 -- Store_String_Chars. The reason argument is expected to be a string
899 -- literal or concatenation of string literals. An error is given for
900 -- any other form.
903 -- Given a node, return the renamed object if the node represents a renamed
904 -- object, otherwise return the node unchanged. The node may represent an
905 -- arbitrary expression.
908 -- Given an entity for an exception, package, subprogram or generic unit,
909 -- returns the ultimately renamed entity if this is a renaming. If this is
910 -- not a renamed entity, returns its argument. It is an error to call this
911 -- with any other kind of entity.
914 -- Return the Requires component of Test_Case pragma N, or Empty otherwise
915 -- Bad name now that this no longer applies to Contract_Case ???
918 -- Nod is either a procedure call statement, or a function call, or an
919 -- accept statement node. This procedure finds the Entity_Id of the related
920 -- subprogram or entry and returns it, or if no subprogram can be found,
921 -- returns Empty.
924 -- Given the entity for a subprogram (E_Function or E_Procedure), return
925 -- the corresponding N_Subprogram_Body node. If the corresponding body
926 -- is missing (as for an imported subprogram), return Empty.
930 -- Given an entity for a task type or subtype, retrieves the
931 -- Task_Body_Procedure field from the corresponding task type declaration.
934 -- Returns true if type or subtype T is an access type, or has a component
935 -- (at any recursive level) that is an access type. This is a conservative
936 -- predicate, if it is not known whether or not T contains access values
937 -- (happens for generic formals in some cases), then False is returned.
938 -- Note that tagged types return False. Even though the tag is implemented
939 -- as an access type internally, this function tests only for access types
940 -- known to the programmer. See also Has_Tagged_Component.
943 -- Simple predicate to test for defaulted discriminants
946 -- Result of Has_Compatible_Alignment test, description found below. Note
947 -- that the values are arranged in increasing order of problematicness.
949 function Has_Compatible_Alignment
952 -- Obj is an object entity, and expr is a node for an object reference. If
953 -- the alignment of the object referenced by Expr is known to be compatible
954 -- with the alignment of Obj (i.e. is larger or the same), then the result
955 -- is Known_Compatible. If the alignment of the object referenced by Expr
956 -- is known to be less than the alignment of Obj, then Known_Incompatible
957 -- is returned. If neither condition can be reliably established at compile
958 -- time, then Unknown is returned. This is used to determine if alignment
959 -- checks are required for address clauses, and also whether copies must
960 -- be made when objects are passed by reference.
961 --
962 -- Note: Known_Incompatible does not mean that at run time the alignment
963 -- of Expr is known to be wrong for Obj, just that it can be determined
964 -- that alignments have been explicitly or implicitly specified which are
965 -- incompatible (whereas Unknown means that even this is not known). The
966 -- appropriate reaction of a caller to Known_Incompatible is to treat it as
967 -- Unknown, but issue a warning that there may be an alignment error.
970 -- Determines if the node can have declarations
973 -- Determines if the floating-point type E supports denormal numbers.
974 -- Returns False if E is not a floating-point type.
976 function Has_Discriminant_Dependent_Constraint
978 -- Returns True if and only if Comp has a constrained subtype that depends
979 -- on a discriminant.
982 -- Determines if the range of the floating-point type E includes
983 -- infinities. Returns False if E is not a floating-point type.
985 function Has_Interfaces
988 -- Where T is a concurrent type or a record type, returns true if T covers
989 -- any abstract interface types. In case of private types the argument
990 -- Use_Full_View controls if the check is done using its full view (if
991 -- available).
994 -- This is a simple minded function for determining whether an expression
995 -- has no obvious side effects. It is used only for determining whether
996 -- warnings are needed in certain situations, and is not guaranteed to
997 -- be accurate in either direction. Exceptions may mean an expression
998 -- does in fact have side effects, but this may be ignored and True is
999 -- returned, or a complex expression may in fact be side effect free
1000 -- but we don't recognize it here and return False. The Side_Effect_Free
1001 -- routine in Remove_Side_Effects is much more extensive and perhaps could
1002 -- be shared, so that this routine would be more accurate.
1005 -- Determine whether node N has a null exclusion
1008 -- Predicate to determine whether a controlled type has a user-defined
1009 -- Initialize primitive (and, in Ada 2012, whether that primitive is
1010 -- non-null), which causes the type to not have preelaborable
1011 -- initialization.
1014 -- Return True iff type E has preelaborable initialization as defined in
1015 -- Ada 2005 (see AI-161 for details of the definition of this attribute).
1018 -- Check if a type has a (sub)component of a private type that has not
1019 -- yet received a full declaration.
1022 -- Determines if the floating-point type E supports signed zeros.
1023 -- Returns False if E is not a floating-point type.
1026 -- Return whether an array type has static bounds
1029 -- Tests if type T is derived from Ada.Streams.Root_Stream_Type, or in the
1030 -- case of a composite type, has a component for which this predicate is
1031 -- True, and if so returns True. Otherwise a result of False means that
1032 -- there is no Stream type in sight. For a private type, the test is
1033 -- applied to the underlying type (or returns False if there is no
1034 -- underlying type).
1037 -- Returns true if the last character of E is Suffix. Used in Assertions.
1040 -- Returns the name of E adding Suffix
1043 -- Returns the name of E without Suffix
1046 -- Returns True if Typ is a composite type (array or record) which is
1047 -- either itself a tagged type, or has a component (recursively) which is
1048 -- a tagged type. Returns False for non-composite type, or if no tagged
1049 -- component is present. This function is used to check if "=" has to be
1050 -- expanded into a bunch component comparisons.
1053 -- Given an arbitrary type, determine whether it contains at least one
1054 -- volatile component.
1057 -- Subp is a subprogram marked with pragma Implemented. Return the specific
1058 -- implementation requirement which the pragma imposes. The return value is
1059 -- either Name_By_Any, Name_By_Entry or Name_By_Protected_Procedure.
1061 function Implements_Interface
1065 -- Returns true if the Typ_Ent implements interface Iface_Ent
1068 -- Determine whether an arbitrary node appears in a pragma that acts as an
1069 -- assertion expression. See Sem_Prag for the list of qualifying pragmas.
1072 -- Returns True if the current scope is within a generic instance
1075 -- Returns True if current scope is within the body of an instance, where
1076 -- several semantic checks (e.g. accessibility checks) are relaxed.
1079 -- Returns True if current scope is with the private part or the body of
1080 -- an instance. Other semantic checks are suppressed in this context.
1083 -- Returns True if current scope is within the visible part of a package
1084 -- instance, where several additional semantic checks apply.
1087 -- Returns True if current scope is within a package body
1090 -- Returns True if node N belongs to a parameter specification
1093 -- Returns true if the expression N occurs within a pragma with name Nam
1096 -- Returns True if N denotes a component or subcomponent in a record or
1097 -- array that has Reverse_Storage_Order.
1100 -- Determines if the current scope is within a subprogram compilation unit
1101 -- (inside a subprogram declaration, subprogram body, or generic subprogram
1102 -- declaration) or within a task or protected body. The test is for
1103 -- appearing anywhere within such a construct (that is it does not need
1104 -- to be directly within).
1107 -- Determine whether a declaration occurs within the visible part of a
1108 -- package specification. The package must be on the scope stack, and the
1109 -- corresponding private part must not.
1112 -- Given the entity of a constant or a type, retrieve the incomplete or
1113 -- partial view of the same entity. Note that Id may not have a partial
1114 -- view in which case the function returns Empty.
1117 -- Inherit the default initial condition procedure from the parent type of
1118 -- derived type Typ.
1121 -- Inherit the rep item chain of type From_Typ without clobbering any
1122 -- existing rep items on Typ's chain. Typ is the destination type.
1124 procedure Inherit_Subprogram_Contract
1127 -- Inherit relevant contract items from source subprogram From_Subp. Subp
1128 -- denotes the destination subprogram. The inherited items are:
1129 -- Extensions_Visible
1130 -- ??? it would be nice if this routine handles Pre'Class and Post'Class
1133 -- In a context that requires a composite or subprogram type and where a
1134 -- prefix is an access type, rewrite the access type node N (which is the
1135 -- prefix, e.g. of an indexed component) as an explicit dereference.
1138 -- Examine all deferred constants in the declaration list Decls and check
1139 -- whether they have been completed by a full constant declaration or an
1140 -- Import pragma. Emit the error message if that is not the case.
1143 -- Determines if N is an actual parameter of out mode in a subprogram call
1146 -- Determines if N is an actual parameter in a subprogram call
1149 -- Determines if N is an actual parameter of a formal of tagged type in a
1150 -- subprogram call.
1153 -- Determine if Obj is an aliased view, i.e. the name of an object to which
1154 -- 'Access or 'Unchecked_Access can apply. Note that this routine uses the
1155 -- rules of the language, it does not take into account the restriction
1156 -- No_Implicit_Aliasing, so it can return True if the restriction is active
1157 -- and Obj violates the restriction. The caller is responsible for calling
1158 -- Restrict.Check_No_Implicit_Aliasing if True is returned, but there is a
1159 -- requirement for obeying the restriction in the call context.
1161 function Is_Ancestor_Package
1164 -- Determine whether package E1 is an ancestor of E2
1167 -- Determines if the given node denotes an atomic object in the sense of
1168 -- the legality checks described in RM C.6(12).
1171 -- Determine whether node N denotes attribute 'Result
1174 -- Determine whether node N denotes a body or a package declaration
1177 -- True if T is a bounded string type. Used to make sure "=" composes
1178 -- properly for bounded string types.
1181 -- Exp is the expression for an array bound. Determines whether the
1182 -- bound is a compile-time known value, or a constant entity, or an
1183 -- enumeration literal, or an expression composed of constant-bound
1184 -- subexpressions which are evaluated by means of standard operators.
1187 -- This routine recognizes expressions that denote an element of one of
1188 -- the predefined containers, when the source only contains an indexing
1189 -- operation and an implicit dereference is inserted by the compiler.
1190 -- In the absence of this optimization, the indexing creates a temporary
1191 -- controlled cursor that sets the tampering bit of the container, and
1192 -- restricts the use of the convenient notation C (X) to contexts that
1193 -- do not check the tampering bit (e.g. C.Include (X, C (Y)). Exp is an
1194 -- explicit dereference. The transformation applies when it has the form
1195 -- F (X).Discr.all.
1197 function Is_Controlling_Limited_Procedure
1199 -- Ada 2005 (AI-345): Determine whether Proc_Nam is a primitive procedure
1200 -- of a limited interface with a controlling first parameter.
1203 -- Returns True if N is a call to a CPP constructor
1205 function Is_Child_Or_Sibling
1208 -- Determine the following relations between two arbitrary packages:
1209 -- 1) One package is the parent of a child package
1210 -- 2) Both packages are siblings and share a common parent
1213 -- First determine whether type T is an interface and then check whether
1214 -- it is of protected, synchronized or task kind.
1217 -- Returns true if type T represents a delegate. A Delegate is the CIL
1218 -- object used to represent access-to-subprogram types. This is only
1219 -- relevant to CIL, will always return false for other targets.
1221 function Is_Dependent_Component_Of_Mutable_Object
1223 -- Returns True if Object is the name of a subcomponent that depends on
1224 -- discriminants of a variable whose nominal subtype is unconstrained and
1225 -- not indefinite, and the variable is not aliased. Otherwise returns
1226 -- False. The nodes passed to this function are assumed to denote objects.
1229 -- N is a subexpression node of an access type. This function returns true
1230 -- if N appears as the prefix of a node that does a dereference of the
1231 -- access value (selected/indexed component, explicit dereference or a
1232 -- slice), and false otherwise.
1235 -- Returns True if type T1 is a descendent of type T2, and false otherwise.
1236 -- This is the RM definition, a type is a descendent of another type if it
1237 -- is the same type or is derived from a descendent of the other type.
1240 -- The SPARK property "effectively volatile" applies to both types and
1241 -- objects. To qualify as such, an entity must be either volatile or be
1242 -- (of) an array type subject to aspect Volatile_Components.
1245 -- Determine whether an arbitrary node denotes an effectively volatile
1246 -- object.
1249 -- Predicate to determine whether a scope entity comes from a rewritten
1250 -- expression function call, and should be inlined unconditionally. Also
1251 -- used to determine that such a call does not constitute a freeze point.
1254 -- Determine whether node N denotes a reference to a formal parameter of
1255 -- a specific tagged type whose related subprogram is subject to pragma
1256 -- Extensions_Visible with value "False". Several other constructs fall
1257 -- under this category:
1258 -- 1) A qualified expression whose operand is EVF
1259 -- 2) A type conversion whose operand is EVF
1260 -- 3) An if expression with at least one EVF dependent_expression
1261 -- 4) A case expression with at least one EVF dependent_expression
1265 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
1266 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
1267 -- if it is False (i.e. zero).
1270 -- Returns True iff the number U is a model number of the fixed-point type
1271 -- T, i.e. if it is an exact multiple of Small.
1274 -- Typ is a type entity. This function returns true if this type is fully
1275 -- initialized, meaning that an object of the type is fully initialized.
1276 -- Note that initialization resulting from use of pragma Normalized_Scalars
1277 -- does not count. Note that this is only used for the purpose of issuing
1278 -- warnings for objects that are potentially referenced uninitialized. This
1279 -- means that the result returned is not crucial, but should err on the
1280 -- side of thinking things are fully initialized if it does not know.
1283 -- Determine whether entity Id is Ghost. To qualify as such, the entity
1284 -- must be subject to Convention Ghost.
1287 -- Determine whether statement or pragma N is ghost. To qualify as such, N
1288 -- must either
1289 -- 1) Occur within a ghost subprogram or package
1290 -- 2) Denote a call to a ghost procedure
1291 -- 3) Denote an assignment statement whose target is a ghost variable
1292 -- 4) Denote a pragma that mentions a ghost entity
1295 -- E is a subprogram. Return True is E is an implicit operation inherited
1296 -- by a derived type declaration.
1298 function Is_Inherited_Operation_For_Type
1301 -- E is a subprogram. Return True is E is an implicit operation inherited
1302 -- by the derived type declaration for type Typ.
1305 -- AI05-0139-2: Check whether Typ is one of the predefined interfaces in
1306 -- Ada.Iterator_Interfaces, or it is derived from one.
1310 -- Returns Yes if N is definitely used as Name in an assignment statement.
1311 -- Returns No if N is definitely NOT used as a Name in an assignment
1312 -- statement. Returns Unknown if we can't tell at this stage (happens in
1313 -- the case where we don't know the type of N yet, and we have something
1314 -- like N.A := 3, where this counts as N being used on the left side of
1315 -- an assignment only if N is not an access type. If it is an access type
1316 -- then it is N.all.A that is assigned, not N.
1319 -- A library-level declaration is one that is accessible from Standard,
1320 -- i.e. a library unit or an entity declared in a library package.
1323 -- Determine whether a given type is a limited class-wide type, in which
1324 -- case it needs a Master_Id, because extensions of its designated type
1325 -- may include task components. A class-wide type that comes from a
1326 -- limited view must be treated in the same way.
1329 -- Determines whether Expr is a reference to a variable or IN OUT mode
1330 -- parameter of the current enclosing subprogram.
1331 -- Why are OUT parameters not considered here ???
1334 -- Determines if the tree referenced by N represents an object. Both
1335 -- variable and constant objects return True (compare Is_Variable).
1338 -- Used to test if AV is an acceptable formal for an OUT or IN OUT formal.
1339 -- Note that the Is_Variable function is not quite the right test because
1340 -- this is a case in which conversions whose expression is a variable (in
1341 -- the Is_Variable sense) with an untagged type target are considered view
1342 -- conversions and hence variables.
1344 function Is_Partially_Initialized_Type
1347 -- Typ is a type entity. This function returns true if this type is partly
1348 -- initialized, meaning that an object of the type is at least partly
1349 -- initialized (in particular in the record case, that at least one
1350 -- component has an initialization expression). Note that initialization
1351 -- resulting from the use of pragma Normalized_Scalars does not count.
1352 -- Include_Implicit controls whether implicit initialization of access
1353 -- values to null, and of discriminant values, is counted as making the
1354 -- type be partially initialized. For the default setting of True, these
1355 -- implicit cases do count, and discriminated types or types containing
1356 -- access values not explicitly initialized will return True. Otherwise
1357 -- if Include_Implicit is False, these cases do not count as making the
1358 -- type be partially initialized.
1361 -- Predicate to implement definition given in RM 6.1.1 (20/3)
1364 -- Determines if type T is a potentially persistent type. A potentially
1365 -- persistent type is defined (recursively) as a scalar type, an untagged
1366 -- record whose components are all of a potentially persistent type, or an
1367 -- array with all static constraints whose component type is potentially
1368 -- persistent. A private type is potentially persistent if the full type
1369 -- is potentially persistent.
1372 -- Return True if node N denotes a protected type name which represents
1373 -- the current instance of a protected object according to RM 9.4(21/2).
1376 -- Return True if a compilation unit is the specification or the
1377 -- body of a remote call interface package.
1380 -- Return True if E is a remote access-to-class-wide type
1383 -- Return True if E is a remote access to subprogram type
1386 -- Return True if N denotes a potentially remote call
1389 -- Return True if Proc_Nam is a procedure renaming of an entry
1392 -- AI05-0139-2: Check whether Typ is derived from the predefined interface
1393 -- Ada.Iterator_Interfaces.Reversible_Iterator.
1396 -- Given an N_Identifier node N, determines if it is a Selector_Name.
1397 -- As described in Sinfo, Selector_Names are special because they
1398 -- represent use of the N_Identifier node for a true identifier, when
1399 -- normally such nodes represent a direct name.
1402 -- Determines if the tree referenced by N represents an initialization
1403 -- expression in SPARK 2005, suitable for initializing an object in an
1404 -- object declaration.
1407 -- Determines if the tree referenced by N represents an object in SPARK
1408 -- 2005. This differs from Is_Object_Reference in that only variables,
1409 -- constants, formal parameters, and selected_components of those are
1410 -- valid objects in SPARK 2005.
1413 -- Determine whether an arbitrary [private] type is specifically tagged
1417 -- Check if the node N is a statement node. Note that this includes
1418 -- the case of procedure call statements (unlike the direct use of
1419 -- the N_Statement_Other_Than_Procedure_Call subtype from Sinfo).
1420 -- Note that a label is *not* a statement, and will return False.
1423 -- Determine whether declarative node N is subject to aspect or pragma
1424 -- Ghost. Use this routine in cases where [source] pragma Ghost has not
1425 -- been analyzed yet, but the context needs to establish the "ghostness"
1426 -- of N.
1428 function Is_Subprogram_Stub_Without_Prior_Declaration
1430 -- Return True if N is a subprogram stub with no prior subprogram
1431 -- declaration.
1434 -- Returns True if E is a synchronized tagged type (AARM 3.9.4 (6/2))
1437 -- Returns True if the node N is a statement which is known to cause an
1438 -- unconditional transfer of control at runtime, i.e. the following
1439 -- statement definitely will not be executed.
1443 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
1444 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
1445 -- if it is True (i.e. non-zero).
1448 -- Determine whether an arbitrary entity denotes an instance of function
1449 -- Ada.Unchecked_Conversion.
1453 -- True if T is Universal_Integer or Universal_Real
1456 -- Returns true if type T represents a value type. This is only relevant to
1457 -- CIL, will always return false for other targets. A value type is a CIL
1458 -- object that is accessed directly, as opposed to the other CIL objects
1459 -- that are accessed through managed pointers.
1462 -- Returns true if E has variable size components
1465 -- Returns true if E has variable size components
1467 function Is_Variable
1470 -- Determines if the tree referenced by N represents a variable, i.e. can
1471 -- appear on the left side of an assignment. There is one situation (formal
1472 -- parameters) in which untagged type conversions are also considered
1473 -- variables, but Is_Variable returns False for such cases, since it has
1474 -- no knowledge of the context. Note that this is the point at which
1475 -- Assignment_OK is checked, and True is returned for any tree thus marked.
1476 -- Use_Original_Node is used to perform the test on Original_Node (N). By
1477 -- default is True since this routine is commonly invoked as part of the
1478 -- semantic analysis and it must not be disturbed by the rewriten nodes.
1481 -- Check whether T is derived from a visibly controlled type. This is true
1482 -- if the root type is declared in Ada.Finalization. If T is derived
1483 -- instead from a private type whose full view is controlled, an explicit
1484 -- Initialize/Adjust/Finalize subprogram does not override the inherited
1485 -- one.
1488 -- Determines if the given node denotes an volatile object in the sense of
1489 -- the legality checks described in RM C.6(12). Note that the test here is
1490 -- for something actually declared as volatile, not for an object that gets
1491 -- treated as volatile (see Einfo.Treat_As_Volatile).
1494 -- Applies to Itypes. True if the Itype is attached to a declaration for
1495 -- the type through its Parent field, which may or not be present in the
1496 -- tree.
1499 -- This procedure is called to clear all constant indications from all
1500 -- entities in the current scope and in any parent scopes if the current
1501 -- scope is a block or a package (and that recursion continues to the top
1502 -- scope that is not a block or a package). This is used when the
1503 -- sequential flow-of-control assumption is violated (occurrence of a
1504 -- label, head of a loop, or start of an exception handler). The effect of
1505 -- the call is to clear the Current_Value field (but we do not need to
1506 -- clear the Is_True_Constant flag, since that only gets reset if there
1507 -- really is an assignment somewhere in the entity scope). This procedure
1508 -- also calls Kill_All_Checks, since this is a special case of needing to
1509 -- forget saved values. This procedure also clears the Is_Known_Null and
1510 -- Is_Known_Non_Null and Is_Known_Valid flags in variables, constants or
1511 -- parameters since these are also not known to be trustable any more.
1512 --
1513 -- The Last_Assignment_Only flag is set True to clear only Last_Assignment
1514 -- fields and leave other fields unchanged. This is used when we encounter
1515 -- an unconditional flow of control change (return, goto, raise). In such
1516 -- cases we don't need to clear the current values, since it may be that
1517 -- the flow of control change occurs in a conditional context, and if it
1518 -- is not taken, then it is just fine to keep the current values. But the
1519 -- Last_Assignment field is different, if we have a sequence assign-to-v,
1520 -- conditional-return, assign-to-v, we do not want to complain that the
1521 -- second assignment clobbers the first.
1523 procedure Kill_Current_Values
1526 -- This performs the same processing as described above for the form with
1527 -- no argument, but for the specific entity given. The call has no effect
1528 -- if the entity Ent is not for an object. Last_Assignment_Only has the
1529 -- same meaning as for the call with no Ent.
1532 -- Called when an address clause or pragma Import is applied to an entity.
1533 -- If the entity is a variable or a constant, and size check code is
1534 -- present, this size check code is killed, since the object will not be
1535 -- allocated by the program.
1538 -- The node N is an entity reference. This function determines whether the
1539 -- reference is for sure an assignment of the entity, returning True if
1540 -- so. This differs from May_Be_Lvalue in that it defaults in the other
1541 -- direction. Cases which may possibly be assignments but are not known to
1542 -- be may return True from May_Be_Lvalue, but False from this function.
1545 -- HSS is a handled statement sequence. This function returns the last
1546 -- statement in Statements (HSS) that has Comes_From_Source set. If no
1547 -- such statement exists, Empty is returned.
1549 function Matching_Static_Array_Bounds
1552 -- L_Typ and R_Typ are two array types. Returns True when they have the
1553 -- same number of dimensions, and the same static bounds for each index
1554 -- position.
1557 -- Given a node which designates the context of analysis and an origin in
1558 -- the tree, traverse from Root_Nod and mark all allocators as either
1559 -- dynamic or static depending on Context_Nod. Any incorrect marking is
1560 -- cleaned up during resolution.
1563 -- Determines if N could be an lvalue (e.g. an assignment left hand side).
1564 -- An lvalue is defined as any expression which appears in a context where
1565 -- a name is required by the syntax, and the identity, rather than merely
1566 -- the value of the node is needed (for example, the prefix of an Access
1567 -- attribute is in this category). Note that, as implied by the name, this
1568 -- test is conservative. If it cannot be sure that N is NOT an lvalue, then
1569 -- it returns True. It tries hard to get the answer right, but it is hard
1570 -- to guarantee this in all cases. Note that it is more possible to give
1571 -- correct answer if the tree is fully analyzed.
1574 -- Returns True if a function has defaults for all but its first
1575 -- formal. Used in Ada 2005 mode to solve the syntactic ambiguity that
1576 -- results from an indexing of a function call written in prefix form.
1579 -- Copy recursively an analyzed list of nodes. Uses New_Copy_Tree defined
1580 -- below. As for New_Copy_Tree, it is illegal to attempt to copy extended
1581 -- nodes (entities) either directly or indirectly using this function.
1583 function New_Copy_Tree
1588 -- Given a node that is the root of a subtree, Copy_Tree copies the entire
1589 -- syntactic subtree, including recursively any descendents whose parent
1590 -- field references a copied node (descendents not linked to a copied node
1591 -- by the parent field are not copied, instead the copied tree references
1592 -- the same descendent as the original in this case, which is appropriate
1593 -- for non-syntactic fields such as Etype). The parent pointers in the
1594 -- copy are properly set. Copy_Tree (Empty/Error) returns Empty/Error.
1595 -- The one exception to the rule of not copying semantic fields is that
1596 -- any implicit types attached to the subtree are duplicated, so that
1597 -- the copy contains a distinct set of implicit type entities. Thus this
1598 -- function is used when it is necessary to duplicate an analyzed tree,
1599 -- declared in the same or some other compilation unit. This function is
1600 -- declared here rather than in atree because it uses semantic information
1601 -- in particular concerning the structure of itypes and the generation of
1602 -- public symbols.
1604 -- The Map argument, if set to a non-empty Elist, specifies a set of
1605 -- mappings to be applied to entities in the tree. The map has the form:
1606 --
1607 -- old entity 1
1608 -- new entity to replace references to entity 1
1609 -- old entity 2
1610 -- new entity to replace references to entity 2
1611 -- ...
1612 --
1613 -- The call destroys the contents of Map in this case
1614 --
1615 -- The parameter New_Sloc, if set to a value other than No_Location, is
1616 -- used as the Sloc value for all nodes in the new copy. If New_Sloc is
1617 -- set to its default value No_Location, then the Sloc values of the
1618 -- nodes in the copy are simply copied from the corresponding original.
1619 --
1620 -- The Comes_From_Source indication is unchanged if New_Sloc is set to
1621 -- the default No_Location value, but is reset if New_Sloc is given, since
1622 -- in this case the result clearly is neither a source node or an exact
1623 -- copy of a source node.
1624 --
1625 -- The parameter New_Scope, if set to a value other than Empty, is the
1626 -- value to use as the Scope for any Itypes that are copied. The most
1627 -- typical value for this parameter, if given, is Current_Scope.
1629 function New_External_Entity
1637 -- This function creates an N_Defining_Identifier node for an internal
1638 -- created entity, such as an implicit type or subtype, or a record
1639 -- initialization procedure. The entity name is constructed with a call
1640 -- to New_External_Name (Related_Id, Suffix, Suffix_Index, Prefix), so
1641 -- that the generated name may be referenced as a public entry, and the
1642 -- Is_Public flag is set if needed (using Set_Public_Status). If the
1643 -- entity is for a type or subtype, the size/align fields are initialized
1644 -- to unknown (Uint_0).
1646 function New_Internal_Entity
1651 -- This function is similar to New_External_Entity, except that the
1652 -- name is constructed by New_Internal_Name (Id_Char). This is used
1653 -- when the resulting entity does not have to be referenced as a
1654 -- public entity (and in this case Is_Public is not set).
1658 -- Next_Actual (N) is equivalent to N := Next_Actual (N). Note that we
1659 -- inline this procedural form, but not the functional form that follows.
1662 -- Find next actual parameter in declaration order. As described for
1663 -- First_Actual, this is the next actual in the declaration order, not
1664 -- the call order, so this does not correspond to simply taking the
1665 -- next entry of the Parameter_Associations list. The argument is an
1666 -- actual previously returned by a call to First_Actual or Next_Actual.
1667 -- Note that the result produced is always an expression, not a parameter
1668 -- association node, even if named notation was used.
1670 procedure Normalize_Actuals
1675 -- Reorders lists of actuals according to names of formals, value returned
1676 -- in Success indicates success of reordering. For more details, see body.
1677 -- Errors are reported only if Report is set to True.
1680 -- This routine is called if the sub-expression N maybe the target of
1681 -- an assignment (e.g. it is the left side of an assignment, used as
1682 -- an out parameters, or used as prefixes of access attributes). It
1683 -- sets May_Be_Modified in the associated entity if there is one,
1684 -- taking into account the rule that in the case of renamed objects,
1685 -- it is the flag in the renamed object that must be set.
1686 --
1687 -- The parameter Sure is set True if the modification is sure to occur
1688 -- (e.g. target of assignment, or out parameter), and to False if the
1689 -- modification is only potential (e.g. address of entity taken).
1692 -- Return the accessibility level of the view of the object Obj. For
1693 -- convenience, qualified expressions applied to object names are also
1694 -- allowed as actuals for this function.
1697 -- [Ada 2012: AI05-0125-1]: If S is an inherited dispatching primitive S2,
1698 -- or overrides an inherited dispatching primitive S2, the original
1699 -- corresponding operation of S is the original corresponding operation of
1700 -- S2. Otherwise, it is S itself.
1703 -- N is a pragma node or aspect specification node. This function returns
1704 -- the name of the pragma or aspect in original source form, taking into
1705 -- account possible rewrites, and also cases where a pragma comes from an
1706 -- aspect (in such cases, the name can be different from the pragma name,
1707 -- e.g. a Pre aspect generates a Precondition pragma). This also deals with
1708 -- the presence of 'Class, which results in one of the special names
1709 -- Name_uPre, Name_uPost, Name_uInvariant, or Name_uType_Invariant being
1710 -- returned to represent the corresponding aspects with x'Class names.
1713 -- Given a policy, return the policy identifier associated with it. If no
1714 -- such policy is in effect, the value returned is No_Name.
1717 -- Subp is the entity for a subprogram call. This function returns True if
1718 -- predicate tests are required for the arguments in this call (this is the
1719 -- normal case). It returns False for special cases where these predicate
1720 -- tests should be skipped (see body for details).
1723 -- Returns True if the names of both entities correspond with matching
1724 -- primitives. This routine includes support for the case in which one
1725 -- or both entities correspond with entities built by Derive_Subprogram
1726 -- with a special name to avoid being overridden (i.e. return true in case
1727 -- of entities with names "nameP" and "name" or vice versa).
1730 -- Returns some private component (if any) of the given Type_Id.
1731 -- Used to enforce the rules on visibility of operations on composite
1732 -- types, that depend on the full view of the component type. For a
1733 -- record type there may be several such components, we just return
1734 -- the first one.
1736 procedure Process_End_Label
1740 -- N is a node whose End_Label is to be processed, generating all
1741 -- appropriate cross-reference entries, and performing style checks
1742 -- for any identifier references in the end label. Typ is either
1743 -- 'e' or 't indicating the type of the cross-reference entity
1744 -- (e for spec, t for body, see Lib.Xref spec for details). The
1745 -- parameter Ent gives the entity to which the End_Label refers,
1746 -- and to which cross-references are to be generated.
1749 -- Determine whether entity Id is referenced within expression Expr
1752 -- Returns True if the expression Expr contains any references to a
1753 -- generic type. This can only happen within a generic template.
1756 -- Removes E from the homonym chain
1759 -- This is used to construct the second argument in a call to Rep_To_Pos
1760 -- which is Standard_True if range checks are enabled (E is an entity to
1761 -- which the Range_Checks_Suppressed test is applied), and Standard_False
1762 -- if range checks are suppressed. Loc is the location for the node that
1763 -- is returned (which is a New_Occurrence of the appropriate entity).
1764 --
1765 -- Note: one might think that it would be fine to always use True and
1766 -- to ignore the suppress in this case, but it is generally better to
1767 -- believe a request to suppress exceptions if possible, and further
1768 -- more there is at least one case in the generated code (the code for
1769 -- array assignment in a loop) that depends on this suppression.
1772 -- N is a node which should have an entity value if it is an entity name.
1773 -- If not, then check if there were previous errors. If so, just fill
1774 -- in with Any_Id and ignore. Otherwise signal a program error exception.
1775 -- This is used as a defense mechanism against ill-formed trees caused by
1776 -- previous errors (particularly in -gnatq mode).
1778 function Requires_State_Refinement
1781 -- Determine whether a package denoted by its spec and body entities
1782 -- requires refinement of abstract states.
1785 -- Id is a type entity. The result is True when temporaries of this type
1786 -- need to be wrapped in a transient scope to be reclaimed properly when a
1787 -- secondary stack is in use. Examples of types requiring such wrapping are
1788 -- controlled types and variable-sized types including unconstrained
1789 -- arrays.
1792 -- Reset the Analyzed flags in all nodes of the tree whose root is N
1795 -- Set the current SPARK_Mode to whatever Mode denotes. This routime must
1796 -- be used in tandem with Save_SPARK_Mode_And_Set.
1799 -- Return true if Subp is a function that returns an unconstrained type
1802 -- Similar to attribute Root_Type, but this version always follows the
1803 -- Full_View of a private type (if available) while searching for the
1804 -- ultimate derivation ancestor.
1806 function Safe_To_Capture_Value
1810 -- The caller is interested in capturing a value (either the current value,
1811 -- or an indication that the value is non-null) for the given entity Ent.
1812 -- This value can only be captured if sequential execution semantics can be
1813 -- properly guaranteed so that a subsequent reference will indeed be sure
1814 -- that this current value indication is correct. The node N is the
1815 -- construct which resulted in the possible capture of the value (this
1816 -- is used to check if we are in a conditional).
1817 --
1818 -- Cond is used to skip the test for being inside a conditional. It is used
1819 -- in the case of capturing values from if/while tests, which already do a
1820 -- proper job of handling scoping issues without this help.
1821 --
1822 -- The only entities whose values can be captured are OUT and IN OUT formal
1823 -- parameters, and variables unless Cond is True, in which case we also
1824 -- allow IN formals, loop parameters and constants, where we cannot ever
1825 -- capture actual value information, but we can capture conditional tests.
1828 -- Determine if two (possibly expanded) names are the same name. This is
1829 -- a purely syntactic test, and N1 and N2 need not be analyzed.
1832 -- Determine if Node1 and Node2 are known to designate the same object.
1833 -- This is a semantic test and both nodes must be fully analyzed. A result
1834 -- of True is decisively correct. A result of False does not necessarily
1835 -- mean that different objects are designated, just that this could not
1836 -- be reliably determined at compile time.
1839 -- Determines if T1 and T2 represent exactly the same type. Two types
1840 -- are the same if they are identical, or if one is an unconstrained
1841 -- subtype of the other, or they are both common subtypes of the same
1842 -- type with identical constraints. The result returned is conservative.
1843 -- It is True if the types are known to be the same, but a result of
1844 -- False is indecisive (e.g. the compiler may not be able to tell that
1845 -- two constraints are identical).
1848 -- Determines if Node1 and Node2 are known to be the same value, which is
1849 -- true if they are both compile time known values and have the same value,
1850 -- or if they are the same object (in the sense of function Same_Object).
1851 -- A result of False does not necessarily mean they have different values,
1852 -- just that it is not possible to determine they have the same value.
1854 procedure Save_SPARK_Mode_And_Set
1857 -- Save the current SPARK_Mode in effect in Mode. Establish the SPARK_Mode
1858 -- (if any) of a package or a subprogram denoted by Context. This routine
1859 -- must be used in tandem with Restore_SPARK_Mode.
1862 -- Tests if type T can be determined at compile time to have at least one
1863 -- scalar part in the sense of the Valid_Scalars attribute. Returns True if
1864 -- this is the case, and False if no scalar parts are present (meaning that
1865 -- the result of Valid_Scalars applied to T is always vacuously True).
1868 -- Determines if the entity Scope1 is the same as Scope2, or if it is
1869 -- inside it, where both entities represent scopes. Note that scopes
1870 -- are only partially ordered, so Scope_Within_Or_Same (A,B) and
1871 -- Scope_Within_Or_Same (B,A) can both be False for a given pair A,B.
1874 -- Like Scope_Within_Or_Same, except that this function returns
1875 -- False in the case where Scope1 and Scope2 are the same scope.
1878 -- Same as Basic_Set_Convention, but with an extra check for access types.
1879 -- In particular, if E is an access-to-subprogram type, and Val is a
1880 -- foreign convention, then we set Can_Use_Internal_Rep to False on E.
1881 -- Also, if the Etype of E is set and is an anonymous access type with
1882 -- no convention set, this anonymous type inherits the convention of E.
1886 -- Establish the entity E as the currently visible definition of its
1887 -- associated name (i.e. the Node_Id associated with its name).
1890 -- Sets the Debug_Info_Needed flag on entity T , and also on any entities
1891 -- that are needed by T (for an object, the type of the object is needed,
1892 -- and for a type, various subsidiary types are needed -- see body for
1893 -- details). Never has any effect on T if the Debug_Info_Off flag is set.
1894 -- This routine should always be used instead of Set_Needs_Debug_Info to
1895 -- ensure that subsidiary entities are properly handled.
1898 -- This procedure has the same calling sequence as Set_Entity, but it
1899 -- performs additional checks as follows:
1900 --
1901 -- If Style_Check is set, then it calls a style checking routine which
1902 -- can check identifier spelling style. This procedure also takes care
1903 -- of checking the restriction No_Implementation_Identifiers.
1904 --
1905 -- If restriction No_Abort_Statements is set, then it checks that the
1906 -- entity is not Ada.Task_Identification.Abort_Task.
1907 --
1908 -- If restriction No_Dynamic_Attachment is set, then it checks that the
1909 -- entity is not one of the restricted names for this restriction.
1910 --
1911 -- If restriction No_Long_Long_Integers is set, then it checks that the
1912 -- entity is not Standard.Long_Long_Integer.
1913 --
1914 -- If restriction No_Implementation_Identifiers is set, then it checks
1915 -- that the entity is not implementation defined.
1918 -- Set the relevant ghost attribute of entity Id depending on the current
1919 -- Ghost assertion policy in effect.
1923 -- Sets the Entity_Id value associated with the given name, which is the
1924 -- Id of the innermost visible entity with the given name. See the body
1925 -- of package Sem_Ch8 for further details on the handling of visibility.
1928 -- The arguments may be parameter associations, whose descendants
1929 -- are the optional formal name and the actual parameter. Positional
1930 -- parameters are already members of a list, and do not need to be
1931 -- chained separately. See also First_Actual and Next_Actual.
1935 -- Sets Optimize_Alignment_Space/Time flags in E from current settings
1938 -- If an entity (visible or otherwise) is defined in a library
1939 -- package, or a package that is itself public, then this subprogram
1940 -- labels the entity public as well.
1943 -- N is the node for either a left hand side (Out_Param set to False),
1944 -- or an Out or In_Out parameter (Out_Param set to True). If there is
1945 -- an assignable entity being referenced, then the appropriate flag
1946 -- (Referenced_As_LHS if Out_Param is False, Referenced_As_Out_Parameter
1947 -- if Out_Param is True) is set True, and the other flag set False.
1950 -- Set the flag Is_Transient of the current scope
1954 -- Copies the Esize field and Has_Biased_Representation flag from sub(type)
1955 -- entity T2 to (sub)type entity T1. Also copies the Is_Unsigned_Type flag
1956 -- in the fixed-point and discrete cases, and also copies the alignment
1957 -- value from T2 to T1. It does NOT copy the RM_Size field, which must be
1958 -- separately set if this is required to be copied also.
1961 -- True if the current scope is transient
1964 -- This function analyzes the given expression node and then resolves it
1965 -- as Standard.Boolean. If the result is static, then Uint_1 or Uint_0 is
1966 -- returned corresponding to the value, otherwise an error message is
1967 -- output and No_Uint is returned.
1970 -- This function analyzes the given expression node and then resolves it
1971 -- as any integer type. If the result is static, then the value of the
1972 -- universal expression is returned, otherwise an error message is output
1973 -- and a value of No_Uint is returned.
1976 -- Return True if it can be statically determined that the Expressions
1977 -- E1 and E2 refer to different objects
1980 -- Determine whether node N is a loop statement subject to at least one
1981 -- 'Loop_Entry attribute.
1984 -- Return the accessibility level of the view denoted by Subp
1987 -- Return True if Typ supports the GCC built-in atomic operations (i.e. if
1988 -- Typ is properly sized and aligned).
1991 -- Print debugging information on entry to each unit being analyzed
1994 -- Move a list of entities from one scope to another, and recompute
1995 -- Is_Public based upon the new scope.
1998 -- Return the accessibility level of Typ
2000 function Type_Without_Stream_Operation
2003 -- AI05-0161: In Ada 2012, if the restriction No_Default_Stream_Attributes
2004 -- is active then we cannot generate stream subprograms for composite types
2005 -- with elementary subcomponents that lack user-defined stream subprograms.
2006 -- This predicate determines whether a type has such an elementary
2007 -- subcomponent. If Op is TSS_Null, a type that lacks either Read or Write
2008 -- prevents the construction of a composite stream operation. If Op is
2009 -- specified we check only for the given stream operation.
2012 -- Return the entity which represents declaration N, so that different
2013 -- views of the same entity have the same unique defining entity:
2014 -- * package spec and body;
2015 -- * subprogram declaration, subprogram stub and subprogram body;
2016 -- * private view and full view of a type;
2017 -- * private view and full view of a deferred constant.
2018 -- In other cases, return the defining entity for N.
2021 -- Return the unique entity for entity E, which would be returned by
2022 -- Unique_Defining_Entity if applied to the enclosing declaration of E.
2025 -- Return a unique name for entity E, which could be used to identify E
2026 -- across compilation units.
2029 -- Determine whether a compilation unit is visible in the current context,
2030 -- because there is a with_clause that makes the unit available. Used to
2031 -- provide better messages on common visiblity errors on operators.
2034 -- Yields Universal_Integer or Universal_Real if this is a candidate
2038 -- Removes any qualifications from Expr. For example, for T1'(T2'(X)), this
2039 -- returns X. If Expr is not a qualified expression, returns Expr.
2042 -- [Ada 2012:AI-0125-1]: Collect all the visible parents and progenitors
2043 -- of a type extension or private extension declaration. If the full-view
2044 -- of private parents and progenitors is available then it is used to
2045 -- generate the list of visible ancestors; otherwise their partial
2046 -- view is added to the resulting list.
2048 function Within_Ghost_Scope
2050 -- Determine whether an arbitrary entity is either a scope or within a
2051 -- scope subject to convention Ghost or one that inherits "ghostness" from
2052 -- an enclosing construct.
2055 -- Determines if Current_Scope is within an init proc
2058 -- Returns True if entity Id is declared within scope S
2061 -- Output error message for incorrectly typed expression. Expr is the node
2062 -- for the incorrectly typed construct (Etype (Expr) is the type found),
2063 -- and Expected_Type is the entity for the expected type. Note that Expr
2064 -- does not have to be a subexpression, anything with an Etype field may
2065 -- be used.