1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2016, 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 expander
28 with Exp_Tss
; use Exp_Tss
;
29 with Namet
; use Namet
;
30 with Rtsfind
; use Rtsfind
;
31 with Sinfo
; use Sinfo
;
32 with Types
; use Types
;
33 with Uintp
; use Uintp
;
37 -----------------------------------------------
38 -- Handling of Actions Associated with Nodes --
39 -----------------------------------------------
41 -- The evaluation of certain expression nodes involves the elaboration
42 -- of associated types and other declarations, and the execution of
43 -- statement sequences. Expansion routines generating such actions must
44 -- find an appropriate place in the tree to hang the actions so that
45 -- they will be evaluated at the appropriate point.
47 -- Some cases are simple:
49 -- For an expression occurring in a simple statement that is in a list
50 -- of statements, the actions are simply inserted into the list before
51 -- the associated statement.
53 -- For an expression occurring in a declaration (declarations always
54 -- appear in lists), the actions are similarly inserted into the list
55 -- just before the associated declaration.
57 -- The following special cases arise:
59 -- For actions associated with the right operand of a short circuit
60 -- form, the actions are first stored in the short circuit form node
61 -- in the Actions field. The expansion of these forms subsequently
62 -- expands the short circuit forms into if statements which can then
63 -- be moved as described above.
65 -- For actions appearing in the Condition expression of a while loop,
66 -- or an elsif clause, the actions are similarly temporarily stored in
67 -- in the node (N_Elsif_Part or N_Iteration_Scheme) associated with
68 -- the expression using the Condition_Actions field. Subsequently, the
69 -- expansion of these nodes rewrites the control structures involved to
70 -- reposition the actions in normal statement sequence.
72 -- For actions appearing in the then or else expression of a conditional
73 -- expression, these actions are similarly placed in the node, using the
74 -- Then_Actions or Else_Actions field as appropriate. Once again the
75 -- expansion of the N_If_Expression node rewrites the node so that the
76 -- actions can be positioned normally.
78 -- For actions coming from expansion of the expression in an expression
79 -- with actions node, the action is appended to the list of actions.
81 -- Basically what we do is to climb up to the tree looking for the
82 -- proper insertion point, as described by one of the above cases,
83 -- and then insert the appropriate action or actions.
85 -- Note if more than one insert call is made specifying the same
86 -- Assoc_Node, then the actions are elaborated in the order of the
87 -- calls, and this guarantee is preserved for the special cases above.
89 procedure Insert_Action
90 (Assoc_Node
: Node_Id
;
91 Ins_Action
: Node_Id
);
92 -- Insert the action Ins_Action at the appropriate point as described
93 -- above. The action is analyzed using the default checks after it is
94 -- inserted. Assoc_Node is the node with which the action is associated.
96 procedure Insert_Action
97 (Assoc_Node
: Node_Id
;
100 -- Insert the action Ins_Action at the appropriate point as described
101 -- above. The action is analyzed using the default checks as modified
102 -- by the given Suppress argument after it is inserted. Assoc_Node is
103 -- the node with which the action is associated.
105 procedure Insert_Actions
106 (Assoc_Node
: Node_Id
;
107 Ins_Actions
: List_Id
);
108 -- Insert the list of action Ins_Actions at the appropriate point as
109 -- described above. The actions are analyzed using the default checks
110 -- after they are inserted. Assoc_Node is the node with which the actions
111 -- are associated. Ins_Actions may be No_List, in which case the call has
114 procedure Insert_Actions
115 (Assoc_Node
: Node_Id
;
116 Ins_Actions
: List_Id
;
117 Suppress
: Check_Id
);
118 -- Insert the list of action Ins_Actions at the appropriate point as
119 -- described above. The actions are analyzed using the default checks
120 -- as modified by the given Suppress argument after they are inserted.
121 -- Assoc_Node is the node with which the actions are associated.
122 -- Ins_Actions may be No_List, in which case the call has no effect.
124 procedure Insert_Action_After
125 (Assoc_Node
: Node_Id
;
126 Ins_Action
: Node_Id
);
127 -- Assoc_Node must be a node in a list. Same as Insert_Action but the
128 -- action will be inserted after N in a manner that is compatible with
129 -- the transient scope mechanism.
131 -- Note: If several successive calls to Insert_Action_After are made for
132 -- the same node, they will each in turn be inserted just after the node.
133 -- This means they will end up being executed in reverse order. Use the
134 -- call to Insert_Actions_After to insert a list of actions to be executed
135 -- in the sequence in which they are given in the list.
137 procedure Insert_Actions_After
138 (Assoc_Node
: Node_Id
;
139 Ins_Actions
: List_Id
);
140 -- Assoc_Node must be a node in a list. Same as Insert_Actions but
141 -- actions will be inserted after N in a manner that is compatible with
142 -- the transient scope mechanism. This procedure must be used instead
143 -- of Insert_List_After if Assoc_Node may be in a transient scope.
145 -- Implementation limitation: Assoc_Node must be a statement. We can
146 -- generalize to expressions if there is a need but this is tricky to
147 -- implement because of short-circuits (among other things).???
149 procedure Insert_Declaration
(N
: Node_Id
; Decl
: Node_Id
);
150 -- N must be a subexpression (Nkind in N_Subexpr). This is similar to
151 -- Insert_Action (N, Decl), but inserts Decl outside the expression in
152 -- which N appears. This is called Insert_Declaration because the intended
153 -- use is for declarations that have no associated code. We can't go
154 -- moving other kinds of things out of the current expression, since they
155 -- could be executed conditionally (e.g. right operand of short circuit,
156 -- or THEN/ELSE of if expression). This is currently used only in
157 -- Modify_Tree_For_C mode, where it is needed because in C we have no
158 -- way of having declarations within an expression (a really annoying
161 procedure Insert_Library_Level_Action
(N
: Node_Id
);
162 -- This procedure inserts and analyzes the node N as an action at the
163 -- library level for the current unit (i.e. it is attached to the
164 -- Actions field of the N_Compilation_Aux node for the main unit).
166 procedure Insert_Library_Level_Actions
(L
: List_Id
);
167 -- Similar, but inserts a list of actions
169 -----------------------
170 -- Other Subprograms --
171 -----------------------
173 procedure Activate_Atomic_Synchronization
(N
: Node_Id
);
174 -- N is a node for which atomic synchronization may be required (it is
175 -- either an identifier, expanded name, or selected/indexed component or
176 -- an explicit dereference). The caller has checked the basic conditions
177 -- (atomic variable appearing and Atomic_Sync not disabled). This function
178 -- checks if atomic synchronization is required and if so sets the flag
179 -- and if appropriate generates a warning (in -gnatw.n mode).
181 procedure Adjust_Condition
(N
: Node_Id
);
182 -- The node N is an expression whose root-type is Boolean, and which
183 -- represents a boolean value used as a condition (i.e. a True/False
184 -- value). This routine handles the case of C and Fortran convention
185 -- boolean types, which have zero/non-zero semantics rather than the normal
186 -- 0/1 semantics, and also the case of an enumeration rep clause that
187 -- specifies a non-standard representation. On return, node N always has
188 -- the type Standard.Boolean, with a value that is a standard Boolean
189 -- values of 0/1 for False/True. This procedure is used in two situations.
190 -- First, the processing for a condition field always calls
191 -- Adjust_Condition, so that the boolean value presented to the backend is
192 -- a standard value. Second, for the code for boolean operations such as
193 -- AND, Adjust_Condition is called on both operands, and then the operation
194 -- is done in the domain of Standard_Boolean, then Adjust_Result_Type is
195 -- called on the result to possibly reset the original type. This procedure
196 -- also takes care of validity checking if Validity_Checks = Tests.
198 procedure Adjust_Result_Type
(N
: Node_Id
; T
: Entity_Id
);
199 -- The processing of boolean operations like AND uses the procedure
200 -- Adjust_Condition so that it can operate on Standard.Boolean, which is
201 -- the only boolean type on which the backend needs to be able to implement
202 -- such operators. This means that the result is also of type
203 -- Standard.Boolean. In general the type must be reset back to the original
204 -- type to get proper semantics, and that is the purpose of this procedure.
205 -- N is the node (of type Standard.Boolean), and T is the desired type. As
206 -- an optimization, this procedure leaves the type as Standard.Boolean in
207 -- contexts where this is permissible (in particular for Condition fields,
208 -- and for operands of other logical operations higher up the tree). The
209 -- call to this procedure is completely ignored if the argument N is not of
212 procedure Append_Freeze_Action
(T
: Entity_Id
; N
: Node_Id
);
213 -- Add a new freeze action for the given type. The freeze action is
214 -- attached to the freeze node for the type. Actions will be elaborated in
215 -- the order in which they are added. Note that the added node is not
216 -- analyzed. The analyze call is found in Exp_Ch13.Expand_N_Freeze_Entity.
218 procedure Append_Freeze_Actions
(T
: Entity_Id
; L
: List_Id
);
219 -- Adds the given list of freeze actions (declarations or statements) for
220 -- the given type. The freeze actions are attached to the freeze node for
221 -- the type. Actions will be elaborated in the order in which they are
222 -- added, and the actions within the list will be elaborated in list order.
223 -- Note that the added nodes are not analyzed. The analyze call is found in
224 -- Exp_Ch13.Expand_N_Freeze_Entity.
226 procedure Build_Allocate_Deallocate_Proc
228 Is_Allocate
: Boolean);
229 -- Create a custom Allocate/Deallocate to be associated with an allocation
232 -- 1) controlled objects
233 -- 2) class-wide objects
234 -- 3) any kind of object on a subpool
236 -- N must be an allocator or the declaration of a temporary variable which
237 -- represents the expression of the original allocator node, otherwise N
238 -- must be a free statement. If flag Is_Allocate is set, the generated
239 -- routine is allocate, deallocate otherwise.
241 function Build_Abort_Undefer_Block
244 Context
: Node_Id
) return Node_Id
;
245 -- Wrap statements Stmts in a block where the AT END handler contains a
246 -- call to Abort_Undefer_Direct. Context is the node which prompted the
247 -- inlining of the abort undefer routine. Note that this routine does
248 -- not install a call to Abort_Defer.
250 procedure Build_Class_Wide_Expression
253 Par_Subp
: Entity_Id
;
254 Adjust_Sloc
: Boolean);
255 -- Build the expression for an inherited class-wide condition. Prag is
256 -- the pragma constructed from the corresponding aspect of the parent
257 -- subprogram, and Subp is the overriding operation, and Par_Subp is
258 -- the overridden operation that has the condition. Adjust_Sloc is True
259 -- when the sloc of nodes traversed should be adjusted for the inherited
260 -- pragma. The routine is also called to check whether an inherited
261 -- operation that is not overridden but has inherited conditions needs
262 -- a wrapper, because the inherited condition includes calls to other
263 -- primitives that have been overridden. In that case the first argument
264 -- is the expression of the original class-wide aspect. In SPARK_Mode, such
265 -- operation which are just inherited but have modified pre/postconditions
268 function Build_DIC_Call
271 Typ
: Entity_Id
) return Node_Id
;
272 -- Build a call to the DIC procedure of type Typ with Obj_Id as the actual
275 procedure Build_DIC_Procedure_Body
(Typ
: Entity_Id
);
276 -- Create the body of the procedure which verifies the assertion expression
277 -- of pragma Default_Initial_Condition at run time.
279 procedure Build_DIC_Procedure_Declaration
(Typ
: Entity_Id
);
280 -- Create the declaration of the procedure which verifies the assertion
281 -- expression of pragma Default_Initial_Condition at run time.
283 procedure Build_Procedure_Form
(N
: Node_Id
);
284 -- Create a procedure declaration which emulates the behavior of a function
285 -- that returns an array type, for C-compatible generation.
287 function Build_Runtime_Call
(Loc
: Source_Ptr
; RE
: RE_Id
) return Node_Id
;
288 -- Build an N_Procedure_Call_Statement calling the given runtime entity.
289 -- The call has no parameters. The first argument provides the location
290 -- information for the tree and for error messages. The call node is not
291 -- analyzed on return, the caller is responsible for analyzing it.
293 function Build_SS_Mark_Call
295 Mark
: Entity_Id
) return Node_Id
;
296 -- Build a call to routine System.Secondary_Stack.Mark. Mark denotes the
297 -- entity of the secondary stack mark.
299 function Build_SS_Release_Call
301 Mark
: Entity_Id
) return Node_Id
;
302 -- Build a call to routine System.Secondary_Stack.Release. Mark denotes the
303 -- entity of the secondary stack mark.
305 function Build_Task_Image_Decls
309 In_Init_Proc
: Boolean := False) return List_Id
;
310 -- Build declaration for a variable that holds an identifying string to be
311 -- used as a task name. Id_Ref is an identifier if the task is a variable,
312 -- and a selected or indexed component if the task is component of an
313 -- object. If it is an indexed component, A_Type is the corresponding array
314 -- type. Its index types are used to build the string as an image of the
315 -- index values. For composite types, the result includes two declarations:
316 -- one for a generated function that computes the image without using
317 -- concatenation, and one for the variable that holds the result.
319 -- If In_Init_Proc is true, the call is part of the initialization of
320 -- a component of a composite type, and the enclosing initialization
321 -- procedure must be flagged as using the secondary stack. If In_Init_Proc
322 -- is false, the call is for a stand-alone object, and the generated
323 -- function itself must do its own cleanups.
325 procedure Build_Transient_Object_Statements
327 Fin_Call
: out Node_Id
;
328 Hook_Assign
: out Node_Id
;
329 Hook_Clear
: out Node_Id
;
330 Hook_Decl
: out Node_Id
;
331 Ptr_Decl
: out Node_Id
;
332 Finalize_Obj
: Boolean := True);
333 -- Subsidiary to the processing of transient objects in transient scopes,
334 -- if expressions, case expressions, expression_with_action nodes, array
335 -- aggregates, and record aggregates. Obj_Decl denotes the declaration of
336 -- the transient object. Generate the following nodes:
338 -- * Fin_Call - the call to [Deep_]Finalize which cleans up the transient
339 -- object if flag Finalize_Obj is set to True, or finalizes the hook when
340 -- the flag is False.
342 -- * Hook_Assign - the assignment statement which captures a reference to
343 -- the transient object in the hook.
345 -- * Hook_Clear - the assignment statement which resets the hook to null
347 -- * Hook_Decl - the declaration of the hook object
349 -- * Ptr_Decl - the full type declaration of the hook type
351 -- These nodes are inserted in specific places depending on the context by
352 -- the various Process_Transient_xxx routines.
354 procedure Check_Float_Op_Overflow
(N
: Node_Id
);
355 -- Called where we could have a floating-point binary operator where we
356 -- must check for infinities if we are operating in Check_Float_Overflow
357 -- mode. Note that we don't need to worry about unary operator cases,
358 -- since for floating-point, abs, unary "-", and unary "+" can never
361 function Component_May_Be_Bit_Aligned
(Comp
: Entity_Id
) return Boolean;
362 -- This function is in charge of detecting record components that may
363 -- cause trouble in the back end if an attempt is made to assign the
364 -- component. The back end can handle such assignments with no problem if
365 -- the components involved are small (64-bits or less) records or scalar
366 -- items (including bit-packed arrays represented with modular types) or
367 -- are both aligned on a byte boundary (starting on a byte boundary, and
368 -- occupying an integral number of bytes).
370 -- However, problems arise for records larger than 64 bits, or for arrays
371 -- (other than bit-packed arrays represented with a modular type) if the
372 -- component starts on a non-byte boundary, or does not occupy an integral
373 -- number of bytes (i.e. there are some bits possibly shared with fields
374 -- at the start or beginning of the component). The back end cannot handle
375 -- loading and storing such components in a single operation.
377 -- This function is used to detect the troublesome situation. it is
378 -- conservative in the sense that it produces True unless it knows for
379 -- sure that the component is safe (as outlined in the first paragraph
380 -- above). The code generation for record and array assignment checks for
381 -- trouble using this function, and if so the assignment is generated
382 -- component-wise, which the back end is required to handle correctly.
384 -- Note that in GNAT 3, the back end will reject such components anyway,
385 -- so the hard work in checking for this case is wasted in GNAT 3, but
386 -- it is harmless, so it is easier to do it in all cases, rather than
387 -- conditionalize it in GNAT 5 or beyond.
389 function Containing_Package_With_Ext_Axioms
390 (E
: Entity_Id
) return Entity_Id
;
391 -- Returns the package entity with an external axiomatization containing E,
392 -- if any, or Empty if none.
394 procedure Convert_To_Actual_Subtype
(Exp
: Node_Id
);
395 -- The Etype of an expression is the nominal type of the expression,
396 -- not the actual subtype. Often these are the same, but not always.
397 -- For example, a reference to a formal of unconstrained type has the
398 -- unconstrained type as its Etype, but the actual subtype is obtained by
399 -- applying the actual bounds. This routine is given an expression, Exp,
400 -- and (if necessary), replaces it using Rewrite, with a conversion to
401 -- the actual subtype, building the actual subtype if necessary. If the
402 -- expression is already of the requested type, then it is unchanged.
404 function Corresponding_Runtime_Package
(Typ
: Entity_Id
) return RTU_Id
;
405 -- Return the id of the runtime package that will provide support for
406 -- concurrent type Typ. Currently only protected types are supported,
407 -- and the returned value is one of the following:
408 -- System_Tasking_Protected_Objects
409 -- System_Tasking_Protected_Objects_Entries
410 -- System_Tasking_Protected_Objects_Single_Entry
412 function Current_Sem_Unit_Declarations
return List_Id
;
413 -- Return the place where it is fine to insert declarations for the
414 -- current semantic unit. If the unit is a package body, return the
415 -- visible declarations of the corresponding spec. For RCI stubs, this
416 -- is necessary because the point at which they are generated may not
417 -- be the earliest point at which they are used.
419 function Duplicate_Subexpr
421 Name_Req
: Boolean := False;
422 Renaming_Req
: Boolean := False) return Node_Id
;
423 -- Given the node for a subexpression, this function makes a logical copy
424 -- of the subexpression, and returns it. This is intended for use when the
425 -- expansion of an expression needs to repeat part of it. For example,
426 -- replacing a**2 by a*a requires two references to a which may be a
427 -- complex subexpression. Duplicate_Subexpr guarantees not to duplicate
428 -- side effects. If necessary, it generates actions to save the expression
429 -- value in a temporary, inserting these actions into the tree using
430 -- Insert_Actions with Exp as the insertion location. The original
431 -- expression and the returned result then become references to this saved
432 -- value. Exp must be analyzed on entry. On return, Exp is analyzed, but
433 -- the caller is responsible for analyzing the returned copy after it is
434 -- attached to the tree.
436 -- The Name_Req flag is set to ensure that the result is suitable for use
437 -- in a context requiring a name (for example, the prefix of an attribute
438 -- reference) (can't this just be a qualification in Ada 2012???).
440 -- The Renaming_Req flag is set to produce an object renaming declaration
441 -- rather than an object declaration. This is valid only if the expression
442 -- Exp designates a renamable object. This is used for example in the case
443 -- of an unchecked deallocation, to make sure the object gets set to null.
445 -- Note that if there are any run time checks in Exp, these same checks
446 -- will be duplicated in the returned duplicated expression. The two
447 -- following functions allow this behavior to be modified.
449 function Duplicate_Subexpr_No_Checks
451 Name_Req
: Boolean := False;
452 Renaming_Req
: Boolean := False;
453 Related_Id
: Entity_Id
:= Empty
;
454 Is_Low_Bound
: Boolean := False;
455 Is_High_Bound
: Boolean := False) return Node_Id
;
456 -- Identical in effect to Duplicate_Subexpr, except that Remove_Checks is
457 -- called on the result, so that the duplicated expression does not include
458 -- checks. This is appropriate for use when Exp, the original expression is
459 -- unconditionally elaborated before the duplicated expression, so that
460 -- there is no need to repeat any checks.
462 -- Related_Id denotes the entity of the context where Expr appears. Flags
463 -- Is_Low_Bound and Is_High_Bound specify whether the expression to check
464 -- is the low or the high bound of a range. These three optional arguments
465 -- signal Remove_Side_Effects to create an external symbol of the form
466 -- Chars (Related_Id)_FIRST/_LAST. For suggested use of these parameters
467 -- see the warning in the body of Sem_Ch3.Process_Range_Expr_In_Decl.
469 function Duplicate_Subexpr_Move_Checks
471 Name_Req
: Boolean := False;
472 Renaming_Req
: Boolean := False) return Node_Id
;
473 -- Identical in effect to Duplicate_Subexpr, except that Remove_Checks is
474 -- called on Exp after the duplication is complete, so that the original
475 -- expression does not include checks. In this case the result returned
476 -- (the duplicated expression) will retain the original checks. This is
477 -- appropriate for use when the duplicated expression is sure to be
478 -- elaborated before the original expression Exp, so that there is no need
479 -- to repeat the checks.
481 procedure Ensure_Defined
(Typ
: Entity_Id
; N
: Node_Id
);
482 -- This procedure ensures that type referenced by Typ is defined. For the
483 -- case of a type other than an Itype, nothing needs to be done, since
484 -- all such types have declaration nodes. For Itypes, an N_Itype_Reference
485 -- node is generated and inserted as an action on node N. This is typically
486 -- used to ensure that an Itype is properly defined outside a conditional
487 -- construct when it is referenced in more than one branch.
489 function Entry_Names_OK
return Boolean;
490 -- Determine whether it is appropriate to dynamically allocate strings
491 -- which represent entry [family member] names. These strings are created
492 -- by the compiler and used by GDB.
494 procedure Evaluate_Name
(Nam
: Node_Id
);
495 -- Remove all side effects from a name which appears as part of an object
496 -- renaming declaration. More comments are needed here that explain how
497 -- this differs from Force_Evaluation and Remove_Side_Effects ???
499 procedure Evolve_And_Then
(Cond
: in out Node_Id
; Cond1
: Node_Id
);
500 -- Rewrites Cond with the expression: Cond and then Cond1. If Cond is
501 -- Empty, then simply returns Cond1 (this allows the use of Empty to
502 -- initialize a series of checks evolved by this routine, with a final
503 -- result of Empty indicating that no checks were required). The Sloc field
504 -- of the constructed N_And_Then node is copied from Cond1.
506 procedure Evolve_Or_Else
(Cond
: in out Node_Id
; Cond1
: Node_Id
);
507 -- Rewrites Cond with the expression: Cond or else Cond1. If Cond is Empty,
508 -- then simply returns Cond1 (this allows the use of Empty to initialize a
509 -- series of checks evolved by this routine, with a final result of Empty
510 -- indicating that no checks were required). The Sloc field of the
511 -- constructed N_Or_Else node is copied from Cond1.
513 procedure Expand_Static_Predicates_In_Choices
(N
: Node_Id
);
514 -- N is either a case alternative or a variant. The Discrete_Choices field
515 -- of N points to a list of choices. If any of these choices is the name
516 -- of a (statically) predicated subtype, then it is rewritten as the series
517 -- of choices that correspond to the values allowed for the subtype.
519 procedure Expand_Subtype_From_Expr
521 Unc_Type
: Entity_Id
;
522 Subtype_Indic
: Node_Id
;
524 Related_Id
: Entity_Id
:= Empty
);
525 -- Build a constrained subtype from the initial value in object
526 -- declarations and/or allocations when the type is indefinite (including
527 -- class-wide). Set Related_Id to request an external name for the subtype
528 -- rather than an internal temporary.
530 function Finalize_Address
(Typ
: Entity_Id
) return Entity_Id
;
531 -- Locate TSS primitive Finalize_Address in type Typ. Return Empty if the
532 -- subprogram is not available.
534 function Find_Interface_ADT
536 Iface
: Entity_Id
) return Elmt_Id
;
537 -- Ada 2005 (AI-251): Given a type T implementing the interface Iface,
538 -- return the element of Access_Disp_Table containing the tag of the
541 function Find_Interface_Tag
543 Iface
: Entity_Id
) return Entity_Id
;
544 -- Ada 2005 (AI-251): Given a type T implementing the interface Iface,
545 -- return the record component containing the tag of Iface.
547 function Find_Prim_Op
(T
: Entity_Id
; Name
: Name_Id
) return Entity_Id
;
548 -- Find the first primitive operation of a tagged type T with name Name.
549 -- This function allows the use of a primitive operation which is not
550 -- directly visible. If T is a class wide type, then the reference is to an
551 -- operation of the corresponding root type. It is an error if no primitive
552 -- operation with the given name is found.
554 function Find_Prim_Op
556 Name
: TSS_Name_Type
) return Entity_Id
;
557 -- Find the first primitive operation of type T whose name has the form
558 -- indicated by the name parameter (i.e. is a type support subprogram
559 -- with the indicated suffix). This function allows use of a primitive
560 -- operation which is not directly visible. If T is a class wide type,
561 -- then the reference is to an operation of the corresponding root type.
563 function Find_Optional_Prim_Op
564 (T
: Entity_Id
; Name
: Name_Id
) return Entity_Id
;
565 function Find_Optional_Prim_Op
567 Name
: TSS_Name_Type
) return Entity_Id
;
568 -- Same as Find_Prim_Op, except returns Empty if not found
570 function Find_Protection_Object
(Scop
: Entity_Id
) return Entity_Id
;
571 -- Traverse the scope stack starting from Scop and look for an entry, entry
572 -- family, or a subprogram that has a Protection_Object and return it. Must
573 -- always return a value since the context in which this routine is invoked
574 -- should always have a protection object.
576 function Find_Protection_Type
(Conc_Typ
: Entity_Id
) return Entity_Id
;
577 -- Given a protected type or its corresponding record, find the type of
580 function Find_Hook_Context
(N
: Node_Id
) return Node_Id
;
581 -- Determine a suitable node on which to attach actions related to N that
582 -- need to be elaborated unconditionally. In general this is the topmost
583 -- expression of which N is a subexpression, which in turn may or may not
584 -- be evaluated, for example if N is the right operand of a short circuit
587 function Following_Address_Clause
(D
: Node_Id
) return Node_Id
;
588 -- D is the node for an object declaration. This function searches the
589 -- current declarative part to look for an address clause for the object
590 -- being declared, and returns the clause if one is found, returns
593 -- Note: this function can be costly and must be invoked with special care.
594 -- Possibly we could introduce a flag at parse time indicating the presence
595 -- of an address clause to speed this up???
597 -- Note: currently this function does not scan the private part, that seems
598 -- like a potential bug ???
600 type Force_Evaluation_Mode
is (Relaxed
, Strict
);
602 procedure Force_Evaluation
604 Name_Req
: Boolean := False;
605 Related_Id
: Entity_Id
:= Empty
;
606 Is_Low_Bound
: Boolean := False;
607 Is_High_Bound
: Boolean := False;
608 Mode
: Force_Evaluation_Mode
:= Relaxed
);
609 -- Force the evaluation of the expression right away. Similar behavior
610 -- to Remove_Side_Effects when Variable_Ref is set to TRUE. That is to
611 -- say, it removes the side effects and captures the values of the
612 -- variables. Remove_Side_Effects guarantees that multiple evaluations
613 -- of the same expression won't generate multiple side effects, whereas
614 -- Force_Evaluation further guarantees that all evaluations will yield
615 -- the same result. If Mode is Relaxed then calls to this subprogram have
616 -- no effect if Exp is side-effect free; if Mode is Strict and Exp is not
617 -- a static expression then no side-effect check is performed on Exp and
618 -- temporaries are unconditionally generated.
620 -- Related_Id denotes the entity of the context where Expr appears. Flags
621 -- Is_Low_Bound and Is_High_Bound specify whether the expression to check
622 -- is the low or the high bound of a range. These three optional arguments
623 -- signal Remove_Side_Effects to create an external symbol of the form
624 -- Chars (Related_Id)_FIRST/_LAST. If Related_Id is set, then exactly one
625 -- of the Is_xxx_Bound flags must be set. For use of these parameters see
626 -- the warning in the body of Sem_Ch3.Process_Range_Expr_In_Decl.
628 function Fully_Qualified_Name_String
630 Append_NUL
: Boolean := True) return String_Id
;
631 -- Generates the string literal corresponding to the fully qualified name
632 -- of entity E, in all upper case, with an ASCII.NUL appended at the end
633 -- of the name if Append_NUL is True.
635 procedure Generate_Poll_Call
(N
: Node_Id
);
636 -- If polling is active, then a call to the Poll routine is built,
637 -- and then inserted before the given node N and analyzed.
639 procedure Get_Current_Value_Condition
643 -- This routine processes the Current_Value field of the variable Var. If
644 -- the Current_Value field is null or if it represents a known value, then
645 -- on return Cond is set to N_Empty, and Val is set to Empty.
647 -- The other case is when Current_Value points to an N_If_Statement or an
648 -- N_Elsif_Part or a N_Iteration_Scheme node (see description in Einfo for
649 -- exact details). In this case, Get_Current_Condition digs out the
650 -- condition, and then checks if the condition is known false, known true,
651 -- or not known at all. In the first two cases, Get_Current_Condition will
652 -- return with Op set to the appropriate conditional operator (inverted if
653 -- the condition is known false), and Val set to the constant value. If the
654 -- condition is not known, then Op and Val are set for the empty case
655 -- (N_Empty and Empty).
657 -- The check for whether the condition is true/false unknown depends
660 -- For an IF, the condition is known true in the THEN part, known false
661 -- in any ELSIF or ELSE part, and not known outside the IF statement in
664 -- For an ELSIF, the condition is known true in the ELSIF part, known
665 -- FALSE in any subsequent ELSIF, or ELSE part, and not known before the
666 -- ELSIF, or after the end of the IF statement.
668 -- The caller can use this result to determine the value (for the case of
669 -- N_Op_Eq), or to determine the result of some other test in other cases
670 -- (e.g. no access check required if N_Op_Ne Null).
672 function Get_Stream_Size
(E
: Entity_Id
) return Uint
;
673 -- Return the stream size value of the subtype E
675 function Has_Access_Constraint
(E
: Entity_Id
) return Boolean;
676 -- Given object or type E, determine if a discriminant is of an access type
678 function Has_Annotate_Pragma_For_External_Axiomatization
679 (E
: Entity_Id
) return Boolean;
680 -- Returns whether E is a package entity, for which the initial list of
681 -- pragmas at the start of the package declaration contains
682 -- pragma Annotate (GNATprove, External_Axiomatization);
684 function Homonym_Number
(Subp
: Entity_Id
) return Nat
;
685 -- Here subp is the entity for a subprogram. This routine returns the
686 -- homonym number used to disambiguate overloaded subprograms in the same
687 -- scope (the number is used as part of constructed names to make sure that
688 -- they are unique). The number is the ordinal position on the Homonym
689 -- chain, counting only entries in the current scope. If an entity is not
690 -- overloaded, the returned number will be one.
692 function Inside_Init_Proc
return Boolean;
693 -- Returns True if current scope is within an init proc
695 function In_Library_Level_Package_Body
(Id
: Entity_Id
) return Boolean;
696 -- Given an arbitrary entity, determine whether it appears at the library
697 -- level of a package body.
699 function In_Unconditional_Context
(Node
: Node_Id
) return Boolean;
700 -- Node is the node for a statement or a component of a statement. This
701 -- function determines if the statement appears in a context that is
702 -- unconditionally executed, i.e. it is not within a loop or a conditional
703 -- or a case statement etc.
705 function Is_All_Null_Statements
(L
: List_Id
) return Boolean;
706 -- Return True if all the items of the list are N_Null_Statement nodes.
707 -- False otherwise. True for an empty list. It is an error to call this
708 -- routine with No_List as the argument.
710 function Is_Displacement_Of_Object_Or_Function_Result
711 (Obj_Id
: Entity_Id
) return Boolean;
712 -- Determine whether Obj_Id is a source entity that has been initialized by
713 -- either a controlled function call or the assignment of another source
714 -- object. In both cases the initialization expression is rewritten as a
715 -- class-wide conversion of Ada.Tags.Displace.
717 function Is_Finalizable_Transient
719 Rel_Node
: Node_Id
) return Boolean;
720 -- Determine whether declaration Decl denotes a controlled transient which
721 -- should be finalized. Rel_Node is the related context. Even though some
722 -- transients are controlled, they may act as renamings of other objects or
725 function Is_Fully_Repped_Tagged_Type
(T
: Entity_Id
) return Boolean;
726 -- Tests given type T, and returns True if T is a non-discriminated tagged
727 -- type which has a record representation clause that specifies the layout
728 -- of all the components, including recursively components in all parent
729 -- types. We exclude discriminated types for convenience, it is extremely
730 -- unlikely that the special processing associated with the use of this
731 -- routine is useful for the case of a discriminated type, and testing for
732 -- component overlap would be a pain.
734 function Is_Library_Level_Tagged_Type
(Typ
: Entity_Id
) return Boolean;
735 -- Return True if Typ is a library level tagged type. Currently we use
736 -- this information to build statically allocated dispatch tables.
738 function Is_Non_BIP_Func_Call
(Expr
: Node_Id
) return Boolean;
739 -- Determine whether node Expr denotes a non build-in-place function call
741 function Is_Object_Access_BIP_Func_Call
743 Obj_Id
: Entity_Id
) return Boolean;
744 -- Determine if Expr denotes a build-in-place function which stores its
745 -- result in the BIPaccess actual parameter whose prefix must match Obj_Id.
747 function Is_Possibly_Unaligned_Object
(N
: Node_Id
) return Boolean;
748 -- Node N is an object reference. This function returns True if it is
749 -- possible that the object may not be aligned according to the normal
750 -- default alignment requirement for its type (e.g. if it appears in a
751 -- packed record, or as part of a component that has a component clause.)
753 function Is_Possibly_Unaligned_Slice
(N
: Node_Id
) return Boolean;
754 -- Determine whether the node P is a slice of an array where the slice
755 -- result may cause alignment problems because it has an alignment that
756 -- is not compatible with the type. Return True if so.
758 function Is_Ref_To_Bit_Packed_Array
(N
: Node_Id
) return Boolean;
759 -- Determine whether the node P is a reference to a bit packed array, i.e.
760 -- whether the designated object is a component of a bit packed array, or a
761 -- subcomponent of such a component. If so, then all subscripts in P are
762 -- evaluated with a call to Force_Evaluation, and True is returned.
763 -- Otherwise False is returned, and P is not affected.
765 function Is_Ref_To_Bit_Packed_Slice
(N
: Node_Id
) return Boolean;
766 -- Determine whether the node P is a reference to a bit packed slice, i.e.
767 -- whether the designated object is bit packed slice or a component of a
768 -- bit packed slice. Return True if so.
770 function Is_Related_To_Func_Return
(Id
: Entity_Id
) return Boolean;
771 -- Determine whether object Id is related to an expanded return statement.
772 -- The case concerned is "return Id.all;".
774 function Is_Renamed_Object
(N
: Node_Id
) return Boolean;
775 -- Returns True if the node N is a renamed object. An expression is
776 -- considered to be a renamed object if either it is the Name of an object
777 -- renaming declaration, or is the prefix of a name which is a renamed
778 -- object. For example, in:
780 -- x : r renames a (1 .. 2) (1);
782 -- We consider that a (1 .. 2) is a renamed object since it is the prefix
783 -- of the name in the renaming declaration.
785 function Is_Secondary_Stack_BIP_Func_Call
(Expr
: Node_Id
) return Boolean;
786 -- Determine whether Expr denotes a build-in-place function which returns
787 -- its result on the secondary stack.
789 function Is_Tag_To_Class_Wide_Conversion
790 (Obj_Id
: Entity_Id
) return Boolean;
791 -- Determine whether object Obj_Id is the result of a tag-to-class-wide
794 function Is_Untagged_Derivation
(T
: Entity_Id
) return Boolean;
795 -- Returns true if type T is not tagged and is a derived type,
796 -- or is a private type whose completion is such a type.
798 function Is_Volatile_Reference
(N
: Node_Id
) return Boolean;
799 -- Checks if the node N represents a volatile reference, which can be
800 -- either a direct reference to a variable treated as volatile, or an
801 -- indexed/selected component where the prefix is treated as volatile,
802 -- or has Volatile_Components set. A slice of a volatile variable is
805 procedure Kill_Dead_Code
(N
: Node_Id
; Warn
: Boolean := False);
806 -- N represents a node for a section of code that is known to be dead. Any
807 -- exception handler references and warning messages relating to this code
808 -- are removed. If Warn is True, a warning will be output at the start of N
809 -- indicating the deletion of the code. Note that the tree for the deleted
810 -- code is left intact so that e.g. cross-reference data is still valid.
812 procedure Kill_Dead_Code
(L
: List_Id
; Warn
: Boolean := False);
813 -- Like the above procedure, but applies to every element in the given
814 -- list. If Warn is True, a warning will be output at the start of N
815 -- indicating the deletion of the code.
817 function Known_Non_Negative
(Opnd
: Node_Id
) return Boolean;
818 -- Given a node for a subexpression, determines if it represents a value
819 -- that cannot possibly be negative, and if so returns True. A value of
820 -- False means that it is not known if the value is positive or negative.
822 function Known_Non_Null
(N
: Node_Id
) return Boolean;
823 -- Given a node N for a subexpression of an access type, determines if
824 -- this subexpression yields a value that is known at compile time to
825 -- be non-null and returns True if so. Returns False otherwise. It is
826 -- an error to call this function if N is not of an access type.
828 function Known_Null
(N
: Node_Id
) return Boolean;
829 -- Given a node N for a subexpression of an access type, determines if this
830 -- subexpression yields a value that is known at compile time to be null
831 -- and returns True if so. Returns False otherwise. It is an error to call
832 -- this function if N is not of an access type.
834 function Make_Invariant_Call
(Expr
: Node_Id
) return Node_Id
;
835 -- Expr is an object of a type which Has_Invariants set (and which thus
836 -- also has an Invariant_Procedure set). If invariants are enabled, this
837 -- function returns a call to the Invariant procedure passing Expr as the
838 -- argument, and returns it unanalyzed. If invariants are not enabled,
839 -- returns a null statement.
841 function Make_Predicate_Call
844 Mem
: Boolean := False) return Node_Id
;
845 -- Typ is a type with Predicate_Function set. This routine builds a call to
846 -- this function passing Expr as the argument, and returns it unanalyzed.
847 -- If Mem is set True, this is the special call for the membership case,
848 -- and the function called is the Predicate_Function_M if present.
850 function Make_Predicate_Check
852 Expr
: Node_Id
) return Node_Id
;
853 -- Typ is a type with Predicate_Function set. This routine builds a Check
854 -- pragma whose first argument is Predicate, and the second argument is
855 -- a call to the predicate function of Typ with Expr as the argument. If
856 -- Predicate_Check is suppressed then a null statement is returned instead.
858 function Make_Subtype_From_Expr
861 Related_Id
: Entity_Id
:= Empty
) return Node_Id
;
862 -- Returns a subtype indication corresponding to the actual type of an
863 -- expression E. Unc_Typ is an unconstrained array or record, or a class-
864 -- wide type. Set Related_Id to request an external name for the subtype
865 -- rather than an internal temporary.
867 function Matching_Standard_Type
(Typ
: Entity_Id
) return Entity_Id
;
868 -- Given a scalar subtype Typ, returns a matching type in standard that
869 -- has the same object size value. For example, a 16 bit signed type will
870 -- typically return Standard_Short_Integer. For fixed-point types, this
871 -- will return integer types of the corresponding size.
873 function May_Generate_Large_Temp
(Typ
: Entity_Id
) return Boolean;
874 -- Determines if the given type, Typ, may require a large temporary of the
875 -- kind that causes back-end trouble if stack checking is enabled. The
876 -- result is True only the size of the type is known at compile time and
877 -- large, where large is defined heuristically by the body of this routine.
878 -- The purpose of this routine is to help avoid generating troublesome
879 -- temporaries that interfere with stack checking mechanism. Note that the
880 -- caller has to check whether stack checking is actually enabled in order
881 -- to guide the expansion (typically of a function call).
883 function Needs_Constant_Address
885 Typ
: Entity_Id
) return Boolean;
886 -- Check whether the expression in an address clause is restricted to
887 -- consist of constants, when the object has a nontrivial initialization
890 function Needs_Finalization
(T
: Entity_Id
) return Boolean;
891 -- True if type T is controlled, or has controlled subcomponents. Also
892 -- True if T is a class-wide type, because some type extension might add
893 -- controlled subcomponents, except that if pragma Restrictions
894 -- (No_Finalization) applies, this is False for class-wide types.
896 function Non_Limited_Designated_Type
(T
: Entity_Id
) return Entity_Id
;
897 -- An anonymous access type may designate a limited view. Check whether
898 -- non-limited view is available during expansion, to examine components
899 -- or other characteristics of the full type.
901 function OK_To_Do_Constant_Replacement
(E
: Entity_Id
) return Boolean;
902 -- This function is used when testing whether or not to replace a reference
903 -- to entity E by a known constant value. Such replacement must be done
904 -- only in a scope known to be safe for such replacements. In particular,
905 -- if we are within a subprogram and the entity E is declared outside the
906 -- subprogram then we cannot do the replacement, since we do not attempt to
907 -- trace subprogram call flow. It is also unsafe to replace statically
908 -- allocated values (since they can be modified outside the scope), and we
909 -- also inhibit replacement of Volatile or aliased objects since their
910 -- address might be captured in a way we do not detect. A value of True is
911 -- returned only if the replacement is safe.
913 function Possible_Bit_Aligned_Component
(N
: Node_Id
) return Boolean;
914 -- This function is used during processing the assignment of a record or
915 -- indexed component. The argument N is either the left hand or right hand
916 -- side of an assignment, and this function determines if there is a record
917 -- component reference where the record may be bit aligned in a manner that
918 -- causes trouble for the back end (see Component_May_Be_Bit_Aligned for
921 function Power_Of_Two
(N
: Node_Id
) return Nat
;
922 -- Determines if N is a known at compile time value which is of the form
923 -- 2**K, where K is in the range 1 .. M, where the Esize of N is 2**(M+1).
924 -- If so, returns the value K, otherwise returns zero. The caller checks
925 -- that N is of an integer type.
927 procedure Process_Statements_For_Controlled_Objects
(N
: Node_Id
);
928 -- N is a node which contains a non-handled statement list. Inspect the
929 -- statements looking for declarations of controlled objects. If at least
930 -- one such object is found, wrap the statement list in a block.
932 function Remove_Init_Call
934 Rep_Clause
: Node_Id
) return Node_Id
;
935 -- Look for init_proc call or aggregate initialization statements for
936 -- variable Var, either among declarations between that of Var and a
937 -- subsequent Rep_Clause applying to Var, or in the list of freeze actions
938 -- associated with Var, and if found, remove and return that call node.
940 procedure Remove_Side_Effects
942 Name_Req
: Boolean := False;
943 Renaming_Req
: Boolean := False;
944 Variable_Ref
: Boolean := False;
945 Related_Id
: Entity_Id
:= Empty
;
946 Is_Low_Bound
: Boolean := False;
947 Is_High_Bound
: Boolean := False;
948 Check_Side_Effects
: Boolean := True);
949 -- Given the node for a subexpression, this function replaces the node if
950 -- necessary by an equivalent subexpression that is guaranteed to be side
951 -- effect free. This is done by extracting any actions that could cause
952 -- side effects, and inserting them using Insert_Actions into the tree
953 -- to which Exp is attached. Exp must be analyzed and resolved before the
954 -- call and is analyzed and resolved on return. Name_Req may only be set to
955 -- True if Exp has the form of a name, and the effect is to guarantee that
956 -- any replacement maintains the form of name. If Renaming_Req is set to
957 -- True, the routine produces an object renaming reclaration capturing the
958 -- expression. If Variable_Ref is set to True, a variable is considered as
959 -- side effect (used in implementing Force_Evaluation). Note: after call to
960 -- Remove_Side_Effects, it is safe to call New_Copy_Tree to obtain a copy
961 -- of the resulting expression. If Check_Side_Effects is set to True then
962 -- no action is performed if Exp is known to be side-effect free.
964 -- Related_Id denotes the entity of the context where Expr appears. Flags
965 -- Is_Low_Bound and Is_High_Bound specify whether the expression to check
966 -- is the low or the high bound of a range. These three optional arguments
967 -- signal Remove_Side_Effects to create an external symbol of the form
968 -- Chars (Related_Id)_FIRST/_LAST. If Related_Id is set, then exactly one
969 -- of the Is_xxx_Bound flags must be set. For use of these parameters see
970 -- the warning in the body of Sem_Ch3.Process_Range_Expr_In_Decl.
972 -- The side effects are captured using one of the following methods:
974 -- 1) a constant initialized with the value of the subexpression
975 -- 2) a renaming of the subexpression
976 -- 3) a reference to the subexpression
978 -- For elementary types, methods 1) and 2) are used; for composite types,
979 -- methods 2) and 3) are used. The renaming (method 2) is used only when
980 -- the subexpression denotes a name, so that it can be elaborated by gigi
981 -- without evaluating the subexpression.
983 -- Historical note: the reference (method 3) used to be the common fallback
984 -- method but it gives rise to aliasing issues if the subexpression denotes
985 -- a name that is not aliased, since it is equivalent to taking the address
986 -- in this case. The renaming (method 2) used to be applied to any objects
987 -- in the RM sense, that is to say to the cases where a renaming is legal
988 -- in Ada. But for some of these cases, most notably functions calls, the
989 -- renaming cannot be elaborated without evaluating the subexpression, so
990 -- gigi would resort to method 1) or 3) under the hood for them.
992 function Represented_As_Scalar
(T
: Entity_Id
) return Boolean;
993 -- Returns True iff the implementation of this type in code generation
994 -- terms is scalar. This is true for scalars in the Ada sense, and for
995 -- packed arrays which are represented by a scalar (modular) type.
997 function Requires_Cleanup_Actions
999 Lib_Level
: Boolean) return Boolean;
1000 -- Given a node N, determine whether its declarative and/or statement list
1001 -- contains one of the following:
1003 -- 1) controlled objects
1004 -- 2) library-level tagged types
1006 -- These cases require special actions on scope exit. The flag Lib_Level
1007 -- is set True if the construct is at library level, and False otherwise.
1009 function Safe_Unchecked_Type_Conversion
(Exp
: Node_Id
) return Boolean;
1010 -- Given the node for an N_Unchecked_Type_Conversion, return True if this
1011 -- is an unchecked conversion that Gigi can handle directly. Otherwise
1012 -- return False if it is one for which the front end must provide a
1013 -- temporary. Note that the node need not be analyzed, and thus the Etype
1014 -- field may not be set, but in that case it must be the case that the
1015 -- Subtype_Mark field of the node is set/analyzed.
1017 procedure Set_Current_Value_Condition
(Cnode
: Node_Id
);
1018 -- Cnode is N_If_Statement, N_Elsif_Part, or N_Iteration_Scheme (the latter
1019 -- when a WHILE condition is present). This call checks whether Condition
1020 -- (Cnode) has embedded expressions of a form that should result in setting
1021 -- the Current_Value field of one or more entities, and if so sets these
1022 -- fields to point to Cnode.
1024 procedure Set_Elaboration_Flag
(N
: Node_Id
; Spec_Id
: Entity_Id
);
1025 -- N is the node for a subprogram or generic body, and Spec_Id is the
1026 -- entity for the corresponding spec. If an elaboration entity is defined,
1027 -- then this procedure generates an assignment statement to set it True,
1028 -- immediately after the body is elaborated. However, no assignment is
1029 -- generated in the case of library level procedures, since the setting of
1030 -- the flag in this case is generated in the binder. We do that so that we
1031 -- can detect cases where this is the only elaboration action that is
1034 procedure Set_Renamed_Subprogram
(N
: Node_Id
; E
: Entity_Id
);
1035 -- N is an node which is an entity name that represents the name of a
1036 -- renamed subprogram. The node is rewritten to be an identifier that
1037 -- refers directly to the renamed subprogram, given by entity E.
1039 function Side_Effect_Free
1041 Name_Req
: Boolean := False;
1042 Variable_Ref
: Boolean := False) return Boolean;
1043 -- Determines if the tree N represents an expression that is known not
1044 -- to have side effects. If this function returns True, then for example
1045 -- a call to Remove_Side_Effects has no effect.
1047 -- Name_Req controls the handling of volatile variable references. If
1048 -- Name_Req is False (the normal case), then volatile references are
1049 -- considered to be side effects. If Name_Req is True, then volatility
1050 -- of variables is ignored.
1052 -- If Variable_Ref is True, then all variable references are considered to
1053 -- be side effects (regardless of volatility or the setting of Name_Req).
1055 function Side_Effect_Free
1057 Name_Req
: Boolean := False;
1058 Variable_Ref
: Boolean := False) return Boolean;
1059 -- Determines if all elements of the list L are side-effect free. Name_Req
1060 -- and Variable_Ref are as described above.
1062 procedure Silly_Boolean_Array_Not_Test
(N
: Node_Id
; T
: Entity_Id
);
1063 -- N is the node for a boolean array NOT operation, and T is the type of
1064 -- the array. This routine deals with the silly case where the subtype of
1065 -- the boolean array is False..False or True..True, where it is required
1066 -- that a Constraint_Error exception be raised (RM 4.5.6(6)).
1068 procedure Silly_Boolean_Array_Xor_Test
(N
: Node_Id
; T
: Entity_Id
);
1069 -- N is the node for a boolean array XOR operation, and T is the type of
1070 -- the array. This routine deals with the silly case where the subtype of
1071 -- the boolean array is True..True, where a raise of a Constraint_Error
1072 -- exception is required (RM 4.5.6(6)).
1074 function Target_Has_Fixed_Ops
1075 (Left_Typ
: Entity_Id
;
1076 Right_Typ
: Entity_Id
;
1077 Result_Typ
: Entity_Id
) return Boolean;
1078 -- Returns True if and only if the target machine has direct support
1079 -- for fixed-by-fixed multiplications and divisions for the given
1080 -- operand and result types. This is called in package Exp_Fixd to
1081 -- determine whether to expand such operations.
1083 function Type_May_Have_Bit_Aligned_Components
1084 (Typ
: Entity_Id
) return Boolean;
1085 -- Determines if Typ is a composite type that has within it (looking down
1086 -- recursively at any subcomponents), a record type which has component
1087 -- that may be bit aligned (see Possible_Bit_Aligned_Component). The result
1088 -- is conservative, in that a result of False is decisive. A result of True
1089 -- means that such a component may or may not be present.
1091 procedure Update_Primitives_Mapping
1092 (Inher_Id
: Entity_Id
;
1093 Subp_Id
: Entity_Id
);
1094 -- Map primitive operations of the parent type to the corresponding
1095 -- operations of the descendant. Note that the descendant type may not be
1096 -- frozen yet, so we cannot use the dispatch table directly. This is called
1097 -- when elaborating a contract for a subprogram, and when freezing a type
1098 -- extension to verify legality rules on inherited conditions.
1100 procedure Update_Primitives_Mapping_Of_Types
1101 (Par_Typ
: Entity_Id
;
1102 Deriv_Typ
: Entity_Id
);
1103 -- Map the primitive operations of parent type Par_Typ to the corresponding
1104 -- primitives of derived type Deriv_Typ.
1106 function Within_Case_Or_If_Expression
(N
: Node_Id
) return Boolean;
1107 -- Determine whether arbitrary node N is within a case or an if expression
1109 function Within_Internal_Subprogram
return Boolean;
1110 -- Indicates that some expansion is taking place within the body of a
1111 -- predefined primitive operation. Some expansion activity (e.g. predicate
1112 -- checks) is disabled in such.
1115 pragma Inline
(Duplicate_Subexpr
);
1116 pragma Inline
(Force_Evaluation
);
1117 pragma Inline
(Is_Library_Level_Tagged_Type
);