1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2011, 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 Nmake; use Nmake;
32 with Snames; use Snames;
33 with Types; use Types;
34 with Uintp; use Uintp;
35 with Urealp; use Urealp;
39 function Abstract_Interface_List (Typ : Entity_Id) return List_Id;
40 -- Given a type that implements interfaces look for its associated
41 -- definition node and return its list of interfaces.
43 procedure Add_Access_Type_To_Process (E : Entity_Id; A : Entity_Id);
44 -- Add A to the list of access types to process when expanding the
47 procedure Add_Global_Declaration (N : Node_Id);
48 -- These procedures adds a declaration N at the library level, to be
49 -- elaborated before any other code in the unit. It is used for example
50 -- for the entity that marks whether a unit has been elaborated. The
51 -- declaration is added to the Declarations list of the Aux_Decls_Node
52 -- for the current unit. The declarations are added in the current scope,
53 -- so the caller should push a new scope as required before the call.
55 function Addressable (V : Uint) return Boolean;
56 function Addressable (V : Int) return Boolean;
57 pragma Inline (Addressable);
58 -- Returns True if the value of V is the word size of an addressable
59 -- factor of the word size (typically 8, 16, 32 or 64).
61 function Alignment_In_Bits (E : Entity_Id) return Uint;
62 -- If the alignment of the type or object E is currently known to the
63 -- compiler, then this function returns the alignment value in bits.
64 -- Otherwise Uint_0 is returned, indicating that the alignment of the
65 -- entity is not yet known to the compiler.
67 procedure Apply_Compile_Time_Constraint_Error
70 Reason : RT_Exception_Code;
71 Ent : Entity_Id := Empty;
72 Typ : Entity_Id := Empty;
73 Loc : Source_Ptr := No_Location;
74 Rep : Boolean := True;
75 Warn : Boolean := False);
76 -- N is a subexpression which will raise constraint error when evaluated
77 -- at runtime. Msg is a message that explains the reason for raising the
78 -- exception. The last character is ? if the message is always a warning,
79 -- even in Ada 95, and is not a ? if the message represents an illegality
80 -- (because of violation of static expression rules) in Ada 95 (but not
81 -- in Ada 83). Typically this routine posts all messages at the Sloc of
82 -- node N. However, if Loc /= No_Location, Loc is the Sloc used to output
83 -- the message. After posting the appropriate message, and if the flag
84 -- Rep is set, this routine replaces the expression with an appropriate
85 -- N_Raise_Constraint_Error node using the given Reason code. This node
86 -- is then marked as being static if the original node is static, but
87 -- sets the flag Raises_Constraint_Error, preventing further evaluation.
88 -- The error message may contain a } or & insertion character. This
89 -- normally references Etype (N), unless the Ent argument is given
90 -- explicitly, in which case it is used instead. The type of the raise
91 -- node that is built is normally Etype (N), but if the Typ parameter
92 -- is present, this is used instead. Warn is normally False. If it is
93 -- True then the message is treated as a warning even though it does
94 -- not end with a ? (this is used when the caller wants to parameterize
95 -- whether an error or warning is given.
97 procedure Bad_Predicated_Subtype_Use
101 -- This is called when Typ, a predicated subtype, is used in a context
102 -- which does not allow the use of a predicated subtype. Msg is passed
103 -- to Error_Msg_FE to output an appropriate message using N as the
104 -- location, and Typ as the entity. The caller must set up any insertions
105 -- other than the & for the type itself. Note that if Typ is a generic
106 -- actual type, then the message will be output as a warning, and a
107 -- raise Program_Error is inserted using Insert_Action with node N as
108 -- the insertion point. Node N also supplies the source location for
109 -- construction of the raise node. If Typ is NOT a type with predicates
110 -- this call has no effect.
112 function Build_Actual_Subtype
114 N : Node_Or_Entity_Id) return Node_Id;
115 -- Build an anonymous subtype for an entity or expression, using the
116 -- bounds of the entity or the discriminants of the enclosing record.
117 -- T is the type for which the actual subtype is required, and N is either
118 -- a defining identifier, or any subexpression.
120 function Build_Actual_Subtype_Of_Component
122 N : Node_Id) return Node_Id;
123 -- Determine whether a selected component has a type that depends on
124 -- discriminants, and build actual subtype for it if so.
126 function Build_Default_Subtype
128 N : Node_Id) return Entity_Id;
129 -- If T is an unconstrained type with defaulted discriminants, build a
130 -- subtype constrained by the default values, insert the subtype
131 -- declaration in the tree before N, and return the entity of that
132 -- subtype. Otherwise, simply return T.
134 function Build_Discriminal_Subtype_Of_Component
135 (T : Entity_Id) return Node_Id;
136 -- Determine whether a record component has a type that depends on
137 -- discriminants, and build actual subtype for it if so.
139 procedure Build_Elaboration_Entity (N : Node_Id; Spec_Id : Entity_Id);
140 -- Given a compilation unit node N, allocate an elaboration counter for
141 -- the compilation unit, and install it in the Elaboration_Entity field
142 -- of Spec_Id, the entity for the compilation unit.
144 procedure Build_Explicit_Dereference
147 -- AI05-139: Names with implicit dereference. If the expression N is a
148 -- reference type and the context imposes the corresponding designated
149 -- type, convert N into N.Disc.all. Such expressions are always over-
150 -- loaded with both interpretations, and the dereference interpretation
151 -- carries the name of the reference discriminant.
153 function Cannot_Raise_Constraint_Error (Expr : Node_Id) return Boolean;
154 -- Returns True if the expression cannot possibly raise Constraint_Error.
155 -- The response is conservative in the sense that a result of False does
156 -- not necessarily mean that CE could be raised, but a response of True
157 -- means that for sure CE cannot be raised.
159 procedure Check_Implicit_Dereference (Nam : Node_Id; Typ : Entity_Id);
160 -- AI05-139-2: Accessors and iterators for containers. This procedure
161 -- checks whether T is a reference type, and if so it adds an interprettion
162 -- to Expr whose type is the designated type of the reference_discriminant.
164 procedure Check_Later_Vs_Basic_Declarations
166 During_Parsing : Boolean);
167 -- If During_Parsing is True, check for misplacement of later vs basic
168 -- declarations in Ada 83. If During_Parsing is False, and the SPARK
169 -- restriction is set, do the same: although SPARK 95 removes the
170 -- distinction between initial and later declarative items, the distinction
171 -- remains in the Examiner (JB01-005). Note that the Examiner does not
172 -- count package declarations in later declarative items.
174 procedure Check_Dynamically_Tagged_Expression
177 Related_Nod : Node_Id);
178 -- Check wrong use of dynamically tagged expression
180 procedure Check_Fully_Declared (T : Entity_Id; N : Node_Id);
181 -- Verify that the full declaration of type T has been seen. If not, place
182 -- error message on node N. Used in object declarations, type conversions
183 -- and qualified expressions.
185 procedure Check_Nested_Access (Ent : Entity_Id);
186 -- Check whether Ent denotes an entity declared in an uplevel scope, which
187 -- is accessed inside a nested procedure, and set Has_Up_Level_Access flag
188 -- accordingly. This is currently only enabled for VM_Target /= No_VM.
190 procedure Check_Order_Dependence;
191 -- Examine the actuals in a top-level call to determine whether aliasing
192 -- between two actuals, one of which is writable, can make the call
195 procedure Check_Potentially_Blocking_Operation (N : Node_Id);
196 -- N is one of the statement forms that is a potentially blocking
197 -- operation. If it appears within a protected action, emit warning.
199 procedure Check_Unprotected_Access
202 -- Check whether the expression is a pointer to a protected component,
203 -- and the context is external to the protected operation, to warn against
204 -- a possible unlocked access to data.
206 procedure Check_VMS (Construct : Node_Id);
207 -- Check that this the target is OpenVMS, and if so, return with no effect,
208 -- otherwise post an error noting this can only be used with OpenVMS ports.
209 -- The argument is the construct in question and is used to post the error
212 procedure Collect_Interfaces
214 Ifaces_List : out Elist_Id;
215 Exclude_Parents : Boolean := False;
216 Use_Full_View : Boolean := True);
217 -- Ada 2005 (AI-251): Collect whole list of abstract interfaces that are
218 -- directly or indirectly implemented by T. Exclude_Parents is used to
219 -- avoid the addition of inherited interfaces to the generated list.
220 -- Use_Full_View is used to collect the interfaces using the full-view
223 procedure Collect_Interface_Components
224 (Tagged_Type : Entity_Id;
225 Components_List : out Elist_Id);
226 -- Ada 2005 (AI-251): Collect all the tag components associated with the
227 -- secondary dispatch tables of a tagged type.
229 procedure Collect_Interfaces_Info
231 Ifaces_List : out Elist_Id;
232 Components_List : out Elist_Id;
233 Tags_List : out Elist_Id);
234 -- Ada 2005 (AI-251): Collect all the interfaces associated with T plus
235 -- the record component and tag associated with each of these interfaces.
236 -- On exit Ifaces_List, Components_List and Tags_List have the same number
237 -- of elements, and elements at the same position on these tables provide
238 -- information on the same interface type.
240 procedure Collect_Parents
243 Use_Full_View : Boolean := True);
244 -- Collect all the parents of Typ. Use_Full_View is used to collect them
245 -- using the full-view of private parents (if available).
247 function Collect_Primitive_Operations (T : Entity_Id) return Elist_Id;
248 -- Called upon type derivation and extension. We scan the declarative part
249 -- in which the type appears, and collect subprograms that have one
250 -- subsidiary subtype of the type. These subprograms can only appear after
253 function Compile_Time_Constraint_Error
256 Ent : Entity_Id := Empty;
257 Loc : Source_Ptr := No_Location;
258 Warn : Boolean := False) return Node_Id;
259 -- This is similar to Apply_Compile_Time_Constraint_Error in that it
260 -- generates a warning (or error) message in the same manner, but it does
261 -- not replace any nodes. For convenience, the function always returns its
262 -- first argument. The message is a warning if the message ends with ?, or
263 -- we are operating in Ada 83 mode, or the Warn parameter is set to True.
265 procedure Conditional_Delay (New_Ent, Old_Ent : Entity_Id);
266 -- Sets the Has_Delayed_Freeze flag of New if the Delayed_Freeze flag of
267 -- Old is set and Old has no yet been Frozen (i.e. Is_Frozen is false).
269 function Copy_Parameter_List (Subp_Id : Entity_Id) return List_Id;
270 -- Utility to create a parameter profile for a new subprogram spec, when
271 -- the subprogram has a body that acts as spec. This is done for some cases
272 -- of inlining, and for private protected ops. Also used to create bodies
273 -- for stubbed subprograms.
275 function Current_Entity (N : Node_Id) return Entity_Id;
276 pragma Inline (Current_Entity);
277 -- Find the currently visible definition for a given identifier, that is to
278 -- say the first entry in the visibility chain for the Chars of N.
280 function Current_Entity_In_Scope (N : Node_Id) return Entity_Id;
281 -- Find whether there is a previous definition for identifier N in the
282 -- current scope. Because declarations for a scope are not necessarily
283 -- contiguous (e.g. for packages) the first entry on the visibility chain
284 -- for N is not necessarily in the current scope.
286 function Current_Scope return Entity_Id;
287 -- Get entity representing current scope
289 function Current_Subprogram return Entity_Id;
290 -- Returns current enclosing subprogram. If Current_Scope is a subprogram,
291 -- then that is what is returned, otherwise the Enclosing_Subprogram of the
292 -- Current_Scope is returned. The returned value is Empty if this is called
293 -- from a library package which is not within any subprogram.
295 function Deepest_Type_Access_Level (Typ : Entity_Id) return Uint;
296 -- Same as Type_Access_Level, except that if the type is the type of an Ada
297 -- 2012 stand-alone object of an anonymous access type, then return the
298 -- static accesssibility level of the object. In that case, the dynamic
299 -- accessibility level of the object may take on values in a range. The low
300 -- bound of of that range is returned by Type_Access_Level; this function
301 -- yields the high bound of that range.
303 function Defining_Entity (N : Node_Id) return Entity_Id;
304 -- Given a declaration N, returns the associated defining entity. If the
305 -- declaration has a specification, the entity is obtained from the
306 -- specification. If the declaration has a defining unit name, then the
307 -- defining entity is obtained from the defining unit name ignoring any
308 -- child unit prefixes.
310 function Denotes_Discriminant
312 Check_Concurrent : Boolean := False) return Boolean;
313 -- Returns True if node N is an Entity_Name node for a discriminant. If the
314 -- flag Check_Concurrent is true, function also returns true when N denotes
315 -- the discriminal of the discriminant of a concurrent type. This is needed
316 -- to disable some optimizations on private components of protected types,
317 -- and constraint checks on entry families constrained by discriminants.
319 function Denotes_Same_Object (A1, A2 : Node_Id) return Boolean;
320 function Denotes_Same_Prefix (A1, A2 : Node_Id) return Boolean;
321 -- Functions to detect suspicious overlapping between actuals in a call,
322 -- when one of them is writable. The predicates are those proposed in
323 -- AI05-0144, to detect dangerous order dependence in complex calls.
324 -- I would add a parameter Warn which enables more extensive testing of
325 -- cases as we find appropriate when we are only warning ??? Or perhaps
326 -- return an indication of (Error, Warn, OK) ???
328 function Denotes_Variable (N : Node_Id) return Boolean;
329 -- Returns True if node N denotes a single variable without parentheses
331 function Depends_On_Discriminant (N : Node_Id) return Boolean;
332 -- Returns True if N denotes a discriminant or if N is a range, a subtype
333 -- indication or a scalar subtype where one of the bounds is a
336 function Designate_Same_Unit
338 Name2 : Node_Id) return Boolean;
339 -- Return true if Name1 and Name2 designate the same unit name; each of
340 -- these names is supposed to be a selected component name, an expanded
341 -- name, a defining program unit name or an identifier.
343 function Dynamic_Accessibility_Level (Expr : Node_Id) return Node_Id;
344 -- Expr should be an expression of an access type. Builds an integer
345 -- literal except in cases involving anonymous access types where
346 -- accessibility levels are tracked at runtime (access parameters and Ada
347 -- 2012 stand-alone objects).
349 function Effective_Extra_Accessibility (Id : Entity_Id) return Entity_Id;
350 -- Same as Einfo.Extra_Accessibility except thtat object renames
351 -- are looked through.
353 function Enclosing_CPP_Parent (Typ : Entity_Id) return Entity_Id;
354 -- Returns the closest ancestor of Typ that is a CPP type.
356 function Enclosing_Generic_Body
357 (N : Node_Id) return Node_Id;
358 -- Returns the Node_Id associated with the innermost enclosing generic
359 -- body, if any. If none, then returns Empty.
361 function Enclosing_Generic_Unit
362 (N : Node_Id) return Node_Id;
363 -- Returns the Node_Id associated with the innermost enclosing generic
364 -- unit, if any. If none, then returns Empty.
366 function Enclosing_Lib_Unit_Entity return Entity_Id;
367 -- Returns the entity of enclosing N_Compilation_Unit Node which is the
368 -- root of the current scope (which must not be Standard_Standard, and the
369 -- caller is responsible for ensuring this condition).
371 function Enclosing_Lib_Unit_Node (N : Node_Id) return Node_Id;
372 -- Returns the enclosing N_Compilation_Unit Node that is the root of a
373 -- subtree containing N.
375 function Enclosing_Package (E : Entity_Id) return Entity_Id;
376 -- Utility function to return the Ada entity of the package enclosing
377 -- the entity E, if any. Returns Empty if no enclosing package.
379 function Enclosing_Subprogram (E : Entity_Id) return Entity_Id;
380 -- Utility function to return the Ada entity of the subprogram enclosing
381 -- the entity E, if any. Returns Empty if no enclosing subprogram.
383 procedure Ensure_Freeze_Node (E : Entity_Id);
384 -- Make sure a freeze node is allocated for entity E. If necessary, build
385 -- and initialize a new freeze node and set Has_Delayed_Freeze True for E.
387 procedure Enter_Name (Def_Id : Entity_Id);
388 -- Insert new name in symbol table of current scope with check for
389 -- duplications (error message is issued if a conflict is found).
390 -- Note: Enter_Name is not used for overloadable entities, instead these
391 -- are entered using Sem_Ch6.Enter_Overloadable_Entity.
393 procedure Explain_Limited_Type (T : Entity_Id; N : Node_Id);
394 -- This procedure is called after issuing a message complaining about an
395 -- inappropriate use of limited type T. If useful, it adds additional
396 -- continuation lines to the message explaining why type T is limited.
397 -- Messages are placed at node N.
399 procedure Find_Actual
401 Formal : out Entity_Id;
403 -- Determines if the node N is an actual parameter of a function of a
404 -- procedure call. If so, then Formal points to the entity for the formal
405 -- (Ekind is E_In_Parameter, E_Out_Parameter, or E_In_Out_Parameter) and
406 -- Call is set to the node for the corresponding call. If the node N is not
407 -- an actual parameter then Formal and Call are set to Empty.
409 function Find_Corresponding_Discriminant
411 Typ : Entity_Id) return Entity_Id;
412 -- Because discriminants may have different names in a generic unit and in
413 -- an instance, they are resolved positionally when possible. A reference
414 -- to a discriminant carries the discriminant that it denotes when it is
415 -- analyzed. Subsequent uses of this id on a different type denotes the
416 -- discriminant at the same position in this new type.
418 procedure Find_Overlaid_Entity
422 -- The node N should be an address representation clause. Determines if
423 -- the target expression is the address of an entity with an optional
424 -- offset. If so, set Ent to the entity and, if there is an offset, set
425 -- Off to True, otherwise to False. If N is not an address representation
426 -- clause, or if it is not possible to determine that the address is of
427 -- this form, then set Ent to Empty.
429 function Find_Parameter_Type (Param : Node_Id) return Entity_Id;
430 -- Return the type of formal parameter Param as determined by its
433 function Find_Static_Alternative (N : Node_Id) return Node_Id;
434 -- N is a case statement whose expression is a compile-time value.
435 -- Determine the alternative chosen, so that the code of non-selected
436 -- alternatives, and the warnings that may apply to them, are removed.
438 function Find_Body_Discriminal
439 (Spec_Discriminant : Entity_Id) return Entity_Id;
440 -- Given a discriminant of the record type that implements a task or
441 -- protected type, return the discriminal of the corresponding discriminant
442 -- of the actual concurrent type.
444 function First_Actual (Node : Node_Id) return Node_Id;
445 -- Node is an N_Function_Call or N_Procedure_Call_Statement node. The
446 -- result returned is the first actual parameter in declaration order
447 -- (not the order of parameters as they appeared in the source, which
448 -- can be quite different as a result of the use of named parameters).
449 -- Empty is returned for a call with no parameters. The procedure for
450 -- iterating through the actuals in declaration order is to use this
451 -- function to find the first actual, and then use Next_Actual to obtain
452 -- the next actual in declaration order. Note that the value returned
453 -- is always the expression (not the N_Parameter_Association nodes,
454 -- even if named association is used).
456 procedure Gather_Components
459 Governed_By : List_Id;
461 Report_Errors : out Boolean);
462 -- The purpose of this procedure is to gather the valid components in a
463 -- record type according to the values of its discriminants, in order to
464 -- validate the components of a record aggregate.
466 -- Typ is the type of the aggregate when its constrained discriminants
467 -- need to be collected, otherwise it is Empty.
469 -- Comp_List is an N_Component_List node.
471 -- Governed_By is a list of N_Component_Association nodes, where each
472 -- choice list contains the name of a discriminant and the expression
473 -- field gives its value. The values of the discriminants governing
474 -- the (possibly nested) variant parts in Comp_List are found in this
475 -- Component_Association List.
477 -- Into is the list where the valid components are appended. Note that
478 -- Into need not be an Empty list. If it's not, components are attached
481 -- Report_Errors is set to True if the values of the discriminants are
484 -- This procedure is also used when building a record subtype. If the
485 -- discriminant constraint of the subtype is static, the components of the
486 -- subtype are only those of the variants selected by the values of the
487 -- discriminants. Otherwise all components of the parent must be included
488 -- in the subtype for semantic analysis.
490 function Get_Actual_Subtype (N : Node_Id) return Entity_Id;
491 -- Given a node for an expression, obtain the actual subtype of the
492 -- expression. In the case of a parameter where the formal is an
493 -- unconstrained array or discriminated type, this will be the previously
494 -- constructed subtype of the actual. Note that this is not quite the
495 -- "Actual Subtype" of the RM, since it is always a constrained type, i.e.
496 -- it is the subtype of the value of the actual. The actual subtype is also
497 -- returned in other cases where it has already been constructed for an
498 -- object. Otherwise the expression type is returned unchanged, except for
499 -- the case of an unconstrained array type, where an actual subtype is
500 -- created, using Insert_Actions if necessary to insert any associated
503 function Get_Actual_Subtype_If_Available (N : Node_Id) return Entity_Id;
504 -- This is like Get_Actual_Subtype, except that it never constructs an
505 -- actual subtype. If an actual subtype is already available, i.e. the
506 -- Actual_Subtype field of the corresponding entity is set, then it is
507 -- returned. Otherwise the Etype of the node is returned.
509 function Get_Body_From_Stub (N : Node_Id) return Node_Id;
510 -- Return the body node for a stub (subprogram or package)
512 function Get_Default_External_Name (E : Node_Or_Entity_Id) return Node_Id;
513 -- This is used to construct the string literal node representing a
514 -- default external name, i.e. one that is constructed from the name of an
515 -- entity, or (in the case of extended DEC import/export pragmas, an
516 -- identifier provided as the external name. Letters in the name are
517 -- according to the setting of Opt.External_Name_Default_Casing.
519 function Get_Enclosing_Object (N : Node_Id) return Entity_Id;
520 -- If expression N references a part of an object, return this object.
521 -- Otherwise return Empty. Expression N should have been resolved already.
523 function Get_Ensures_From_Test_Case_Pragma (N : Node_Id) return Node_Id;
524 -- Return the Ensures component of Test_Case pragma N, or Empty otherwise
526 function Get_Generic_Entity (N : Node_Id) return Entity_Id;
527 -- Returns the true generic entity in an instantiation. If the name in the
528 -- instantiation is a renaming, the function returns the renamed generic.
530 procedure Get_Index_Bounds (N : Node_Id; L, H : out Node_Id);
531 -- This procedure assigns to L and H respectively the values of the low and
532 -- high bounds of node N, which must be a range, subtype indication, or the
533 -- name of a scalar subtype. The result in L, H may be set to Error if
534 -- there was an earlier error in the range.
536 function Get_Enum_Lit_From_Pos
539 Loc : Source_Ptr) return Node_Id;
540 -- This function returns an identifier denoting the E_Enumeration_Literal
541 -- entity for the specified value from the enumeration type or subtype T.
542 -- The second argument is the Pos value, which is assumed to be in range.
543 -- The third argument supplies a source location for constructed nodes
544 -- returned by this function.
546 procedure Get_Library_Unit_Name_String (Decl_Node : Node_Id);
547 -- Retrieve the fully expanded name of the library unit declared by
548 -- Decl_Node into the name buffer.
550 function Get_Name_Entity_Id (Id : Name_Id) return Entity_Id;
551 pragma Inline (Get_Name_Entity_Id);
552 -- An entity value is associated with each name in the name table. The
553 -- Get_Name_Entity_Id function fetches the Entity_Id of this entity, which
554 -- is the innermost visible entity with the given name. See the body of
555 -- Sem_Ch8 for further details on handling of entity visibility.
557 function Get_Name_From_Test_Case_Pragma (N : Node_Id) return String_Id;
558 -- Return the Name component of Test_Case pragma N
560 function Get_Pragma_Id (N : Node_Id) return Pragma_Id;
561 pragma Inline (Get_Pragma_Id);
562 -- Obtains the Pragma_Id from the Chars field of Pragma_Identifier (N)
564 function Get_Referenced_Object (N : Node_Id) return Node_Id;
565 -- Given a node, return the renamed object if the node represents a renamed
566 -- object, otherwise return the node unchanged. The node may represent an
567 -- arbitrary expression.
569 function Get_Renamed_Entity (E : Entity_Id) return Entity_Id;
570 -- Given an entity for an exception, package, subprogram or generic unit,
571 -- returns the ultimately renamed entity if this is a renaming. If this is
572 -- not a renamed entity, returns its argument. It is an error to call this
573 -- with any other kind of entity.
575 function Get_Requires_From_Test_Case_Pragma (N : Node_Id) return Node_Id;
576 -- Return the Requires component of Test_Case pragma N, or Empty otherwise
578 function Get_Subprogram_Entity (Nod : Node_Id) return Entity_Id;
579 -- Nod is either a procedure call statement, or a function call, or an
580 -- accept statement node. This procedure finds the Entity_Id of the related
581 -- subprogram or entry and returns it, or if no subprogram can be found,
584 function Get_Subprogram_Body (E : Entity_Id) return Node_Id;
585 -- Given the entity for a subprogram (E_Function or E_Procedure), return
586 -- the corresponding N_Subprogram_Body node. If the corresponding body
587 -- is missing (as for an imported subprogram), return Empty.
589 function Get_Task_Body_Procedure (E : Entity_Id) return Node_Id;
590 pragma Inline (Get_Task_Body_Procedure);
591 -- Given an entity for a task type or subtype, retrieves the
592 -- Task_Body_Procedure field from the corresponding task type declaration.
594 function Has_Access_Values (T : Entity_Id) return Boolean;
595 -- Returns true if type or subtype T is an access type, or has a component
596 -- (at any recursive level) that is an access type. This is a conservative
597 -- predicate, if it is not known whether or not T contains access values
598 -- (happens for generic formals in some cases), then False is returned.
599 -- Note that tagged types return False. Even though the tag is implemented
600 -- as an access type internally, this function tests only for access types
601 -- known to the programmer. See also Has_Tagged_Component.
603 type Alignment_Result is (Known_Compatible, Unknown, Known_Incompatible);
604 -- Result of Has_Compatible_Alignment test, description found below. Note
605 -- that the values are arranged in increasing order of problematicness.
607 function Has_Compatible_Alignment
609 Expr : Node_Id) return Alignment_Result;
610 -- Obj is an object entity, and expr is a node for an object reference. If
611 -- the alignment of the object referenced by Expr is known to be compatible
612 -- with the alignment of Obj (i.e. is larger or the same), then the result
613 -- is Known_Compatible. If the alignment of the object referenced by Expr
614 -- is known to be less than the alignment of Obj, then Known_Incompatible
615 -- is returned. If neither condition can be reliably established at compile
616 -- time, then Unknown is returned. This is used to determine if alignment
617 -- checks are required for address clauses, and also whether copies must
618 -- be made when objects are passed by reference.
620 -- Note: Known_Incompatible does not mean that at run time the alignment
621 -- of Expr is known to be wrong for Obj, just that it can be determined
622 -- that alignments have been explicitly or implicitly specified which are
623 -- incompatible (whereas Unknown means that even this is not known). The
624 -- appropriate reaction of a caller to Known_Incompatible is to treat it as
625 -- Unknown, but issue a warning that there may be an alignment error.
627 function Has_Declarations (N : Node_Id) return Boolean;
628 -- Determines if the node can have declarations
630 function Has_Discriminant_Dependent_Constraint
631 (Comp : Entity_Id) return Boolean;
632 -- Returns True if and only if Comp has a constrained subtype that depends
633 -- on a discriminant.
635 function Has_Infinities (E : Entity_Id) return Boolean;
636 -- Determines if the range of the floating-point type E includes
637 -- infinities. Returns False if E is not a floating-point type.
639 function Has_Interfaces
641 Use_Full_View : Boolean := True) return Boolean;
642 -- Where T is a concurrent type or a record type, returns true if T covers
643 -- any abstract interface types. In case of private types the argument
644 -- Use_Full_View controls if the check is done using its full view (if
647 function Has_Null_Exclusion (N : Node_Id) return Boolean;
648 -- Determine whether node N has a null exclusion
650 function Has_Overriding_Initialize (T : Entity_Id) return Boolean;
651 -- Predicate to determine whether a controlled type has a user-defined
652 -- Initialize primitive (and, in Ada 2012, whether that primitive is
653 -- non-null), which causes the type to not have preelaborable
656 function Has_Preelaborable_Initialization (E : Entity_Id) return Boolean;
657 -- Return True iff type E has preelaborable initialization as defined in
658 -- Ada 2005 (see AI-161 for details of the definition of this attribute).
660 function Has_Private_Component (Type_Id : Entity_Id) return Boolean;
661 -- Check if a type has a (sub)component of a private type that has not
662 -- yet received a full declaration.
664 function Has_Static_Array_Bounds (Typ : Node_Id) return Boolean;
665 -- Return whether an array type has static bounds
667 function Has_Stream (T : Entity_Id) return Boolean;
668 -- Tests if type T is derived from Ada.Streams.Root_Stream_Type, or in the
669 -- case of a composite type, has a component for which this predicate is
670 -- True, and if so returns True. Otherwise a result of False means that
671 -- there is no Stream type in sight. For a private type, the test is
672 -- applied to the underlying type (or returns False if there is no
675 function Has_Suffix (E : Entity_Id; Suffix : Character) return Boolean;
676 -- Returns true if the last character of E is Suffix. Used in Assertions.
678 function Has_Tagged_Component (Typ : Entity_Id) return Boolean;
679 -- Returns True if Typ is a composite type (array or record) which is
680 -- either itself a tagged type, or has a component (recursively) which is
681 -- a tagged type. Returns False for non-composite type, or if no tagged
682 -- component is present. This function is used to check if "=" has to be
683 -- expanded into a bunch component comparisons.
685 function Implementation_Kind (Subp : Entity_Id) return Name_Id;
686 -- Subp is a subprogram marked with pragma Implemented. Return the specific
687 -- implementation requirement which the pragma imposes. The return value is
688 -- either Name_By_Any, Name_By_Entry or Name_By_Protected_Procedure.
690 function Implements_Interface
691 (Typ_Ent : Entity_Id;
692 Iface_Ent : Entity_Id;
693 Exclude_Parents : Boolean := False) return Boolean;
694 -- Returns true if the Typ_Ent implements interface Iface_Ent
696 function In_Instance return Boolean;
697 -- Returns True if the current scope is within a generic instance
699 function In_Instance_Body return Boolean;
700 -- Returns True if current scope is within the body of an instance, where
701 -- several semantic checks (e.g. accessibility checks) are relaxed.
703 function In_Instance_Not_Visible return Boolean;
704 -- Returns True if current scope is with the private part or the body of
705 -- an instance. Other semantic checks are suppressed in this context.
707 function In_Instance_Visible_Part return Boolean;
708 -- Returns True if current scope is within the visible part of a package
709 -- instance, where several additional semantic checks apply.
711 function In_Package_Body return Boolean;
712 -- Returns True if current scope is within a package body
714 function In_Parameter_Specification (N : Node_Id) return Boolean;
715 -- Returns True if node N belongs to a parameter specification
717 function In_Subprogram_Or_Concurrent_Unit return Boolean;
718 -- Determines if the current scope is within a subprogram compilation unit
719 -- (inside a subprogram declaration, subprogram body, or generic
720 -- subprogram declaration) or within a task or protected body. The test is
721 -- for appearing anywhere within such a construct (that is it does not need
722 -- to be directly within).
724 function In_Visible_Part (Scope_Id : Entity_Id) return Boolean;
725 -- Determine whether a declaration occurs within the visible part of a
726 -- package specification. The package must be on the scope stack, and the
727 -- corresponding private part must not.
729 function Incomplete_Or_Private_View (Typ : Entity_Id) return Entity_Id;
730 -- Given the entity of a type, retrieve the incomplete or private view of
731 -- the same type. Note that Typ may not have a partial view to begin with,
732 -- in that case the function returns Empty.
734 procedure Insert_Explicit_Dereference (N : Node_Id);
735 -- In a context that requires a composite or subprogram type and where a
736 -- prefix is an access type, rewrite the access type node N (which is the
737 -- prefix, e.g. of an indexed component) as an explicit dereference.
739 procedure Inspect_Deferred_Constant_Completion (Decls : List_Id);
740 -- Examine all deferred constants in the declaration list Decls and check
741 -- whether they have been completed by a full constant declaration or an
742 -- Import pragma. Emit the error message if that is not the case.
744 function Is_Actual_Out_Parameter (N : Node_Id) return Boolean;
745 -- Determines if N is an actual parameter of out mode in a subprogram call
747 function Is_Actual_Parameter (N : Node_Id) return Boolean;
748 -- Determines if N is an actual parameter in a subprogram call
750 function Is_Actual_Tagged_Parameter (N : Node_Id) return Boolean;
751 -- Determines if N is an actual parameter of a formal of tagged type in a
754 function Is_Aliased_View (Obj : Node_Id) return Boolean;
755 -- Determine if Obj is an aliased view, i.e. the name of an object to which
756 -- 'Access or 'Unchecked_Access can apply. Note that the implementation
757 -- takes the No_Implicit_Aiasing restriction into account.
759 function Is_Ancestor_Package
761 E2 : Entity_Id) return Boolean;
762 -- Determine whether package E1 is an ancestor of E2
764 function Is_Atomic_Object (N : Node_Id) return Boolean;
765 -- Determines if the given node denotes an atomic object in the sense of
766 -- the legality checks described in RM C.6(12).
768 function Is_Controlling_Limited_Procedure
769 (Proc_Nam : Entity_Id) return Boolean;
770 -- Ada 2005 (AI-345): Determine whether Proc_Nam is a primitive procedure
771 -- of a limited interface with a controlling first parameter.
773 function Is_CPP_Constructor_Call (N : Node_Id) return Boolean;
774 -- Returns True if N is a call to a CPP constructor
776 function Is_Dependent_Component_Of_Mutable_Object
777 (Object : Node_Id) return Boolean;
778 -- Returns True if Object is the name of a subcomponent that depends on
779 -- discriminants of a variable whose nominal subtype is unconstrained and
780 -- not indefinite, and the variable is not aliased. Otherwise returns
781 -- False. The nodes passed to this function are assumed to denote objects.
783 function Is_Dereferenced (N : Node_Id) return Boolean;
784 -- N is a subexpression node of an access type. This function returns true
785 -- if N appears as the prefix of a node that does a dereference of the
786 -- access value (selected/indexed component, explicit dereference or a
787 -- slice), and false otherwise.
789 function Is_Descendent_Of (T1 : Entity_Id; T2 : Entity_Id) return Boolean;
790 -- Returns True if type T1 is a descendent of type T2, and false otherwise.
791 -- This is the RM definition, a type is a descendent of another type if it
792 -- is the same type or is derived from a descendent of the other type.
794 function Is_Concurrent_Interface (T : Entity_Id) return Boolean;
795 -- First determine whether type T is an interface and then check whether
796 -- it is of protected, synchronized or task kind.
798 function Is_Expression_Function (Subp : Entity_Id) return Boolean;
799 -- Predicate to determine whether a function entity comes from a rewritten
800 -- expression function, and should be inlined unconditionally.
802 function Is_False (U : Uint) return Boolean;
803 pragma Inline (Is_False);
804 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
805 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
806 -- if it is False (i.e. zero).
808 function Is_Fixed_Model_Number (U : Ureal; T : Entity_Id) return Boolean;
809 -- Returns True iff the number U is a model number of the fixed-point type
810 -- T, i.e. if it is an exact multiple of Small.
812 function Is_Fully_Initialized_Type (Typ : Entity_Id) return Boolean;
813 -- Typ is a type entity. This function returns true if this type is fully
814 -- initialized, meaning that an object of the type is fully initialized.
815 -- Note that initialization resulting from use of pragma Normalized_Scalars
816 -- does not count. Note that this is only used for the purpose of issuing
817 -- warnings for objects that are potentially referenced uninitialized. This
818 -- means that the result returned is not crucial, but should err on the
819 -- side of thinking things are fully initialized if it does not know.
821 function Is_Inherited_Operation (E : Entity_Id) return Boolean;
822 -- E is a subprogram. Return True is E is an implicit operation inherited
823 -- by a derived type declaration.
825 function Is_Inherited_Operation_For_Type
827 Typ : Entity_Id) return Boolean;
828 -- E is a subprogram. Return True is E is an implicit operation inherited
829 -- by the derived type declaration for type Typ.
831 function Is_Iterator (Typ : Entity_Id) return Boolean;
832 -- AI05-0139-2: Check whether Typ is derived from the predefined interface
833 -- Ada.Iterator_Interfaces.Forward_Iterator.
835 function Is_LHS (N : Node_Id) return Boolean;
836 -- Returns True iff N is used as Name in an assignment statement
838 function Is_Library_Level_Entity (E : Entity_Id) return Boolean;
839 -- A library-level declaration is one that is accessible from Standard,
840 -- i.e. a library unit or an entity declared in a library package.
842 function Is_Local_Variable_Reference (Expr : Node_Id) return Boolean;
843 -- Determines whether Expr is a reference to a variable or IN OUT mode
844 -- parameter of the current enclosing subprogram.
845 -- Why are OUT parameters not considered here ???
847 function Is_Object_Reference (N : Node_Id) return Boolean;
848 -- Determines if the tree referenced by N represents an object. Both
849 -- variable and constant objects return True (compare Is_Variable).
851 function Is_OK_Variable_For_Out_Formal (AV : Node_Id) return Boolean;
852 -- Used to test if AV is an acceptable formal for an OUT or IN OUT formal.
853 -- Note that the Is_Variable function is not quite the right test because
854 -- this is a case in which conversions whose expression is a variable (in
855 -- the Is_Variable sense) with a non-tagged type target are considered view
856 -- conversions and hence variables.
858 function Is_Partially_Initialized_Type
860 Include_Implicit : Boolean := True) return Boolean;
861 -- Typ is a type entity. This function returns true if this type is partly
862 -- initialized, meaning that an object of the type is at least partly
863 -- initialized (in particular in the record case, that at least one
864 -- component has an initialization expression). Note that initialization
865 -- resulting from the use of pragma Normalized_Scalars does not count.
866 -- Include_Implicit controls whether implicit initialization of access
867 -- values to null, and of discriminant values, is counted as making the
868 -- type be partially initialized. For the default setting of True, these
869 -- implicit cases do count, and discriminated types or types containing
870 -- access values not explicitly initialized will return True. Otherwise
871 -- if Include_Implicit is False, these cases do not count as making the
872 -- type be partially initialized.
874 function Is_Potentially_Persistent_Type (T : Entity_Id) return Boolean;
875 -- Determines if type T is a potentially persistent type. A potentially
876 -- persistent type is defined (recursively) as a scalar type, a non-tagged
877 -- record whose components are all of a potentially persistent type, or an
878 -- array with all static constraints whose component type is potentially
879 -- persistent. A private type is potentially persistent if the full type
880 -- is potentially persistent.
882 function Is_Protected_Self_Reference (N : Node_Id) return Boolean;
883 -- Return True if node N denotes a protected type name which represents
884 -- the current instance of a protected object according to RM 9.4(21/2).
886 function Is_RCI_Pkg_Spec_Or_Body (Cunit : Node_Id) return Boolean;
887 -- Return True if a compilation unit is the specification or the
888 -- body of a remote call interface package.
890 function Is_Remote_Access_To_Class_Wide_Type (E : Entity_Id) return Boolean;
891 -- Return True if E is a remote access-to-class-wide type
893 function Is_Remote_Access_To_Subprogram_Type (E : Entity_Id) return Boolean;
894 -- Return True if E is a remote access to subprogram type
896 function Is_Remote_Call (N : Node_Id) return Boolean;
897 -- Return True if N denotes a potentially remote call
899 function Is_Renamed_Entry (Proc_Nam : Entity_Id) return Boolean;
900 -- Return True if Proc_Nam is a procedure renaming of an entry
902 function Is_Reversible_Iterator (Typ : Entity_Id) return Boolean;
903 -- AI05-0139-2: Check whether Typ is derived from the predefined interface
904 -- Ada.Iterator_Interfaces.Reversible_Iterator.
906 function Is_Selector_Name (N : Node_Id) return Boolean;
907 -- Given an N_Identifier node N, determines if it is a Selector_Name.
908 -- As described in Sinfo, Selector_Names are special because they
909 -- represent use of the N_Identifier node for a true identifier, when
910 -- normally such nodes represent a direct name.
912 function Is_SPARK_Initialization_Expr (N : Node_Id) return Boolean;
913 -- Determines if the tree referenced by N represents an initialization
914 -- expression in SPARK, suitable for initializing an object in an object
917 function Is_SPARK_Object_Reference (N : Node_Id) return Boolean;
918 -- Determines if the tree referenced by N represents an object in SPARK
920 function Is_Statement (N : Node_Id) return Boolean;
921 pragma Inline (Is_Statement);
922 -- Check if the node N is a statement node. Note that this includes
923 -- the case of procedure call statements (unlike the direct use of
924 -- the N_Statement_Other_Than_Procedure_Call subtype from Sinfo).
925 -- Note that a label is *not* a statement, and will return False.
927 function Is_Subprogram_Stub_Without_Prior_Declaration
928 (N : Node_Id) return Boolean;
929 -- Return True if N is a subprogram stub with no prior subprogram
932 function Is_Synchronized_Tagged_Type (E : Entity_Id) return Boolean;
933 -- Returns True if E is a synchronized tagged type (AARM 3.9.4 (6/2))
935 function Is_Transfer (N : Node_Id) return Boolean;
936 -- Returns True if the node N is a statement which is known to cause an
937 -- unconditional transfer of control at runtime, i.e. the following
938 -- statement definitely will not be executed.
940 function Is_True (U : Uint) return Boolean;
941 pragma Inline (Is_True);
942 -- The argument is a Uint value which is the Boolean'Pos value of a Boolean
943 -- operand (i.e. is either 0 for False, or 1 for True). This function tests
944 -- if it is True (i.e. non-zero).
946 function Is_Universal_Numeric_Type (T : Entity_Id) return Boolean;
947 pragma Inline (Is_Universal_Numeric_Type);
948 -- True if T is Universal_Integer or Universal_Real
950 function Is_Value_Type (T : Entity_Id) return Boolean;
951 -- Returns true if type T represents a value type. This is only relevant to
952 -- CIL, will always return false for other targets. A value type is a CIL
953 -- object that is accessed directly, as opposed to the other CIL objects
954 -- that are accessed through managed pointers.
956 function Is_VMS_Operator (Op : Entity_Id) return Boolean;
957 -- Determine whether an operator is one of the intrinsics defined
958 -- in the DEC system extension.
960 function Is_Delegate (T : Entity_Id) return Boolean;
961 -- Returns true if type T represents a delegate. A Delegate is the CIL
962 -- object used to represent access-to-subprogram types. This is only
963 -- relevant to CIL, will always return false for other targets.
967 Use_Original_Node : Boolean := True) return Boolean;
968 -- Determines if the tree referenced by N represents a variable, i.e. can
969 -- appear on the left side of an assignment. There is one situation (formal
970 -- parameters) in which non-tagged type conversions are also considered
971 -- variables, but Is_Variable returns False for such cases, since it has
972 -- no knowledge of the context. Note that this is the point at which
973 -- Assignment_OK is checked, and True is returned for any tree thus marked.
974 -- Use_Original_Node is used to perform the test on Original_Node (N). By
975 -- default is True since this routine is commonly invoked as part of the
976 -- semantic analysis and it must not be disturbed by the rewriten nodes.
978 function Is_Visibly_Controlled (T : Entity_Id) return Boolean;
979 -- Check whether T is derived from a visibly controlled type. This is true
980 -- if the root type is declared in Ada.Finalization. If T is derived
981 -- instead from a private type whose full view is controlled, an explicit
982 -- Initialize/Adjust/Finalize subprogram does not override the inherited
985 function Is_Volatile_Object (N : Node_Id) return Boolean;
986 -- Determines if the given node denotes an volatile object in the sense of
987 -- the legality checks described in RM C.6(12). Note that the test here is
988 -- for something actually declared as volatile, not for an object that gets
989 -- treated as volatile (see Einfo.Treat_As_Volatile).
991 function Itype_Has_Declaration (Id : Entity_Id) return Boolean;
992 -- Applies to Itypes. True if the Itype is attached to a declaration for
993 -- the type through its Parent field, which may or not be present in the
996 procedure Kill_Current_Values (Last_Assignment_Only : Boolean := False);
997 -- This procedure is called to clear all constant indications from all
998 -- entities in the current scope and in any parent scopes if the current
999 -- scope is a block or a package (and that recursion continues to the top
1000 -- scope that is not a block or a package). This is used when the
1001 -- sequential flow-of-control assumption is violated (occurrence of a
1002 -- label, head of a loop, or start of an exception handler). The effect of
1003 -- the call is to clear the Constant_Value field (but we do not need to
1004 -- clear the Is_True_Constant flag, since that only gets reset if there
1005 -- really is an assignment somewhere in the entity scope). This procedure
1006 -- also calls Kill_All_Checks, since this is a special case of needing to
1007 -- forget saved values. This procedure also clears the Is_Known_Null and
1008 -- Is_Known_Non_Null and Is_Known_Valid flags in variables, constants or
1009 -- parameters since these are also not known to be trustable any more.
1011 -- The Last_Assignment_Only flag is set True to clear only Last_Assignment
1012 -- fields and leave other fields unchanged. This is used when we encounter
1013 -- an unconditional flow of control change (return, goto, raise). In such
1014 -- cases we don't need to clear the current values, since it may be that
1015 -- the flow of control change occurs in a conditional context, and if it
1016 -- is not taken, then it is just fine to keep the current values. But the
1017 -- Last_Assignment field is different, if we have a sequence assign-to-v,
1018 -- conditional-return, assign-to-v, we do not want to complain that the
1019 -- second assignment clobbers the first.
1021 procedure Kill_Current_Values
1023 Last_Assignment_Only : Boolean := False);
1024 -- This performs the same processing as described above for the form with
1025 -- no argument, but for the specific entity given. The call has no effect
1026 -- if the entity Ent is not for an object. Last_Assignment_Only has the
1027 -- same meaning as for the call with no Ent.
1029 procedure Kill_Size_Check_Code (E : Entity_Id);
1030 -- Called when an address clause or pragma Import is applied to an entity.
1031 -- If the entity is a variable or a constant, and size check code is
1032 -- present, this size check code is killed, since the object will not be
1033 -- allocated by the program.
1035 function Known_To_Be_Assigned (N : Node_Id) return Boolean;
1036 -- The node N is an entity reference. This function determines whether the
1037 -- reference is for sure an assignment of the entity, returning True if
1038 -- so. This differs from May_Be_Lvalue in that it defaults in the other
1039 -- direction. Cases which may possibly be assignments but are not known to
1040 -- be may return True from May_Be_Lvalue, but False from this function.
1042 function Last_Source_Statement (HSS : Node_Id) return Node_Id;
1043 -- HSS is a handled statement sequence. This function returns the last
1044 -- statement in Statements (HSS) that has Comes_From_Source set. If no
1045 -- such statement exists, Empty is returned.
1047 function Make_Simple_Return_Statement
1049 Expression : Node_Id := Empty) return Node_Id
1050 renames Make_Return_Statement;
1051 -- See Sinfo. We rename Make_Return_Statement to the correct Ada 2005
1052 -- terminology here. Clients should use Make_Simple_Return_Statement.
1054 function Matching_Static_Array_Bounds
1056 R_Typ : Node_Id) return Boolean;
1057 -- L_Typ and R_Typ are two array types. Returns True when they have the
1058 -- same number of dimensions, and the same static bounds for each index
1061 Make_Return_Statement : constant := -2 ** 33;
1062 -- Attempt to prevent accidental uses of Make_Return_Statement. If this
1063 -- and the one in Nmake are both potentially use-visible, it will cause
1064 -- a compilation error. Note that type and value are irrelevant.
1066 N_Return_Statement : constant := -2**33;
1067 -- Attempt to prevent accidental uses of N_Return_Statement; similar to
1068 -- Make_Return_Statement above.
1070 procedure Mark_Coextensions (Context_Nod : Node_Id; Root_Nod : Node_Id);
1071 -- Given a node which designates the context of analysis and an origin in
1072 -- the tree, traverse from Root_Nod and mark all allocators as either
1073 -- dynamic or static depending on Context_Nod. Any erroneous marking is
1074 -- cleaned up during resolution.
1076 function May_Be_Lvalue (N : Node_Id) return Boolean;
1077 -- Determines if N could be an lvalue (e.g. an assignment left hand side).
1078 -- An lvalue is defined as any expression which appears in a context where
1079 -- a name is required by the syntax, and the identity, rather than merely
1080 -- the value of the node is needed (for example, the prefix of an Access
1081 -- attribute is in this category). Note that, as implied by the name, this
1082 -- test is conservative. If it cannot be sure that N is NOT an lvalue, then
1083 -- it returns True. It tries hard to get the answer right, but it is hard
1084 -- to guarantee this in all cases. Note that it is more possible to give
1085 -- correct answer if the tree is fully analyzed.
1087 function Needs_One_Actual (E : Entity_Id) return Boolean;
1088 -- Returns True if a function has defaults for all but its first
1089 -- formal. Used in Ada 2005 mode to solve the syntactic ambiguity that
1090 -- results from an indexing of a function call written in prefix form.
1092 function New_Copy_List_Tree (List : List_Id) return List_Id;
1093 -- Copy recursively an analyzed list of nodes. Uses New_Copy_Tree defined
1094 -- below. As for New_Copy_Tree, it is illegal to attempt to copy extended
1095 -- nodes (entities) either directly or indirectly using this function.
1097 function New_Copy_Tree
1099 Map : Elist_Id := No_Elist;
1100 New_Sloc : Source_Ptr := No_Location;
1101 New_Scope : Entity_Id := Empty) return Node_Id;
1102 -- Given a node that is the root of a subtree, Copy_Tree copies the entire
1103 -- syntactic subtree, including recursively any descendents whose parent
1104 -- field references a copied node (descendents not linked to a copied node
1105 -- by the parent field are not copied, instead the copied tree references
1106 -- the same descendent as the original in this case, which is appropriate
1107 -- for non-syntactic fields such as Etype). The parent pointers in the
1108 -- copy are properly set. Copy_Tree (Empty/Error) returns Empty/Error.
1109 -- The one exception to the rule of not copying semantic fields is that
1110 -- any implicit types attached to the subtree are duplicated, so that
1111 -- the copy contains a distinct set of implicit type entities. Thus this
1112 -- function is used when it is necessary to duplicate an analyzed tree,
1113 -- declared in the same or some other compilation unit. This function is
1114 -- declared here rather than in atree because it uses semantic information
1115 -- in particular concerning the structure of itypes and the generation of
1118 -- The Map argument, if set to a non-empty Elist, specifies a set of
1119 -- mappings to be applied to entities in the tree. The map has the form:
1122 -- new entity to replace references to entity 1
1124 -- new entity to replace references to entity 2
1127 -- The call destroys the contents of Map in this case
1129 -- The parameter New_Sloc, if set to a value other than No_Location, is
1130 -- used as the Sloc value for all nodes in the new copy. If New_Sloc is
1131 -- set to its default value No_Location, then the Sloc values of the
1132 -- nodes in the copy are simply copied from the corresponding original.
1134 -- The Comes_From_Source indication is unchanged if New_Sloc is set to
1135 -- the default No_Location value, but is reset if New_Sloc is given, since
1136 -- in this case the result clearly is neither a source node or an exact
1137 -- copy of a source node.
1139 -- The parameter New_Scope, if set to a value other than Empty, is the
1140 -- value to use as the Scope for any Itypes that are copied. The most
1141 -- typical value for this parameter, if given, is Current_Scope.
1143 function New_External_Entity
1144 (Kind : Entity_Kind;
1145 Scope_Id : Entity_Id;
1146 Sloc_Value : Source_Ptr;
1147 Related_Id : Entity_Id;
1149 Suffix_Index : Nat := 0;
1150 Prefix : Character := ' ') return Entity_Id;
1151 -- This function creates an N_Defining_Identifier node for an internal
1152 -- created entity, such as an implicit type or subtype, or a record
1153 -- initialization procedure. The entity name is constructed with a call
1154 -- to New_External_Name (Related_Id, Suffix, Suffix_Index, Prefix), so
1155 -- that the generated name may be referenced as a public entry, and the
1156 -- Is_Public flag is set if needed (using Set_Public_Status). If the
1157 -- entity is for a type or subtype, the size/align fields are initialized
1158 -- to unknown (Uint_0).
1160 function New_Internal_Entity
1161 (Kind : Entity_Kind;
1162 Scope_Id : Entity_Id;
1163 Sloc_Value : Source_Ptr;
1164 Id_Char : Character) return Entity_Id;
1165 -- This function is similar to New_External_Entity, except that the
1166 -- name is constructed by New_Internal_Name (Id_Char). This is used
1167 -- when the resulting entity does not have to be referenced as a
1168 -- public entity (and in this case Is_Public is not set).
1170 procedure Next_Actual (Actual_Id : in out Node_Id);
1171 pragma Inline (Next_Actual);
1172 -- Next_Actual (N) is equivalent to N := Next_Actual (N). Note that we
1173 -- inline this procedural form, but not the functional form that follows.
1175 function Next_Actual (Actual_Id : Node_Id) return Node_Id;
1176 -- Find next actual parameter in declaration order. As described for
1177 -- First_Actual, this is the next actual in the declaration order, not
1178 -- the call order, so this does not correspond to simply taking the
1179 -- next entry of the Parameter_Associations list. The argument is an
1180 -- actual previously returned by a call to First_Actual or Next_Actual.
1181 -- Note that the result produced is always an expression, not a parameter
1182 -- association node, even if named notation was used.
1184 procedure Normalize_Actuals
1188 Success : out Boolean);
1189 -- Reorders lists of actuals according to names of formals, value returned
1190 -- in Success indicates success of reordering. For more details, see body.
1191 -- Errors are reported only if Report is set to True.
1193 procedure Note_Possible_Modification (N : Node_Id; Sure : Boolean);
1194 -- This routine is called if the sub-expression N maybe the target of
1195 -- an assignment (e.g. it is the left side of an assignment, used as
1196 -- an out parameters, or used as prefixes of access attributes). It
1197 -- sets May_Be_Modified in the associated entity if there is one,
1198 -- taking into account the rule that in the case of renamed objects,
1199 -- it is the flag in the renamed object that must be set.
1201 -- The parameter Sure is set True if the modification is sure to occur
1202 -- (e.g. target of assignment, or out parameter), and to False if the
1203 -- modification is only potential (e.g. address of entity taken).
1205 function Original_Corresponding_Operation (S : Entity_Id) return Entity_Id;
1206 -- [Ada 2012: AI05-0125-1]: If S is an inherited dispatching primitive S2,
1207 -- or overrides an inherited dispatching primitive S2, the original
1208 -- corresponding operation of S is the original corresponding operation of
1209 -- S2. Otherwise, it is S itself.
1211 function Object_Access_Level (Obj : Node_Id) return Uint;
1212 -- Return the accessibility level of the view of the object Obj.
1213 -- For convenience, qualified expressions applied to object names
1214 -- are also allowed as actuals for this function.
1216 function Primitive_Names_Match (E1, E2 : Entity_Id) return Boolean;
1217 -- Returns True if the names of both entities correspond with matching
1218 -- primitives. This routine includes support for the case in which one
1219 -- or both entities correspond with entities built by Derive_Subprogram
1220 -- with a special name to avoid being overridden (i.e. return true in case
1221 -- of entities with names "nameP" and "name" or vice versa).
1223 function Private_Component (Type_Id : Entity_Id) return Entity_Id;
1224 -- Returns some private component (if any) of the given Type_Id.
1225 -- Used to enforce the rules on visibility of operations on composite
1226 -- types, that depend on the full view of the component type. For a
1227 -- record type there may be several such components, we just return
1230 procedure Process_End_Label
1234 -- N is a node whose End_Label is to be processed, generating all
1235 -- appropriate cross-reference entries, and performing style checks
1236 -- for any identifier references in the end label. Typ is either
1237 -- 'e' or 't indicating the type of the cross-reference entity
1238 -- (e for spec, t for body, see Lib.Xref spec for details). The
1239 -- parameter Ent gives the entity to which the End_Label refers,
1240 -- and to which cross-references are to be generated.
1242 function References_Generic_Formal_Type (N : Node_Id) return Boolean;
1243 -- Returns True if the expression Expr contains any references to a
1244 -- generic type. This can only happen within a generic template.
1246 procedure Remove_Homonym (E : Entity_Id);
1247 -- Removes E from the homonym chain
1249 function Rep_To_Pos_Flag (E : Entity_Id; Loc : Source_Ptr) return Node_Id;
1250 -- This is used to construct the second argument in a call to Rep_To_Pos
1251 -- which is Standard_True if range checks are enabled (E is an entity to
1252 -- which the Range_Checks_Suppressed test is applied), and Standard_False
1253 -- if range checks are suppressed. Loc is the location for the node that
1254 -- is returned (which is a New_Occurrence of the appropriate entity).
1256 -- Note: one might think that it would be fine to always use True and
1257 -- to ignore the suppress in this case, but it is generally better to
1258 -- believe a request to suppress exceptions if possible, and further
1259 -- more there is at least one case in the generated code (the code for
1260 -- array assignment in a loop) that depends on this suppression.
1262 procedure Require_Entity (N : Node_Id);
1263 -- N is a node which should have an entity value if it is an entity name.
1264 -- If not, then check if there were previous errors. If so, just fill
1265 -- in with Any_Id and ignore. Otherwise signal a program error exception.
1266 -- This is used as a defense mechanism against ill-formed trees caused by
1267 -- previous errors (particularly in -gnatq mode).
1269 function Requires_Transient_Scope (Id : Entity_Id) return Boolean;
1270 -- Id is a type entity. The result is True when temporaries of this type
1271 -- need to be wrapped in a transient scope to be reclaimed properly when a
1272 -- secondary stack is in use. Examples of types requiring such wrapping are
1273 -- controlled types and variable-sized types including unconstrained
1276 procedure Reset_Analyzed_Flags (N : Node_Id);
1277 -- Reset the Analyzed flags in all nodes of the tree whose root is N
1279 function Safe_To_Capture_Value
1282 Cond : Boolean := False) return Boolean;
1283 -- The caller is interested in capturing a value (either the current value,
1284 -- or an indication that the value is non-null) for the given entity Ent.
1285 -- This value can only be captured if sequential execution semantics can be
1286 -- properly guaranteed so that a subsequent reference will indeed be sure
1287 -- that this current value indication is correct. The node N is the
1288 -- construct which resulted in the possible capture of the value (this
1289 -- is used to check if we are in a conditional).
1291 -- Cond is used to skip the test for being inside a conditional. It is used
1292 -- in the case of capturing values from if/while tests, which already do a
1293 -- proper job of handling scoping issues without this help.
1295 -- The only entities whose values can be captured are OUT and IN OUT formal
1296 -- parameters, and variables unless Cond is True, in which case we also
1297 -- allow IN formals, loop parameters and constants, where we cannot ever
1298 -- capture actual value information, but we can capture conditional tests.
1300 function Same_Name (N1, N2 : Node_Id) return Boolean;
1301 -- Determine if two (possibly expanded) names are the same name. This is
1302 -- a purely syntactic test, and N1 and N2 need not be analyzed.
1304 function Same_Object (Node1, Node2 : Node_Id) return Boolean;
1305 -- Determine if Node1 and Node2 are known to designate the same object.
1306 -- This is a semantic test and both nodes must be fully analyzed. A result
1307 -- of True is decisively correct. A result of False does not necessarily
1308 -- mean that different objects are designated, just that this could not
1309 -- be reliably determined at compile time.
1311 function Same_Type (T1, T2 : Entity_Id) return Boolean;
1312 -- Determines if T1 and T2 represent exactly the same type. Two types
1313 -- are the same if they are identical, or if one is an unconstrained
1314 -- subtype of the other, or they are both common subtypes of the same
1315 -- type with identical constraints. The result returned is conservative.
1316 -- It is True if the types are known to be the same, but a result of
1317 -- False is indecisive (e.g. the compiler may not be able to tell that
1318 -- two constraints are identical).
1320 function Same_Value (Node1, Node2 : Node_Id) return Boolean;
1321 -- Determines if Node1 and Node2 are known to be the same value, which is
1322 -- true if they are both compile time known values and have the same value,
1323 -- or if they are the same object (in the sense of function Same_Object).
1324 -- A result of False does not necessarily mean they have different values,
1325 -- just that it is not possible to determine they have the same value.
1327 function Scope_Within_Or_Same (Scope1, Scope2 : Entity_Id) return Boolean;
1328 -- Determines if the entity Scope1 is the same as Scope2, or if it is
1329 -- inside it, where both entities represent scopes. Note that scopes
1330 -- are only partially ordered, so Scope_Within_Or_Same (A,B) and
1331 -- Scope_Within_Or_Same (B,A) can both be False for a given pair A,B.
1333 procedure Save_Actual (N : Node_Id; Writable : Boolean := False);
1334 -- Enter an actual in a call in a table global, for subsequent check of
1335 -- possible order dependence in the presence of IN OUT parameters for
1336 -- functions in Ada 2012 (or access parameters in older language versions).
1338 function Scope_Within (Scope1, Scope2 : Entity_Id) return Boolean;
1339 -- Like Scope_Within_Or_Same, except that this function returns
1340 -- False in the case where Scope1 and Scope2 are the same scope.
1342 procedure Set_Convention (E : Entity_Id; Val : Convention_Id);
1343 -- Same as Basic_Set_Convention, but with an extra check for access types.
1344 -- In particular, if E is an access-to-subprogram type, and Val is a
1345 -- foreign convention, then we set Can_Use_Internal_Rep to False on E.
1347 procedure Set_Current_Entity (E : Entity_Id);
1348 pragma Inline (Set_Current_Entity);
1349 -- Establish the entity E as the currently visible definition of its
1350 -- associated name (i.e. the Node_Id associated with its name).
1352 procedure Set_Debug_Info_Needed (T : Entity_Id);
1353 -- Sets the Debug_Info_Needed flag on entity T , and also on any entities
1354 -- that are needed by T (for an object, the type of the object is needed,
1355 -- and for a type, various subsidiary types are needed -- see body for
1356 -- details). Never has any effect on T if the Debug_Info_Off flag is set.
1357 -- This routine should always be used instead of Set_Needs_Debug_Info to
1358 -- ensure that subsidiary entities are properly handled.
1360 procedure Set_Entity_With_Style_Check (N : Node_Id; Val : Entity_Id);
1361 -- This procedure has the same calling sequence as Set_Entity, but
1362 -- if Style_Check is set, then it calls a style checking routine which
1363 -- can check identifier spelling style.
1365 procedure Set_Name_Entity_Id (Id : Name_Id; Val : Entity_Id);
1366 pragma Inline (Set_Name_Entity_Id);
1367 -- Sets the Entity_Id value associated with the given name, which is the
1368 -- Id of the innermost visible entity with the given name. See the body
1369 -- of package Sem_Ch8 for further details on the handling of visibility.
1371 procedure Set_Next_Actual (Ass1_Id : Node_Id; Ass2_Id : Node_Id);
1372 -- The arguments may be parameter associations, whose descendants
1373 -- are the optional formal name and the actual parameter. Positional
1374 -- parameters are already members of a list, and do not need to be
1375 -- chained separately. See also First_Actual and Next_Actual.
1377 procedure Set_Optimize_Alignment_Flags (E : Entity_Id);
1378 pragma Inline (Set_Optimize_Alignment_Flags);
1379 -- Sets Optimize_Alignment_Space/Time flags in E from current settings
1381 procedure Set_Public_Status (Id : Entity_Id);
1382 -- If an entity (visible or otherwise) is defined in a library
1383 -- package, or a package that is itself public, then this subprogram
1384 -- labels the entity public as well.
1386 procedure Set_Referenced_Modified (N : Node_Id; Out_Param : Boolean);
1387 -- N is the node for either a left hand side (Out_Param set to False),
1388 -- or an Out or In_Out parameter (Out_Param set to True). If there is
1389 -- an assignable entity being referenced, then the appropriate flag
1390 -- (Referenced_As_LHS if Out_Param is False, Referenced_As_Out_Parameter
1391 -- if Out_Param is True) is set True, and the other flag set False.
1393 procedure Set_Scope_Is_Transient (V : Boolean := True);
1394 -- Set the flag Is_Transient of the current scope
1396 procedure Set_Size_Info (T1, T2 : Entity_Id);
1397 pragma Inline (Set_Size_Info);
1398 -- Copies the Esize field and Has_Biased_Representation flag from sub(type)
1399 -- entity T2 to (sub)type entity T1. Also copies the Is_Unsigned_Type flag
1400 -- in the fixed-point and discrete cases, and also copies the alignment
1401 -- value from T2 to T1. It does NOT copy the RM_Size field, which must be
1402 -- separately set if this is required to be copied also.
1404 function Scope_Is_Transient return Boolean;
1405 -- True if the current scope is transient
1407 function Static_Boolean (N : Node_Id) return Uint;
1408 -- This function analyzes the given expression node and then resolves it
1409 -- as Standard.Boolean. If the result is static, then Uint_1 or Uint_0 is
1410 -- returned corresponding to the value, otherwise an error message is
1411 -- output and No_Uint is returned.
1413 function Static_Integer (N : Node_Id) return Uint;
1414 -- This function analyzes the given expression node and then resolves it
1415 -- as any integer type. If the result is static, then the value of the
1416 -- universal expression is returned, otherwise an error message is output
1417 -- and a value of No_Uint is returned.
1419 function Statically_Different (E1, E2 : Node_Id) return Boolean;
1420 -- Return True if it can be statically determined that the Expressions
1421 -- E1 and E2 refer to different objects
1423 function Subprogram_Access_Level (Subp : Entity_Id) return Uint;
1424 -- Return the accessibility level of the view denoted by Subp
1426 procedure Trace_Scope (N : Node_Id; E : Entity_Id; Msg : String);
1427 -- Print debugging information on entry to each unit being analyzed
1429 procedure Transfer_Entities (From : Entity_Id; To : Entity_Id);
1430 -- Move a list of entities from one scope to another, and recompute
1431 -- Is_Public based upon the new scope.
1433 function Type_Access_Level (Typ : Entity_Id) return Uint;
1434 -- Return the accessibility level of Typ
1436 function Type_Without_Stream_Operation
1438 Op : TSS_Name_Type := TSS_Null) return Entity_Id;
1439 -- AI05-0161: In Ada 2012, if the restriction No_Default_Stream_Attributes
1440 -- is active then we cannot generate stream subprograms for composite types
1441 -- with elementary subcomponents that lack user-defined stream subprograms.
1442 -- This predicate determines whether a type has such an elementary
1443 -- subcomponent. If Op is TSS_Null, a type that lacks either Read or Write
1444 -- prevents the construction of a composite stream operation. If Op is
1445 -- specified we check only for the given stream operation.
1447 function Unique_Defining_Entity (N : Node_Id) return Entity_Id;
1448 -- Return the entity which represents declaration N, so that different
1449 -- views of the same entity have the same unique defining entity:
1450 -- * package spec and body;
1451 -- * subprogram declaration, subprogram stub and subprogram body;
1452 -- * private view and full view of a type;
1453 -- * private view and full view of a deferred constant.
1454 -- In other cases, return the defining entity for N.
1456 function Unique_Entity (E : Entity_Id) return Entity_Id;
1457 -- Return the unique entity for entity E, which would be returned by
1458 -- Unique_Defining_Entity if applied to the enclosing declaration of E.
1460 function Unique_Name (E : Entity_Id) return String;
1461 -- Return a unique name for entity E, which could be used to identify E
1462 -- across compilation units.
1464 function Unit_Declaration_Node (Unit_Id : Entity_Id) return Node_Id;
1465 -- Unit_Id is the simple name of a program unit, this function returns the
1466 -- corresponding xxx_Declaration node for the entity. Also applies to the
1467 -- body entities for subprograms, tasks and protected units, in which case
1468 -- it returns the subprogram, task or protected body node for it. The unit
1469 -- may be a child unit with any number of ancestors.
1471 function Unit_Is_Visible (U : Entity_Id) return Boolean;
1472 -- Determine whether a compilation unit is visible in the current context,
1473 -- because there is a with_clause that makes the unit available. Used to
1474 -- provide better messages on common visiblity errors on operators.
1476 function Universal_Interpretation (Opnd : Node_Id) return Entity_Id;
1477 -- Yields Universal_Integer or Universal_Real if this is a candidate
1479 function Unqualify (Expr : Node_Id) return Node_Id;
1480 pragma Inline (Unqualify);
1481 -- Removes any qualifications from Expr. For example, for T1'(T2'(X)), this
1482 -- returns X. If Expr is not a qualified expression, returns Expr.
1484 function Visible_Ancestors (Typ : Entity_Id) return Elist_Id;
1485 -- [Ada 2012:AI-0125-1]: Collect all the visible parents and progenitors
1486 -- of a type extension or private extension declaration. If the full-view
1487 -- of private parents and progenitors is available then it is used to
1488 -- generate the list of visible ancestors; otherwise their partial
1489 -- view is added to the resulting list.
1491 function Within_Init_Proc return Boolean;
1492 -- Determines if Current_Scope is within an init proc
1494 procedure Wrong_Type (Expr : Node_Id; Expected_Type : Entity_Id);
1495 -- Output error message for incorrectly typed expression. Expr is the node
1496 -- for the incorrectly typed construct (Etype (Expr) is the type found),
1497 -- and Expected_Type is the entity for the expected type. Note that Expr
1498 -- does not have to be a subexpression, anything with an Etype field may