* tree-cfg.c (tree_find_edge_insert_loc): Handle naked RETURN_EXPR.
[official-gcc.git] / gcc / ada / exp_util.ads
bloba63cc71c09b61bb40307eb793d4b8de33b2ea9e1
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- E X P _ U T I L --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2005 Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
21 -- --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 -- --
25 ------------------------------------------------------------------------------
27 -- Package containing utility procedures used throughout the expander
29 with Exp_Tss; use Exp_Tss;
30 with Rtsfind; use Rtsfind;
31 with Sinfo; use Sinfo;
32 with Types; use Types;
34 package Exp_Util is
36 -----------------------------------------------
37 -- Handling of Actions Associated with Nodes --
38 -----------------------------------------------
40 -- The evaluation of certain expression nodes involves the elaboration
41 -- of associated types and other declarations, and the execution of
42 -- statement sequences. Expansion routines generating such actions must
43 -- find an appropriate place in the tree to hang the actions so that
44 -- they will be evaluated at the appropriate point.
46 -- Some cases are simple:
48 -- For an expression occurring in a simple statement that is in a list
49 -- of statements, the actions are simply inserted into the list before
50 -- the associated statement.
52 -- For an expression occurring in a declaration (declarations always
53 -- appear in lists), the actions are similarly inserted into the list
54 -- just before the associated declaration.
56 -- The following special cases arise:
58 -- For actions associated with the right operand of a short circuit
59 -- form, the actions are first stored in the short circuit form node
60 -- in the Actions field. The expansion of these forms subsequently
61 -- expands the short circuit forms into if statements which can then
62 -- be moved as described above.
64 -- For actions appearing in the Condition expression of a while loop,
65 -- or an elsif clause, the actions are similarly temporarily stored in
66 -- in the node (N_Elsif_Part or N_Iteration_Scheme) associated with
67 -- the expression using the Condition_Actions field. Subsequently, the
68 -- expansion of these nodes rewrites the control structures involved to
69 -- reposition the actions in normal statement sequence.
71 -- For actions appearing in the then or else expression of a conditional
72 -- expression, these actions are similarly placed in the node, using the
73 -- Then_Actions or Else_Actions field as appropriate. Once again the
74 -- expansion of the N_Conditional_Expression node rewrites the node so
75 -- that the actions can be normally positioned.
77 -- Basically what we do is to climb up to the tree looking for the
78 -- proper insertion point, as described by one of the above cases,
79 -- and then insert the appropriate action or actions.
81 -- Note if more than one insert call is made specifying the same
82 -- Assoc_Node, then the actions are elaborated in the order of the
83 -- calls, and this guarantee is preserved for the special cases above.
85 procedure Insert_Action
86 (Assoc_Node : Node_Id;
87 Ins_Action : Node_Id);
88 -- Insert the action Ins_Action at the appropriate point as described
89 -- above. The action is analyzed using the default checks after it is
90 -- inserted. Assoc_Node is the node with which the action is associated.
92 procedure Insert_Action
93 (Assoc_Node : Node_Id;
94 Ins_Action : Node_Id;
95 Suppress : Check_Id);
96 -- Insert the action Ins_Action at the appropriate point as described
97 -- above. The action is analyzed using the default checks as modified
98 -- by the given Suppress argument after it is inserted. Assoc_Node is
99 -- the node with which the action is associated.
101 procedure Insert_Actions
102 (Assoc_Node : Node_Id;
103 Ins_Actions : List_Id);
104 -- Insert the list of action Ins_Actions at the appropriate point as
105 -- described above. The actions are analyzed using the default checks
106 -- after they are inserted. Assoc_Node is the node with which the actions
107 -- are associated. Ins_Actions may be No_List, in which case the call has
108 -- no effect.
110 procedure Insert_Actions
111 (Assoc_Node : Node_Id;
112 Ins_Actions : List_Id;
113 Suppress : Check_Id);
114 -- Insert the list of action Ins_Actions at the appropriate point as
115 -- described above. The actions are analyzed using the default checks
116 -- as modified by the given Suppress argument after they are inserted.
117 -- Assoc_Node is the node with which the actions are associated.
118 -- Ins_Actions may be No_List, in which case the call has no effect.
120 procedure Insert_Actions_After
121 (Assoc_Node : Node_Id;
122 Ins_Actions : List_Id);
123 -- Assoc_Node must be a node in a list. Same as Insert_Actions but
124 -- actions will be inserted after N in a manner that is compatible with
125 -- the transient scope mechanism. This procedure must be used instead
126 -- of Insert_List_After if Assoc_Node may be in a transient scope.
128 -- Implementation limitation: Assoc_Node must be a statement. We can
129 -- generalize to expressions if there is a need but this is tricky to
130 -- implement because of short-circuits (among other things).???
132 procedure Insert_Library_Level_Action (N : Node_Id);
133 -- This procedure inserts and analyzes the node N as an action at the
134 -- library level for the current unit (i.e. it is attached to the
135 -- Actions field of the N_Compilation_Aux node for the main unit).
137 procedure Insert_Library_Level_Actions (L : List_Id);
138 -- Similar, but inserts a list of actions
140 -----------------------
141 -- Other Subprograms --
142 -----------------------
144 procedure Adjust_Condition (N : Node_Id);
145 -- The node N is an expression whose root-type is Boolean, and which
146 -- represents a boolean value used as a condition (i.e. a True/False
147 -- value). This routine handles the case of C and Fortran convention
148 -- boolean types, which have zero/non-zero semantics rather than the normal
149 -- 0/1 semantics, and also the case of an enumeration rep clause that
150 -- specifies a non-standard representation. On return, node N always has
151 -- the type Standard.Boolean, with a value that is a standard Boolean
152 -- values of 0/1 for False/True. This procedure is used in two situations.
153 -- First, the processing for a condition field always calls
154 -- Adjust_Condition, so that the boolean value presented to the backend is
155 -- a standard value. Second, for the code for boolean operations such as
156 -- AND, Adjust_Condition is called on both operands, and then the operation
157 -- is done in the domain of Standard_Boolean, then Adjust_Result_Type is
158 -- called on the result to possibly reset the original type. This procedure
159 -- also takes care of validity checking if Validity_Checks = Tests.
161 procedure Adjust_Result_Type (N : Node_Id; T : Entity_Id);
162 -- The processing of boolean operations like AND uses the procedure
163 -- Adjust_Condition so that it can operate on Standard.Boolean, which is
164 -- the only boolean type on which the backend needs to be able to implement
165 -- such operators. This means that the result is also of type
166 -- Standard.Boolean. In general the type must be reset back to the original
167 -- type to get proper semantics, and that is the purpose of this procedure.
168 -- N is the node (of type Standard.Boolean), and T is the desired type. As
169 -- an optimization, this procedure leaves the type as Standard.Boolean in
170 -- contexts where this is permissible (in particular for Condition fields,
171 -- and for operands of other logical operations higher up the tree). The
172 -- call to this procedure is completely ignored if the argument N is not of
173 -- type Boolean.
175 procedure Append_Freeze_Action (T : Entity_Id; N : Node_Id);
176 -- Add a new freeze action for the given type. The freeze action is
177 -- attached to the freeze node for the type. Actions will be elaborated in
178 -- the order in which they are added. Note that the added node is not
179 -- analyzed. The analyze call is found in Sem_Ch13.Expand_N_Freeze_Entity.
181 procedure Append_Freeze_Actions (T : Entity_Id; L : List_Id);
182 -- Adds the given list of freeze actions (declarations or statements) for
183 -- the given type. The freeze actions are attached to the freeze node for
184 -- the type. Actions will be elaborated in the order in which they are
185 -- added, and the actions within the list will be elaborated in list order.
186 -- Note that the added nodes are not analyzed. The analyze call is found in
187 -- Sem_Ch13.Expand_N_Freeze_Entity.
189 function Build_Runtime_Call (Loc : Source_Ptr; RE : RE_Id) return Node_Id;
190 -- Build an N_Procedure_Call_Statement calling the given runtime entity.
191 -- The call has no parameters. The first argument provides the location
192 -- information for the tree and for error messages. The call node is not
193 -- analyzed on return, the caller is responsible for analyzing it.
195 function Build_Task_Image_Decls
196 (Loc : Source_Ptr;
197 Id_Ref : Node_Id;
198 A_Type : Entity_Id)
199 return List_Id;
200 -- Build declaration for a variable that holds an identifying string to be
201 -- used as a task name. Id_Ref is an identifier if the task is a variable,
202 -- and a selected or indexed component if the task is component of an
203 -- object. If it is an indexed component, A_Type is the corresponding array
204 -- type. Its index types are used to build the string as an image of the
205 -- index values. For composite types, the result includes two declarations:
206 -- one for a generated function that computes the image without using
207 -- concatenation, and one for the variable that holds the result.
209 function Component_May_Be_Bit_Aligned (Comp : Entity_Id) return Boolean;
210 -- This function is in charge of detecting record components that may cause
211 -- trouble in the back end if an attempt is made to assign the component.
212 -- The back end can handle such assignments with no problem if the
213 -- components involved are small (64-bits or less) records or scalar items
214 -- (including bit-packed arrays represented with modular types) or are both
215 -- aligned on a byte boundary (starting on a byte boundary, and occupying
216 -- an integral number of bytes).
218 -- However, problems arise for records larger than 64 bits, or for arrays
219 -- (other than bit-packed arrays represented with a modular type) if the
220 -- component starts on a non-byte boundary, or does not occupy an integral
221 -- number of bytes (i.e. there are some bits possibly shared with fields at
222 -- the start or beginning of the component). The back end cannot handle
223 -- loading and storing such components in a single operation.
225 -- This function is used to detect the troublesome situation. it is
226 -- conservative in the sense that it produces True unless it knows for sure
227 -- that the component is safe (as outlined in the first paragraph above).
228 -- The code generation for record and array assignment checks for trouble
229 -- using this function, and if so the assignment is generated
230 -- component-wise, which the back end is required to handle correctly.
232 -- Note that in GNAT 3, the back end will reject such components anyway, so
233 -- the hard work in checking for this case is wasted in GNAT 3, but it's
234 -- harmless, so it is easier to do it in all cases, rather than
235 -- conditionalize it in GNAT 5 or beyond.
237 procedure Convert_To_Actual_Subtype (Exp : Node_Id);
238 -- The Etype of an expression is the nominal type of the expression, not
239 -- the actual subtype. Often these are the same, but not always. For
240 -- example, a reference to a formal of unconstrained type has the
241 -- unconstrained type as its Etype, but the actual subtype is obtained by
242 -- applying the actual bounds. This routine is given an expression, Exp,
243 -- and (if necessary), replaces it using Rewrite, with a conversion to the
244 -- actual subtype, building the actual subtype if necessary. If the
245 -- expression is already of the requested type, then it is unchanged.
247 function Current_Sem_Unit_Declarations return List_Id;
248 -- Return the a place where it is fine to insert declarations for the
249 -- current semantic unit. If the unit is a package body, return the
250 -- visible declarations of the corresponding spec. For RCI stubs, this
251 -- is necessary because the point at which they are generated may not
252 -- be the earliest point at which they are used.
254 function Duplicate_Subexpr
255 (Exp : Node_Id;
256 Name_Req : Boolean := False) return Node_Id;
257 -- Given the node for a subexpression, this function makes a logical copy
258 -- of the subexpression, and returns it. This is intended for use when the
259 -- expansion of an expression needs to repeat part of it. For example,
260 -- replacing a**2 by a*a requires two references to a which may be a
261 -- complex subexpression. Duplicate_Subexpr guarantees not to duplicate
262 -- side effects. If necessary, it generates actions to save the expression
263 -- value in a temporary, inserting these actions into the tree using
264 -- Insert_Actions with Exp as the insertion location. The original
265 -- expression and the returned result then become references to this saved
266 -- value. Exp must be analyzed on entry. On return, Exp is analyzed, but
267 -- the caller is responsible for analyzing the returned copy after it is
268 -- attached to the tree. The Name_Req flag is set to ensure that the result
269 -- is suitable for use in a context requiring name (e.g. the prefix of an
270 -- attribute reference).
272 -- Note that if there are any run time checks in Exp, these same checks
273 -- will be duplicated in the returned duplicated expression. The two
274 -- following functions allow this behavior to be modified.
276 function Duplicate_Subexpr_No_Checks
277 (Exp : Node_Id;
278 Name_Req : Boolean := False) return Node_Id;
279 -- Identical in effect to Duplicate_Subexpr, except that Remove_Checks
280 -- is called on the result, so that the duplicated expression does not
281 -- include checks. This is appropriate for use when Exp, the original
282 -- expression is unconditionally elaborated before the duplicated
283 -- expression, so that there is no need to repeat any checks.
285 function Duplicate_Subexpr_Move_Checks
286 (Exp : Node_Id;
287 Name_Req : Boolean := False) return Node_Id;
288 -- Identical in effect to Duplicate_Subexpr, except that Remove_Checks is
289 -- called on Exp after the duplication is complete, so that the original
290 -- expression does not include checks. In this case the result returned
291 -- (the duplicated expression) will retain the original checks. This is
292 -- appropriate for use when the duplicated expression is sure to be
293 -- elaborated before the original expression Exp, so that there is no need
294 -- to repeat the checks.
296 procedure Ensure_Defined (Typ : Entity_Id; N : Node_Id);
297 -- This procedure ensures that type referenced by Typ is defined. For the
298 -- case of a type other than an Itype, nothing needs to be done, since
299 -- all such types have declaration nodes. For Itypes, an N_Itype_Reference
300 -- node is generated and inserted at the given node N. This is typically
301 -- used to ensure that an Itype is properly defined outside a conditional
302 -- construct when it is referenced in more than one branch.
304 procedure Evolve_And_Then (Cond : in out Node_Id; Cond1 : Node_Id);
305 -- Rewrites Cond with the expression: Cond and then Cond1. If Cond is
306 -- Empty, then simply returns Cond1 (this allows the use of Empty to
307 -- initialize a series of checks evolved by this routine, with a final
308 -- result of Empty indicating that no checks were required). The Sloc field
309 -- of the constructed N_And_Then node is copied from Cond1.
311 procedure Evolve_Or_Else (Cond : in out Node_Id; Cond1 : Node_Id);
312 -- Rewrites Cond with the expression: Cond or else Cond1. If Cond is Empty,
313 -- then simply returns Cond1 (this allows the use of Empty to initialize a
314 -- series of checks evolved by this routine, with a final result of Empty
315 -- indicating that no checks were required). The Sloc field of the
316 -- constructed N_Or_Else node is copied from Cond1.
318 procedure Expand_Subtype_From_Expr
319 (N : Node_Id;
320 Unc_Type : Entity_Id;
321 Subtype_Indic : Node_Id;
322 Exp : Node_Id);
323 -- Build a constrained subtype from the initial value in object
324 -- declarations and/or allocations when the type is indefinite (including
325 -- class-wide).
327 function Find_Interface_ADT
328 (T : Entity_Id;
329 Iface : Entity_Id) return Entity_Id;
330 -- Ada 2005 (AI-251): Given a type T implementing the interface Iface,
331 -- return the Access_Disp_Table value of the interface.
333 function Find_Interface_Tag
334 (T : Entity_Id;
335 Iface : Entity_Id) return Entity_Id;
336 -- Ada 2005 (AI-251): Given a type T implementing the interface Iface,
337 -- return the record component containing the tag of Iface.
339 function Find_Prim_Op (T : Entity_Id; Name : Name_Id) return Entity_Id;
340 -- Find the first primitive operation of type T whose name is 'Name'.
341 -- This function allows the use of a primitive operation which is not
342 -- directly visible. If T is a class wide type, then the reference is
343 -- to an operation of the corresponding root type.
345 function Find_Prim_Op
346 (T : Entity_Id;
347 Name : TSS_Name_Type) return Entity_Id;
348 -- Find the first primitive operation of type T whose name has the form
349 -- indicated by the name parameter (i.e. is a type support subprogram
350 -- with the indicated suffix). This function allows use of a primitive
351 -- operation which is not directly visible. If T is a class wide type,
352 -- then the reference is to an operation of the corresponding root type.
354 procedure Force_Evaluation
355 (Exp : Node_Id;
356 Name_Req : Boolean := False);
357 -- Force the evaluation of the expression right away. Similar behavior
358 -- to Remove_Side_Effects when Variable_Ref is set to TRUE. That is to
359 -- say, it removes the side-effects and capture the values of the
360 -- variables. Remove_Side_Effects guarantees that multiple evaluations
361 -- of the same expression won't generate multiple side effects, whereas
362 -- Force_Evaluation further guarantees that all evaluations will yield
363 -- the same result.
365 procedure Generate_Poll_Call (N : Node_Id);
366 -- If polling is active, then a call to the Poll routine is built,
367 -- and then inserted before the given node N and analyzed.
369 procedure Get_Current_Value_Condition
370 (Var : Node_Id;
371 Op : out Node_Kind;
372 Val : out Node_Id);
373 -- This routine processes the Current_Value field of the variable Var. If
374 -- the Current_Value field is null or if it represents a known value, then
375 -- on return Cond is set to N_Empty, and Val is set to Empty.
377 -- The other case is when Current_Value points to an N_If_Statement or an
378 -- N_Elsif_Part (while statement). Such a setting only occurs if the
379 -- condition of an IF or ELSIF is of the form X op Y, where is the variable
380 -- in question, Y is a compile-time known value, and op is one of the six
381 -- possible relational operators.
383 -- In this case, Get_Current_Condition digs out the condition, and then
384 -- checks if the condition is known false, known true, or not known at all.
385 -- In the first two cases, Get_Current_Condition will return with Op set to
386 -- the appropriate conditional operator (inverted if the condition is known
387 -- false), and Val set to the constant value. If the condition is not
388 -- known, then Cond and Val are set for the empty case (N_Empty and Empty).
390 -- The check for whether the condition is true/false unknown depends
391 -- on the case:
393 -- For an IF, the condition is known true in the THEN part, known false
394 -- in any ELSIF or ELSE part, and not known outside the IF statement in
395 -- question.
397 -- For an ELSIF, the condition is known true in the ELSIF part, known
398 -- FALSE in any subsequent ELSIF, or ELSE part, and not known before the
399 -- ELSIF, or after the end of the IF statement.
401 -- The caller can use this result to determine the value (for the case of
402 -- N_Op_Eq), or to determine the result of some other test in other cases
403 -- (e.g. no access check required if N_Op_Ne Null).
405 function Homonym_Number (Subp : Entity_Id) return Nat;
406 -- Here subp is the entity for a subprogram. This routine returns the
407 -- homonym number used to disambiguate overloaded subprograms in the same
408 -- scope (the number is used as part of constructed names to make sure that
409 -- they are unique). The number is the ordinal position on the Homonym
410 -- chain, counting only entries in the curren scope. If an entity is not
411 -- overloaded, the returned number will be one.
413 function Implements_Limited_Interface (Typ : Entity_Id) return Boolean;
414 -- Ada 2005 (AI-345): Determine whether Typ implements some limited
415 -- interface. The interface may be of limited, protected, synchronized
416 -- or taks kind. Typ may also be derived from a type that implements a
417 -- limited interface.
419 function Inside_Init_Proc return Boolean;
420 -- Returns True if current scope is within an init proc
422 function In_Unconditional_Context (Node : Node_Id) return Boolean;
423 -- Node is the node for a statement or a component of a statement. This
424 -- function deteermines if the statement appears in a context that is
425 -- unconditionally executed, i.e. it is not within a loop or a conditional
426 -- or a case statement etc.
428 function Is_All_Null_Statements (L : List_Id) return Boolean;
429 -- Return True if all the items of the list are N_Null_Statement nodes.
430 -- False otherwise. True for an empty list. It is an error to call this
431 -- routine with No_List as the argument.
433 function Is_Predefined_Dispatching_Operation
434 (Subp : Entity_Id) return Boolean;
435 -- Ada 2005 (AI-251): Determines if Subp is a predefined primitive
436 -- operation.
438 function Is_Ref_To_Bit_Packed_Array (N : Node_Id) return Boolean;
439 -- Determine whether the node P is a reference to a bit packed array, i.e.
440 -- whether the designated object is a component of a bit packed array, or a
441 -- subcomponent of such a component. If so, then all subscripts in P are
442 -- evaluated with a call to Force_Evaluation, and True is returned.
443 -- Otherwise False is returned, and P is not affected.
445 function Is_Ref_To_Bit_Packed_Slice (N : Node_Id) return Boolean;
446 -- Determine whether the node P is a reference to a bit packed slice, i.e.
447 -- whether the designated object is bit packed slice or a component of a
448 -- bit packed slice. Return True if so.
450 function Is_Possibly_Unaligned_Slice (N : Node_Id) return Boolean;
451 -- Determine whether the node P is a slice of an array where the slice
452 -- result may cause alignment problems because it has an alignment that
453 -- is not compatible with the type. Return True if so.
455 function Is_Possibly_Unaligned_Object (N : Node_Id) return Boolean;
456 -- Node N is an object reference. This function returns True if it is
457 -- possible that the object may not be aligned according to the normal
458 -- default alignment requirement for its type (e.g. if it appears in a
459 -- packed record, or as part of a component that has a component clause.
461 function Is_Renamed_Object (N : Node_Id) return Boolean;
462 -- Returns True if the node N is a renamed object. An expression is
463 -- considered to be a renamed object if either it is the Name of an object
464 -- renaming declaration, or is the prefix of a name which is a renamed
465 -- object. For example, in:
467 -- x : r renames a (1 .. 2) (1);
469 -- We consider that a (1 .. 2) is a renamed object since it is the prefix
470 -- of the name in the renaming declaration.
472 function Is_Untagged_Derivation (T : Entity_Id) return Boolean;
473 -- Returns true if type T is not tagged and is a derived type,
474 -- or is a private type whose completion is such a type.
476 procedure Kill_Dead_Code (N : Node_Id);
477 -- N represents a node for a section of code that is known to be dead. The
478 -- node is deleted, and any exception handler references and warning
479 -- messages relating to this code are removed.
481 procedure Kill_Dead_Code (L : List_Id);
482 -- Like the above procedure, but applies to every element in the given
483 -- list. Each of the entries is removed from the list before killing it.
485 function Known_Non_Negative (Opnd : Node_Id) return Boolean;
486 -- Given a node for a subexpression, determines if it represents a value
487 -- that cannot possibly be negative, and if so returns True. A value of
488 -- False means that it is not known if the value is positive or negative.
490 function Known_Non_Null (N : Node_Id) return Boolean;
491 -- Given a node N for a subexpression of an access type, determines if
492 -- this subexpression yields a value that is known at compile time to
493 -- be non-null and returns True if so. Returns False otherwise. It is
494 -- an error to call this function if N is not of an access type.
496 function Make_Subtype_From_Expr
497 (E : Node_Id;
498 Unc_Typ : Entity_Id) return Node_Id;
499 -- Returns a subtype indication corresponding to the actual type of an
500 -- expression E. Unc_Typ is an unconstrained array or record, or
501 -- a classwide type.
503 function May_Generate_Large_Temp (Typ : Entity_Id) return Boolean;
504 -- Determines if the given type, Typ, may require a large temporary of the
505 -- kind that causes back-end trouble if stack checking is enabled. The
506 -- result is True only the size of the type is known at compile time and
507 -- large, where large is defined heuristically by the body of this routine.
508 -- The purpose of this routine is to help avoid generating troublesome
509 -- temporaries that interfere with stack checking mechanism. Note that the
510 -- caller has to check whether stack checking is actually enabled in order
511 -- to guide the expansion (typically of a function call).
513 procedure Remove_Side_Effects
514 (Exp : Node_Id;
515 Name_Req : Boolean := False;
516 Variable_Ref : Boolean := False);
517 -- Given the node for a subexpression, this function replaces the node if
518 -- necessary by an equivalent subexpression that is guaranteed to be side
519 -- effect free. This is done by extracting any actions that could cause
520 -- side effects, and inserting them using Insert_Actions into the tree to
521 -- which Exp is attached. Exp must be analyzed and resolved before the call
522 -- and is analyzed and resolved on return. The Name_Req may only be set to
523 -- True if Exp has the form of a name, and the effect is to guarantee that
524 -- any replacement maintains the form of name. If Variable_Ref is set to
525 -- TRUE, a variable is considered as side effect (used in implementing
526 -- Force_Evaluation). Note: after call to Remove_Side_Effects, it is safe
527 -- to call New_Copy_Tree to obtain a copy of the resulting expression.
529 function Represented_As_Scalar (T : Entity_Id) return Boolean;
530 -- Returns True iff the implementation of this type in code generation
531 -- terms is scalar. This is true for scalars in the Ada sense, and for
532 -- packed arrays which are represented by a scalar (modular) type.
534 function Safe_Unchecked_Type_Conversion (Exp : Node_Id) return Boolean;
535 -- Given the node for an N_Unchecked_Type_Conversion, return True if this
536 -- is an unchecked conversion that Gigi can handle directly. Otherwise
537 -- return False if it is one for which the front end must provide a
538 -- temporary. Note that the node need not be analyzed, and thus the Etype
539 -- field may not be set, but in that case it must be the case that the
540 -- Subtype_Mark field of the node is set/analyzed.
542 procedure Set_Elaboration_Flag (N : Node_Id; Spec_Id : Entity_Id);
543 -- N is the node for a subprogram or generic body, and Spec_Id is the
544 -- entity for the corresponding spec. If an elaboration entity is defined,
545 -- then this procedure generates an assignment statement to set it True,
546 -- immediately after the body is elaborated. However, no assignment is
547 -- generated in the case of library level procedures, since the setting of
548 -- the flag in this case is generated in the binder. We do that so that we
549 -- can detect cases where this is the only elaboration action that is
550 -- required.
552 function Target_Has_Fixed_Ops
553 (Left_Typ : Entity_Id;
554 Right_Typ : Entity_Id;
555 Result_Typ : Entity_Id) return Boolean;
556 -- Returns True if and only if the target machine has direct support
557 -- for fixed-by-fixed multiplications and divisions for the given
558 -- operand and result types. This is called in package Exp_Fixd to
559 -- determine whether to expand such operations.
561 function Type_May_Have_Bit_Aligned_Components
562 (Typ : Entity_Id) return Boolean;
563 -- Determines if Typ is a composite type that has within it (looking down
564 -- recursively at any subcomponents), a record type which has component
565 -- that may be bit aligned (see Possible_Bit_Aligned_Component). The result
566 -- is conservative, in that a result of False is decisive. A result of True
567 -- means that such a component may or may not be present.
569 procedure Wrap_Cleanup_Procedure (N : Node_Id);
570 -- Given an N_Subprogram_Body node, this procedure adds an Abort_Defer call
571 -- at the start of the statement sequence, and an Abort_Undefer call at the
572 -- end of the statement sequence. All cleanup routines (i.e. those that are
573 -- called from "at end" handlers) must defer abort on entry and undefer
574 -- abort on exit. Note that it is assumed that the code for the procedure
575 -- does not contain any return statements which would allow the flow of
576 -- control to escape doing the undefer call.
578 private
579 pragma Inline (Force_Evaluation);
580 pragma Inline (Duplicate_Subexpr);
582 end Exp_Util;