OSDN Git Service

2011-08-30 Robert Dewar <dewar@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / exp_ch5.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                              E X P _ C H 5                               --
6 --                                                                          --
7 --                                 B o d y                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2011, Free Software Foundation, Inc.         --
10 --                                                                          --
11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
12 -- terms of the  GNU General Public License as published  by the Free Soft- --
13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17 -- for  more details.  You should have  received  a copy of the GNU General --
18 -- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
20 --                                                                          --
21 -- GNAT was originally developed  by the GNAT team at  New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
23 --                                                                          --
24 ------------------------------------------------------------------------------
25
26 with Aspects;  use Aspects;
27 with Atree;    use Atree;
28 with Checks;   use Checks;
29 with Debug;    use Debug;
30 with Einfo;    use Einfo;
31 with Exp_Aggr; use Exp_Aggr;
32 with Exp_Ch6;  use Exp_Ch6;
33 with Exp_Ch7;  use Exp_Ch7;
34 with Exp_Ch11; use Exp_Ch11;
35 with Exp_Dbug; use Exp_Dbug;
36 with Exp_Pakd; use Exp_Pakd;
37 with Exp_Tss;  use Exp_Tss;
38 with Exp_Util; use Exp_Util;
39 with Namet;    use Namet;
40 with Nlists;   use Nlists;
41 with Nmake;    use Nmake;
42 with Opt;      use Opt;
43 with Restrict; use Restrict;
44 with Rident;   use Rident;
45 with Rtsfind;  use Rtsfind;
46 with Sinfo;    use Sinfo;
47 with Sem;      use Sem;
48 with Sem_Aux;  use Sem_Aux;
49 with Sem_Ch3;  use Sem_Ch3;
50 with Sem_Ch8;  use Sem_Ch8;
51 with Sem_Ch13; use Sem_Ch13;
52 with Sem_Eval; use Sem_Eval;
53 with Sem_Res;  use Sem_Res;
54 with Sem_Util; use Sem_Util;
55 with Snames;   use Snames;
56 with Stand;    use Stand;
57 with Stringt;  use Stringt;
58 with Targparm; use Targparm;
59 with Tbuild;   use Tbuild;
60 with Validsw;  use Validsw;
61
62 package body Exp_Ch5 is
63
64    function Change_Of_Representation (N : Node_Id) return Boolean;
65    --  Determine if the right hand side of the assignment N is a type
66    --  conversion which requires a change of representation. Called
67    --  only for the array and record cases.
68
69    procedure Expand_Assign_Array (N : Node_Id; Rhs : Node_Id);
70    --  N is an assignment which assigns an array value. This routine process
71    --  the various special cases and checks required for such assignments,
72    --  including change of representation. Rhs is normally simply the right
73    --  hand side of the assignment, except that if the right hand side is
74    --  a type conversion or a qualified expression, then the Rhs is the
75    --  actual expression inside any such type conversions or qualifications.
76
77    function Expand_Assign_Array_Loop
78      (N      : Node_Id;
79       Larray : Entity_Id;
80       Rarray : Entity_Id;
81       L_Type : Entity_Id;
82       R_Type : Entity_Id;
83       Ndim   : Pos;
84       Rev    : Boolean) return Node_Id;
85    --  N is an assignment statement which assigns an array value. This routine
86    --  expands the assignment into a loop (or nested loops for the case of a
87    --  multi-dimensional array) to do the assignment component by component.
88    --  Larray and Rarray are the entities of the actual arrays on the left
89    --  hand and right hand sides. L_Type and R_Type are the types of these
90    --  arrays (which may not be the same, due to either sliding, or to a
91    --  change of representation case). Ndim is the number of dimensions and
92    --  the parameter Rev indicates if the loops run normally (Rev = False),
93    --  or reversed (Rev = True). The value returned is the constructed
94    --  loop statement. Auxiliary declarations are inserted before node N
95    --  using the standard Insert_Actions mechanism.
96
97    procedure Expand_Assign_Record (N : Node_Id);
98    --  N is an assignment of a non-tagged record value. This routine handles
99    --  the case where the assignment must be made component by component,
100    --  either because the target is not byte aligned, or there is a change
101    --  of representation, or when we have a tagged type with a representation
102    --  clause (this last case is required because holes in the tagged type
103    --  might be filled with components from child types).
104
105    procedure Expand_Iterator_Loop (N : Node_Id);
106    --  Expand loop over arrays and containers that uses the form "for X of C"
107    --  with an optional subtype mark, or "for Y in C".
108
109    procedure Expand_Predicated_Loop (N : Node_Id);
110    --  Expand for loop over predicated subtype
111
112    function Make_Tag_Ctrl_Assignment (N : Node_Id) return List_Id;
113    --  Generate the necessary code for controlled and tagged assignment, that
114    --  is to say, finalization of the target before, adjustment of the target
115    --  after and save and restore of the tag and finalization pointers which
116    --  are not 'part of the value' and must not be changed upon assignment. N
117    --  is the original Assignment node.
118
119    ------------------------------
120    -- Change_Of_Representation --
121    ------------------------------
122
123    function Change_Of_Representation (N : Node_Id) return Boolean is
124       Rhs : constant Node_Id := Expression (N);
125    begin
126       return
127         Nkind (Rhs) = N_Type_Conversion
128           and then
129             not Same_Representation (Etype (Rhs), Etype (Expression (Rhs)));
130    end Change_Of_Representation;
131
132    -------------------------
133    -- Expand_Assign_Array --
134    -------------------------
135
136    --  There are two issues here. First, do we let Gigi do a block move, or
137    --  do we expand out into a loop? Second, we need to set the two flags
138    --  Forwards_OK and Backwards_OK which show whether the block move (or
139    --  corresponding loops) can be legitimately done in a forwards (low to
140    --  high) or backwards (high to low) manner.
141
142    procedure Expand_Assign_Array (N : Node_Id; Rhs : Node_Id) is
143       Loc : constant Source_Ptr := Sloc (N);
144
145       Lhs : constant Node_Id := Name (N);
146
147       Act_Lhs : constant Node_Id := Get_Referenced_Object (Lhs);
148       Act_Rhs : Node_Id          := Get_Referenced_Object (Rhs);
149
150       L_Type : constant Entity_Id :=
151                  Underlying_Type (Get_Actual_Subtype (Act_Lhs));
152       R_Type : Entity_Id :=
153                  Underlying_Type (Get_Actual_Subtype (Act_Rhs));
154
155       L_Slice : constant Boolean := Nkind (Act_Lhs) = N_Slice;
156       R_Slice : constant Boolean := Nkind (Act_Rhs) = N_Slice;
157
158       Crep : constant Boolean := Change_Of_Representation (N);
159
160       Larray  : Node_Id;
161       Rarray  : Node_Id;
162
163       Ndim : constant Pos := Number_Dimensions (L_Type);
164
165       Loop_Required : Boolean := False;
166       --  This switch is set to True if the array move must be done using
167       --  an explicit front end generated loop.
168
169       procedure Apply_Dereference (Arg : Node_Id);
170       --  If the argument is an access to an array, and the assignment is
171       --  converted into a procedure call, apply explicit dereference.
172
173       function Has_Address_Clause (Exp : Node_Id) return Boolean;
174       --  Test if Exp is a reference to an array whose declaration has
175       --  an address clause, or it is a slice of such an array.
176
177       function Is_Formal_Array (Exp : Node_Id) return Boolean;
178       --  Test if Exp is a reference to an array which is either a formal
179       --  parameter or a slice of a formal parameter. These are the cases
180       --  where hidden aliasing can occur.
181
182       function Is_Non_Local_Array (Exp : Node_Id) return Boolean;
183       --  Determine if Exp is a reference to an array variable which is other
184       --  than an object defined in the current scope, or a slice of such
185       --  an object. Such objects can be aliased to parameters (unlike local
186       --  array references).
187
188       -----------------------
189       -- Apply_Dereference --
190       -----------------------
191
192       procedure Apply_Dereference (Arg : Node_Id) is
193          Typ : constant Entity_Id := Etype (Arg);
194       begin
195          if Is_Access_Type (Typ) then
196             Rewrite (Arg, Make_Explicit_Dereference (Loc,
197               Prefix => Relocate_Node (Arg)));
198             Analyze_And_Resolve (Arg, Designated_Type (Typ));
199          end if;
200       end Apply_Dereference;
201
202       ------------------------
203       -- Has_Address_Clause --
204       ------------------------
205
206       function Has_Address_Clause (Exp : Node_Id) return Boolean is
207       begin
208          return
209            (Is_Entity_Name (Exp) and then
210                               Present (Address_Clause (Entity (Exp))))
211              or else
212            (Nkind (Exp) = N_Slice and then Has_Address_Clause (Prefix (Exp)));
213       end Has_Address_Clause;
214
215       ---------------------
216       -- Is_Formal_Array --
217       ---------------------
218
219       function Is_Formal_Array (Exp : Node_Id) return Boolean is
220       begin
221          return
222            (Is_Entity_Name (Exp) and then Is_Formal (Entity (Exp)))
223              or else
224            (Nkind (Exp) = N_Slice and then Is_Formal_Array (Prefix (Exp)));
225       end Is_Formal_Array;
226
227       ------------------------
228       -- Is_Non_Local_Array --
229       ------------------------
230
231       function Is_Non_Local_Array (Exp : Node_Id) return Boolean is
232       begin
233          return (Is_Entity_Name (Exp)
234                    and then Scope (Entity (Exp)) /= Current_Scope)
235             or else (Nkind (Exp) = N_Slice
236                        and then Is_Non_Local_Array (Prefix (Exp)));
237       end Is_Non_Local_Array;
238
239       --  Determine if Lhs, Rhs are formal arrays or nonlocal arrays
240
241       Lhs_Formal : constant Boolean := Is_Formal_Array (Act_Lhs);
242       Rhs_Formal : constant Boolean := Is_Formal_Array (Act_Rhs);
243
244       Lhs_Non_Local_Var : constant Boolean := Is_Non_Local_Array (Act_Lhs);
245       Rhs_Non_Local_Var : constant Boolean := Is_Non_Local_Array (Act_Rhs);
246
247    --  Start of processing for Expand_Assign_Array
248
249    begin
250       --  Deal with length check. Note that the length check is done with
251       --  respect to the right hand side as given, not a possible underlying
252       --  renamed object, since this would generate incorrect extra checks.
253
254       Apply_Length_Check (Rhs, L_Type);
255
256       --  We start by assuming that the move can be done in either direction,
257       --  i.e. that the two sides are completely disjoint.
258
259       Set_Forwards_OK  (N, True);
260       Set_Backwards_OK (N, True);
261
262       --  Normally it is only the slice case that can lead to overlap, and
263       --  explicit checks for slices are made below. But there is one case
264       --  where the slice can be implicit and invisible to us: when we have a
265       --  one dimensional array, and either both operands are parameters, or
266       --  one is a parameter (which can be a slice passed by reference) and the
267       --  other is a non-local variable. In this case the parameter could be a
268       --  slice that overlaps with the other operand.
269
270       --  However, if the array subtype is a constrained first subtype in the
271       --  parameter case, then we don't have to worry about overlap, since
272       --  slice assignments aren't possible (other than for a slice denoting
273       --  the whole array).
274
275       --  Note: No overlap is possible if there is a change of representation,
276       --  so we can exclude this case.
277
278       if Ndim = 1
279         and then not Crep
280         and then
281            ((Lhs_Formal and Rhs_Formal)
282               or else
283             (Lhs_Formal and Rhs_Non_Local_Var)
284               or else
285             (Rhs_Formal and Lhs_Non_Local_Var))
286         and then
287            (not Is_Constrained (Etype (Lhs))
288              or else not Is_First_Subtype (Etype (Lhs)))
289
290          --  In the case of compiling for the Java or .NET Virtual Machine,
291          --  slices are always passed by making a copy, so we don't have to
292          --  worry about overlap. We also want to prevent generation of "<"
293          --  comparisons for array addresses, since that's a meaningless
294          --  operation on the VM.
295
296         and then VM_Target = No_VM
297       then
298          Set_Forwards_OK  (N, False);
299          Set_Backwards_OK (N, False);
300
301          --  Note: the bit-packed case is not worrisome here, since if we have
302          --  a slice passed as a parameter, it is always aligned on a byte
303          --  boundary, and if there are no explicit slices, the assignment
304          --  can be performed directly.
305       end if;
306
307       --  If either operand has an address clause clear Backwards_OK and
308       --  Forwards_OK, since we cannot tell if the operands overlap. We
309       --  exclude this treatment when Rhs is an aggregate, since we know
310       --  that overlap can't occur.
311
312       if (Has_Address_Clause (Lhs) and then Nkind (Rhs) /= N_Aggregate)
313         or else Has_Address_Clause (Rhs)
314       then
315          Set_Forwards_OK  (N, False);
316          Set_Backwards_OK (N, False);
317       end if;
318
319       --  We certainly must use a loop for change of representation and also
320       --  we use the operand of the conversion on the right hand side as the
321       --  effective right hand side (the component types must match in this
322       --  situation).
323
324       if Crep then
325          Act_Rhs := Get_Referenced_Object (Rhs);
326          R_Type  := Get_Actual_Subtype (Act_Rhs);
327          Loop_Required := True;
328
329       --  We require a loop if the left side is possibly bit unaligned
330
331       elsif Possible_Bit_Aligned_Component (Lhs)
332               or else
333             Possible_Bit_Aligned_Component (Rhs)
334       then
335          Loop_Required := True;
336
337       --  Arrays with controlled components are expanded into a loop to force
338       --  calls to Adjust at the component level.
339
340       elsif Has_Controlled_Component (L_Type) then
341          Loop_Required := True;
342
343          --  If object is atomic, we cannot tolerate a loop
344
345       elsif Is_Atomic_Object (Act_Lhs)
346               or else
347             Is_Atomic_Object (Act_Rhs)
348       then
349          return;
350
351       --  Loop is required if we have atomic components since we have to
352       --  be sure to do any accesses on an element by element basis.
353
354       elsif Has_Atomic_Components (L_Type)
355         or else Has_Atomic_Components (R_Type)
356         or else Is_Atomic (Component_Type (L_Type))
357         or else Is_Atomic (Component_Type (R_Type))
358       then
359          Loop_Required := True;
360
361       --  Case where no slice is involved
362
363       elsif not L_Slice and not R_Slice then
364
365          --  The following code deals with the case of unconstrained bit packed
366          --  arrays. The problem is that the template for such arrays contains
367          --  the bounds of the actual source level array, but the copy of an
368          --  entire array requires the bounds of the underlying array. It would
369          --  be nice if the back end could take care of this, but right now it
370          --  does not know how, so if we have such a type, then we expand out
371          --  into a loop, which is inefficient but works correctly. If we don't
372          --  do this, we get the wrong length computed for the array to be
373          --  moved. The two cases we need to worry about are:
374
375          --  Explicit dereference of an unconstrained packed array type as in
376          --  the following example:
377
378          --    procedure C52 is
379          --       type BITS is array(INTEGER range <>) of BOOLEAN;
380          --       pragma PACK(BITS);
381          --       type A is access BITS;
382          --       P1,P2 : A;
383          --    begin
384          --       P1 := new BITS (1 .. 65_535);
385          --       P2 := new BITS (1 .. 65_535);
386          --       P2.ALL := P1.ALL;
387          --    end C52;
388
389          --  A formal parameter reference with an unconstrained bit array type
390          --  is the other case we need to worry about (here we assume the same
391          --  BITS type declared above):
392
393          --    procedure Write_All (File : out BITS; Contents : BITS);
394          --    begin
395          --       File.Storage := Contents;
396          --    end Write_All;
397
398          --  We expand to a loop in either of these two cases
399
400          --  Question for future thought. Another potentially more efficient
401          --  approach would be to create the actual subtype, and then do an
402          --  unchecked conversion to this actual subtype ???
403
404          Check_Unconstrained_Bit_Packed_Array : declare
405
406             function Is_UBPA_Reference (Opnd : Node_Id) return Boolean;
407             --  Function to perform required test for the first case, above
408             --  (dereference of an unconstrained bit packed array).
409
410             -----------------------
411             -- Is_UBPA_Reference --
412             -----------------------
413
414             function Is_UBPA_Reference (Opnd : Node_Id) return Boolean is
415                Typ      : constant Entity_Id := Underlying_Type (Etype (Opnd));
416                P_Type   : Entity_Id;
417                Des_Type : Entity_Id;
418
419             begin
420                if Present (Packed_Array_Type (Typ))
421                  and then Is_Array_Type (Packed_Array_Type (Typ))
422                  and then not Is_Constrained (Packed_Array_Type (Typ))
423                then
424                   return True;
425
426                elsif Nkind (Opnd) = N_Explicit_Dereference then
427                   P_Type := Underlying_Type (Etype (Prefix (Opnd)));
428
429                   if not Is_Access_Type (P_Type) then
430                      return False;
431
432                   else
433                      Des_Type := Designated_Type (P_Type);
434                      return
435                        Is_Bit_Packed_Array (Des_Type)
436                          and then not Is_Constrained (Des_Type);
437                   end if;
438
439                else
440                   return False;
441                end if;
442             end Is_UBPA_Reference;
443
444          --  Start of processing for Check_Unconstrained_Bit_Packed_Array
445
446          begin
447             if Is_UBPA_Reference (Lhs)
448                  or else
449                Is_UBPA_Reference (Rhs)
450             then
451                Loop_Required := True;
452
453             --  Here if we do not have the case of a reference to a bit packed
454             --  unconstrained array case. In this case gigi can most certainly
455             --  handle the assignment if a forwards move is allowed.
456
457             --  (could it handle the backwards case also???)
458
459             elsif Forwards_OK (N) then
460                return;
461             end if;
462          end Check_Unconstrained_Bit_Packed_Array;
463
464       --  The back end can always handle the assignment if the right side is a
465       --  string literal (note that overlap is definitely impossible in this
466       --  case). If the type is packed, a string literal is always converted
467       --  into an aggregate, except in the case of a null slice, for which no
468       --  aggregate can be written. In that case, rewrite the assignment as a
469       --  null statement, a length check has already been emitted to verify
470       --  that the range of the left-hand side is empty.
471
472       --  Note that this code is not executed if we have an assignment of a
473       --  string literal to a non-bit aligned component of a record, a case
474       --  which cannot be handled by the backend.
475
476       elsif Nkind (Rhs) = N_String_Literal then
477          if String_Length (Strval (Rhs)) = 0
478            and then Is_Bit_Packed_Array (L_Type)
479          then
480             Rewrite (N, Make_Null_Statement (Loc));
481             Analyze (N);
482          end if;
483
484          return;
485
486       --  If either operand is bit packed, then we need a loop, since we can't
487       --  be sure that the slice is byte aligned. Similarly, if either operand
488       --  is a possibly unaligned slice, then we need a loop (since the back
489       --  end cannot handle unaligned slices).
490
491       elsif Is_Bit_Packed_Array (L_Type)
492         or else Is_Bit_Packed_Array (R_Type)
493         or else Is_Possibly_Unaligned_Slice (Lhs)
494         or else Is_Possibly_Unaligned_Slice (Rhs)
495       then
496          Loop_Required := True;
497
498       --  If we are not bit-packed, and we have only one slice, then no overlap
499       --  is possible except in the parameter case, so we can let the back end
500       --  handle things.
501
502       elsif not (L_Slice and R_Slice) then
503          if Forwards_OK (N) then
504             return;
505          end if;
506       end if;
507
508       --  If the right-hand side is a string literal, introduce a temporary for
509       --  it, for use in the generated loop that will follow.
510
511       if Nkind (Rhs) = N_String_Literal then
512          declare
513             Temp : constant Entity_Id := Make_Temporary (Loc, 'T', Rhs);
514             Decl : Node_Id;
515
516          begin
517             Decl :=
518               Make_Object_Declaration (Loc,
519                  Defining_Identifier => Temp,
520                  Object_Definition => New_Occurrence_Of (L_Type, Loc),
521                  Expression => Relocate_Node (Rhs));
522
523             Insert_Action (N, Decl);
524             Rewrite (Rhs, New_Occurrence_Of (Temp, Loc));
525             R_Type := Etype (Temp);
526          end;
527       end if;
528
529       --  Come here to complete the analysis
530
531       --    Loop_Required: Set to True if we know that a loop is required
532       --                   regardless of overlap considerations.
533
534       --    Forwards_OK:   Set to False if we already know that a forwards
535       --                   move is not safe, else set to True.
536
537       --    Backwards_OK:  Set to False if we already know that a backwards
538       --                   move is not safe, else set to True
539
540       --  Our task at this stage is to complete the overlap analysis, which can
541       --  result in possibly setting Forwards_OK or Backwards_OK to False, and
542       --  then generating the final code, either by deciding that it is OK
543       --  after all to let Gigi handle it, or by generating appropriate code
544       --  in the front end.
545
546       declare
547          L_Index_Typ : constant Node_Id := Etype (First_Index (L_Type));
548          R_Index_Typ : constant Node_Id := Etype (First_Index (R_Type));
549
550          Left_Lo  : constant Node_Id := Type_Low_Bound  (L_Index_Typ);
551          Left_Hi  : constant Node_Id := Type_High_Bound (L_Index_Typ);
552          Right_Lo : constant Node_Id := Type_Low_Bound  (R_Index_Typ);
553          Right_Hi : constant Node_Id := Type_High_Bound (R_Index_Typ);
554
555          Act_L_Array : Node_Id;
556          Act_R_Array : Node_Id;
557
558          Cleft_Lo  : Node_Id;
559          Cright_Lo : Node_Id;
560          Condition : Node_Id;
561
562          Cresult : Compare_Result;
563
564       begin
565          --  Get the expressions for the arrays. If we are dealing with a
566          --  private type, then convert to the underlying type. We can do
567          --  direct assignments to an array that is a private type, but we
568          --  cannot assign to elements of the array without this extra
569          --  unchecked conversion.
570
571          --  Note: We propagate Parent to the conversion nodes to generate
572          --  a well-formed subtree.
573
574          if Nkind (Act_Lhs) = N_Slice then
575             Larray := Prefix (Act_Lhs);
576          else
577             Larray := Act_Lhs;
578
579             if Is_Private_Type (Etype (Larray)) then
580                declare
581                   Par : constant Node_Id := Parent (Larray);
582                begin
583                   Larray :=
584                     Unchecked_Convert_To
585                       (Underlying_Type (Etype (Larray)), Larray);
586                   Set_Parent (Larray, Par);
587                end;
588             end if;
589          end if;
590
591          if Nkind (Act_Rhs) = N_Slice then
592             Rarray := Prefix (Act_Rhs);
593          else
594             Rarray := Act_Rhs;
595
596             if Is_Private_Type (Etype (Rarray)) then
597                declare
598                   Par : constant Node_Id := Parent (Rarray);
599                begin
600                   Rarray :=
601                     Unchecked_Convert_To
602                       (Underlying_Type (Etype (Rarray)), Rarray);
603                   Set_Parent (Rarray, Par);
604                end;
605             end if;
606          end if;
607
608          --  If both sides are slices, we must figure out whether it is safe
609          --  to do the move in one direction or the other. It is always safe
610          --  if there is a change of representation since obviously two arrays
611          --  with different representations cannot possibly overlap.
612
613          if (not Crep) and L_Slice and R_Slice then
614             Act_L_Array := Get_Referenced_Object (Prefix (Act_Lhs));
615             Act_R_Array := Get_Referenced_Object (Prefix (Act_Rhs));
616
617             --  If both left and right hand arrays are entity names, and refer
618             --  to different entities, then we know that the move is safe (the
619             --  two storage areas are completely disjoint).
620
621             if Is_Entity_Name (Act_L_Array)
622               and then Is_Entity_Name (Act_R_Array)
623               and then Entity (Act_L_Array) /= Entity (Act_R_Array)
624             then
625                null;
626
627             --  Otherwise, we assume the worst, which is that the two arrays
628             --  are the same array. There is no need to check if we know that
629             --  is the case, because if we don't know it, we still have to
630             --  assume it!
631
632             --  Generally if the same array is involved, then we have an
633             --  overlapping case. We will have to really assume the worst (i.e.
634             --  set neither of the OK flags) unless we can determine the lower
635             --  or upper bounds at compile time and compare them.
636
637             else
638                Cresult :=
639                  Compile_Time_Compare
640                    (Left_Lo, Right_Lo, Assume_Valid => True);
641
642                if Cresult = Unknown then
643                   Cresult :=
644                     Compile_Time_Compare
645                       (Left_Hi, Right_Hi, Assume_Valid => True);
646                end if;
647
648                case Cresult is
649                   when LT | LE | EQ => Set_Backwards_OK (N, False);
650                   when GT | GE      => Set_Forwards_OK  (N, False);
651                   when NE | Unknown => Set_Backwards_OK (N, False);
652                                        Set_Forwards_OK  (N, False);
653                end case;
654             end if;
655          end if;
656
657          --  If after that analysis Loop_Required is False, meaning that we
658          --  have not discovered some non-overlap reason for requiring a loop,
659          --  then the outcome depends on the capabilities of the back end.
660
661          if not Loop_Required then
662
663             --  The GCC back end can deal with all cases of overlap by falling
664             --  back to memmove if it cannot use a more efficient approach.
665
666             if VM_Target = No_VM and not AAMP_On_Target then
667                return;
668
669             --  Assume other back ends can handle it if Forwards_OK is set
670
671             elsif Forwards_OK (N) then
672                return;
673
674             --  If Forwards_OK is not set, the back end will need something
675             --  like memmove to handle the move. For now, this processing is
676             --  activated using the .s debug flag (-gnatd.s).
677
678             elsif Debug_Flag_Dot_S then
679                return;
680             end if;
681          end if;
682
683          --  At this stage we have to generate an explicit loop, and we have
684          --  the following cases:
685
686          --  Forwards_OK = True
687
688          --    Rnn : right_index := right_index'First;
689          --    for Lnn in left-index loop
690          --       left (Lnn) := right (Rnn);
691          --       Rnn := right_index'Succ (Rnn);
692          --    end loop;
693
694          --    Note: the above code MUST be analyzed with checks off, because
695          --    otherwise the Succ could overflow. But in any case this is more
696          --    efficient!
697
698          --  Forwards_OK = False, Backwards_OK = True
699
700          --    Rnn : right_index := right_index'Last;
701          --    for Lnn in reverse left-index loop
702          --       left (Lnn) := right (Rnn);
703          --       Rnn := right_index'Pred (Rnn);
704          --    end loop;
705
706          --    Note: the above code MUST be analyzed with checks off, because
707          --    otherwise the Pred could overflow. But in any case this is more
708          --    efficient!
709
710          --  Forwards_OK = Backwards_OK = False
711
712          --    This only happens if we have the same array on each side. It is
713          --    possible to create situations using overlays that violate this,
714          --    but we simply do not promise to get this "right" in this case.
715
716          --    There are two possible subcases. If the No_Implicit_Conditionals
717          --    restriction is set, then we generate the following code:
718
719          --      declare
720          --        T : constant <operand-type> := rhs;
721          --      begin
722          --        lhs := T;
723          --      end;
724
725          --    If implicit conditionals are permitted, then we generate:
726
727          --      if Left_Lo <= Right_Lo then
728          --         <code for Forwards_OK = True above>
729          --      else
730          --         <code for Backwards_OK = True above>
731          --      end if;
732
733          --  In order to detect possible aliasing, we examine the renamed
734          --  expression when the source or target is a renaming. However,
735          --  the renaming may be intended to capture an address that may be
736          --  affected by subsequent code, and therefore we must recover
737          --  the actual entity for the expansion that follows, not the
738          --  object it renames. In particular, if source or target designate
739          --  a portion of a dynamically allocated object, the pointer to it
740          --  may be reassigned but the renaming preserves the proper location.
741
742          if Is_Entity_Name (Rhs)
743            and then
744              Nkind (Parent (Entity (Rhs))) = N_Object_Renaming_Declaration
745            and then Nkind (Act_Rhs) = N_Slice
746          then
747             Rarray := Rhs;
748          end if;
749
750          if Is_Entity_Name (Lhs)
751            and then
752              Nkind (Parent (Entity (Lhs))) = N_Object_Renaming_Declaration
753            and then Nkind (Act_Lhs) = N_Slice
754          then
755             Larray := Lhs;
756          end if;
757
758          --  Cases where either Forwards_OK or Backwards_OK is true
759
760          if Forwards_OK (N) or else Backwards_OK (N) then
761             if Needs_Finalization (Component_Type (L_Type))
762               and then Base_Type (L_Type) = Base_Type (R_Type)
763               and then Ndim = 1
764               and then not No_Ctrl_Actions (N)
765             then
766                declare
767                   Proc    : constant Entity_Id :=
768                               TSS (Base_Type (L_Type), TSS_Slice_Assign);
769                   Actuals : List_Id;
770
771                begin
772                   Apply_Dereference (Larray);
773                   Apply_Dereference (Rarray);
774                   Actuals := New_List (
775                     Duplicate_Subexpr (Larray,   Name_Req => True),
776                     Duplicate_Subexpr (Rarray,   Name_Req => True),
777                     Duplicate_Subexpr (Left_Lo,  Name_Req => True),
778                     Duplicate_Subexpr (Left_Hi,  Name_Req => True),
779                     Duplicate_Subexpr (Right_Lo, Name_Req => True),
780                     Duplicate_Subexpr (Right_Hi, Name_Req => True));
781
782                   Append_To (Actuals,
783                     New_Occurrence_Of (
784                       Boolean_Literals (not Forwards_OK (N)), Loc));
785
786                   Rewrite (N,
787                     Make_Procedure_Call_Statement (Loc,
788                       Name => New_Reference_To (Proc, Loc),
789                       Parameter_Associations => Actuals));
790                end;
791
792             else
793                Rewrite (N,
794                  Expand_Assign_Array_Loop
795                    (N, Larray, Rarray, L_Type, R_Type, Ndim,
796                     Rev => not Forwards_OK (N)));
797             end if;
798
799          --  Case of both are false with No_Implicit_Conditionals
800
801          elsif Restriction_Active (No_Implicit_Conditionals) then
802             declare
803                   T : constant Entity_Id :=
804                         Make_Defining_Identifier (Loc, Chars => Name_T);
805
806             begin
807                Rewrite (N,
808                  Make_Block_Statement (Loc,
809                   Declarations => New_List (
810                     Make_Object_Declaration (Loc,
811                       Defining_Identifier => T,
812                       Constant_Present  => True,
813                       Object_Definition =>
814                         New_Occurrence_Of (Etype (Rhs), Loc),
815                       Expression        => Relocate_Node (Rhs))),
816
817                     Handled_Statement_Sequence =>
818                       Make_Handled_Sequence_Of_Statements (Loc,
819                         Statements => New_List (
820                           Make_Assignment_Statement (Loc,
821                             Name       => Relocate_Node (Lhs),
822                             Expression => New_Occurrence_Of (T, Loc))))));
823             end;
824
825          --  Case of both are false with implicit conditionals allowed
826
827          else
828             --  Before we generate this code, we must ensure that the left and
829             --  right side array types are defined. They may be itypes, and we
830             --  cannot let them be defined inside the if, since the first use
831             --  in the then may not be executed.
832
833             Ensure_Defined (L_Type, N);
834             Ensure_Defined (R_Type, N);
835
836             --  We normally compare addresses to find out which way round to
837             --  do the loop, since this is reliable, and handles the cases of
838             --  parameters, conversions etc. But we can't do that in the bit
839             --  packed case or the VM case, because addresses don't work there.
840
841             if not Is_Bit_Packed_Array (L_Type) and then VM_Target = No_VM then
842                Condition :=
843                  Make_Op_Le (Loc,
844                    Left_Opnd =>
845                      Unchecked_Convert_To (RTE (RE_Integer_Address),
846                        Make_Attribute_Reference (Loc,
847                          Prefix =>
848                            Make_Indexed_Component (Loc,
849                              Prefix =>
850                                Duplicate_Subexpr_Move_Checks (Larray, True),
851                              Expressions => New_List (
852                                Make_Attribute_Reference (Loc,
853                                  Prefix =>
854                                    New_Reference_To
855                                      (L_Index_Typ, Loc),
856                                  Attribute_Name => Name_First))),
857                          Attribute_Name => Name_Address)),
858
859                    Right_Opnd =>
860                      Unchecked_Convert_To (RTE (RE_Integer_Address),
861                        Make_Attribute_Reference (Loc,
862                          Prefix =>
863                            Make_Indexed_Component (Loc,
864                              Prefix =>
865                                Duplicate_Subexpr_Move_Checks (Rarray, True),
866                              Expressions => New_List (
867                                Make_Attribute_Reference (Loc,
868                                  Prefix =>
869                                    New_Reference_To
870                                      (R_Index_Typ, Loc),
871                                  Attribute_Name => Name_First))),
872                          Attribute_Name => Name_Address)));
873
874             --  For the bit packed and VM cases we use the bounds. That's OK,
875             --  because we don't have to worry about parameters, since they
876             --  cannot cause overlap. Perhaps we should worry about weird slice
877             --  conversions ???
878
879             else
880                --  Copy the bounds
881
882                Cleft_Lo  := New_Copy_Tree (Left_Lo);
883                Cright_Lo := New_Copy_Tree (Right_Lo);
884
885                --  If the types do not match we add an implicit conversion
886                --  here to ensure proper match
887
888                if Etype (Left_Lo) /= Etype (Right_Lo) then
889                   Cright_Lo :=
890                     Unchecked_Convert_To (Etype (Left_Lo), Cright_Lo);
891                end if;
892
893                --  Reset the Analyzed flag, because the bounds of the index
894                --  type itself may be universal, and must must be reanalyzed
895                --  to acquire the proper type for the back end.
896
897                Set_Analyzed (Cleft_Lo, False);
898                Set_Analyzed (Cright_Lo, False);
899
900                Condition :=
901                  Make_Op_Le (Loc,
902                    Left_Opnd  => Cleft_Lo,
903                    Right_Opnd => Cright_Lo);
904             end if;
905
906             if Needs_Finalization (Component_Type (L_Type))
907               and then Base_Type (L_Type) = Base_Type (R_Type)
908               and then Ndim = 1
909               and then not No_Ctrl_Actions (N)
910             then
911
912                --  Call TSS procedure for array assignment, passing the
913                --  explicit bounds of right and left hand sides.
914
915                declare
916                   Proc    : constant Entity_Id :=
917                               TSS (Base_Type (L_Type), TSS_Slice_Assign);
918                   Actuals : List_Id;
919
920                begin
921                   Apply_Dereference (Larray);
922                   Apply_Dereference (Rarray);
923                   Actuals := New_List (
924                     Duplicate_Subexpr (Larray,   Name_Req => True),
925                     Duplicate_Subexpr (Rarray,   Name_Req => True),
926                     Duplicate_Subexpr (Left_Lo,  Name_Req => True),
927                     Duplicate_Subexpr (Left_Hi,  Name_Req => True),
928                     Duplicate_Subexpr (Right_Lo, Name_Req => True),
929                     Duplicate_Subexpr (Right_Hi, Name_Req => True));
930
931                   Append_To (Actuals,
932                      Make_Op_Not (Loc,
933                        Right_Opnd => Condition));
934
935                   Rewrite (N,
936                     Make_Procedure_Call_Statement (Loc,
937                       Name => New_Reference_To (Proc, Loc),
938                       Parameter_Associations => Actuals));
939                end;
940
941             else
942                Rewrite (N,
943                  Make_Implicit_If_Statement (N,
944                    Condition => Condition,
945
946                    Then_Statements => New_List (
947                      Expand_Assign_Array_Loop
948                       (N, Larray, Rarray, L_Type, R_Type, Ndim,
949                        Rev => False)),
950
951                    Else_Statements => New_List (
952                      Expand_Assign_Array_Loop
953                       (N, Larray, Rarray, L_Type, R_Type, Ndim,
954                        Rev => True))));
955             end if;
956          end if;
957
958          Analyze (N, Suppress => All_Checks);
959       end;
960
961    exception
962       when RE_Not_Available =>
963          return;
964    end Expand_Assign_Array;
965
966    ------------------------------
967    -- Expand_Assign_Array_Loop --
968    ------------------------------
969
970    --  The following is an example of the loop generated for the case of a
971    --  two-dimensional array:
972
973    --    declare
974    --       R2b : Tm1X1 := 1;
975    --    begin
976    --       for L1b in 1 .. 100 loop
977    --          declare
978    --             R4b : Tm1X2 := 1;
979    --          begin
980    --             for L3b in 1 .. 100 loop
981    --                vm1 (L1b, L3b) := vm2 (R2b, R4b);
982    --                R4b := Tm1X2'succ(R4b);
983    --             end loop;
984    --          end;
985    --          R2b := Tm1X1'succ(R2b);
986    --       end loop;
987    --    end;
988
989    --  Here Rev is False, and Tm1Xn are the subscript types for the right hand
990    --  side. The declarations of R2b and R4b are inserted before the original
991    --  assignment statement.
992
993    function Expand_Assign_Array_Loop
994      (N      : Node_Id;
995       Larray : Entity_Id;
996       Rarray : Entity_Id;
997       L_Type : Entity_Id;
998       R_Type : Entity_Id;
999       Ndim   : Pos;
1000       Rev    : Boolean) return Node_Id
1001    is
1002       Loc  : constant Source_Ptr := Sloc (N);
1003
1004       Lnn : array (1 .. Ndim) of Entity_Id;
1005       Rnn : array (1 .. Ndim) of Entity_Id;
1006       --  Entities used as subscripts on left and right sides
1007
1008       L_Index_Type : array (1 .. Ndim) of Entity_Id;
1009       R_Index_Type : array (1 .. Ndim) of Entity_Id;
1010       --  Left and right index types
1011
1012       Assign : Node_Id;
1013
1014       F_Or_L : Name_Id;
1015       S_Or_P : Name_Id;
1016
1017       function Build_Step (J : Nat) return Node_Id;
1018       --  The increment step for the index of the right-hand side is written
1019       --  as an attribute reference (Succ or Pred). This function returns
1020       --  the corresponding node, which is placed at the end of the loop body.
1021
1022       ----------------
1023       -- Build_Step --
1024       ----------------
1025
1026       function Build_Step (J : Nat) return Node_Id is
1027          Step : Node_Id;
1028          Lim  : Name_Id;
1029
1030       begin
1031          if Rev then
1032             Lim := Name_First;
1033          else
1034             Lim := Name_Last;
1035          end if;
1036
1037          Step :=
1038             Make_Assignment_Statement (Loc,
1039                Name => New_Occurrence_Of (Rnn (J), Loc),
1040                Expression =>
1041                  Make_Attribute_Reference (Loc,
1042                    Prefix =>
1043                      New_Occurrence_Of (R_Index_Type (J), Loc),
1044                    Attribute_Name => S_Or_P,
1045                    Expressions => New_List (
1046                      New_Occurrence_Of (Rnn (J), Loc))));
1047
1048       --  Note that on the last iteration of the loop, the index is increased
1049       --  (or decreased) past the corresponding bound. This is consistent with
1050       --  the C semantics of the back-end, where such an off-by-one value on a
1051       --  dead index variable is OK. However, in CodePeer mode this leads to
1052       --  spurious warnings, and thus we place a guard around the attribute
1053       --  reference. For obvious reasons we only do this for CodePeer.
1054
1055          if CodePeer_Mode then
1056             Step :=
1057               Make_If_Statement (Loc,
1058                  Condition =>
1059                     Make_Op_Ne (Loc,
1060                        Left_Opnd  => New_Occurrence_Of (Lnn (J), Loc),
1061                        Right_Opnd =>
1062                          Make_Attribute_Reference (Loc,
1063                            Prefix => New_Occurrence_Of (L_Index_Type (J), Loc),
1064                            Attribute_Name => Lim)),
1065                  Then_Statements => New_List (Step));
1066          end if;
1067
1068          return Step;
1069       end Build_Step;
1070
1071    --  Start of processing for Expand_Assign_Array_Loop
1072
1073    begin
1074       if Rev then
1075          F_Or_L := Name_Last;
1076          S_Or_P := Name_Pred;
1077       else
1078          F_Or_L := Name_First;
1079          S_Or_P := Name_Succ;
1080       end if;
1081
1082       --  Setup index types and subscript entities
1083
1084       declare
1085          L_Index : Node_Id;
1086          R_Index : Node_Id;
1087
1088       begin
1089          L_Index := First_Index (L_Type);
1090          R_Index := First_Index (R_Type);
1091
1092          for J in 1 .. Ndim loop
1093             Lnn (J) := Make_Temporary (Loc, 'L');
1094             Rnn (J) := Make_Temporary (Loc, 'R');
1095
1096             L_Index_Type (J) := Etype (L_Index);
1097             R_Index_Type (J) := Etype (R_Index);
1098
1099             Next_Index (L_Index);
1100             Next_Index (R_Index);
1101          end loop;
1102       end;
1103
1104       --  Now construct the assignment statement
1105
1106       declare
1107          ExprL : constant List_Id := New_List;
1108          ExprR : constant List_Id := New_List;
1109
1110       begin
1111          for J in 1 .. Ndim loop
1112             Append_To (ExprL, New_Occurrence_Of (Lnn (J), Loc));
1113             Append_To (ExprR, New_Occurrence_Of (Rnn (J), Loc));
1114          end loop;
1115
1116          Assign :=
1117            Make_Assignment_Statement (Loc,
1118              Name =>
1119                Make_Indexed_Component (Loc,
1120                  Prefix      => Duplicate_Subexpr (Larray, Name_Req => True),
1121                  Expressions => ExprL),
1122              Expression =>
1123                Make_Indexed_Component (Loc,
1124                  Prefix      => Duplicate_Subexpr (Rarray, Name_Req => True),
1125                  Expressions => ExprR));
1126
1127          --  We set assignment OK, since there are some cases, e.g. in object
1128          --  declarations, where we are actually assigning into a constant.
1129          --  If there really is an illegality, it was caught long before now,
1130          --  and was flagged when the original assignment was analyzed.
1131
1132          Set_Assignment_OK (Name (Assign));
1133
1134          --  Propagate the No_Ctrl_Actions flag to individual assignments
1135
1136          Set_No_Ctrl_Actions (Assign, No_Ctrl_Actions (N));
1137       end;
1138
1139       --  Now construct the loop from the inside out, with the last subscript
1140       --  varying most rapidly. Note that Assign is first the raw assignment
1141       --  statement, and then subsequently the loop that wraps it up.
1142
1143       for J in reverse 1 .. Ndim loop
1144          Assign :=
1145            Make_Block_Statement (Loc,
1146              Declarations => New_List (
1147               Make_Object_Declaration (Loc,
1148                 Defining_Identifier => Rnn (J),
1149                 Object_Definition =>
1150                   New_Occurrence_Of (R_Index_Type (J), Loc),
1151                 Expression =>
1152                   Make_Attribute_Reference (Loc,
1153                     Prefix => New_Occurrence_Of (R_Index_Type (J), Loc),
1154                     Attribute_Name => F_Or_L))),
1155
1156            Handled_Statement_Sequence =>
1157              Make_Handled_Sequence_Of_Statements (Loc,
1158                Statements => New_List (
1159                  Make_Implicit_Loop_Statement (N,
1160                    Iteration_Scheme =>
1161                      Make_Iteration_Scheme (Loc,
1162                        Loop_Parameter_Specification =>
1163                          Make_Loop_Parameter_Specification (Loc,
1164                            Defining_Identifier => Lnn (J),
1165                            Reverse_Present => Rev,
1166                            Discrete_Subtype_Definition =>
1167                              New_Reference_To (L_Index_Type (J), Loc))),
1168
1169                    Statements => New_List (Assign, Build_Step (J))))));
1170       end loop;
1171
1172       return Assign;
1173    end Expand_Assign_Array_Loop;
1174
1175    --------------------------
1176    -- Expand_Assign_Record --
1177    --------------------------
1178
1179    procedure Expand_Assign_Record (N : Node_Id) is
1180       Lhs   : constant Node_Id    := Name (N);
1181       Rhs   : Node_Id             := Expression (N);
1182       L_Typ : constant Entity_Id  := Base_Type (Etype (Lhs));
1183
1184    begin
1185       --  If change of representation, then extract the real right hand side
1186       --  from the type conversion, and proceed with component-wise assignment,
1187       --  since the two types are not the same as far as the back end is
1188       --  concerned.
1189
1190       if Change_Of_Representation (N) then
1191          Rhs := Expression (Rhs);
1192
1193       --  If this may be a case of a large bit aligned component, then proceed
1194       --  with component-wise assignment, to avoid possible clobbering of other
1195       --  components sharing bits in the first or last byte of the component to
1196       --  be assigned.
1197
1198       elsif Possible_Bit_Aligned_Component (Lhs)
1199               or
1200             Possible_Bit_Aligned_Component (Rhs)
1201       then
1202          null;
1203
1204       --  If we have a tagged type that has a complete record representation
1205       --  clause, we must do we must do component-wise assignments, since child
1206       --  types may have used gaps for their components, and we might be
1207       --  dealing with a view conversion.
1208
1209       elsif Is_Fully_Repped_Tagged_Type (L_Typ) then
1210          null;
1211
1212       --  If neither condition met, then nothing special to do, the back end
1213       --  can handle assignment of the entire component as a single entity.
1214
1215       else
1216          return;
1217       end if;
1218
1219       --  At this stage we know that we must do a component wise assignment
1220
1221       declare
1222          Loc   : constant Source_Ptr := Sloc (N);
1223          R_Typ : constant Entity_Id  := Base_Type (Etype (Rhs));
1224          Decl  : constant Node_Id    := Declaration_Node (R_Typ);
1225          RDef  : Node_Id;
1226          F     : Entity_Id;
1227
1228          function Find_Component
1229            (Typ  : Entity_Id;
1230             Comp : Entity_Id) return Entity_Id;
1231          --  Find the component with the given name in the underlying record
1232          --  declaration for Typ. We need to use the actual entity because the
1233          --  type may be private and resolution by identifier alone would fail.
1234
1235          function Make_Component_List_Assign
1236            (CL  : Node_Id;
1237             U_U : Boolean := False) return List_Id;
1238          --  Returns a sequence of statements to assign the components that
1239          --  are referenced in the given component list. The flag U_U is
1240          --  used to force the usage of the inferred value of the variant
1241          --  part expression as the switch for the generated case statement.
1242
1243          function Make_Field_Assign
1244            (C   : Entity_Id;
1245             U_U : Boolean := False) return Node_Id;
1246          --  Given C, the entity for a discriminant or component, build an
1247          --  assignment for the corresponding field values. The flag U_U
1248          --  signals the presence of an Unchecked_Union and forces the usage
1249          --  of the inferred discriminant value of C as the right hand side
1250          --  of the assignment.
1251
1252          function Make_Field_Assigns (CI : List_Id) return List_Id;
1253          --  Given CI, a component items list, construct series of statements
1254          --  for fieldwise assignment of the corresponding components.
1255
1256          --------------------
1257          -- Find_Component --
1258          --------------------
1259
1260          function Find_Component
1261            (Typ  : Entity_Id;
1262             Comp : Entity_Id) return Entity_Id
1263          is
1264             Utyp : constant Entity_Id := Underlying_Type (Typ);
1265             C    : Entity_Id;
1266
1267          begin
1268             C := First_Entity (Utyp);
1269             while Present (C) loop
1270                if Chars (C) = Chars (Comp) then
1271                   return C;
1272                end if;
1273
1274                Next_Entity (C);
1275             end loop;
1276
1277             raise Program_Error;
1278          end Find_Component;
1279
1280          --------------------------------
1281          -- Make_Component_List_Assign --
1282          --------------------------------
1283
1284          function Make_Component_List_Assign
1285            (CL  : Node_Id;
1286             U_U : Boolean := False) return List_Id
1287          is
1288             CI : constant List_Id := Component_Items (CL);
1289             VP : constant Node_Id := Variant_Part (CL);
1290
1291             Alts   : List_Id;
1292             DC     : Node_Id;
1293             DCH    : List_Id;
1294             Expr   : Node_Id;
1295             Result : List_Id;
1296             V      : Node_Id;
1297
1298          begin
1299             Result := Make_Field_Assigns (CI);
1300
1301             if Present (VP) then
1302                V := First_Non_Pragma (Variants (VP));
1303                Alts := New_List;
1304                while Present (V) loop
1305                   DCH := New_List;
1306                   DC := First (Discrete_Choices (V));
1307                   while Present (DC) loop
1308                      Append_To (DCH, New_Copy_Tree (DC));
1309                      Next (DC);
1310                   end loop;
1311
1312                   Append_To (Alts,
1313                     Make_Case_Statement_Alternative (Loc,
1314                       Discrete_Choices => DCH,
1315                       Statements =>
1316                         Make_Component_List_Assign (Component_List (V))));
1317                   Next_Non_Pragma (V);
1318                end loop;
1319
1320                --  If we have an Unchecked_Union, use the value of the inferred
1321                --  discriminant of the variant part expression as the switch
1322                --  for the case statement. The case statement may later be
1323                --  folded.
1324
1325                if U_U then
1326                   Expr :=
1327                     New_Copy (Get_Discriminant_Value (
1328                       Entity (Name (VP)),
1329                       Etype (Rhs),
1330                       Discriminant_Constraint (Etype (Rhs))));
1331                else
1332                   Expr :=
1333                     Make_Selected_Component (Loc,
1334                       Prefix        => Duplicate_Subexpr (Rhs),
1335                       Selector_Name =>
1336                         Make_Identifier (Loc, Chars (Name (VP))));
1337                end if;
1338
1339                Append_To (Result,
1340                  Make_Case_Statement (Loc,
1341                    Expression => Expr,
1342                    Alternatives => Alts));
1343             end if;
1344
1345             return Result;
1346          end Make_Component_List_Assign;
1347
1348          -----------------------
1349          -- Make_Field_Assign --
1350          -----------------------
1351
1352          function Make_Field_Assign
1353            (C   : Entity_Id;
1354             U_U : Boolean := False) return Node_Id
1355          is
1356             A    : Node_Id;
1357             Expr : Node_Id;
1358
1359          begin
1360             --  In the case of an Unchecked_Union, use the discriminant
1361             --  constraint value as on the right hand side of the assignment.
1362
1363             if U_U then
1364                Expr :=
1365                  New_Copy (Get_Discriminant_Value (C,
1366                    Etype (Rhs),
1367                    Discriminant_Constraint (Etype (Rhs))));
1368             else
1369                Expr :=
1370                  Make_Selected_Component (Loc,
1371                    Prefix        => Duplicate_Subexpr (Rhs),
1372                    Selector_Name => New_Occurrence_Of (C, Loc));
1373             end if;
1374
1375             A :=
1376               Make_Assignment_Statement (Loc,
1377                 Name =>
1378                   Make_Selected_Component (Loc,
1379                     Prefix        => Duplicate_Subexpr (Lhs),
1380                     Selector_Name =>
1381                       New_Occurrence_Of (Find_Component (L_Typ, C), Loc)),
1382                 Expression => Expr);
1383
1384             --  Set Assignment_OK, so discriminants can be assigned
1385
1386             Set_Assignment_OK (Name (A), True);
1387
1388             if Componentwise_Assignment (N)
1389               and then Nkind (Name (A)) = N_Selected_Component
1390               and then Chars (Selector_Name (Name (A))) = Name_uParent
1391             then
1392                Set_Componentwise_Assignment (A);
1393             end if;
1394
1395             return A;
1396          end Make_Field_Assign;
1397
1398          ------------------------
1399          -- Make_Field_Assigns --
1400          ------------------------
1401
1402          function Make_Field_Assigns (CI : List_Id) return List_Id is
1403             Item   : Node_Id;
1404             Result : List_Id;
1405
1406          begin
1407             Item := First (CI);
1408             Result := New_List;
1409
1410             while Present (Item) loop
1411
1412                --  Look for components, but exclude _tag field assignment if
1413                --  the special Componentwise_Assignment flag is set.
1414
1415                if Nkind (Item) = N_Component_Declaration
1416                  and then not (Is_Tag (Defining_Identifier (Item))
1417                                  and then Componentwise_Assignment (N))
1418                then
1419                   Append_To
1420                     (Result, Make_Field_Assign (Defining_Identifier (Item)));
1421                end if;
1422
1423                Next (Item);
1424             end loop;
1425
1426             return Result;
1427          end Make_Field_Assigns;
1428
1429       --  Start of processing for Expand_Assign_Record
1430
1431       begin
1432          --  Note that we use the base types for this processing. This results
1433          --  in some extra work in the constrained case, but the change of
1434          --  representation case is so unusual that it is not worth the effort.
1435
1436          --  First copy the discriminants. This is done unconditionally. It
1437          --  is required in the unconstrained left side case, and also in the
1438          --  case where this assignment was constructed during the expansion
1439          --  of a type conversion (since initialization of discriminants is
1440          --  suppressed in this case). It is unnecessary but harmless in
1441          --  other cases.
1442
1443          if Has_Discriminants (L_Typ) then
1444             F := First_Discriminant (R_Typ);
1445             while Present (F) loop
1446
1447                --  If we are expanding the initialization of a derived record
1448                --  that constrains or renames discriminants of the parent, we
1449                --  must use the corresponding discriminant in the parent.
1450
1451                declare
1452                   CF : Entity_Id;
1453
1454                begin
1455                   if Inside_Init_Proc
1456                     and then Present (Corresponding_Discriminant (F))
1457                   then
1458                      CF := Corresponding_Discriminant (F);
1459                   else
1460                      CF := F;
1461                   end if;
1462
1463                   if Is_Unchecked_Union (Base_Type (R_Typ)) then
1464                      Insert_Action (N, Make_Field_Assign (CF, True));
1465                   else
1466                      Insert_Action (N, Make_Field_Assign (CF));
1467                   end if;
1468
1469                   Next_Discriminant (F);
1470                end;
1471             end loop;
1472          end if;
1473
1474          --  We know the underlying type is a record, but its current view
1475          --  may be private. We must retrieve the usable record declaration.
1476
1477          if Nkind_In (Decl, N_Private_Type_Declaration,
1478                             N_Private_Extension_Declaration)
1479            and then Present (Full_View (R_Typ))
1480          then
1481             RDef := Type_Definition (Declaration_Node (Full_View (R_Typ)));
1482          else
1483             RDef := Type_Definition (Decl);
1484          end if;
1485
1486          if Nkind (RDef) = N_Derived_Type_Definition then
1487             RDef := Record_Extension_Part (RDef);
1488          end if;
1489
1490          if Nkind (RDef) = N_Record_Definition
1491            and then Present (Component_List (RDef))
1492          then
1493             if Is_Unchecked_Union (R_Typ) then
1494                Insert_Actions (N,
1495                  Make_Component_List_Assign (Component_List (RDef), True));
1496             else
1497                Insert_Actions
1498                  (N, Make_Component_List_Assign (Component_List (RDef)));
1499             end if;
1500
1501             Rewrite (N, Make_Null_Statement (Loc));
1502          end if;
1503       end;
1504    end Expand_Assign_Record;
1505
1506    -----------------------------------
1507    -- Expand_N_Assignment_Statement --
1508    -----------------------------------
1509
1510    --  This procedure implements various cases where an assignment statement
1511    --  cannot just be passed on to the back end in untransformed state.
1512
1513    procedure Expand_N_Assignment_Statement (N : Node_Id) is
1514       Loc  : constant Source_Ptr := Sloc (N);
1515       Crep : constant Boolean    := Change_Of_Representation (N);
1516       Lhs  : constant Node_Id    := Name (N);
1517       Rhs  : constant Node_Id    := Expression (N);
1518       Typ  : constant Entity_Id  := Underlying_Type (Etype (Lhs));
1519       Exp  : Node_Id;
1520
1521    begin
1522       --  Special case to check right away, if the Componentwise_Assignment
1523       --  flag is set, this is a reanalysis from the expansion of the primitive
1524       --  assignment procedure for a tagged type, and all we need to do is to
1525       --  expand to assignment of components, because otherwise, we would get
1526       --  infinite recursion (since this looks like a tagged assignment which
1527       --  would normally try to *call* the primitive assignment procedure).
1528
1529       if Componentwise_Assignment (N) then
1530          Expand_Assign_Record (N);
1531          return;
1532       end if;
1533
1534       --  Defend against invalid subscripts on left side if we are in standard
1535       --  validity checking mode. No need to do this if we are checking all
1536       --  subscripts.
1537
1538       --  Note that we do this right away, because there are some early return
1539       --  paths in this procedure, and this is required on all paths.
1540
1541       if Validity_Checks_On
1542         and then Validity_Check_Default
1543         and then not Validity_Check_Subscripts
1544       then
1545          Check_Valid_Lvalue_Subscripts (Lhs);
1546       end if;
1547
1548       --  Ada 2005 (AI-327): Handle assignment to priority of protected object
1549
1550       --  Rewrite an assignment to X'Priority into a run-time call
1551
1552       --   For example:         X'Priority := New_Prio_Expr;
1553       --   ...is expanded into  Set_Ceiling (X._Object, New_Prio_Expr);
1554
1555       --  Note that although X'Priority is notionally an object, it is quite
1556       --  deliberately not defined as an aliased object in the RM. This means
1557       --  that it works fine to rewrite it as a call, without having to worry
1558       --  about complications that would other arise from X'Priority'Access,
1559       --  which is illegal, because of the lack of aliasing.
1560
1561       if Ada_Version >= Ada_2005 then
1562          declare
1563             Call           : Node_Id;
1564             Conctyp        : Entity_Id;
1565             Ent            : Entity_Id;
1566             Subprg         : Entity_Id;
1567             RT_Subprg_Name : Node_Id;
1568
1569          begin
1570             --  Handle chains of renamings
1571
1572             Ent := Name (N);
1573             while Nkind (Ent) in N_Has_Entity
1574               and then Present (Entity (Ent))
1575               and then Present (Renamed_Object (Entity (Ent)))
1576             loop
1577                Ent := Renamed_Object (Entity (Ent));
1578             end loop;
1579
1580             --  The attribute Priority applied to protected objects has been
1581             --  previously expanded into a call to the Get_Ceiling run-time
1582             --  subprogram.
1583
1584             if Nkind (Ent) = N_Function_Call
1585               and then (Entity (Name (Ent)) = RTE (RE_Get_Ceiling)
1586                           or else
1587                         Entity (Name (Ent)) = RTE (RO_PE_Get_Ceiling))
1588             then
1589                --  Look for the enclosing concurrent type
1590
1591                Conctyp := Current_Scope;
1592                while not Is_Concurrent_Type (Conctyp) loop
1593                   Conctyp := Scope (Conctyp);
1594                end loop;
1595
1596                pragma Assert (Is_Protected_Type (Conctyp));
1597
1598                --  Generate the first actual of the call
1599
1600                Subprg := Current_Scope;
1601                while not Present (Protected_Body_Subprogram (Subprg)) loop
1602                   Subprg := Scope (Subprg);
1603                end loop;
1604
1605                --  Select the appropriate run-time call
1606
1607                if Number_Entries (Conctyp) = 0 then
1608                   RT_Subprg_Name :=
1609                     New_Reference_To (RTE (RE_Set_Ceiling), Loc);
1610                else
1611                   RT_Subprg_Name :=
1612                     New_Reference_To (RTE (RO_PE_Set_Ceiling), Loc);
1613                end if;
1614
1615                Call :=
1616                  Make_Procedure_Call_Statement (Loc,
1617                    Name => RT_Subprg_Name,
1618                    Parameter_Associations => New_List (
1619                      New_Copy_Tree (First (Parameter_Associations (Ent))),
1620                      Relocate_Node (Expression (N))));
1621
1622                Rewrite (N, Call);
1623                Analyze (N);
1624                return;
1625             end if;
1626          end;
1627       end if;
1628
1629       --  Deal with assignment checks unless suppressed
1630
1631       if not Suppress_Assignment_Checks (N) then
1632
1633          --  First deal with generation of range check if required
1634
1635          if Do_Range_Check (Rhs) then
1636             Set_Do_Range_Check (Rhs, False);
1637             Generate_Range_Check (Rhs, Typ, CE_Range_Check_Failed);
1638          end if;
1639
1640          --  Then generate predicate check if required
1641
1642          Apply_Predicate_Check (Rhs, Typ);
1643       end if;
1644
1645       --  Check for a special case where a high level transformation is
1646       --  required. If we have either of:
1647
1648       --    P.field := rhs;
1649       --    P (sub) := rhs;
1650
1651       --  where P is a reference to a bit packed array, then we have to unwind
1652       --  the assignment. The exact meaning of being a reference to a bit
1653       --  packed array is as follows:
1654
1655       --    An indexed component whose prefix is a bit packed array is a
1656       --    reference to a bit packed array.
1657
1658       --    An indexed component or selected component whose prefix is a
1659       --    reference to a bit packed array is itself a reference ot a
1660       --    bit packed array.
1661
1662       --  The required transformation is
1663
1664       --     Tnn : prefix_type := P;
1665       --     Tnn.field := rhs;
1666       --     P := Tnn;
1667
1668       --  or
1669
1670       --     Tnn : prefix_type := P;
1671       --     Tnn (subscr) := rhs;
1672       --     P := Tnn;
1673
1674       --  Since P is going to be evaluated more than once, any subscripts
1675       --  in P must have their evaluation forced.
1676
1677       if Nkind_In (Lhs, N_Indexed_Component, N_Selected_Component)
1678         and then Is_Ref_To_Bit_Packed_Array (Prefix (Lhs))
1679       then
1680          declare
1681             BPAR_Expr : constant Node_Id   := Relocate_Node (Prefix (Lhs));
1682             BPAR_Typ  : constant Entity_Id := Etype (BPAR_Expr);
1683             Tnn       : constant Entity_Id :=
1684                           Make_Temporary (Loc, 'T', BPAR_Expr);
1685
1686          begin
1687             --  Insert the post assignment first, because we want to copy the
1688             --  BPAR_Expr tree before it gets analyzed in the context of the
1689             --  pre assignment. Note that we do not analyze the post assignment
1690             --  yet (we cannot till we have completed the analysis of the pre
1691             --  assignment). As usual, the analysis of this post assignment
1692             --  will happen on its own when we "run into" it after finishing
1693             --  the current assignment.
1694
1695             Insert_After (N,
1696               Make_Assignment_Statement (Loc,
1697                 Name       => New_Copy_Tree (BPAR_Expr),
1698                 Expression => New_Occurrence_Of (Tnn, Loc)));
1699
1700             --  At this stage BPAR_Expr is a reference to a bit packed array
1701             --  where the reference was not expanded in the original tree,
1702             --  since it was on the left side of an assignment. But in the
1703             --  pre-assignment statement (the object definition), BPAR_Expr
1704             --  will end up on the right hand side, and must be reexpanded. To
1705             --  achieve this, we reset the analyzed flag of all selected and
1706             --  indexed components down to the actual indexed component for
1707             --  the packed array.
1708
1709             Exp := BPAR_Expr;
1710             loop
1711                Set_Analyzed (Exp, False);
1712
1713                if Nkind_In
1714                    (Exp, N_Selected_Component, N_Indexed_Component)
1715                then
1716                   Exp := Prefix (Exp);
1717                else
1718                   exit;
1719                end if;
1720             end loop;
1721
1722             --  Now we can insert and analyze the pre-assignment
1723
1724             --  If the right-hand side requires a transient scope, it has
1725             --  already been placed on the stack. However, the declaration is
1726             --  inserted in the tree outside of this scope, and must reflect
1727             --  the proper scope for its variable. This awkward bit is forced
1728             --  by the stricter scope discipline imposed by GCC 2.97.
1729
1730             declare
1731                Uses_Transient_Scope : constant Boolean :=
1732                                         Scope_Is_Transient
1733                                           and then N = Node_To_Be_Wrapped;
1734
1735             begin
1736                if Uses_Transient_Scope then
1737                   Push_Scope (Scope (Current_Scope));
1738                end if;
1739
1740                Insert_Before_And_Analyze (N,
1741                  Make_Object_Declaration (Loc,
1742                    Defining_Identifier => Tnn,
1743                    Object_Definition   => New_Occurrence_Of (BPAR_Typ, Loc),
1744                    Expression          => BPAR_Expr));
1745
1746                if Uses_Transient_Scope then
1747                   Pop_Scope;
1748                end if;
1749             end;
1750
1751             --  Now fix up the original assignment and continue processing
1752
1753             Rewrite (Prefix (Lhs),
1754               New_Occurrence_Of (Tnn, Loc));
1755
1756             --  We do not need to reanalyze that assignment, and we do not need
1757             --  to worry about references to the temporary, but we do need to
1758             --  make sure that the temporary is not marked as a true constant
1759             --  since we now have a generated assignment to it!
1760
1761             Set_Is_True_Constant (Tnn, False);
1762          end;
1763       end if;
1764
1765       --  When we have the appropriate type of aggregate in the expression (it
1766       --  has been determined during analysis of the aggregate by setting the
1767       --  delay flag), let's perform in place assignment and thus avoid
1768       --  creating a temporary.
1769
1770       if Is_Delayed_Aggregate (Rhs) then
1771          Convert_Aggr_In_Assignment (N);
1772          Rewrite (N, Make_Null_Statement (Loc));
1773          Analyze (N);
1774          return;
1775       end if;
1776
1777       --  Apply discriminant check if required. If Lhs is an access type to a
1778       --  designated type with discriminants, we must always check.
1779
1780       if Has_Discriminants (Etype (Lhs)) then
1781
1782          --  Skip discriminant check if change of representation. Will be
1783          --  done when the change of representation is expanded out.
1784
1785          if not Crep then
1786             Apply_Discriminant_Check (Rhs, Etype (Lhs), Lhs);
1787          end if;
1788
1789       --  If the type is private without discriminants, and the full type
1790       --  has discriminants (necessarily with defaults) a check may still be
1791       --  necessary if the Lhs is aliased. The private determinants must be
1792       --  visible to build the discriminant constraints.
1793       --  What is a "determinant"???
1794
1795       --  Only an explicit dereference that comes from source indicates
1796       --  aliasing. Access to formals of protected operations and entries
1797       --  create dereferences but are not semantic aliasings.
1798
1799       elsif Is_Private_Type (Etype (Lhs))
1800         and then Has_Discriminants (Typ)
1801         and then Nkind (Lhs) = N_Explicit_Dereference
1802         and then Comes_From_Source (Lhs)
1803       then
1804          declare
1805             Lt : constant Entity_Id := Etype (Lhs);
1806          begin
1807             Set_Etype (Lhs, Typ);
1808             Rewrite (Rhs, OK_Convert_To (Base_Type (Typ), Rhs));
1809             Apply_Discriminant_Check (Rhs, Typ, Lhs);
1810             Set_Etype (Lhs, Lt);
1811          end;
1812
1813          --  If the Lhs has a private type with unknown discriminants, it
1814          --  may have a full view with discriminants, but those are nameable
1815          --  only in the underlying type, so convert the Rhs to it before
1816          --  potential checking.
1817
1818       elsif Has_Unknown_Discriminants (Base_Type (Etype (Lhs)))
1819         and then Has_Discriminants (Typ)
1820       then
1821          Rewrite (Rhs, OK_Convert_To (Base_Type (Typ), Rhs));
1822          Apply_Discriminant_Check (Rhs, Typ, Lhs);
1823
1824       --  In the access type case, we need the same discriminant check, and
1825       --  also range checks if we have an access to constrained array.
1826
1827       elsif Is_Access_Type (Etype (Lhs))
1828         and then Is_Constrained (Designated_Type (Etype (Lhs)))
1829       then
1830          if Has_Discriminants (Designated_Type (Etype (Lhs))) then
1831
1832             --  Skip discriminant check if change of representation. Will be
1833             --  done when the change of representation is expanded out.
1834
1835             if not Crep then
1836                Apply_Discriminant_Check (Rhs, Etype (Lhs));
1837             end if;
1838
1839          elsif Is_Array_Type (Designated_Type (Etype (Lhs))) then
1840             Apply_Range_Check (Rhs, Etype (Lhs));
1841
1842             if Is_Constrained (Etype (Lhs)) then
1843                Apply_Length_Check (Rhs, Etype (Lhs));
1844             end if;
1845
1846             if Nkind (Rhs) = N_Allocator then
1847                declare
1848                   Target_Typ : constant Entity_Id := Etype (Expression (Rhs));
1849                   C_Es       : Check_Result;
1850
1851                begin
1852                   C_Es :=
1853                     Get_Range_Checks
1854                       (Lhs,
1855                        Target_Typ,
1856                        Etype (Designated_Type (Etype (Lhs))));
1857
1858                   Insert_Range_Checks
1859                     (C_Es,
1860                      N,
1861                      Target_Typ,
1862                      Sloc (Lhs),
1863                      Lhs);
1864                end;
1865             end if;
1866          end if;
1867
1868       --  Apply range check for access type case
1869
1870       elsif Is_Access_Type (Etype (Lhs))
1871         and then Nkind (Rhs) = N_Allocator
1872         and then Nkind (Expression (Rhs)) = N_Qualified_Expression
1873       then
1874          Analyze_And_Resolve (Expression (Rhs));
1875          Apply_Range_Check
1876            (Expression (Rhs), Designated_Type (Etype (Lhs)));
1877       end if;
1878
1879       --  Ada 2005 (AI-231): Generate the run-time check
1880
1881       if Is_Access_Type (Typ)
1882         and then Can_Never_Be_Null (Etype (Lhs))
1883         and then not Can_Never_Be_Null (Etype (Rhs))
1884       then
1885          Apply_Constraint_Check (Rhs, Etype (Lhs));
1886       end if;
1887
1888       --  Ada 2012 (AI05-148): Update current accessibility level if Rhs is a
1889       --  stand-alone obj of an anonymous access type.
1890
1891       if Is_Access_Type (Typ)
1892         and then Is_Entity_Name (Lhs)
1893         and then Present (Effective_Extra_Accessibility (Entity (Lhs))) then
1894          declare
1895             function Lhs_Entity return Entity_Id;
1896             --  Look through renames to find the underlying entity.
1897             --  For assignment to a rename, we don't care about the
1898             --  Enclosing_Dynamic_Scope of the rename declaration.
1899
1900             ----------------
1901             -- Lhs_Entity --
1902             ----------------
1903
1904             function Lhs_Entity return Entity_Id is
1905                Result : Entity_Id := Entity (Lhs);
1906
1907             begin
1908                while Present (Renamed_Object (Result)) loop
1909
1910                   --  Renamed_Object must return an Entity_Name here
1911                   --  because of preceding "Present (E_E_A (...))" test.
1912
1913                   Result := Entity (Renamed_Object (Result));
1914                end loop;
1915
1916                return Result;
1917             end Lhs_Entity;
1918
1919             --  Local Declarations
1920
1921             Access_Check : constant Node_Id :=
1922                              Make_Raise_Program_Error (Loc,
1923                                Condition =>
1924                                  Make_Op_Gt (Loc,
1925                                    Left_Opnd  =>
1926                                      Dynamic_Accessibility_Level (Rhs),
1927                                    Right_Opnd =>
1928                                      Make_Integer_Literal (Loc,
1929                                        Intval =>
1930                                          Scope_Depth
1931                                            (Enclosing_Dynamic_Scope
1932                                              (Lhs_Entity)))),
1933                                Reason => PE_Accessibility_Check_Failed);
1934
1935             Access_Level_Update : constant Node_Id :=
1936                                     Make_Assignment_Statement (Loc,
1937                                      Name       =>
1938                                        New_Occurrence_Of
1939                                          (Effective_Extra_Accessibility
1940                                             (Entity (Lhs)), Loc),
1941                                      Expression =>
1942                                         Dynamic_Accessibility_Level (Rhs));
1943
1944          begin
1945             if not Accessibility_Checks_Suppressed (Entity (Lhs)) then
1946                Insert_Action (N, Access_Check);
1947             end if;
1948
1949             Insert_Action (N, Access_Level_Update);
1950          end;
1951       end if;
1952
1953       --  Case of assignment to a bit packed array element. If there is a
1954       --  change of representation this must be expanded into components,
1955       --  otherwise this is a bit-field assignment.
1956
1957       if Nkind (Lhs) = N_Indexed_Component
1958         and then Is_Bit_Packed_Array (Etype (Prefix (Lhs)))
1959       then
1960          --  Normal case, no change of representation
1961
1962          if not Crep then
1963             Expand_Bit_Packed_Element_Set (N);
1964             return;
1965
1966          --  Change of representation case
1967
1968          else
1969             --  Generate the following, to force component-by-component
1970             --  assignments in an efficient way. Otherwise each component
1971             --  will require a temporary and two bit-field manipulations.
1972
1973             --  T1 : Elmt_Type;
1974             --  T1 := RhS;
1975             --  Lhs := T1;
1976
1977             declare
1978                Tnn : constant Entity_Id := Make_Temporary (Loc, 'T');
1979                Stats : List_Id;
1980
1981             begin
1982                Stats :=
1983                  New_List (
1984                    Make_Object_Declaration (Loc,
1985                      Defining_Identifier => Tnn,
1986                      Object_Definition   =>
1987                        New_Occurrence_Of (Etype (Lhs), Loc)),
1988                    Make_Assignment_Statement (Loc,
1989                      Name       => New_Occurrence_Of (Tnn, Loc),
1990                      Expression => Relocate_Node (Rhs)),
1991                    Make_Assignment_Statement (Loc,
1992                      Name       => Relocate_Node (Lhs),
1993                      Expression => New_Occurrence_Of (Tnn, Loc)));
1994
1995                Insert_Actions (N, Stats);
1996                Rewrite (N, Make_Null_Statement (Loc));
1997                Analyze (N);
1998             end;
1999          end if;
2000
2001       --  Build-in-place function call case. Note that we're not yet doing
2002       --  build-in-place for user-written assignment statements (the assignment
2003       --  here came from an aggregate.)
2004
2005       elsif Ada_Version >= Ada_2005
2006         and then Is_Build_In_Place_Function_Call (Rhs)
2007       then
2008          Make_Build_In_Place_Call_In_Assignment (N, Rhs);
2009
2010       elsif Is_Tagged_Type (Typ) and then Is_Value_Type (Etype (Lhs)) then
2011
2012          --  Nothing to do for valuetypes
2013          --  ??? Set_Scope_Is_Transient (False);
2014
2015          return;
2016
2017       elsif Is_Tagged_Type (Typ)
2018         or else (Needs_Finalization (Typ) and then not Is_Array_Type (Typ))
2019       then
2020          Tagged_Case : declare
2021             L                   : List_Id := No_List;
2022             Expand_Ctrl_Actions : constant Boolean := not No_Ctrl_Actions (N);
2023
2024          begin
2025             --  In the controlled case, we ensure that function calls are
2026             --  evaluated before finalizing the target. In all cases, it makes
2027             --  the expansion easier if the side-effects are removed first.
2028
2029             Remove_Side_Effects (Lhs);
2030             Remove_Side_Effects (Rhs);
2031
2032             --  Avoid recursion in the mechanism
2033
2034             Set_Analyzed (N);
2035
2036             --  If dispatching assignment, we need to dispatch to _assign
2037
2038             if Is_Class_Wide_Type (Typ)
2039
2040                --  If the type is tagged, we may as well use the predefined
2041                --  primitive assignment. This avoids inlining a lot of code
2042                --  and in the class-wide case, the assignment is replaced
2043                --  by a dispatching call to _assign. It is suppressed in the
2044                --  case of assignments created by the expander that correspond
2045                --  to initializations, where we do want to copy the tag
2046                --  (Expand_Ctrl_Actions flag is set True in this case). It is
2047                --  also suppressed if restriction No_Dispatching_Calls is in
2048                --  force because in that case predefined primitives are not
2049                --  generated.
2050
2051                or else (Is_Tagged_Type (Typ)
2052                          and then not Is_Value_Type (Etype (Lhs))
2053                          and then Chars (Current_Scope) /= Name_uAssign
2054                          and then Expand_Ctrl_Actions
2055                          and then
2056                            not Restriction_Active (No_Dispatching_Calls))
2057             then
2058                --  Fetch the primitive op _assign and proper type to call it.
2059                --  Because of possible conflicts between private and full view,
2060                --  fetch the proper type directly from the operation profile.
2061
2062                declare
2063                   Op    : constant Entity_Id :=
2064                             Find_Prim_Op (Typ, Name_uAssign);
2065                   F_Typ : Entity_Id := Etype (First_Formal (Op));
2066
2067                begin
2068                   --  If the assignment is dispatching, make sure to use the
2069                   --  proper type.
2070
2071                   if Is_Class_Wide_Type (Typ) then
2072                      F_Typ := Class_Wide_Type (F_Typ);
2073                   end if;
2074
2075                   L := New_List;
2076
2077                   --  In case of assignment to a class-wide tagged type, before
2078                   --  the assignment we generate run-time check to ensure that
2079                   --  the tags of source and target match.
2080
2081                   if Is_Class_Wide_Type (Typ)
2082                     and then Is_Tagged_Type (Typ)
2083                     and then Is_Tagged_Type (Underlying_Type (Etype (Rhs)))
2084                   then
2085                      Append_To (L,
2086                        Make_Raise_Constraint_Error (Loc,
2087                          Condition =>
2088                            Make_Op_Ne (Loc,
2089                              Left_Opnd =>
2090                                Make_Selected_Component (Loc,
2091                                  Prefix        => Duplicate_Subexpr (Lhs),
2092                                  Selector_Name =>
2093                                    Make_Identifier (Loc, Name_uTag)),
2094                              Right_Opnd =>
2095                                Make_Selected_Component (Loc,
2096                                  Prefix        => Duplicate_Subexpr (Rhs),
2097                                  Selector_Name =>
2098                                    Make_Identifier (Loc, Name_uTag))),
2099                          Reason => CE_Tag_Check_Failed));
2100                   end if;
2101
2102                   declare
2103                      Left_N  : Node_Id := Duplicate_Subexpr (Lhs);
2104                      Right_N : Node_Id := Duplicate_Subexpr (Rhs);
2105
2106                   begin
2107                      --  In order to dispatch the call to _assign the type of
2108                      --  the actuals must match. Add conversion (if required).
2109
2110                      if Etype (Lhs) /= F_Typ then
2111                         Left_N := Unchecked_Convert_To (F_Typ, Left_N);
2112                      end if;
2113
2114                      if Etype (Rhs) /= F_Typ then
2115                         Right_N := Unchecked_Convert_To (F_Typ, Right_N);
2116                      end if;
2117
2118                      Append_To (L,
2119                        Make_Procedure_Call_Statement (Loc,
2120                          Name => New_Reference_To (Op, Loc),
2121                          Parameter_Associations => New_List (
2122                            Node1 => Left_N,
2123                            Node2 => Right_N)));
2124                   end;
2125                end;
2126
2127             else
2128                L := Make_Tag_Ctrl_Assignment (N);
2129
2130                --  We can't afford to have destructive Finalization Actions in
2131                --  the Self assignment case, so if the target and the source
2132                --  are not obviously different, code is generated to avoid the
2133                --  self assignment case:
2134
2135                --    if lhs'address /= rhs'address then
2136                --       <code for controlled and/or tagged assignment>
2137                --    end if;
2138
2139                --  Skip this if Restriction (No_Finalization) is active
2140
2141                if not Statically_Different (Lhs, Rhs)
2142                  and then Expand_Ctrl_Actions
2143                  and then not Restriction_Active (No_Finalization)
2144                then
2145                   L := New_List (
2146                     Make_Implicit_If_Statement (N,
2147                       Condition =>
2148                         Make_Op_Ne (Loc,
2149                           Left_Opnd =>
2150                             Make_Attribute_Reference (Loc,
2151                               Prefix         => Duplicate_Subexpr (Lhs),
2152                               Attribute_Name => Name_Address),
2153
2154                            Right_Opnd =>
2155                             Make_Attribute_Reference (Loc,
2156                               Prefix         => Duplicate_Subexpr (Rhs),
2157                               Attribute_Name => Name_Address)),
2158
2159                       Then_Statements => L));
2160                end if;
2161
2162                --  We need to set up an exception handler for implementing
2163                --  7.6.1(18). The remaining adjustments are tackled by the
2164                --  implementation of adjust for record_controllers (see
2165                --  s-finimp.adb).
2166
2167                --  This is skipped if we have no finalization
2168
2169                if Expand_Ctrl_Actions
2170                  and then not Restriction_Active (No_Finalization)
2171                then
2172                   L := New_List (
2173                     Make_Block_Statement (Loc,
2174                       Handled_Statement_Sequence =>
2175                         Make_Handled_Sequence_Of_Statements (Loc,
2176                           Statements => L,
2177                           Exception_Handlers => New_List (
2178                             Make_Handler_For_Ctrl_Operation (Loc)))));
2179                end if;
2180             end if;
2181
2182             Rewrite (N,
2183               Make_Block_Statement (Loc,
2184                 Handled_Statement_Sequence =>
2185                   Make_Handled_Sequence_Of_Statements (Loc, Statements => L)));
2186
2187             --  If no restrictions on aborts, protect the whole assignment
2188             --  for controlled objects as per 9.8(11).
2189
2190             if Needs_Finalization (Typ)
2191               and then Expand_Ctrl_Actions
2192               and then Abort_Allowed
2193             then
2194                declare
2195                   Blk : constant Entity_Id :=
2196                           New_Internal_Entity
2197                             (E_Block, Current_Scope, Sloc (N), 'B');
2198
2199                begin
2200                   Set_Scope (Blk, Current_Scope);
2201                   Set_Etype (Blk, Standard_Void_Type);
2202                   Set_Identifier (N, New_Occurrence_Of (Blk, Sloc (N)));
2203
2204                   Prepend_To (L, Build_Runtime_Call (Loc, RE_Abort_Defer));
2205                   Set_At_End_Proc (Handled_Statement_Sequence (N),
2206                     New_Occurrence_Of (RTE (RE_Abort_Undefer_Direct), Loc));
2207                   Expand_At_End_Handler
2208                     (Handled_Statement_Sequence (N), Blk);
2209                end;
2210             end if;
2211
2212             --  N has been rewritten to a block statement for which it is
2213             --  known by construction that no checks are necessary: analyze
2214             --  it with all checks suppressed.
2215
2216             Analyze (N, Suppress => All_Checks);
2217             return;
2218          end Tagged_Case;
2219
2220       --  Array types
2221
2222       elsif Is_Array_Type (Typ) then
2223          declare
2224             Actual_Rhs : Node_Id := Rhs;
2225
2226          begin
2227             while Nkind_In (Actual_Rhs, N_Type_Conversion,
2228                                         N_Qualified_Expression)
2229             loop
2230                Actual_Rhs := Expression (Actual_Rhs);
2231             end loop;
2232
2233             Expand_Assign_Array (N, Actual_Rhs);
2234             return;
2235          end;
2236
2237       --  Record types
2238
2239       elsif Is_Record_Type (Typ) then
2240          Expand_Assign_Record (N);
2241          return;
2242
2243       --  Scalar types. This is where we perform the processing related to the
2244       --  requirements of (RM 13.9.1(9-11)) concerning the handling of invalid
2245       --  scalar values.
2246
2247       elsif Is_Scalar_Type (Typ) then
2248
2249          --  Case where right side is known valid
2250
2251          if Expr_Known_Valid (Rhs) then
2252
2253             --  Here the right side is valid, so it is fine. The case to deal
2254             --  with is when the left side is a local variable reference whose
2255             --  value is not currently known to be valid. If this is the case,
2256             --  and the assignment appears in an unconditional context, then
2257             --  we can mark the left side as now being valid if one of these
2258             --  conditions holds:
2259
2260             --    The expression of the right side has Do_Range_Check set so
2261             --    that we know a range check will be performed. Note that it
2262             --    can be the case that a range check is omitted because we
2263             --    make the assumption that we can assume validity for operands
2264             --    appearing in the right side in determining whether a range
2265             --    check is required
2266
2267             --    The subtype of the right side matches the subtype of the
2268             --    left side. In this case, even though we have not checked
2269             --    the range of the right side, we know it is in range of its
2270             --    subtype if the expression is valid.
2271
2272             if Is_Local_Variable_Reference (Lhs)
2273               and then not Is_Known_Valid (Entity (Lhs))
2274               and then In_Unconditional_Context (N)
2275             then
2276                if Do_Range_Check (Rhs)
2277                  or else Etype (Lhs) = Etype (Rhs)
2278                then
2279                   Set_Is_Known_Valid (Entity (Lhs), True);
2280                end if;
2281             end if;
2282
2283          --  Case where right side may be invalid in the sense of the RM
2284          --  reference above. The RM does not require that we check for the
2285          --  validity on an assignment, but it does require that the assignment
2286          --  of an invalid value not cause erroneous behavior.
2287
2288          --  The general approach in GNAT is to use the Is_Known_Valid flag
2289          --  to avoid the need for validity checking on assignments. However
2290          --  in some cases, we have to do validity checking in order to make
2291          --  sure that the setting of this flag is correct.
2292
2293          else
2294             --  Validate right side if we are validating copies
2295
2296             if Validity_Checks_On
2297               and then Validity_Check_Copies
2298             then
2299                --  Skip this if left hand side is an array or record component
2300                --  and elementary component validity checks are suppressed.
2301
2302                if Nkind_In (Lhs, N_Selected_Component, N_Indexed_Component)
2303                  and then not Validity_Check_Components
2304                then
2305                   null;
2306                else
2307                   Ensure_Valid (Rhs);
2308                end if;
2309
2310                --  We can propagate this to the left side where appropriate
2311
2312                if Is_Local_Variable_Reference (Lhs)
2313                  and then not Is_Known_Valid (Entity (Lhs))
2314                  and then In_Unconditional_Context (N)
2315                then
2316                   Set_Is_Known_Valid (Entity (Lhs), True);
2317                end if;
2318
2319             --  Otherwise check to see what should be done
2320
2321             --  If left side is a local variable, then we just set its flag to
2322             --  indicate that its value may no longer be valid, since we are
2323             --  copying a potentially invalid value.
2324
2325             elsif Is_Local_Variable_Reference (Lhs) then
2326                Set_Is_Known_Valid (Entity (Lhs), False);
2327
2328             --  Check for case of a nonlocal variable on the left side which
2329             --  is currently known to be valid. In this case, we simply ensure
2330             --  that the right side is valid. We only play the game of copying
2331             --  validity status for local variables, since we are doing this
2332             --  statically, not by tracing the full flow graph.
2333
2334             elsif Is_Entity_Name (Lhs)
2335               and then Is_Known_Valid (Entity (Lhs))
2336             then
2337                --  Note: If Validity_Checking mode is set to none, we ignore
2338                --  the Ensure_Valid call so don't worry about that case here.
2339
2340                Ensure_Valid (Rhs);
2341
2342             --  In all other cases, we can safely copy an invalid value without
2343             --  worrying about the status of the left side. Since it is not a
2344             --  variable reference it will not be considered
2345             --  as being known to be valid in any case.
2346
2347             else
2348                null;
2349             end if;
2350          end if;
2351       end if;
2352
2353    exception
2354       when RE_Not_Available =>
2355          return;
2356    end Expand_N_Assignment_Statement;
2357
2358    ------------------------------
2359    -- Expand_N_Block_Statement --
2360    ------------------------------
2361
2362    --  Encode entity names defined in block statement
2363
2364    procedure Expand_N_Block_Statement (N : Node_Id) is
2365    begin
2366       Qualify_Entity_Names (N);
2367    end Expand_N_Block_Statement;
2368
2369    -----------------------------
2370    -- Expand_N_Case_Statement --
2371    -----------------------------
2372
2373    procedure Expand_N_Case_Statement (N : Node_Id) is
2374       Loc    : constant Source_Ptr := Sloc (N);
2375       Expr   : constant Node_Id    := Expression (N);
2376       Alt    : Node_Id;
2377       Len    : Nat;
2378       Cond   : Node_Id;
2379       Choice : Node_Id;
2380       Chlist : List_Id;
2381
2382    begin
2383       --  Check for the situation where we know at compile time which branch
2384       --  will be taken
2385
2386       if Compile_Time_Known_Value (Expr) then
2387          Alt := Find_Static_Alternative (N);
2388
2389          Process_Statements_For_Controlled_Objects (Alt);
2390
2391          --  Move statements from this alternative after the case statement.
2392          --  They are already analyzed, so will be skipped by the analyzer.
2393
2394          Insert_List_After (N, Statements (Alt));
2395
2396          --  That leaves the case statement as a shell. So now we can kill all
2397          --  other alternatives in the case statement.
2398
2399          Kill_Dead_Code (Expression (N));
2400
2401          declare
2402             Dead_Alt : Node_Id;
2403
2404          begin
2405             --  Loop through case alternatives, skipping pragmas, and skipping
2406             --  the one alternative that we select (and therefore retain).
2407
2408             Dead_Alt := First (Alternatives (N));
2409             while Present (Dead_Alt) loop
2410                if Dead_Alt /= Alt
2411                  and then Nkind (Dead_Alt) = N_Case_Statement_Alternative
2412                then
2413                   Kill_Dead_Code (Statements (Dead_Alt), Warn_On_Deleted_Code);
2414                end if;
2415
2416                Next (Dead_Alt);
2417             end loop;
2418          end;
2419
2420          Rewrite (N, Make_Null_Statement (Loc));
2421          return;
2422       end if;
2423
2424       --  Here if the choice is not determined at compile time
2425
2426       declare
2427          Last_Alt : constant Node_Id := Last (Alternatives (N));
2428
2429          Others_Present : Boolean;
2430          Others_Node    : Node_Id;
2431
2432          Then_Stms : List_Id;
2433          Else_Stms : List_Id;
2434
2435       begin
2436          if Nkind (First (Discrete_Choices (Last_Alt))) = N_Others_Choice then
2437             Others_Present := True;
2438             Others_Node    := Last_Alt;
2439          else
2440             Others_Present := False;
2441          end if;
2442
2443          --  First step is to worry about possible invalid argument. The RM
2444          --  requires (RM 5.4(13)) that if the result is invalid (e.g. it is
2445          --  outside the base range), then Constraint_Error must be raised.
2446
2447          --  Case of validity check required (validity checks are on, the
2448          --  expression is not known to be valid, and the case statement
2449          --  comes from source -- no need to validity check internally
2450          --  generated case statements).
2451
2452          if Validity_Check_Default then
2453             Ensure_Valid (Expr);
2454          end if;
2455
2456          --  If there is only a single alternative, just replace it with the
2457          --  sequence of statements since obviously that is what is going to
2458          --  be executed in all cases.
2459
2460          Len := List_Length (Alternatives (N));
2461
2462          if Len = 1 then
2463
2464             --  We still need to evaluate the expression if it has any side
2465             --  effects.
2466
2467             Remove_Side_Effects (Expression (N));
2468
2469             Alt := First (Alternatives (N));
2470
2471             Process_Statements_For_Controlled_Objects (Alt);
2472             Insert_List_After (N, Statements (Alt));
2473
2474             --  That leaves the case statement as a shell. The alternative that
2475             --  will be executed is reset to a null list. So now we can kill
2476             --  the entire case statement.
2477
2478             Kill_Dead_Code (Expression (N));
2479             Rewrite (N, Make_Null_Statement (Loc));
2480             return;
2481
2482          --  An optimization. If there are only two alternatives, and only
2483          --  a single choice, then rewrite the whole case statement as an
2484          --  if statement, since this can result in subsequent optimizations.
2485          --  This helps not only with case statements in the source of a
2486          --  simple form, but also with generated code (discriminant check
2487          --  functions in particular)
2488
2489          elsif Len = 2 then
2490             Chlist := Discrete_Choices (First (Alternatives (N)));
2491
2492             if List_Length (Chlist) = 1 then
2493                Choice := First (Chlist);
2494
2495                Then_Stms := Statements (First (Alternatives (N)));
2496                Else_Stms := Statements (Last  (Alternatives (N)));
2497
2498                --  For TRUE, generate "expression", not expression = true
2499
2500                if Nkind (Choice) = N_Identifier
2501                  and then Entity (Choice) = Standard_True
2502                then
2503                   Cond := Expression (N);
2504
2505                --  For FALSE, generate "expression" and switch then/else
2506
2507                elsif Nkind (Choice) = N_Identifier
2508                  and then Entity (Choice) = Standard_False
2509                then
2510                   Cond := Expression (N);
2511                   Else_Stms := Statements (First (Alternatives (N)));
2512                   Then_Stms := Statements (Last  (Alternatives (N)));
2513
2514                --  For a range, generate "expression in range"
2515
2516                elsif Nkind (Choice) = N_Range
2517                  or else (Nkind (Choice) = N_Attribute_Reference
2518                            and then Attribute_Name (Choice) = Name_Range)
2519                  or else (Is_Entity_Name (Choice)
2520                            and then Is_Type (Entity (Choice)))
2521                  or else Nkind (Choice) = N_Subtype_Indication
2522                then
2523                   Cond :=
2524                     Make_In (Loc,
2525                       Left_Opnd  => Expression (N),
2526                       Right_Opnd => Relocate_Node (Choice));
2527
2528                --  For any other subexpression "expression = value"
2529
2530                else
2531                   Cond :=
2532                     Make_Op_Eq (Loc,
2533                       Left_Opnd  => Expression (N),
2534                       Right_Opnd => Relocate_Node (Choice));
2535                end if;
2536
2537                --  Now rewrite the case as an IF
2538
2539                Rewrite (N,
2540                  Make_If_Statement (Loc,
2541                    Condition => Cond,
2542                    Then_Statements => Then_Stms,
2543                    Else_Statements => Else_Stms));
2544                Analyze (N);
2545                return;
2546             end if;
2547          end if;
2548
2549          --  If the last alternative is not an Others choice, replace it with
2550          --  an N_Others_Choice. Note that we do not bother to call Analyze on
2551          --  the modified case statement, since it's only effect would be to
2552          --  compute the contents of the Others_Discrete_Choices which is not
2553          --  needed by the back end anyway.
2554
2555          --  The reason we do this is that the back end always needs some
2556          --  default for a switch, so if we have not supplied one in the
2557          --  processing above for validity checking, then we need to supply
2558          --  one here.
2559
2560          if not Others_Present then
2561             Others_Node := Make_Others_Choice (Sloc (Last_Alt));
2562             Set_Others_Discrete_Choices
2563               (Others_Node, Discrete_Choices (Last_Alt));
2564             Set_Discrete_Choices (Last_Alt, New_List (Others_Node));
2565          end if;
2566
2567          Alt := First (Alternatives (N));
2568          while Present (Alt)
2569            and then Nkind (Alt) = N_Case_Statement_Alternative
2570          loop
2571             Process_Statements_For_Controlled_Objects (Alt);
2572             Next (Alt);
2573          end loop;
2574       end;
2575    end Expand_N_Case_Statement;
2576
2577    -----------------------------
2578    -- Expand_N_Exit_Statement --
2579    -----------------------------
2580
2581    --  The only processing required is to deal with a possible C/Fortran
2582    --  boolean value used as the condition for the exit statement.
2583
2584    procedure Expand_N_Exit_Statement (N : Node_Id) is
2585    begin
2586       Adjust_Condition (Condition (N));
2587    end Expand_N_Exit_Statement;
2588
2589    -----------------------------
2590    -- Expand_N_Goto_Statement --
2591    -----------------------------
2592
2593    --  Add poll before goto if polling active
2594
2595    procedure Expand_N_Goto_Statement (N : Node_Id) is
2596    begin
2597       Generate_Poll_Call (N);
2598    end Expand_N_Goto_Statement;
2599
2600    ---------------------------
2601    -- Expand_N_If_Statement --
2602    ---------------------------
2603
2604    --  First we deal with the case of C and Fortran convention boolean values,
2605    --  with zero/non-zero semantics.
2606
2607    --  Second, we deal with the obvious rewriting for the cases where the
2608    --  condition of the IF is known at compile time to be True or False.
2609
2610    --  Third, we remove elsif parts which have non-empty Condition_Actions and
2611    --  rewrite as independent if statements. For example:
2612
2613    --     if x then xs
2614    --     elsif y then ys
2615    --     ...
2616    --     end if;
2617
2618    --  becomes
2619    --
2620    --     if x then xs
2621    --     else
2622    --        <<condition actions of y>>
2623    --        if y then ys
2624    --        ...
2625    --        end if;
2626    --     end if;
2627
2628    --  This rewriting is needed if at least one elsif part has a non-empty
2629    --  Condition_Actions list. We also do the same processing if there is a
2630    --  constant condition in an elsif part (in conjunction with the first
2631    --  processing step mentioned above, for the recursive call made to deal
2632    --  with the created inner if, this deals with properly optimizing the
2633    --  cases of constant elsif conditions).
2634
2635    procedure Expand_N_If_Statement (N : Node_Id) is
2636       Loc    : constant Source_Ptr := Sloc (N);
2637       Hed    : Node_Id;
2638       E      : Node_Id;
2639       New_If : Node_Id;
2640
2641       Warn_If_Deleted : constant Boolean :=
2642                           Warn_On_Deleted_Code and then Comes_From_Source (N);
2643       --  Indicates whether we want warnings when we delete branches of the
2644       --  if statement based on constant condition analysis. We never want
2645       --  these warnings for expander generated code.
2646
2647    begin
2648       Process_Statements_For_Controlled_Objects (N);
2649
2650       Adjust_Condition (Condition (N));
2651
2652       --  The following loop deals with constant conditions for the IF. We
2653       --  need a loop because as we eliminate False conditions, we grab the
2654       --  first elsif condition and use it as the primary condition.
2655
2656       while Compile_Time_Known_Value (Condition (N)) loop
2657
2658          --  If condition is True, we can simply rewrite the if statement now
2659          --  by replacing it by the series of then statements.
2660
2661          if Is_True (Expr_Value (Condition (N))) then
2662
2663             --  All the else parts can be killed
2664
2665             Kill_Dead_Code (Elsif_Parts (N), Warn_If_Deleted);
2666             Kill_Dead_Code (Else_Statements (N), Warn_If_Deleted);
2667
2668             Hed := Remove_Head (Then_Statements (N));
2669             Insert_List_After (N, Then_Statements (N));
2670             Rewrite (N, Hed);
2671             return;
2672
2673          --  If condition is False, then we can delete the condition and
2674          --  the Then statements
2675
2676          else
2677             --  We do not delete the condition if constant condition warnings
2678             --  are enabled, since otherwise we end up deleting the desired
2679             --  warning. Of course the backend will get rid of this True/False
2680             --  test anyway, so nothing is lost here.
2681
2682             if not Constant_Condition_Warnings then
2683                Kill_Dead_Code (Condition (N));
2684             end if;
2685
2686             Kill_Dead_Code (Then_Statements (N), Warn_If_Deleted);
2687
2688             --  If there are no elsif statements, then we simply replace the
2689             --  entire if statement by the sequence of else statements.
2690
2691             if No (Elsif_Parts (N)) then
2692                if No (Else_Statements (N))
2693                  or else Is_Empty_List (Else_Statements (N))
2694                then
2695                   Rewrite (N,
2696                     Make_Null_Statement (Sloc (N)));
2697                else
2698                   Hed := Remove_Head (Else_Statements (N));
2699                   Insert_List_After (N, Else_Statements (N));
2700                   Rewrite (N, Hed);
2701                end if;
2702
2703                return;
2704
2705             --  If there are elsif statements, the first of them becomes the
2706             --  if/then section of the rebuilt if statement This is the case
2707             --  where we loop to reprocess this copied condition.
2708
2709             else
2710                Hed := Remove_Head (Elsif_Parts (N));
2711                Insert_Actions      (N, Condition_Actions (Hed));
2712                Set_Condition       (N, Condition (Hed));
2713                Set_Then_Statements (N, Then_Statements (Hed));
2714
2715                --  Hed might have been captured as the condition determining
2716                --  the current value for an entity. Now it is detached from
2717                --  the tree, so a Current_Value pointer in the condition might
2718                --  need to be updated.
2719
2720                Set_Current_Value_Condition (N);
2721
2722                if Is_Empty_List (Elsif_Parts (N)) then
2723                   Set_Elsif_Parts (N, No_List);
2724                end if;
2725             end if;
2726          end if;
2727       end loop;
2728
2729       --  Loop through elsif parts, dealing with constant conditions and
2730       --  possible expression actions that are present.
2731
2732       if Present (Elsif_Parts (N)) then
2733          E := First (Elsif_Parts (N));
2734          while Present (E) loop
2735             Process_Statements_For_Controlled_Objects (E);
2736
2737             Adjust_Condition (Condition (E));
2738
2739             --  If there are condition actions, then rewrite the if statement
2740             --  as indicated above. We also do the same rewrite for a True or
2741             --  False condition. The further processing of this constant
2742             --  condition is then done by the recursive call to expand the
2743             --  newly created if statement
2744
2745             if Present (Condition_Actions (E))
2746               or else Compile_Time_Known_Value (Condition (E))
2747             then
2748                --  Note this is not an implicit if statement, since it is part
2749                --  of an explicit if statement in the source (or of an implicit
2750                --  if statement that has already been tested).
2751
2752                New_If :=
2753                  Make_If_Statement (Sloc (E),
2754                    Condition       => Condition (E),
2755                    Then_Statements => Then_Statements (E),
2756                    Elsif_Parts     => No_List,
2757                    Else_Statements => Else_Statements (N));
2758
2759                --  Elsif parts for new if come from remaining elsif's of parent
2760
2761                while Present (Next (E)) loop
2762                   if No (Elsif_Parts (New_If)) then
2763                      Set_Elsif_Parts (New_If, New_List);
2764                   end if;
2765
2766                   Append (Remove_Next (E), Elsif_Parts (New_If));
2767                end loop;
2768
2769                Set_Else_Statements (N, New_List (New_If));
2770
2771                if Present (Condition_Actions (E)) then
2772                   Insert_List_Before (New_If, Condition_Actions (E));
2773                end if;
2774
2775                Remove (E);
2776
2777                if Is_Empty_List (Elsif_Parts (N)) then
2778                   Set_Elsif_Parts (N, No_List);
2779                end if;
2780
2781                Analyze (New_If);
2782                return;
2783
2784             --  No special processing for that elsif part, move to next
2785
2786             else
2787                Next (E);
2788             end if;
2789          end loop;
2790       end if;
2791
2792       --  Some more optimizations applicable if we still have an IF statement
2793
2794       if Nkind (N) /= N_If_Statement then
2795          return;
2796       end if;
2797
2798       --  Another optimization, special cases that can be simplified
2799
2800       --     if expression then
2801       --        return true;
2802       --     else
2803       --        return false;
2804       --     end if;
2805
2806       --  can be changed to:
2807
2808       --     return expression;
2809
2810       --  and
2811
2812       --     if expression then
2813       --        return false;
2814       --     else
2815       --        return true;
2816       --     end if;
2817
2818       --  can be changed to:
2819
2820       --     return not (expression);
2821
2822       --  Only do these optimizations if we are at least at -O1 level and
2823       --  do not do them if control flow optimizations are suppressed.
2824
2825       if Optimization_Level > 0
2826         and then not Opt.Suppress_Control_Flow_Optimizations
2827       then
2828          if Nkind (N) = N_If_Statement
2829            and then No (Elsif_Parts (N))
2830            and then Present (Else_Statements (N))
2831            and then List_Length (Then_Statements (N)) = 1
2832            and then List_Length (Else_Statements (N)) = 1
2833          then
2834             declare
2835                Then_Stm : constant Node_Id := First (Then_Statements (N));
2836                Else_Stm : constant Node_Id := First (Else_Statements (N));
2837
2838             begin
2839                if Nkind (Then_Stm) = N_Simple_Return_Statement
2840                     and then
2841                   Nkind (Else_Stm) = N_Simple_Return_Statement
2842                then
2843                   declare
2844                      Then_Expr : constant Node_Id := Expression (Then_Stm);
2845                      Else_Expr : constant Node_Id := Expression (Else_Stm);
2846
2847                   begin
2848                      if Nkind (Then_Expr) = N_Identifier
2849                           and then
2850                         Nkind (Else_Expr) = N_Identifier
2851                      then
2852                         if Entity (Then_Expr) = Standard_True
2853                           and then Entity (Else_Expr) = Standard_False
2854                         then
2855                            Rewrite (N,
2856                              Make_Simple_Return_Statement (Loc,
2857                                Expression => Relocate_Node (Condition (N))));
2858                            Analyze (N);
2859                            return;
2860
2861                         elsif Entity (Then_Expr) = Standard_False
2862                           and then Entity (Else_Expr) = Standard_True
2863                         then
2864                            Rewrite (N,
2865                              Make_Simple_Return_Statement (Loc,
2866                                Expression =>
2867                                  Make_Op_Not (Loc,
2868                                    Right_Opnd =>
2869                                      Relocate_Node (Condition (N)))));
2870                            Analyze (N);
2871                            return;
2872                         end if;
2873                      end if;
2874                   end;
2875                end if;
2876             end;
2877          end if;
2878       end if;
2879    end Expand_N_If_Statement;
2880
2881    --------------------------
2882    -- Expand_Iterator_Loop --
2883    --------------------------
2884
2885    procedure Expand_Iterator_Loop (N : Node_Id) is
2886       Isc    : constant Node_Id    := Iteration_Scheme (N);
2887       I_Spec : constant Node_Id    := Iterator_Specification (Isc);
2888       Id     : constant Entity_Id  := Defining_Identifier (I_Spec);
2889       Loc    : constant Source_Ptr := Sloc (N);
2890
2891       Container     : constant Node_Id   := Name (I_Spec);
2892       Container_Typ : constant Entity_Id := Etype (Container);
2893       Cursor        : Entity_Id;
2894       Iterator      : Entity_Id;
2895       New_Loop      : Node_Id;
2896       Stats         : List_Id := Statements (N);
2897
2898    begin
2899       --  Processing for arrays
2900
2901       if Is_Array_Type (Container_Typ) then
2902
2903          --  for Element of Array loop
2904          --
2905          --  This case requires an internally generated cursor to iterate over
2906          --  the array.
2907
2908          if Of_Present (I_Spec) then
2909             Iterator := Make_Temporary (Loc, 'C');
2910
2911             --  Generate:
2912             --    Element : Component_Type renames Container (Iterator);
2913
2914             Prepend_To (Stats,
2915               Make_Object_Renaming_Declaration (Loc,
2916                 Defining_Identifier => Id,
2917                 Subtype_Mark =>
2918                   New_Reference_To (Component_Type (Container_Typ), Loc),
2919                 Name =>
2920                   Make_Indexed_Component (Loc,
2921                     Prefix => Relocate_Node (Container),
2922                     Expressions => New_List (
2923                       New_Reference_To (Iterator, Loc)))));
2924
2925          --  for Index in Array loop
2926
2927          --  This case utilizes the already given iterator name
2928
2929          else
2930             Iterator := Id;
2931          end if;
2932
2933          --  Generate:
2934          --    for Iterator in [reverse] Container'Range loop
2935          --       Element : Component_Type renames Container (Iterator);
2936          --       --  for the "of" form
2937
2938          --       <original loop statements>
2939          --    end loop;
2940
2941          New_Loop :=
2942            Make_Loop_Statement (Loc,
2943              Iteration_Scheme =>
2944                Make_Iteration_Scheme (Loc,
2945                  Loop_Parameter_Specification =>
2946                    Make_Loop_Parameter_Specification (Loc,
2947                      Defining_Identifier => Iterator,
2948                        Discrete_Subtype_Definition =>
2949                          Make_Attribute_Reference (Loc,
2950                            Prefix => Relocate_Node (Container),
2951                            Attribute_Name => Name_Range),
2952                       Reverse_Present => Reverse_Present (I_Spec))),
2953               Statements => Stats,
2954               End_Label  => Empty);
2955
2956       --  Processing for containers
2957
2958       else
2959          --  For an iterator of the form "Of" then name is some expression,
2960          --  which is transformed into a call to the default iterator.
2961
2962          --  For an iterator of the form "in" then name is a function call
2963          --  that delivers an iterator.
2964
2965          --  The for loop is expanded into a while loop which uses a container
2966          --  specific cursor to examine each element.
2967
2968          --    Iter : Iterator_Type := Container.Iterate;
2969          --    Cursor : Cursor_type := First (Iter);
2970          --    while Has_Element (Iter) loop
2971          --       declare
2972          --       --  the block is added when Element_Type is controlled
2973
2974          --          Obj : Pack.Element_Type := Element (Iterator);
2975          --          --  for the "of" loop form
2976          --       begin
2977          --          <original loop statements>
2978          --       end;
2979
2980          --       Cursor := Iter.Next (Cursor);
2981          --    end loop;
2982
2983          --  If "reverse" is present, then the initialization of the cursor
2984          --  uses Last and the step becomes Prev. Pack is the name of the
2985          --  package which instantiates the container.
2986
2987          declare
2988             Element_Type : constant Entity_Id := Etype (Id);
2989             Iter_Type    : Entity_Id;
2990             Pack         : Entity_Id;
2991             Decl         : Node_Id;
2992             Name_Init    : Name_Id;
2993             Name_Step    : Name_Id;
2994
2995          begin
2996
2997             --  The type of the iterator is the return type of the Iterate
2998             --  function used. For the "of" form this is the default iterator
2999             --  for the type, otherwise it is the type of the explicit
3000             --  function used in the loop.
3001
3002             Iter_Type := Etype (Name (I_Spec));
3003
3004             if Is_Entity_Name (Container) then
3005                Pack := Scope (Etype (Container));
3006
3007             else
3008                Pack := Scope (Entity (Name (Container)));
3009             end if;
3010
3011             --  The "of" case uses an internally generated cursor whose type
3012             --  is found in the container package. The domain of iteration
3013             --  is expanded into a call to the default Iterator function, but
3014             --  this expansion does not take place in a quantifier expressions
3015             --  that are analyzed with expansion disabled, and in that case the
3016             --  type of the iterator must be obtained from the aspect.
3017
3018             if Of_Present (I_Spec) then
3019                declare
3020                   Default_Iter : constant Entity_Id :=
3021                                    Entity
3022                                      (Find_Aspect
3023                                        (Etype (Container),
3024                                         Aspect_Default_Iterator));
3025
3026                   Container_Arg : Node_Id;
3027                   Ent           : Entity_Id;
3028
3029                begin
3030                   Cursor := Make_Temporary (Loc, 'I');
3031
3032                   if Is_Iterator (Iter_Type) then
3033                      null;
3034
3035                   else
3036                      Iter_Type := Etype (Default_Iter);
3037
3038                      --  Rewrite domain of iteration as a call to the default
3039                      --  iterator for the container type. If the container is
3040                      --  a derived type and the aspect is inherited, convert
3041                      --  container to parent type. The Cursor type is also
3042                      --  inherited from the scope of the parent.
3043
3044                      if Base_Type (Etype (Container)) =
3045                         Base_Type (Etype (First_Formal (Default_Iter)))
3046                      then
3047                         Container_Arg := New_Copy_Tree (Container);
3048
3049                      else
3050                         Pack := Scope (Default_Iter);
3051
3052                         Container_Arg :=
3053                           Make_Type_Conversion (Loc,
3054                             Subtype_Mark =>
3055                               New_Occurrence_Of
3056                                 (Etype (First_Formal (Default_Iter)), Loc),
3057                             Expression => New_Copy_Tree (Container));
3058                      end if;
3059
3060                      Rewrite (Name (I_Spec),
3061                        Make_Function_Call (Loc,
3062                          Name => New_Occurrence_Of (Default_Iter, Loc),
3063                          Parameter_Associations =>
3064                            New_List (Container_Arg)));
3065                      Analyze_And_Resolve (Name (I_Spec));
3066                   end if;
3067
3068                   --  Find cursor type in proper container package.
3069
3070                   Ent := First_Entity (Pack);
3071                   while Present (Ent) loop
3072                      if Chars (Ent) = Name_Cursor then
3073                         Set_Etype (Cursor, Etype (Ent));
3074                         exit;
3075                      end if;
3076                      Next_Entity (Ent);
3077                   end loop;
3078
3079                   --  Generate:
3080                   --    Id : Element_Type renames Pack.Element (Cursor);
3081
3082                   Decl :=
3083                     Make_Object_Renaming_Declaration (Loc,
3084                       Defining_Identifier => Id,
3085                       Subtype_Mark        =>
3086                         New_Reference_To (Element_Type, Loc),
3087                       Name                =>
3088                         Make_Indexed_Component (Loc,
3089                           Prefix      => Make_Selected_Component (Loc,
3090                               Prefix        => New_Reference_To (Pack, Loc),
3091                               Selector_Name =>
3092                                 Make_Identifier (Loc, Chars => Name_Element)),
3093                           Expressions =>
3094                             New_List (New_Occurrence_Of (Cursor, Loc))));
3095
3096                   --  If the container holds controlled objects, wrap the loop
3097                   --  statements and element renaming declaration with a block.
3098                   --  This ensures that the result of Element (Iterator) is
3099                   --  cleaned up after each iteration of the loop.
3100
3101                   if Needs_Finalization (Element_Type) then
3102
3103                      --  Generate:
3104                      --    declare
3105                      --       Id : Element_Type := Pack.Element (Iterator);
3106                      --    begin
3107                      --       <original loop statements>
3108                      --    end;
3109
3110                      Stats := New_List (
3111                        Make_Block_Statement (Loc,
3112                          Declarations               => New_List (Decl),
3113                          Handled_Statement_Sequence =>
3114                            Make_Handled_Sequence_Of_Statements (Loc,
3115                               Statements => Stats)));
3116
3117                   --  Elements do not need finalization
3118
3119                   else
3120                      Prepend_To (Stats, Decl);
3121                   end if;
3122                end;
3123
3124             --  X in Iterate (S) : type of iterator is type of explicitly
3125             --  given Iterate function.
3126
3127             else
3128                Cursor := Id;
3129             end if;
3130
3131             Iterator := Make_Temporary (Loc, 'I');
3132
3133             --  Determine the advancement and initialization steps for the
3134             --  cursor.
3135
3136             --  Must verify that the container has a reverse iterator ???
3137
3138             if Reverse_Present (I_Spec) then
3139                Name_Init := Name_Last;
3140                Name_Step := Name_Previous;
3141             else
3142                Name_Init := Name_First;
3143                Name_Step := Name_Next;
3144             end if;
3145
3146             --  For both iterator forms, add a call to the step operation to
3147             --  advance the cursor. Generate:
3148
3149             --     Cursor := Iterator.Next (Cursor);
3150
3151             --   or else
3152
3153             --     Cursor := Next (Cursor);
3154
3155             declare
3156                Rhs : Node_Id;
3157
3158             begin
3159                Rhs :=
3160                  Make_Function_Call (Loc,
3161                    Name                   =>
3162                      Make_Selected_Component (Loc,
3163                        Prefix        => New_Reference_To (Iterator, Loc),
3164                        Selector_Name => Make_Identifier (Loc, Name_Step)),
3165                    Parameter_Associations => New_List (
3166                       New_Reference_To (Cursor, Loc)));
3167
3168                Append_To (Stats,
3169                  Make_Assignment_Statement (Loc,
3170                     Name       => New_Occurrence_Of (Cursor, Loc),
3171                     Expression => Rhs));
3172             end;
3173
3174             --  Generate:
3175             --    while Iterator.Has_Element loop
3176             --       <Stats>
3177             --    end loop;
3178
3179             New_Loop :=
3180               Make_Loop_Statement (Loc,
3181                 Iteration_Scheme =>
3182                   Make_Iteration_Scheme (Loc,
3183                     Condition =>
3184                       Make_Function_Call (Loc,
3185                         Name                   =>
3186                           Make_Selected_Component (Loc,
3187                            Prefix => New_Occurrence_Of (Pack, Loc),
3188                            Selector_Name =>
3189                              Make_Identifier (Loc,  Name_Has_Element)),
3190
3191                         Parameter_Associations =>
3192                           New_List (
3193                             New_Reference_To (Cursor, Loc)))),
3194                 Statements => Stats,
3195                 End_Label  => Empty);
3196
3197             --  Create the declarations for Iterator and cursor and insert then
3198             --  before the source loop. Generate:
3199
3200             --    I : Iterator_Type := Iterate (Container);
3201             --    C : Pack.Cursor_Type := Container.[First | Last];
3202
3203             declare
3204                Decl1 : Node_Id;
3205                Decl2 : Node_Id;
3206
3207             begin
3208                Decl1 :=
3209                  Make_Object_Declaration (Loc,
3210                    Defining_Identifier => Iterator,
3211                    Object_Definition   => New_Occurrence_Of (Iter_Type, Loc),
3212                    Expression          => Relocate_Node (Name (I_Spec)));
3213                Set_Assignment_OK (Decl1);
3214
3215                Decl2 :=
3216                  Make_Object_Declaration (Loc,
3217                    Defining_Identifier => Cursor,
3218                    Object_Definition   =>
3219                      New_Occurrence_Of (Etype (Cursor), Loc),
3220                    Expression          =>
3221                      Make_Selected_Component (Loc,
3222                        Prefix        => New_Reference_To (Iterator, Loc),
3223                        Selector_Name =>
3224                          Make_Identifier (Loc, Name_Init)));
3225
3226                Set_Assignment_OK (Decl2);
3227
3228                Insert_Actions (N,
3229                  New_List (Decl1, Decl2));
3230             end;
3231
3232             --  The Iterator is not modified in the source, but of course will
3233             --  be updated in the generated code. Indicate that it is actually
3234             --  set to prevent spurious warnings.
3235
3236             Set_Never_Set_In_Source (Iterator, False);
3237
3238             --  If the range of iteration is given by a function call that
3239             --  returns a container, the finalization actions have been saved
3240             --  in the Condition_Actions of the iterator. Insert them now at
3241             --  the head of the loop.
3242
3243             if Present (Condition_Actions (Isc)) then
3244                Insert_List_Before (N, Condition_Actions (Isc));
3245             end if;
3246          end;
3247       end if;
3248
3249       Rewrite (N, New_Loop);
3250       Analyze (N);
3251    end Expand_Iterator_Loop;
3252
3253    -----------------------------
3254    -- Expand_N_Loop_Statement --
3255    -----------------------------
3256
3257    --  1. Remove null loop entirely
3258    --  2. Deal with while condition for C/Fortran boolean
3259    --  3. Deal with loops with a non-standard enumeration type range
3260    --  4. Deal with while loops where Condition_Actions is set
3261    --  5. Deal with loops over predicated subtypes
3262    --  6. Deal with loops with iterators over arrays and containers
3263    --  7. Insert polling call if required
3264
3265    procedure Expand_N_Loop_Statement (N : Node_Id) is
3266       Loc  : constant Source_Ptr := Sloc (N);
3267       Isc  : constant Node_Id    := Iteration_Scheme (N);
3268
3269    begin
3270       --  Delete null loop
3271
3272       if Is_Null_Loop (N) then
3273          Rewrite (N, Make_Null_Statement (Loc));
3274          return;
3275       end if;
3276
3277       Process_Statements_For_Controlled_Objects (N);
3278
3279       --  Deal with condition for C/Fortran Boolean
3280
3281       if Present (Isc) then
3282          Adjust_Condition (Condition (Isc));
3283       end if;
3284
3285       --  Generate polling call
3286
3287       if Is_Non_Empty_List (Statements (N)) then
3288          Generate_Poll_Call (First (Statements (N)));
3289       end if;
3290
3291       --  Nothing more to do for plain loop with no iteration scheme
3292
3293       if No (Isc) then
3294          null;
3295
3296       --  Case of for loop (Loop_Parameter_Specification present)
3297
3298       --  Note: we do not have to worry about validity checking of the for loop
3299       --  range bounds here, since they were frozen with constant declarations
3300       --  and it is during that process that the validity checking is done.
3301
3302       elsif Present (Loop_Parameter_Specification (Isc)) then
3303          declare
3304             LPS     : constant Node_Id   := Loop_Parameter_Specification (Isc);
3305             Loop_Id : constant Entity_Id := Defining_Identifier (LPS);
3306             Ltype   : constant Entity_Id := Etype (Loop_Id);
3307             Btype   : constant Entity_Id := Base_Type (Ltype);
3308             Expr    : Node_Id;
3309             New_Id  : Entity_Id;
3310
3311          begin
3312             --  Deal with loop over predicates
3313
3314             if Is_Discrete_Type (Ltype)
3315               and then Present (Predicate_Function (Ltype))
3316             then
3317                Expand_Predicated_Loop (N);
3318
3319             --  Handle the case where we have a for loop with the range type
3320             --  being an enumeration type with non-standard representation.
3321             --  In this case we expand:
3322
3323             --    for x in [reverse] a .. b loop
3324             --       ...
3325             --    end loop;
3326
3327             --  to
3328
3329             --    for xP in [reverse] integer
3330             --      range etype'Pos (a) .. etype'Pos (b)
3331             --    loop
3332             --       declare
3333             --          x : constant etype := Pos_To_Rep (xP);
3334             --       begin
3335             --          ...
3336             --       end;
3337             --    end loop;
3338
3339             elsif Is_Enumeration_Type (Btype)
3340               and then Present (Enum_Pos_To_Rep (Btype))
3341             then
3342                New_Id :=
3343                  Make_Defining_Identifier (Loc,
3344                    Chars => New_External_Name (Chars (Loop_Id), 'P'));
3345
3346                --  If the type has a contiguous representation, successive
3347                --  values can be generated as offsets from the first literal.
3348
3349                if Has_Contiguous_Rep (Btype) then
3350                   Expr :=
3351                      Unchecked_Convert_To (Btype,
3352                        Make_Op_Add (Loc,
3353                          Left_Opnd =>
3354                             Make_Integer_Literal (Loc,
3355                               Enumeration_Rep (First_Literal (Btype))),
3356                          Right_Opnd => New_Reference_To (New_Id, Loc)));
3357                else
3358                   --  Use the constructed array Enum_Pos_To_Rep
3359
3360                   Expr :=
3361                     Make_Indexed_Component (Loc,
3362                       Prefix      =>
3363                         New_Reference_To (Enum_Pos_To_Rep (Btype), Loc),
3364                       Expressions =>
3365                         New_List (New_Reference_To (New_Id, Loc)));
3366                end if;
3367
3368                Rewrite (N,
3369                  Make_Loop_Statement (Loc,
3370                    Identifier => Identifier (N),
3371
3372                    Iteration_Scheme =>
3373                      Make_Iteration_Scheme (Loc,
3374                        Loop_Parameter_Specification =>
3375                          Make_Loop_Parameter_Specification (Loc,
3376                            Defining_Identifier => New_Id,
3377                            Reverse_Present => Reverse_Present (LPS),
3378
3379                            Discrete_Subtype_Definition =>
3380                              Make_Subtype_Indication (Loc,
3381
3382                                Subtype_Mark =>
3383                                  New_Reference_To (Standard_Natural, Loc),
3384
3385                                Constraint =>
3386                                  Make_Range_Constraint (Loc,
3387                                    Range_Expression =>
3388                                      Make_Range (Loc,
3389
3390                                        Low_Bound =>
3391                                          Make_Attribute_Reference (Loc,
3392                                            Prefix =>
3393                                              New_Reference_To (Btype, Loc),
3394
3395                                            Attribute_Name => Name_Pos,
3396
3397                                            Expressions => New_List (
3398                                              Relocate_Node
3399                                                (Type_Low_Bound (Ltype)))),
3400
3401                                        High_Bound =>
3402                                          Make_Attribute_Reference (Loc,
3403                                            Prefix =>
3404                                              New_Reference_To (Btype, Loc),
3405
3406                                            Attribute_Name => Name_Pos,
3407
3408                                            Expressions => New_List (
3409                                              Relocate_Node
3410                                                (Type_High_Bound
3411                                                   (Ltype))))))))),
3412
3413                    Statements => New_List (
3414                      Make_Block_Statement (Loc,
3415                        Declarations => New_List (
3416                          Make_Object_Declaration (Loc,
3417                            Defining_Identifier => Loop_Id,
3418                            Constant_Present    => True,
3419                            Object_Definition   =>
3420                              New_Reference_To (Ltype, Loc),
3421                            Expression          => Expr)),
3422
3423                        Handled_Statement_Sequence =>
3424                          Make_Handled_Sequence_Of_Statements (Loc,
3425                            Statements => Statements (N)))),
3426
3427                    End_Label => End_Label (N)));
3428                Analyze (N);
3429
3430             --  Nothing to do with other cases of for loops
3431
3432             else
3433                null;
3434             end if;
3435          end;
3436
3437       --  Second case, if we have a while loop with Condition_Actions set, then
3438       --  we change it into a plain loop:
3439
3440       --    while C loop
3441       --       ...
3442       --    end loop;
3443
3444       --  changed to:
3445
3446       --    loop
3447       --       <<condition actions>>
3448       --       exit when not C;
3449       --       ...
3450       --    end loop
3451
3452       elsif Present (Isc)
3453         and then Present (Condition_Actions (Isc))
3454         and then Present (Condition (Isc))
3455       then
3456          declare
3457             ES : Node_Id;
3458
3459          begin
3460             ES :=
3461               Make_Exit_Statement (Sloc (Condition (Isc)),
3462                 Condition =>
3463                   Make_Op_Not (Sloc (Condition (Isc)),
3464                     Right_Opnd => Condition (Isc)));
3465
3466             Prepend (ES, Statements (N));
3467             Insert_List_Before (ES, Condition_Actions (Isc));
3468
3469             --  This is not an implicit loop, since it is generated in response
3470             --  to the loop statement being processed. If this is itself
3471             --  implicit, the restriction has already been checked. If not,
3472             --  it is an explicit loop.
3473
3474             Rewrite (N,
3475               Make_Loop_Statement (Sloc (N),
3476                 Identifier => Identifier (N),
3477                 Statements => Statements (N),
3478                 End_Label  => End_Label  (N)));
3479
3480             Analyze (N);
3481          end;
3482
3483       --  Here to deal with iterator case
3484
3485       elsif Present (Isc)
3486         and then Present (Iterator_Specification (Isc))
3487       then
3488          Expand_Iterator_Loop (N);
3489       end if;
3490    end Expand_N_Loop_Statement;
3491
3492    ----------------------------
3493    -- Expand_Predicated_Loop --
3494    ----------------------------
3495
3496    --  Note: the expander can handle generation of loops over predicated
3497    --  subtypes for both the dynamic and static cases. Depending on what
3498    --  we decide is allowed in Ada 2012 mode and/or extensions allowed
3499    --  mode, the semantic analyzer may disallow one or both forms.
3500
3501    procedure Expand_Predicated_Loop (N : Node_Id) is
3502       Loc     : constant Source_Ptr := Sloc (N);
3503       Isc     : constant Node_Id    := Iteration_Scheme (N);
3504       LPS     : constant Node_Id    := Loop_Parameter_Specification (Isc);
3505       Loop_Id : constant Entity_Id  := Defining_Identifier (LPS);
3506       Ltype   : constant Entity_Id  := Etype (Loop_Id);
3507       Stat    : constant List_Id    := Static_Predicate (Ltype);
3508       Stmts   : constant List_Id    := Statements (N);
3509
3510    begin
3511       --  Case of iteration over non-static predicate, should not be possible
3512       --  since this is not allowed by the semantics and should have been
3513       --  caught during analysis of the loop statement.
3514
3515       if No (Stat) then
3516          raise Program_Error;
3517
3518       --  If the predicate list is empty, that corresponds to a predicate of
3519       --  False, in which case the loop won't run at all, and we rewrite the
3520       --  entire loop as a null statement.
3521
3522       elsif Is_Empty_List (Stat) then
3523          Rewrite (N, Make_Null_Statement (Loc));
3524          Analyze (N);
3525
3526       --  For expansion over a static predicate we generate the following
3527
3528       --     declare
3529       --        J : Ltype := min-val;
3530       --     begin
3531       --        loop
3532       --           body
3533       --           case J is
3534       --              when endpoint => J := startpoint;
3535       --              when endpoint => J := startpoint;
3536       --              ...
3537       --              when max-val  => exit;
3538       --              when others   => J := Lval'Succ (J);
3539       --           end case;
3540       --        end loop;
3541       --     end;
3542
3543       --  To make this a little clearer, let's take a specific example:
3544
3545       --        type Int is range 1 .. 10;
3546       --        subtype L is Int with
3547       --          predicate => L in 3 | 10 | 5 .. 7;
3548       --          ...
3549       --        for L in StaticP loop
3550       --           Put_Line ("static:" & J'Img);
3551       --        end loop;
3552
3553       --  In this case, the loop is transformed into
3554
3555       --     begin
3556       --        J : L := 3;
3557       --        loop
3558       --           body
3559       --           case J is
3560       --              when 3  => J := 5;
3561       --              when 7  => J := 10;
3562       --              when 10 => exit;
3563       --              when others  => J := L'Succ (J);
3564       --           end case;
3565       --        end loop;
3566       --     end;
3567
3568       else
3569          Static_Predicate : declare
3570             S    : Node_Id;
3571             D    : Node_Id;
3572             P    : Node_Id;
3573             Alts : List_Id;
3574             Cstm : Node_Id;
3575
3576             function Lo_Val (N : Node_Id) return Node_Id;
3577             --  Given static expression or static range, returns an identifier
3578             --  whose value is the low bound of the expression value or range.
3579
3580             function Hi_Val (N : Node_Id) return Node_Id;
3581             --  Given static expression or static range, returns an identifier
3582             --  whose value is the high bound of the expression value or range.
3583
3584             ------------
3585             -- Hi_Val --
3586             ------------
3587
3588             function Hi_Val (N : Node_Id) return Node_Id is
3589             begin
3590                if Is_Static_Expression (N) then
3591                   return New_Copy (N);
3592                else
3593                   pragma Assert (Nkind (N) = N_Range);
3594                   return New_Copy (High_Bound (N));
3595                end if;
3596             end Hi_Val;
3597
3598             ------------
3599             -- Lo_Val --
3600             ------------
3601
3602             function Lo_Val (N : Node_Id) return Node_Id is
3603             begin
3604                if Is_Static_Expression (N) then
3605                   return New_Copy (N);
3606                else
3607                   pragma Assert (Nkind (N) = N_Range);
3608                   return New_Copy (Low_Bound (N));
3609                end if;
3610             end Lo_Val;
3611
3612          --  Start of processing for Static_Predicate
3613
3614          begin
3615             --  Convert loop identifier to normal variable and reanalyze it so
3616             --  that this conversion works. We have to use the same defining
3617             --  identifier, since there may be references in the loop body.
3618
3619             Set_Analyzed (Loop_Id, False);
3620             Set_Ekind    (Loop_Id, E_Variable);
3621
3622             --  Loop to create branches of case statement
3623
3624             Alts := New_List;
3625             P := First (Stat);
3626             while Present (P) loop
3627                if No (Next (P)) then
3628                   S := Make_Exit_Statement (Loc);
3629                else
3630                   S :=
3631                     Make_Assignment_Statement (Loc,
3632                       Name       => New_Occurrence_Of (Loop_Id, Loc),
3633                       Expression => Lo_Val (Next (P)));
3634                   Set_Suppress_Assignment_Checks (S);
3635                end if;
3636
3637                Append_To (Alts,
3638                  Make_Case_Statement_Alternative (Loc,
3639                    Statements       => New_List (S),
3640                    Discrete_Choices => New_List (Hi_Val (P))));
3641
3642                Next (P);
3643             end loop;
3644
3645             --  Add others choice
3646
3647             S :=
3648                Make_Assignment_Statement (Loc,
3649                  Name       => New_Occurrence_Of (Loop_Id, Loc),
3650                  Expression =>
3651                    Make_Attribute_Reference (Loc,
3652                      Prefix => New_Occurrence_Of (Ltype, Loc),
3653                      Attribute_Name => Name_Succ,
3654                      Expressions    => New_List (
3655                        New_Occurrence_Of (Loop_Id, Loc))));
3656             Set_Suppress_Assignment_Checks (S);
3657
3658             Append_To (Alts,
3659               Make_Case_Statement_Alternative (Loc,
3660                 Discrete_Choices => New_List (Make_Others_Choice (Loc)),
3661                 Statements       => New_List (S)));
3662
3663             --  Construct case statement and append to body statements
3664
3665             Cstm :=
3666               Make_Case_Statement (Loc,
3667                 Expression   => New_Occurrence_Of (Loop_Id, Loc),
3668                 Alternatives => Alts);
3669             Append_To (Stmts, Cstm);
3670
3671             --  Rewrite the loop
3672
3673             D :=
3674                Make_Object_Declaration (Loc,
3675                  Defining_Identifier => Loop_Id,
3676                  Object_Definition   => New_Occurrence_Of (Ltype, Loc),
3677                  Expression          => Lo_Val (First (Stat)));
3678             Set_Suppress_Assignment_Checks (D);
3679
3680             Rewrite (N,
3681               Make_Block_Statement (Loc,
3682                 Declarations               => New_List (D),
3683                 Handled_Statement_Sequence =>
3684                   Make_Handled_Sequence_Of_Statements (Loc,
3685                     Statements => New_List (
3686                       Make_Loop_Statement (Loc,
3687                         Statements => Stmts,
3688                         End_Label  => Empty)))));
3689
3690             Analyze (N);
3691          end Static_Predicate;
3692       end if;
3693    end Expand_Predicated_Loop;
3694
3695    ------------------------------
3696    -- Make_Tag_Ctrl_Assignment --
3697    ------------------------------
3698
3699    function Make_Tag_Ctrl_Assignment (N : Node_Id) return List_Id is
3700       Asn : constant Node_Id    := Relocate_Node (N);
3701       L   : constant Node_Id    := Name (N);
3702       Loc : constant Source_Ptr := Sloc (N);
3703       Res : constant List_Id    := New_List;
3704       T   : constant Entity_Id  := Underlying_Type (Etype (L));
3705
3706       Comp_Asn : constant Boolean := Is_Fully_Repped_Tagged_Type (T);
3707       Ctrl_Act : constant Boolean := Needs_Finalization (T)
3708                                        and then not No_Ctrl_Actions (N);
3709       Save_Tag : constant Boolean := Is_Tagged_Type (T)
3710                                        and then not Comp_Asn
3711                                        and then not No_Ctrl_Actions (N)
3712                                        and then Tagged_Type_Expansion;
3713       --  Tags are not saved and restored when VM_Target because VM tags are
3714       --  represented implicitly in objects.
3715
3716       Next_Id : Entity_Id;
3717       Prev_Id : Entity_Id;
3718       Tag_Id  : Entity_Id;
3719
3720    begin
3721       --  Finalize the target of the assignment when controlled
3722
3723       --  We have two exceptions here:
3724
3725       --   1. If we are in an init proc since it is an initialization more
3726       --      than an assignment.
3727
3728       --   2. If the left-hand side is a temporary that was not initialized
3729       --      (or the parent part of a temporary since it is the case in
3730       --      extension aggregates). Such a temporary does not come from
3731       --      source. We must examine the original node for the prefix, because
3732       --      it may be a component of an entry formal, in which case it has
3733       --      been rewritten and does not appear to come from source either.
3734
3735       --  Case of init proc
3736
3737       if not Ctrl_Act then
3738          null;
3739
3740       --  The left hand side is an uninitialized temporary object
3741
3742       elsif Nkind (L) = N_Type_Conversion
3743         and then Is_Entity_Name (Expression (L))
3744         and then Nkind (Parent (Entity (Expression (L)))) =
3745                                               N_Object_Declaration
3746         and then No_Initialization (Parent (Entity (Expression (L))))
3747       then
3748          null;
3749
3750       else
3751          Append_To (Res,
3752            Make_Final_Call
3753              (Obj_Ref => Duplicate_Subexpr_No_Checks (L),
3754               Typ     => Etype (L)));
3755       end if;
3756
3757       --  Save the Tag in a local variable Tag_Id
3758
3759       if Save_Tag then
3760          Tag_Id := Make_Temporary (Loc, 'A');
3761
3762          Append_To (Res,
3763            Make_Object_Declaration (Loc,
3764              Defining_Identifier => Tag_Id,
3765              Object_Definition   => New_Reference_To (RTE (RE_Tag), Loc),
3766              Expression          =>
3767                Make_Selected_Component (Loc,
3768                  Prefix        => Duplicate_Subexpr_No_Checks (L),
3769                  Selector_Name =>
3770                    New_Reference_To (First_Tag_Component (T), Loc))));
3771
3772       --  Otherwise Tag_Id is not used
3773
3774       else
3775          Tag_Id := Empty;
3776       end if;
3777
3778       --  Save the Prev and Next fields on .NET/JVM. This is not needed on non
3779       --  VM targets since the fields are not part of the object.
3780
3781       if VM_Target /= No_VM
3782         and then Is_Controlled (T)
3783       then
3784          Prev_Id := Make_Temporary (Loc, 'P');
3785          Next_Id := Make_Temporary (Loc, 'N');
3786
3787          --  Generate:
3788          --    Pnn : Root_Controlled_Ptr := Root_Controlled (L).Prev;
3789
3790          Append_To (Res,
3791            Make_Object_Declaration (Loc,
3792              Defining_Identifier => Prev_Id,
3793              Object_Definition   =>
3794                New_Reference_To (RTE (RE_Root_Controlled_Ptr), Loc),
3795              Expression          =>
3796                Make_Selected_Component (Loc,
3797                  Prefix        =>
3798                    Unchecked_Convert_To
3799                      (RTE (RE_Root_Controlled), New_Copy_Tree (L)),
3800                  Selector_Name =>
3801                    Make_Identifier (Loc, Name_Prev))));
3802
3803          --  Generate:
3804          --    Nnn : Root_Controlled_Ptr := Root_Controlled (L).Next;
3805
3806          Append_To (Res,
3807            Make_Object_Declaration (Loc,
3808              Defining_Identifier => Next_Id,
3809              Object_Definition   =>
3810                New_Reference_To (RTE (RE_Root_Controlled_Ptr), Loc),
3811              Expression          =>
3812                Make_Selected_Component (Loc,
3813                  Prefix        =>
3814                    Unchecked_Convert_To
3815                      (RTE (RE_Root_Controlled), New_Copy_Tree (L)),
3816                  Selector_Name =>
3817                    Make_Identifier (Loc, Name_Next))));
3818       end if;
3819
3820       --  If the tagged type has a full rep clause, expand the assignment into
3821       --  component-wise assignments. Mark the node as unanalyzed in order to
3822       --  generate the proper code and propagate this scenario by setting a
3823       --  flag to avoid infinite recursion.
3824
3825       if Comp_Asn then
3826          Set_Analyzed (Asn, False);
3827          Set_Componentwise_Assignment (Asn, True);
3828       end if;
3829
3830       Append_To (Res, Asn);
3831
3832       --  Restore the tag
3833
3834       if Save_Tag then
3835          Append_To (Res,
3836            Make_Assignment_Statement (Loc,
3837              Name       =>
3838                Make_Selected_Component (Loc,
3839                  Prefix        => Duplicate_Subexpr_No_Checks (L),
3840                  Selector_Name =>
3841                    New_Reference_To (First_Tag_Component (T), Loc)),
3842              Expression => New_Reference_To (Tag_Id, Loc)));
3843       end if;
3844
3845       --  Restore the Prev and Next fields on .NET/JVM
3846
3847       if VM_Target /= No_VM
3848         and then Is_Controlled (T)
3849       then
3850          --  Generate:
3851          --    Root_Controlled (L).Prev := Prev_Id;
3852
3853          Append_To (Res,
3854            Make_Assignment_Statement (Loc,
3855              Name       =>
3856                Make_Selected_Component (Loc,
3857                  Prefix        =>
3858                    Unchecked_Convert_To
3859                      (RTE (RE_Root_Controlled), New_Copy_Tree (L)),
3860                  Selector_Name =>
3861                    Make_Identifier (Loc, Name_Prev)),
3862              Expression => New_Reference_To (Prev_Id, Loc)));
3863
3864          --  Generate:
3865          --    Root_Controlled (L).Next := Next_Id;
3866
3867          Append_To (Res,
3868            Make_Assignment_Statement (Loc,
3869              Name       =>
3870                Make_Selected_Component (Loc,
3871                  Prefix        =>
3872                    Unchecked_Convert_To
3873                      (RTE (RE_Root_Controlled), New_Copy_Tree (L)),
3874                  Selector_Name => Make_Identifier (Loc, Name_Next)),
3875              Expression => New_Reference_To (Next_Id, Loc)));
3876       end if;
3877
3878       --  Adjust the target after the assignment when controlled (not in the
3879       --  init proc since it is an initialization more than an assignment).
3880
3881       if Ctrl_Act then
3882          Append_To (Res,
3883            Make_Adjust_Call
3884              (Obj_Ref => Duplicate_Subexpr_Move_Checks (L),
3885               Typ     => Etype (L)));
3886       end if;
3887
3888       return Res;
3889
3890    exception
3891
3892       --  Could use comment here ???
3893
3894       when RE_Not_Available =>
3895          return Empty_List;
3896    end Make_Tag_Ctrl_Assignment;
3897
3898 end Exp_Ch5;