gcc/ada/exp_ch4.adb

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              E X P _ C H 4                               --
   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 Atree;    use Atree;
  27 with Checks;   use Checks;
  28 with Debug;    use Debug;
  29 with Einfo;    use Einfo;
  30 with Elists;   use Elists;
  31 with Errout;   use Errout;
  32 with Exp_Aggr; use Exp_Aggr;
  33 with Exp_Atag; use Exp_Atag;
  34 with Exp_Ch2;  use Exp_Ch2;
  35 with Exp_Ch3;  use Exp_Ch3;
  36 with Exp_Ch6;  use Exp_Ch6;
  37 with Exp_Ch7;  use Exp_Ch7;
  38 with Exp_Ch9;  use Exp_Ch9;
  39 with Exp_Disp; use Exp_Disp;
  40 with Exp_Fixd; use Exp_Fixd;
  41 with Exp_Intr; use Exp_Intr;
  42 with Exp_Pakd; use Exp_Pakd;
  43 with Exp_Tss;  use Exp_Tss;
  44 with Exp_Util; use Exp_Util;
  45 with Exp_VFpt; use Exp_VFpt;
  46 with Freeze;   use Freeze;
  47 with Inline;   use Inline;
  48 with Lib;      use Lib;
  49 with Namet;    use Namet;
  50 with Nlists;   use Nlists;
  51 with Nmake;    use Nmake;
  52 with Opt;      use Opt;
  53 with Par_SCO;  use Par_SCO;
  54 with Restrict; use Restrict;
  55 with Rident;   use Rident;
  56 with Rtsfind;  use Rtsfind;
  57 with Sem;      use Sem;
  58 with Sem_Aux;  use Sem_Aux;
  59 with Sem_Cat;  use Sem_Cat;
  60 with Sem_Ch3;  use Sem_Ch3;
  61 with Sem_Ch8;  use Sem_Ch8;
  62 with Sem_Ch13; use Sem_Ch13;
  63 with Sem_Eval; use Sem_Eval;
  64 with Sem_Res;  use Sem_Res;
  65 with Sem_Type; use Sem_Type;
  66 with Sem_Util; use Sem_Util;
  67 with Sem_Warn; use Sem_Warn;
  68 with Sinfo;    use Sinfo;
  69 with Snames;   use Snames;
  70 with Stand;    use Stand;
  71 with SCIL_LL;  use SCIL_LL;
  72 with Targparm; use Targparm;
  73 with Tbuild;   use Tbuild;
  74 with Ttypes;   use Ttypes;
  75 with Uintp;    use Uintp;
  76 with Urealp;   use Urealp;
  77 with Validsw;  use Validsw;
  78
  79 package body Exp_Ch4 is
  80
  81    -----------------------
  82    -- Local Subprograms --
  83    -----------------------
  84
  85    procedure Binary_Op_Validity_Checks (N : Node_Id);
  86    pragma Inline (Binary_Op_Validity_Checks);
  87    --  Performs validity checks for a binary operator
  88
  89    procedure Build_Boolean_Array_Proc_Call
  90      (N   : Node_Id;
  91       Op1 : Node_Id;
  92       Op2 : Node_Id);
  93    --  If a boolean array assignment can be done in place, build call to
  94    --  corresponding library procedure.
  95
  96    function Current_Anonymous_Master return Entity_Id;
  97    --  Return the entity of the heterogeneous finalization master belonging to
  98    --  the current unit (either function, package or procedure). This master
  99    --  services all anonymous access-to-controlled types. If the current unit
 100    --  does not have such master, create one.
 101
 102    procedure Displace_Allocator_Pointer (N : Node_Id);
 103    --  Ada 2005 (AI-251): Subsidiary procedure to Expand_N_Allocator and
 104    --  Expand_Allocator_Expression. Allocating class-wide interface objects
 105    --  this routine displaces the pointer to the allocated object to reference
 106    --  the component referencing the corresponding secondary dispatch table.
 107
 108    procedure Expand_Allocator_Expression (N : Node_Id);
 109    --  Subsidiary to Expand_N_Allocator, for the case when the expression
 110    --  is a qualified expression or an aggregate.
 111
 112    procedure Expand_Array_Comparison (N : Node_Id);
 113    --  This routine handles expansion of the comparison operators (N_Op_Lt,
 114    --  N_Op_Le, N_Op_Gt, N_Op_Ge) when operating on an array type. The basic
 115    --  code for these operators is similar, differing only in the details of
 116    --  the actual comparison call that is made. Special processing (call a
 117    --  run-time routine)
 118
 119    function Expand_Array_Equality
 120      (Nod    : Node_Id;
 121       Lhs    : Node_Id;
 122       Rhs    : Node_Id;
 123       Bodies : List_Id;
 124       Typ    : Entity_Id) return Node_Id;
 125    --  Expand an array equality into a call to a function implementing this
 126    --  equality, and a call to it. Loc is the location for the generated nodes.
 127    --  Lhs and Rhs are the array expressions to be compared. Bodies is a list
 128    --  on which to attach bodies of local functions that are created in the
 129    --  process. It is the responsibility of the caller to insert those bodies
 130    --  at the right place. Nod provides the Sloc value for the generated code.
 131    --  Normally the types used for the generated equality routine are taken
 132    --  from Lhs and Rhs. However, in some situations of generated code, the
 133    --  Etype fields of Lhs and Rhs are not set yet. In such cases, Typ supplies
 134    --  the type to be used for the formal parameters.
 135
 136    procedure Expand_Boolean_Operator (N : Node_Id);
 137    --  Common expansion processing for Boolean operators (And, Or, Xor) for the
 138    --  case of array type arguments.
 139
 140    procedure Expand_Short_Circuit_Operator (N : Node_Id);
 141    --  Common expansion processing for short-circuit boolean operators
 142
 143    function Expand_Composite_Equality
 144      (Nod    : Node_Id;
 145       Typ    : Entity_Id;
 146       Lhs    : Node_Id;
 147       Rhs    : Node_Id;
 148       Bodies : List_Id) return Node_Id;
 149    --  Local recursive function used to expand equality for nested composite
 150    --  types. Used by Expand_Record/Array_Equality, Bodies is a list on which
 151    --  to attach bodies of local functions that are created in the process.
 152    --  This is the responsibility of the caller to insert those bodies at the
 153    --  right place. Nod provides the Sloc value for generated code. Lhs and Rhs
 154    --  are the left and right sides for the comparison, and Typ is the type of
 155    --  the arrays to compare.
 156
 157    procedure Expand_Concatenate (Cnode : Node_Id; Opnds : List_Id);
 158    --  Routine to expand concatenation of a sequence of two or more operands
 159    --  (in the list Operands) and replace node Cnode with the result of the
 160    --  concatenation. The operands can be of any appropriate type, and can
 161    --  include both arrays and singleton elements.
 162
 163    procedure Fixup_Universal_Fixed_Operation (N : Node_Id);
 164    --  N is a N_Op_Divide or N_Op_Multiply node whose result is universal
 165    --  fixed. We do not have such a type at runtime, so the purpose of this
 166    --  routine is to find the real type by looking up the tree. We also
 167    --  determine if the operation must be rounded.
 168
 169    function Has_Inferable_Discriminants (N : Node_Id) return Boolean;
 170    --  Ada 2005 (AI-216): A view of an Unchecked_Union object has inferable
 171    --  discriminants if it has a constrained nominal type, unless the object
 172    --  is a component of an enclosing Unchecked_Union object that is subject
 173    --  to a per-object constraint and the enclosing object lacks inferable
 174    --  discriminants.
 175    --
 176    --  An expression of an Unchecked_Union type has inferable discriminants
 177    --  if it is either a name of an object with inferable discriminants or a
 178    --  qualified expression whose subtype mark denotes a constrained subtype.
 179
 180    procedure Insert_Dereference_Action (N : Node_Id);
 181    --  N is an expression whose type is an access. When the type of the
 182    --  associated storage pool is derived from Checked_Pool, generate a
 183    --  call to the 'Dereference' primitive operation.
 184
 185    function Make_Array_Comparison_Op
 186      (Typ : Entity_Id;
 187       Nod : Node_Id) return Node_Id;
 188    --  Comparisons between arrays are expanded in line. This function produces
 189    --  the body of the implementation of (a > b), where a and b are one-
 190    --  dimensional arrays of some discrete type. The original node is then
 191    --  expanded into the appropriate call to this function. Nod provides the
 192    --  Sloc value for the generated code.
 193
 194    function Make_Boolean_Array_Op
 195      (Typ : Entity_Id;
 196       N   : Node_Id) return Node_Id;
 197    --  Boolean operations on boolean arrays are expanded in line. This function
 198    --  produce the body for the node N, which is (a and b), (a or b), or (a xor
 199    --  b). It is used only the normal case and not the packed case. The type
 200    --  involved, Typ, is the Boolean array type, and the logical operations in
 201    --  the body are simple boolean operations. Note that Typ is always a
 202    --  constrained type (the caller has ensured this by using
 203    --  Convert_To_Actual_Subtype if necessary).
 204
 205    procedure Optimize_Length_Comparison (N : Node_Id);
 206    --  Given an expression, if it is of the form X'Length op N (or the other
 207    --  way round), where N is known at compile time to be 0 or 1, and X is a
 208    --  simple entity, and op is a comparison operator, optimizes it into a
 209    --  comparison of First and Last.
 210
 211    procedure Rewrite_Comparison (N : Node_Id);
 212    --  If N is the node for a comparison whose outcome can be determined at
 213    --  compile time, then the node N can be rewritten with True or False. If
 214    --  the outcome cannot be determined at compile time, the call has no
 215    --  effect. If N is a type conversion, then this processing is applied to
 216    --  its expression. If N is neither comparison nor a type conversion, the
 217    --  call has no effect.
 218
 219    procedure Tagged_Membership
 220      (N         : Node_Id;
 221       SCIL_Node : out Node_Id;
 222       Result    : out Node_Id);
 223    --  Construct the expression corresponding to the tagged membership test.
 224    --  Deals with a second operand being (or not) a class-wide type.
 225
 226    function Safe_In_Place_Array_Op
 227      (Lhs : Node_Id;
 228       Op1 : Node_Id;
 229       Op2 : Node_Id) return Boolean;
 230    --  In the context of an assignment, where the right-hand side is a boolean
 231    --  operation on arrays, check whether operation can be performed in place.
 232
 233    procedure Unary_Op_Validity_Checks (N : Node_Id);
 234    pragma Inline (Unary_Op_Validity_Checks);
 235    --  Performs validity checks for a unary operator
 236
 237    -------------------------------
 238    -- Binary_Op_Validity_Checks --
 239    -------------------------------
 240
 241    procedure Binary_Op_Validity_Checks (N : Node_Id) is
 242    begin
 243       if Validity_Checks_On and Validity_Check_Operands then
 244          Ensure_Valid (Left_Opnd (N));
 245          Ensure_Valid (Right_Opnd (N));
 246       end if;
 247    end Binary_Op_Validity_Checks;
 248
 249    ------------------------------------
 250    -- Build_Boolean_Array_Proc_Call --
 251    ------------------------------------
 252
 253    procedure Build_Boolean_Array_Proc_Call
 254      (N   : Node_Id;
 255       Op1 : Node_Id;
 256       Op2 : Node_Id)
 257    is
 258       Loc       : constant Source_Ptr := Sloc (N);
 259       Kind      : constant Node_Kind := Nkind (Expression (N));
 260       Target    : constant Node_Id   :=
 261                     Make_Attribute_Reference (Loc,
 262                       Prefix         => Name (N),
 263                       Attribute_Name => Name_Address);
 264
 265       Arg1      : Node_Id := Op1;
 266       Arg2      : Node_Id := Op2;
 267       Call_Node : Node_Id;
 268       Proc_Name : Entity_Id;
 269
 270    begin
 271       if Kind = N_Op_Not then
 272          if Nkind (Op1) in N_Binary_Op then
 273
 274             --  Use negated version of the binary operators
 275
 276             if Nkind (Op1) = N_Op_And then
 277                Proc_Name := RTE (RE_Vector_Nand);
 278
 279             elsif Nkind (Op1) = N_Op_Or then
 280                Proc_Name := RTE (RE_Vector_Nor);
 281
 282             else pragma Assert (Nkind (Op1) = N_Op_Xor);
 283                Proc_Name := RTE (RE_Vector_Xor);
 284             end if;
 285
 286             Call_Node :=
 287               Make_Procedure_Call_Statement (Loc,
 288                 Name => New_Occurrence_Of (Proc_Name, Loc),
 289
 290                 Parameter_Associations => New_List (
 291                   Target,
 292                   Make_Attribute_Reference (Loc,
 293                     Prefix => Left_Opnd (Op1),
 294                     Attribute_Name => Name_Address),
 295
 296                   Make_Attribute_Reference (Loc,
 297                     Prefix => Right_Opnd (Op1),
 298                     Attribute_Name => Name_Address),
 299
 300                   Make_Attribute_Reference (Loc,
 301                     Prefix => Left_Opnd (Op1),
 302                     Attribute_Name => Name_Length)));
 303
 304          else
 305             Proc_Name := RTE (RE_Vector_Not);
 306
 307             Call_Node :=
 308               Make_Procedure_Call_Statement (Loc,
 309                 Name => New_Occurrence_Of (Proc_Name, Loc),
 310                 Parameter_Associations => New_List (
 311                   Target,
 312
 313                   Make_Attribute_Reference (Loc,
 314                     Prefix => Op1,
 315                     Attribute_Name => Name_Address),
 316
 317                   Make_Attribute_Reference (Loc,
 318                     Prefix => Op1,
 319                      Attribute_Name => Name_Length)));
 320          end if;
 321
 322       else
 323          --  We use the following equivalences:
 324
 325          --   (not X) or  (not Y)  =  not (X and Y)  =  Nand (X, Y)
 326          --   (not X) and (not Y)  =  not (X or Y)   =  Nor  (X, Y)
 327          --   (not X) xor (not Y)  =  X xor Y
 328          --   X       xor (not Y)  =  not (X xor Y)  =  Nxor (X, Y)
 329
 330          if Nkind (Op1) = N_Op_Not then
 331             Arg1 := Right_Opnd (Op1);
 332             Arg2 := Right_Opnd (Op2);
 333             if Kind = N_Op_And then
 334                Proc_Name := RTE (RE_Vector_Nor);
 335             elsif Kind = N_Op_Or then
 336                Proc_Name := RTE (RE_Vector_Nand);
 337             else
 338                Proc_Name := RTE (RE_Vector_Xor);
 339             end if;
 340
 341          else
 342             if Kind = N_Op_And then
 343                Proc_Name := RTE (RE_Vector_And);
 344             elsif Kind = N_Op_Or then
 345                Proc_Name := RTE (RE_Vector_Or);
 346             elsif Nkind (Op2) = N_Op_Not then
 347                Proc_Name := RTE (RE_Vector_Nxor);
 348                Arg2 := Right_Opnd (Op2);
 349             else
 350                Proc_Name := RTE (RE_Vector_Xor);
 351             end if;
 352          end if;
 353
 354          Call_Node :=
 355            Make_Procedure_Call_Statement (Loc,
 356              Name => New_Occurrence_Of (Proc_Name, Loc),
 357              Parameter_Associations => New_List (
 358                Target,
 359                Make_Attribute_Reference (Loc,
 360                  Prefix         => Arg1,
 361                  Attribute_Name => Name_Address),
 362                Make_Attribute_Reference (Loc,
 363                  Prefix         => Arg2,
 364                  Attribute_Name => Name_Address),
 365                Make_Attribute_Reference (Loc,
 366                  Prefix         => Arg1,
 367                  Attribute_Name => Name_Length)));
 368       end if;
 369
 370       Rewrite (N, Call_Node);
 371       Analyze (N);
 372
 373    exception
 374       when RE_Not_Available =>
 375          return;
 376    end Build_Boolean_Array_Proc_Call;
 377
 378    ------------------------------
 379    -- Current_Anonymous_Master --
 380    ------------------------------
 381
 382    function Current_Anonymous_Master return Entity_Id is
 383       Decls     : List_Id;
 384       Loc       : Source_Ptr;
 385       Subp_Body : Node_Id;
 386       Unit_Decl : Node_Id;
 387       Unit_Id   : Entity_Id;
 388
 389    begin
 390       Unit_Id := Cunit_Entity (Current_Sem_Unit);
 391
 392       --  Find the entity of the current unit
 393
 394       if Ekind (Unit_Id) = E_Subprogram_Body then
 395
 396          --  When processing subprogram bodies, the proper scope is always that
 397          --  of the spec.
 398
 399          Subp_Body := Unit_Id;
 400          while Present (Subp_Body)
 401            and then Nkind (Subp_Body) /= N_Subprogram_Body
 402          loop
 403             Subp_Body := Parent (Subp_Body);
 404          end loop;
 405
 406          Unit_Id := Corresponding_Spec (Subp_Body);
 407       end if;
 408
 409       Loc := Sloc (Unit_Id);
 410       Unit_Decl := Unit (Cunit (Current_Sem_Unit));
 411
 412       --  Find the declarations list of the current unit
 413
 414       if Nkind (Unit_Decl) = N_Package_Declaration then
 415          Unit_Decl := Specification (Unit_Decl);
 416          Decls := Visible_Declarations (Unit_Decl);
 417
 418          if No (Decls) then
 419             Decls := New_List (Make_Null_Statement (Loc));
 420             Set_Visible_Declarations (Unit_Decl, Decls);
 421
 422          elsif Is_Empty_List (Decls) then
 423             Append_To (Decls, Make_Null_Statement (Loc));
 424          end if;
 425
 426       else
 427          Decls := Declarations (Unit_Decl);
 428
 429          if No (Decls) then
 430             Decls := New_List (Make_Null_Statement (Loc));
 431             Set_Declarations (Unit_Decl, Decls);
 432
 433          elsif Is_Empty_List (Decls) then
 434             Append_To (Decls, Make_Null_Statement (Loc));
 435          end if;
 436       end if;
 437
 438       --  The current unit has an existing anonymous master, traverse its
 439       --  declarations and locate the entity.
 440
 441       if Has_Anonymous_Master (Unit_Id) then
 442          declare
 443             Decl       : Node_Id;
 444             Fin_Mas_Id : Entity_Id;
 445
 446          begin
 447             Decl := First (Decls);
 448             while Present (Decl) loop
 449
 450                --  Look for the first variable in the declarations whole type
 451                --  is Finalization_Master.
 452
 453                if Nkind (Decl) = N_Object_Declaration then
 454                   Fin_Mas_Id := Defining_Identifier (Decl);
 455
 456                   if Ekind (Fin_Mas_Id) = E_Variable
 457                     and then Etype (Fin_Mas_Id) = RTE (RE_Finalization_Master)
 458                   then
 459                      return Fin_Mas_Id;
 460                   end if;
 461                end if;
 462
 463                Next (Decl);
 464             end loop;
 465
 466             --  The master was not found even though the unit was labeled as
 467             --  having one.
 468
 469             raise Program_Error;
 470          end;
 471
 472       --  Create a new anonymous master
 473
 474       else
 475          declare
 476             First_Decl : constant Node_Id := First (Decls);
 477             Action     : Node_Id;
 478             Fin_Mas_Id : Entity_Id;
 479
 480          begin
 481             --  Since the master and its associated initialization is inserted
 482             --  at top level, use the scope of the unit when analyzing.
 483
 484             Push_Scope (Unit_Id);
 485
 486             --  Create the finalization master
 487
 488             Fin_Mas_Id :=
 489               Make_Defining_Identifier (Loc,
 490                 Chars => New_External_Name (Chars (Unit_Id), "AM"));
 491
 492             --  Generate:
 493             --    <Fin_Mas_Id> : Finalization_Master;
 494
 495             Action :=
 496               Make_Object_Declaration (Loc,
 497                 Defining_Identifier => Fin_Mas_Id,
 498                 Object_Definition =>
 499                   New_Reference_To (RTE (RE_Finalization_Master), Loc));
 500
 501             Insert_Before_And_Analyze (First_Decl, Action);
 502
 503             --  Mark the unit to prevent the generation of multiple masters
 504
 505             Set_Has_Anonymous_Master (Unit_Id);
 506
 507             --  Do not set the base pool and mode of operation on .NET/JVM
 508             --  since those targets do not support pools and all VM masters
 509             --  are heterogeneous by default.
 510
 511             if VM_Target = No_VM then
 512
 513                --  Generate:
 514                --    Set_Base_Pool
 515                --      (<Fin_Mas_Id>, Global_Pool_Object'Unrestricted_Access);
 516
 517                Action :=
 518                  Make_Procedure_Call_Statement (Loc,
 519                    Name =>
 520                      New_Reference_To (RTE (RE_Set_Base_Pool), Loc),
 521
 522                    Parameter_Associations => New_List (
 523                      New_Reference_To (Fin_Mas_Id, Loc),
 524                      Make_Attribute_Reference (Loc,
 525                        Prefix =>
 526                          New_Reference_To (RTE (RE_Global_Pool_Object), Loc),
 527                        Attribute_Name => Name_Unrestricted_Access)));
 528
 529                Insert_Before_And_Analyze (First_Decl, Action);
 530
 531                --  Generate:
 532                --    Set_Is_Heterogeneous (<Fin_Mas_Id>);
 533
 534                Action :=
 535                  Make_Procedure_Call_Statement (Loc,
 536                    Name =>
 537                      New_Reference_To (RTE (RE_Set_Is_Heterogeneous), Loc),
 538                    Parameter_Associations => New_List (
 539                      New_Reference_To (Fin_Mas_Id, Loc)));
 540
 541                Insert_Before_And_Analyze (First_Decl, Action);
 542             end if;
 543
 544             --  Restore the original state of the scope stack
 545
 546             Pop_Scope;
 547
 548             return Fin_Mas_Id;
 549          end;
 550       end if;
 551    end Current_Anonymous_Master;
 552
 553    --------------------------------
 554    -- Displace_Allocator_Pointer --
 555    --------------------------------
 556
 557    procedure Displace_Allocator_Pointer (N : Node_Id) is
 558       Loc       : constant Source_Ptr := Sloc (N);
 559       Orig_Node : constant Node_Id := Original_Node (N);
 560       Dtyp      : Entity_Id;
 561       Etyp      : Entity_Id;
 562       PtrT      : Entity_Id;
 563
 564    begin
 565       --  Do nothing in case of VM targets: the virtual machine will handle
 566       --  interfaces directly.
 567
 568       if not Tagged_Type_Expansion then
 569          return;
 570       end if;
 571
 572       pragma Assert (Nkind (N) = N_Identifier
 573         and then Nkind (Orig_Node) = N_Allocator);
 574
 575       PtrT := Etype (Orig_Node);
 576       Dtyp := Available_View (Designated_Type (PtrT));
 577       Etyp := Etype (Expression (Orig_Node));
 578
 579       if Is_Class_Wide_Type (Dtyp)
 580         and then Is_Interface (Dtyp)
 581       then
 582          --  If the type of the allocator expression is not an interface type
 583          --  we can generate code to reference the record component containing
 584          --  the pointer to the secondary dispatch table.
 585
 586          if not Is_Interface (Etyp) then
 587             declare
 588                Saved_Typ : constant Entity_Id := Etype (Orig_Node);
 589
 590             begin
 591                --  1) Get access to the allocated object
 592
 593                Rewrite (N,
 594                  Make_Explicit_Dereference (Loc,
 595                    Relocate_Node (N)));
 596                Set_Etype (N, Etyp);
 597                Set_Analyzed (N);
 598
 599                --  2) Add the conversion to displace the pointer to reference
 600                --     the secondary dispatch table.
 601
 602                Rewrite (N, Convert_To (Dtyp, Relocate_Node (N)));
 603                Analyze_And_Resolve (N, Dtyp);
 604
 605                --  3) The 'access to the secondary dispatch table will be used
 606                --     as the value returned by the allocator.
 607
 608                Rewrite (N,
 609                  Make_Attribute_Reference (Loc,
 610                    Prefix         => Relocate_Node (N),
 611                    Attribute_Name => Name_Access));
 612                Set_Etype (N, Saved_Typ);
 613                Set_Analyzed (N);
 614             end;
 615
 616          --  If the type of the allocator expression is an interface type we
 617          --  generate a run-time call to displace "this" to reference the
 618          --  component containing the pointer to the secondary dispatch table
 619          --  or else raise Constraint_Error if the actual object does not
 620          --  implement the target interface. This case corresponds with the
 621          --  following example:
 622
 623          --   function Op (Obj : Iface_1'Class) return access Iface_2'Class is
 624          --   begin
 625          --      return new Iface_2'Class'(Obj);
 626          --   end Op;
 627
 628          else
 629             Rewrite (N,
 630               Unchecked_Convert_To (PtrT,
 631                 Make_Function_Call (Loc,
 632                   Name => New_Reference_To (RTE (RE_Displace), Loc),
 633                   Parameter_Associations => New_List (
 634                     Unchecked_Convert_To (RTE (RE_Address),
 635                       Relocate_Node (N)),
 636
 637                     New_Occurrence_Of
 638                       (Elists.Node
 639                         (First_Elmt
 640                           (Access_Disp_Table (Etype (Base_Type (Dtyp))))),
 641                        Loc)))));
 642             Analyze_And_Resolve (N, PtrT);
 643          end if;
 644       end if;
 645    end Displace_Allocator_Pointer;
 646
 647    ---------------------------------
 648    -- Expand_Allocator_Expression --
 649    ---------------------------------
 650
 651    procedure Expand_Allocator_Expression (N : Node_Id) is
 652       Loc    : constant Source_Ptr := Sloc (N);
 653       Exp    : constant Node_Id    := Expression (Expression (N));
 654       PtrT   : constant Entity_Id  := Etype (N);
 655       DesigT : constant Entity_Id  := Designated_Type (PtrT);
 656
 657       procedure Apply_Accessibility_Check
 658         (Ref            : Node_Id;
 659          Built_In_Place : Boolean := False);
 660       --  Ada 2005 (AI-344): For an allocator with a class-wide designated
 661       --  type, generate an accessibility check to verify that the level of the
 662       --  type of the created object is not deeper than the level of the access
 663       --  type. If the type of the qualified expression is class- wide, then
 664       --  always generate the check (except in the case where it is known to be
 665       --  unnecessary, see comment below). Otherwise, only generate the check
 666       --  if the level of the qualified expression type is statically deeper
 667       --  than the access type.
 668       --
 669       --  Although the static accessibility will generally have been performed
 670       --  as a legality check, it won't have been done in cases where the
 671       --  allocator appears in generic body, so a run-time check is needed in
 672       --  general. One special case is when the access type is declared in the
 673       --  same scope as the class-wide allocator, in which case the check can
 674       --  never fail, so it need not be generated.
 675       --
 676       --  As an open issue, there seem to be cases where the static level
 677       --  associated with the class-wide object's underlying type is not
 678       --  sufficient to perform the proper accessibility check, such as for
 679       --  allocators in nested subprograms or accept statements initialized by
 680       --  class-wide formals when the actual originates outside at a deeper
 681       --  static level. The nested subprogram case might require passing
 682       --  accessibility levels along with class-wide parameters, and the task
 683       --  case seems to be an actual gap in the language rules that needs to
 684       --  be fixed by the ARG. ???
 685
 686       -------------------------------
 687       -- Apply_Accessibility_Check --
 688       -------------------------------
 689
 690       procedure Apply_Accessibility_Check
 691         (Ref            : Node_Id;
 692          Built_In_Place : Boolean := False)
 693       is
 694          New_Node : Node_Id;
 695
 696       begin
 697          if Ada_Version >= Ada_2005
 698            and then Is_Class_Wide_Type (DesigT)
 699            and then not Scope_Suppress (Accessibility_Check)
 700            and then
 701              (Type_Access_Level (Etype (Exp)) > Type_Access_Level (PtrT)
 702                or else
 703                  (Is_Class_Wide_Type (Etype (Exp))
 704                    and then Scope (PtrT) /= Current_Scope))
 705          then
 706             --  If the allocator was built in place Ref is already a reference
 707             --  to the access object initialized to the result of the allocator
 708             --  (see Exp_Ch6.Make_Build_In_Place_Call_In_Allocator). Otherwise
 709             --  it is the entity associated with the object containing the
 710             --  address of the allocated object.
 711
 712             if Built_In_Place then
 713                New_Node := New_Copy (Ref);
 714             else
 715                New_Node := New_Reference_To (Ref, Loc);
 716             end if;
 717
 718             New_Node :=
 719               Make_Attribute_Reference (Loc,
 720                 Prefix         => New_Node,
 721                 Attribute_Name => Name_Tag);
 722
 723             if Tagged_Type_Expansion then
 724                New_Node := Build_Get_Access_Level (Loc, New_Node);
 725
 726             elsif VM_Target /= No_VM then
 727                New_Node :=
 728                  Make_Function_Call (Loc,
 729                    Name => New_Reference_To (RTE (RE_Get_Access_Level), Loc),
 730                    Parameter_Associations => New_List (New_Node));
 731
 732             --  Cannot generate the runtime check
 733
 734             else
 735                return;
 736             end if;
 737
 738             Insert_Action (N,
 739               Make_Raise_Program_Error (Loc,
 740                 Condition =>
 741                   Make_Op_Gt (Loc,
 742                     Left_Opnd  => New_Node,
 743                     Right_Opnd =>
 744                       Make_Integer_Literal (Loc, Type_Access_Level (PtrT))),
 745                 Reason => PE_Accessibility_Check_Failed));
 746          end if;
 747       end Apply_Accessibility_Check;
 748
 749       --  Local variables
 750
 751       Aggr_In_Place : constant Boolean   := Is_Delayed_Aggregate (Exp);
 752       Indic         : constant Node_Id   := Subtype_Mark (Expression (N));
 753       T             : constant Entity_Id := Entity (Indic);
 754       Node          : Node_Id;
 755       Tag_Assign    : Node_Id;
 756       Temp          : Entity_Id;
 757       Temp_Decl     : Node_Id;
 758
 759       TagT : Entity_Id := Empty;
 760       --  Type used as source for tag assignment
 761
 762       TagR : Node_Id := Empty;
 763       --  Target reference for tag assignment
 764
 765    --  Start of processing for Expand_Allocator_Expression
 766
 767    begin
 768       --  In the case of an Ada 2012 allocator whose initial value comes from a
 769       --  function call, pass "the accessibility level determined by the point
 770       --  of call" (AI05-0234) to the function. Conceptually, this belongs in
 771       --  Expand_Call but it couldn't be done there (because the Etype of the
 772       --  allocator wasn't set then) so we generate the parameter here. See
 773       --  the Boolean variable Defer in (a block within) Expand_Call.
 774
 775       if Ada_Version >= Ada_2012 and then Nkind (Exp) = N_Function_Call then
 776          declare
 777             Subp : Entity_Id;
 778
 779          begin
 780             if Nkind (Name (Exp)) = N_Explicit_Dereference then
 781                Subp := Designated_Type (Etype (Prefix (Name (Exp))));
 782             else
 783                Subp := Entity (Name (Exp));
 784             end if;
 785
 786             Subp := Ultimate_Alias (Subp);
 787
 788             if Present (Extra_Accessibility_Of_Result (Subp)) then
 789                Add_Extra_Actual_To_Call
 790                  (Subprogram_Call => Exp,
 791                   Extra_Formal    => Extra_Accessibility_Of_Result (Subp),
 792                   Extra_Actual    => Dynamic_Accessibility_Level (PtrT));
 793             end if;
 794          end;
 795       end if;
 796
 797       --  Would be nice to comment the branches of this very long if ???
 798
 799       if Is_Tagged_Type (T) or else Needs_Finalization (T) then
 800          if Is_CPP_Constructor_Call (Exp) then
 801
 802             --  Generate:
 803             --    Pnnn : constant ptr_T := new (T);
 804             --    Init (Pnnn.all,...);
 805
 806             --  Allocate the object without an expression
 807
 808             Node := Relocate_Node (N);
 809             Set_Expression (Node, New_Reference_To (Etype (Exp), Loc));
 810
 811             --  Avoid its expansion to avoid generating a call to the default
 812             --  C++ constructor.
 813
 814             Set_Analyzed (Node);
 815
 816             Temp := Make_Temporary (Loc, 'P', N);
 817
 818             Temp_Decl :=
 819               Make_Object_Declaration (Loc,
 820                 Defining_Identifier => Temp,
 821                 Constant_Present    => True,
 822                 Object_Definition   => New_Reference_To (PtrT, Loc),
 823                 Expression          => Node);
 824             Insert_Action (N, Temp_Decl);
 825
 826             Apply_Accessibility_Check (Temp);
 827
 828             --  Locate the enclosing list and insert the C++ constructor call
 829
 830             declare
 831                P : Node_Id;
 832
 833             begin
 834                P := Parent (Node);
 835                while not Is_List_Member (P) loop
 836                   P := Parent (P);
 837                end loop;
 838
 839                Insert_List_After_And_Analyze (P,
 840                  Build_Initialization_Call (Loc,
 841                    Id_Ref          =>
 842                      Make_Explicit_Dereference (Loc,
 843                        Prefix => New_Reference_To (Temp, Loc)),
 844                    Typ             => Etype (Exp),
 845                    Constructor_Ref => Exp));
 846             end;
 847
 848             Rewrite (N, New_Reference_To (Temp, Loc));
 849             Analyze_And_Resolve (N, PtrT);
 850             return;
 851          end if;
 852
 853          --  Ada 2005 (AI-318-02): If the initialization expression is a call
 854          --  to a build-in-place function, then access to the allocated object
 855          --  must be passed to the function. Currently we limit such functions
 856          --  to those with constrained limited result subtypes, but eventually
 857          --  we plan to expand the allowed forms of functions that are treated
 858          --  as build-in-place.
 859
 860          if Ada_Version >= Ada_2005
 861            and then Is_Build_In_Place_Function_Call (Exp)
 862          then
 863             Make_Build_In_Place_Call_In_Allocator (N, Exp);
 864             Apply_Accessibility_Check (N, Built_In_Place => True);
 865             return;
 866          end if;
 867
 868          --  Actions inserted before:
 869          --    Temp : constant ptr_T := new T'(Expression);
 870          --    Temp._tag = T'tag;  --  when not class-wide
 871          --    [Deep_]Adjust (Temp.all);
 872
 873          --  We analyze by hand the new internal allocator to avoid any
 874          --  recursion and inappropriate call to Initialize
 875
 876          --  We don't want to remove side effects when the expression must be
 877          --  built in place. In the case of a build-in-place function call,
 878          --  that could lead to a duplication of the call, which was already
 879          --  substituted for the allocator.
 880
 881          if not Aggr_In_Place then
 882             Remove_Side_Effects (Exp);
 883          end if;
 884
 885          Temp := Make_Temporary (Loc, 'P', N);
 886
 887          --  For a class wide allocation generate the following code:
 888
 889          --    type Equiv_Record is record ... end record;
 890          --    implicit subtype CW is <Class_Wide_Subytpe>;
 891          --    temp : PtrT := new CW'(CW!(expr));
 892
 893          if Is_Class_Wide_Type (T) then
 894             Expand_Subtype_From_Expr (Empty, T, Indic, Exp);
 895
 896             --  Ada 2005 (AI-251): If the expression is a class-wide interface
 897             --  object we generate code to move up "this" to reference the
 898             --  base of the object before allocating the new object.
 899
 900             --  Note that Exp'Address is recursively expanded into a call
 901             --  to Base_Address (Exp.Tag)
 902
 903             if Is_Class_Wide_Type (Etype (Exp))
 904               and then Is_Interface (Etype (Exp))
 905               and then Tagged_Type_Expansion
 906             then
 907                Set_Expression
 908                  (Expression (N),
 909                   Unchecked_Convert_To (Entity (Indic),
 910                     Make_Explicit_Dereference (Loc,
 911                       Unchecked_Convert_To (RTE (RE_Tag_Ptr),
 912                         Make_Attribute_Reference (Loc,
 913                           Prefix         => Exp,
 914                           Attribute_Name => Name_Address)))));
 915             else
 916                Set_Expression
 917                  (Expression (N),
 918                   Unchecked_Convert_To (Entity (Indic), Exp));
 919             end if;
 920
 921             Analyze_And_Resolve (Expression (N), Entity (Indic));
 922          end if;
 923
 924          --  Processing for allocators returning non-interface types
 925
 926          if not Is_Interface (Directly_Designated_Type (PtrT)) then
 927             if Aggr_In_Place then
 928                Temp_Decl :=
 929                  Make_Object_Declaration (Loc,
 930                    Defining_Identifier => Temp,
 931                    Object_Definition   => New_Reference_To (PtrT, Loc),
 932                    Expression          =>
 933                      Make_Allocator (Loc,
 934                        Expression =>
 935                          New_Reference_To (Etype (Exp), Loc)));
 936
 937                --  Copy the Comes_From_Source flag for the allocator we just
 938                --  built, since logically this allocator is a replacement of
 939                --  the original allocator node. This is for proper handling of
 940                --  restriction No_Implicit_Heap_Allocations.
 941
 942                Set_Comes_From_Source
 943                  (Expression (Temp_Decl), Comes_From_Source (N));
 944
 945                Set_No_Initialization (Expression (Temp_Decl));
 946                Insert_Action (N, Temp_Decl);
 947
 948                Build_Allocate_Deallocate_Proc (Temp_Decl, True);
 949                Convert_Aggr_In_Allocator (N, Temp_Decl, Exp);
 950
 951                --  Attach the object to the associated finalization master.
 952                --  This is done manually on .NET/JVM since those compilers do
 953                --  no support pools and can't benefit from internally generated
 954                --  Allocate / Deallocate procedures.
 955
 956                if VM_Target /= No_VM
 957                  and then Is_Controlled (DesigT)
 958                  and then Present (Finalization_Master (PtrT))
 959                then
 960                   Insert_Action (N,
 961                     Make_Attach_Call (
 962                       Obj_Ref =>
 963                         New_Reference_To (Temp, Loc),
 964                       Ptr_Typ => PtrT));
 965                end if;
 966
 967             else
 968                Node := Relocate_Node (N);
 969                Set_Analyzed (Node);
 970
 971                Temp_Decl :=
 972                  Make_Object_Declaration (Loc,
 973                    Defining_Identifier => Temp,
 974                    Constant_Present    => True,
 975                    Object_Definition   => New_Reference_To (PtrT, Loc),
 976                    Expression          => Node);
 977
 978                Insert_Action (N, Temp_Decl);
 979                Build_Allocate_Deallocate_Proc (Temp_Decl, True);
 980
 981                --  Attach the object to the associated finalization master.
 982                --  This is done manually on .NET/JVM since those compilers do
 983                --  no support pools and can't benefit from internally generated
 984                --  Allocate / Deallocate procedures.
 985
 986                if VM_Target /= No_VM
 987                  and then Is_Controlled (DesigT)
 988                  and then Present (Finalization_Master (PtrT))
 989                then
 990                   Insert_Action (N,
 991                     Make_Attach_Call (
 992                       Obj_Ref =>
 993                         New_Reference_To (Temp, Loc),
 994                       Ptr_Typ => PtrT));
 995                end if;
 996             end if;
 997
 998          --  Ada 2005 (AI-251): Handle allocators whose designated type is an
 999          --  interface type. In this case we use the type of the qualified
1000          --  expression to allocate the object.
1001
1002          else
1003             declare
1004                Def_Id   : constant Entity_Id := Make_Temporary (Loc, 'T');
1005                New_Decl : Node_Id;
1006
1007             begin
1008                New_Decl :=
1009                  Make_Full_Type_Declaration (Loc,
1010                    Defining_Identifier => Def_Id,
1011                    Type_Definition =>
1012                      Make_Access_To_Object_Definition (Loc,
1013                        All_Present            => True,
1014                        Null_Exclusion_Present => False,
1015                        Constant_Present       => False,
1016                        Subtype_Indication     =>
1017                          New_Reference_To (Etype (Exp), Loc)));
1018
1019                Insert_Action (N, New_Decl);
1020
1021                --  Inherit the allocation-related attributes from the original
1022                --  access type.
1023
1024                Set_Finalization_Master (Def_Id, Finalization_Master (PtrT));
1025
1026                Set_Associated_Storage_Pool (Def_Id,
1027                  Associated_Storage_Pool (PtrT));
1028
1029                --  Declare the object using the previous type declaration
1030
1031                if Aggr_In_Place then
1032                   Temp_Decl :=
1033                     Make_Object_Declaration (Loc,
1034                       Defining_Identifier => Temp,
1035                       Object_Definition   => New_Reference_To (Def_Id, Loc),
1036                       Expression          =>
1037                         Make_Allocator (Loc,
1038                           New_Reference_To (Etype (Exp), Loc)));
1039
1040                   --  Copy the Comes_From_Source flag for the allocator we just
1041                   --  built, since logically this allocator is a replacement of
1042                   --  the original allocator node. This is for proper handling
1043                   --  of restriction No_Implicit_Heap_Allocations.
1044
1045                   Set_Comes_From_Source
1046                     (Expression (Temp_Decl), Comes_From_Source (N));
1047
1048                   Set_No_Initialization (Expression (Temp_Decl));
1049                   Insert_Action (N, Temp_Decl);
1050
1051                   Build_Allocate_Deallocate_Proc (Temp_Decl, True);
1052                   Convert_Aggr_In_Allocator (N, Temp_Decl, Exp);
1053
1054                else
1055                   Node := Relocate_Node (N);
1056                   Set_Analyzed (Node);
1057
1058                   Temp_Decl :=
1059                     Make_Object_Declaration (Loc,
1060                       Defining_Identifier => Temp,
1061                       Constant_Present    => True,
1062                       Object_Definition   => New_Reference_To (Def_Id, Loc),
1063                       Expression          => Node);
1064
1065                   Insert_Action (N, Temp_Decl);
1066                   Build_Allocate_Deallocate_Proc (Temp_Decl, True);
1067                end if;
1068
1069                --  Generate an additional object containing the address of the
1070                --  returned object. The type of this second object declaration
1071                --  is the correct type required for the common processing that
1072                --  is still performed by this subprogram. The displacement of
1073                --  this pointer to reference the component associated with the
1074                --  interface type will be done at the end of common processing.
1075
1076                New_Decl :=
1077                  Make_Object_Declaration (Loc,
1078                    Defining_Identifier => Make_Temporary (Loc, 'P'),
1079                    Object_Definition   => New_Reference_To (PtrT, Loc),
1080                    Expression          =>
1081                      Unchecked_Convert_To (PtrT,
1082                        New_Reference_To (Temp, Loc)));
1083
1084                Insert_Action (N, New_Decl);
1085
1086                Temp_Decl := New_Decl;
1087                Temp      := Defining_Identifier (New_Decl);
1088             end;
1089          end if;
1090
1091          Apply_Accessibility_Check (Temp);
1092
1093          --  Generate the tag assignment
1094
1095          --  Suppress the tag assignment when VM_Target because VM tags are
1096          --  represented implicitly in objects.
1097
1098          if not Tagged_Type_Expansion then
1099             null;
1100
1101          --  Ada 2005 (AI-251): Suppress the tag assignment with class-wide
1102          --  interface objects because in this case the tag does not change.
1103
1104          elsif Is_Interface (Directly_Designated_Type (Etype (N))) then
1105             pragma Assert (Is_Class_Wide_Type
1106                             (Directly_Designated_Type (Etype (N))));
1107             null;
1108
1109          elsif Is_Tagged_Type (T) and then not Is_Class_Wide_Type (T) then
1110             TagT := T;
1111             TagR := New_Reference_To (Temp, Loc);
1112
1113          elsif Is_Private_Type (T)
1114            and then Is_Tagged_Type (Underlying_Type (T))
1115          then
1116             TagT := Underlying_Type (T);
1117             TagR :=
1118               Unchecked_Convert_To (Underlying_Type (T),
1119                 Make_Explicit_Dereference (Loc,
1120                   Prefix => New_Reference_To (Temp, Loc)));
1121          end if;
1122
1123          if Present (TagT) then
1124             declare
1125                Full_T : constant Entity_Id := Underlying_Type (TagT);
1126             begin
1127                Tag_Assign :=
1128                  Make_Assignment_Statement (Loc,
1129                    Name =>
1130                      Make_Selected_Component (Loc,
1131                        Prefix => TagR,
1132                        Selector_Name =>
1133                          New_Reference_To (First_Tag_Component (Full_T), Loc)),
1134                    Expression =>
1135                      Unchecked_Convert_To (RTE (RE_Tag),
1136                        New_Reference_To
1137                          (Elists.Node
1138                            (First_Elmt (Access_Disp_Table (Full_T))), Loc)));
1139             end;
1140
1141             --  The previous assignment has to be done in any case
1142
1143             Set_Assignment_OK (Name (Tag_Assign));
1144             Insert_Action (N, Tag_Assign);
1145          end if;
1146
1147          if Needs_Finalization (DesigT)
1148             and then Needs_Finalization (T)
1149          then
1150             --  Generate an Adjust call if the object will be moved. In Ada
1151             --  2005, the object may be inherently limited, in which case
1152             --  there is no Adjust procedure, and the object is built in
1153             --  place. In Ada 95, the object can be limited but not
1154             --  inherently limited if this allocator came from a return
1155             --  statement (we're allocating the result on the secondary
1156             --  stack). In that case, the object will be moved, so we _do_
1157             --  want to Adjust.
1158
1159             if not Aggr_In_Place
1160               and then not Is_Immutably_Limited_Type (T)
1161             then
1162                Insert_Action (N,
1163                  Make_Adjust_Call (
1164                    Obj_Ref    =>
1165
1166                      --  An unchecked conversion is needed in the classwide
1167                      --  case because the designated type can be an ancestor
1168                      --  of the subtype mark of the allocator.
1169
1170                      Unchecked_Convert_To (T,
1171                        Make_Explicit_Dereference (Loc,
1172                          Prefix => New_Reference_To (Temp, Loc))),
1173                    Typ => T));
1174             end if;
1175
1176             --  Generate:
1177             --    Set_Finalize_Address (<PtrT>FM, <T>FD'Unrestricted_Access);
1178
1179             --  Do not generate this call in the following cases:
1180
1181             --    * .NET/JVM - these targets do not support address arithmetic
1182             --    and unchecked conversion, key elements of Finalize_Address.
1183
1184             --    * Alfa mode - the call is useless and results in unwanted
1185             --    expansion.
1186
1187             --    * CodePeer mode - TSS primitive Finalize_Address is not
1188             --    created in this mode.
1189
1190             if VM_Target = No_VM
1191               and then not Alfa_Mode
1192               and then not CodePeer_Mode
1193               and then Present (Finalization_Master (PtrT))
1194               and then Present (Temp_Decl)
1195               and then Nkind (Expression (Temp_Decl)) = N_Allocator
1196             then
1197                Insert_Action (N,
1198                  Make_Set_Finalize_Address_Call
1199                    (Loc     => Loc,
1200                     Typ     => T,
1201                     Ptr_Typ => PtrT));
1202             end if;
1203          end if;
1204
1205          Rewrite (N, New_Reference_To (Temp, Loc));
1206          Analyze_And_Resolve (N, PtrT);
1207
1208          --  Ada 2005 (AI-251): Displace the pointer to reference the record
1209          --  component containing the secondary dispatch table of the interface
1210          --  type.
1211
1212          if Is_Interface (Directly_Designated_Type (PtrT)) then
1213             Displace_Allocator_Pointer (N);
1214          end if;
1215
1216       elsif Aggr_In_Place then
1217          Temp := Make_Temporary (Loc, 'P', N);
1218          Temp_Decl :=
1219            Make_Object_Declaration (Loc,
1220              Defining_Identifier => Temp,
1221              Object_Definition   => New_Reference_To (PtrT, Loc),
1222              Expression          =>
1223                Make_Allocator (Loc,
1224                  Expression => New_Reference_To (Etype (Exp), Loc)));
1225
1226          --  Copy the Comes_From_Source flag for the allocator we just built,
1227          --  since logically this allocator is a replacement of the original
1228          --  allocator node. This is for proper handling of restriction
1229          --  No_Implicit_Heap_Allocations.
1230
1231          Set_Comes_From_Source
1232            (Expression (Temp_Decl), Comes_From_Source (N));
1233
1234          Set_No_Initialization (Expression (Temp_Decl));
1235          Insert_Action (N, Temp_Decl);
1236
1237          Build_Allocate_Deallocate_Proc (Temp_Decl, True);
1238          Convert_Aggr_In_Allocator (N, Temp_Decl, Exp);
1239
1240          --  Attach the object to the associated finalization master. Thisis
1241          --  done manually on .NET/JVM since those compilers do no support
1242          --  pools and cannot benefit from internally generated Allocate and
1243          --  Deallocate procedures.
1244
1245          if VM_Target /= No_VM
1246            and then Is_Controlled (DesigT)
1247            and then Present (Finalization_Master (PtrT))
1248          then
1249             Insert_Action (N,
1250               Make_Attach_Call
1251                 (Obj_Ref => New_Reference_To (Temp, Loc),
1252                  Ptr_Typ => PtrT));
1253          end if;
1254
1255          Rewrite (N, New_Reference_To (Temp, Loc));
1256          Analyze_And_Resolve (N, PtrT);
1257
1258       elsif Is_Access_Type (T)
1259         and then Can_Never_Be_Null (T)
1260       then
1261          Install_Null_Excluding_Check (Exp);
1262
1263       elsif Is_Access_Type (DesigT)
1264         and then Nkind (Exp) = N_Allocator
1265         and then Nkind (Expression (Exp)) /= N_Qualified_Expression
1266       then
1267          --  Apply constraint to designated subtype indication
1268
1269          Apply_Constraint_Check (Expression (Exp),
1270            Designated_Type (DesigT),
1271            No_Sliding => True);
1272
1273          if Nkind (Expression (Exp)) = N_Raise_Constraint_Error then
1274
1275             --  Propagate constraint_error to enclosing allocator
1276
1277             Rewrite (Exp, New_Copy (Expression (Exp)));
1278          end if;
1279
1280       else
1281          Build_Allocate_Deallocate_Proc (N, True);
1282
1283          --  If we have:
1284          --    type A is access T1;
1285          --    X : A := new T2'(...);
1286          --  T1 and T2 can be different subtypes, and we might need to check
1287          --  both constraints. First check against the type of the qualified
1288          --  expression.
1289
1290          Apply_Constraint_Check (Exp, T, No_Sliding => True);
1291
1292          if Do_Range_Check (Exp) then
1293             Set_Do_Range_Check (Exp, False);
1294             Generate_Range_Check (Exp, DesigT, CE_Range_Check_Failed);
1295          end if;
1296
1297          --  A check is also needed in cases where the designated subtype is
1298          --  constrained and differs from the subtype given in the qualified
1299          --  expression. Note that the check on the qualified expression does
1300          --  not allow sliding, but this check does (a relaxation from Ada 83).
1301
1302          if Is_Constrained (DesigT)
1303            and then not Subtypes_Statically_Match (T, DesigT)
1304          then
1305             Apply_Constraint_Check
1306               (Exp, DesigT, No_Sliding => False);
1307
1308             if Do_Range_Check (Exp) then
1309                Set_Do_Range_Check (Exp, False);
1310                Generate_Range_Check (Exp, DesigT, CE_Range_Check_Failed);
1311             end if;
1312          end if;
1313
1314          --  For an access to unconstrained packed array, GIGI needs to see an
1315          --  expression with a constrained subtype in order to compute the
1316          --  proper size for the allocator.
1317
1318          if Is_Array_Type (T)
1319            and then not Is_Constrained (T)
1320            and then Is_Packed (T)
1321          then
1322             declare
1323                ConstrT      : constant Entity_Id := Make_Temporary (Loc, 'A');
1324                Internal_Exp : constant Node_Id   := Relocate_Node (Exp);
1325             begin
1326                Insert_Action (Exp,
1327                  Make_Subtype_Declaration (Loc,
1328                    Defining_Identifier => ConstrT,
1329                    Subtype_Indication  =>
1330                      Make_Subtype_From_Expr (Internal_Exp, T)));
1331                Freeze_Itype (ConstrT, Exp);
1332                Rewrite (Exp, OK_Convert_To (ConstrT, Internal_Exp));
1333             end;
1334          end if;
1335
1336          --  Ada 2005 (AI-318-02): If the initialization expression is a call
1337          --  to a build-in-place function, then access to the allocated object
1338          --  must be passed to the function. Currently we limit such functions
1339          --  to those with constrained limited result subtypes, but eventually
1340          --  we plan to expand the allowed forms of functions that are treated
1341          --  as build-in-place.
1342
1343          if Ada_Version >= Ada_2005
1344            and then Is_Build_In_Place_Function_Call (Exp)
1345          then
1346             Make_Build_In_Place_Call_In_Allocator (N, Exp);
1347          end if;
1348       end if;
1349
1350    exception
1351       when RE_Not_Available =>
1352          return;
1353    end Expand_Allocator_Expression;
1354
1355    -----------------------------
1356    -- Expand_Array_Comparison --
1357    -----------------------------
1358
1359    --  Expansion is only required in the case of array types. For the unpacked
1360    --  case, an appropriate runtime routine is called. For packed cases, and
1361    --  also in some other cases where a runtime routine cannot be called, the
1362    --  form of the expansion is:
1363
1364    --     [body for greater_nn; boolean_expression]
1365
1366    --  The body is built by Make_Array_Comparison_Op, and the form of the
1367    --  Boolean expression depends on the operator involved.
1368
1369    procedure Expand_Array_Comparison (N : Node_Id) is
1370       Loc  : constant Source_Ptr := Sloc (N);
1371       Op1  : Node_Id             := Left_Opnd (N);
1372       Op2  : Node_Id             := Right_Opnd (N);
1373       Typ1 : constant Entity_Id  := Base_Type (Etype (Op1));
1374       Ctyp : constant Entity_Id  := Component_Type (Typ1);
1375
1376       Expr      : Node_Id;
1377       Func_Body : Node_Id;
1378       Func_Name : Entity_Id;
1379
1380       Comp : RE_Id;
1381
1382       Byte_Addressable : constant Boolean := System_Storage_Unit = Byte'Size;
1383       --  True for byte addressable target
1384
1385       function Length_Less_Than_4 (Opnd : Node_Id) return Boolean;
1386       --  Returns True if the length of the given operand is known to be less
1387       --  than 4. Returns False if this length is known to be four or greater
1388       --  or is not known at compile time.
1389
1390       ------------------------
1391       -- Length_Less_Than_4 --
1392       ------------------------
1393
1394       function Length_Less_Than_4 (Opnd : Node_Id) return Boolean is
1395          Otyp : constant Entity_Id := Etype (Opnd);
1396
1397       begin
1398          if Ekind (Otyp) = E_String_Literal_Subtype then
1399             return String_Literal_Length (Otyp) < 4;
1400
1401          else
1402             declare
1403                Ityp : constant Entity_Id := Etype (First_Index (Otyp));
1404                Lo   : constant Node_Id   := Type_Low_Bound (Ityp);
1405                Hi   : constant Node_Id   := Type_High_Bound (Ityp);
1406                Lov  : Uint;
1407                Hiv  : Uint;
1408
1409             begin
1410                if Compile_Time_Known_Value (Lo) then
1411                   Lov := Expr_Value (Lo);
1412                else
1413                   return False;
1414                end if;
1415
1416                if Compile_Time_Known_Value (Hi) then
1417                   Hiv := Expr_Value (Hi);
1418                else
1419                   return False;
1420                end if;
1421
1422                return Hiv < Lov + 3;
1423             end;
1424          end if;
1425       end Length_Less_Than_4;
1426
1427    --  Start of processing for Expand_Array_Comparison
1428
1429    begin
1430       --  Deal first with unpacked case, where we can call a runtime routine
1431       --  except that we avoid this for targets for which are not addressable
1432       --  by bytes, and for the JVM/CIL, since they do not support direct
1433       --  addressing of array components.
1434
1435       if not Is_Bit_Packed_Array (Typ1)
1436         and then Byte_Addressable
1437         and then VM_Target = No_VM
1438       then
1439          --  The call we generate is:
1440
1441          --  Compare_Array_xn[_Unaligned]
1442          --    (left'address, right'address, left'length, right'length) <op> 0
1443
1444          --  x = U for unsigned, S for signed
1445          --  n = 8,16,32,64 for component size
1446          --  Add _Unaligned if length < 4 and component size is 8.
1447          --  <op> is the standard comparison operator
1448
1449          if Component_Size (Typ1) = 8 then
1450             if Length_Less_Than_4 (Op1)
1451                  or else
1452                Length_Less_Than_4 (Op2)
1453             then
1454                if Is_Unsigned_Type (Ctyp) then
1455                   Comp := RE_Compare_Array_U8_Unaligned;
1456                else
1457                   Comp := RE_Compare_Array_S8_Unaligned;
1458                end if;
1459
1460             else
1461                if Is_Unsigned_Type (Ctyp) then
1462                   Comp := RE_Compare_Array_U8;
1463                else
1464                   Comp := RE_Compare_Array_S8;
1465                end if;
1466             end if;
1467
1468          elsif Component_Size (Typ1) = 16 then
1469             if Is_Unsigned_Type (Ctyp) then
1470                Comp := RE_Compare_Array_U16;
1471             else
1472                Comp := RE_Compare_Array_S16;
1473             end if;
1474
1475          elsif Component_Size (Typ1) = 32 then
1476             if Is_Unsigned_Type (Ctyp) then
1477                Comp := RE_Compare_Array_U32;
1478             else
1479                Comp := RE_Compare_Array_S32;
1480             end if;
1481
1482          else pragma Assert (Component_Size (Typ1) = 64);
1483             if Is_Unsigned_Type (Ctyp) then
1484                Comp := RE_Compare_Array_U64;
1485             else
1486                Comp := RE_Compare_Array_S64;
1487             end if;
1488          end if;
1489
1490          Remove_Side_Effects (Op1, Name_Req => True);
1491          Remove_Side_Effects (Op2, Name_Req => True);
1492
1493          Rewrite (Op1,
1494            Make_Function_Call (Sloc (Op1),
1495              Name => New_Occurrence_Of (RTE (Comp), Loc),
1496
1497              Parameter_Associations => New_List (
1498                Make_Attribute_Reference (Loc,
1499                  Prefix         => Relocate_Node (Op1),
1500                  Attribute_Name => Name_Address),
1501
1502                Make_Attribute_Reference (Loc,
1503                  Prefix         => Relocate_Node (Op2),
1504                  Attribute_Name => Name_Address),
1505
1506                Make_Attribute_Reference (Loc,
1507                  Prefix         => Relocate_Node (Op1),
1508                  Attribute_Name => Name_Length),
1509
1510                Make_Attribute_Reference (Loc,
1511                  Prefix         => Relocate_Node (Op2),
1512                  Attribute_Name => Name_Length))));
1513
1514          Rewrite (Op2,
1515            Make_Integer_Literal (Sloc (Op2),
1516              Intval => Uint_0));
1517
1518          Analyze_And_Resolve (Op1, Standard_Integer);
1519          Analyze_And_Resolve (Op2, Standard_Integer);
1520          return;
1521       end if;
1522
1523       --  Cases where we cannot make runtime call
1524
1525       --  For (a <= b) we convert to not (a > b)
1526
1527       if Chars (N) = Name_Op_Le then
1528          Rewrite (N,
1529            Make_Op_Not (Loc,
1530              Right_Opnd =>
1531                 Make_Op_Gt (Loc,
1532                  Left_Opnd  => Op1,
1533                  Right_Opnd => Op2)));
1534          Analyze_And_Resolve (N, Standard_Boolean);
1535          return;
1536
1537       --  For < the Boolean expression is
1538       --    greater__nn (op2, op1)
1539
1540       elsif Chars (N) = Name_Op_Lt then
1541          Func_Body := Make_Array_Comparison_Op (Typ1, N);
1542
1543          --  Switch operands
1544
1545          Op1 := Right_Opnd (N);
1546          Op2 := Left_Opnd  (N);
1547
1548       --  For (a >= b) we convert to not (a < b)
1549
1550       elsif Chars (N) = Name_Op_Ge then
1551          Rewrite (N,
1552            Make_Op_Not (Loc,
1553              Right_Opnd =>
1554                Make_Op_Lt (Loc,
1555                  Left_Opnd  => Op1,
1556                  Right_Opnd => Op2)));
1557          Analyze_And_Resolve (N, Standard_Boolean);
1558          return;
1559
1560       --  For > the Boolean expression is
1561       --    greater__nn (op1, op2)
1562
1563       else
1564          pragma Assert (Chars (N) = Name_Op_Gt);
1565          Func_Body := Make_Array_Comparison_Op (Typ1, N);
1566       end if;
1567
1568       Func_Name := Defining_Unit_Name (Specification (Func_Body));
1569       Expr :=
1570         Make_Function_Call (Loc,
1571           Name => New_Reference_To (Func_Name, Loc),
1572           Parameter_Associations => New_List (Op1, Op2));
1573
1574       Insert_Action (N, Func_Body);
1575       Rewrite (N, Expr);
1576       Analyze_And_Resolve (N, Standard_Boolean);
1577
1578    exception
1579       when RE_Not_Available =>
1580          return;
1581    end Expand_Array_Comparison;
1582
1583    ---------------------------
1584    -- Expand_Array_Equality --
1585    ---------------------------
1586
1587    --  Expand an equality function for multi-dimensional arrays. Here is an
1588    --  example of such a function for Nb_Dimension = 2
1589
1590    --  function Enn (A : atyp; B : btyp) return boolean is
1591    --  begin
1592    --     if (A'length (1) = 0 or else A'length (2) = 0)
1593    --          and then
1594    --        (B'length (1) = 0 or else B'length (2) = 0)
1595    --     then
1596    --        return True;    -- RM 4.5.2(22)
1597    --     end if;
1598
1599    --     if A'length (1) /= B'length (1)
1600    --               or else
1601    --           A'length (2) /= B'length (2)
1602    --     then
1603    --        return False;   -- RM 4.5.2(23)
1604    --     end if;
1605
1606    --     declare
1607    --        A1 : Index_T1 := A'first (1);
1608    --        B1 : Index_T1 := B'first (1);
1609    --     begin
1610    --        loop
1611    --           declare
1612    --              A2 : Index_T2 := A'first (2);
1613    --              B2 : Index_T2 := B'first (2);
1614    --           begin
1615    --              loop
1616    --                 if A (A1, A2) /= B (B1, B2) then
1617    --                    return False;
1618    --                 end if;
1619
1620    --                 exit when A2 = A'last (2);
1621    --                 A2 := Index_T2'succ (A2);
1622    --                 B2 := Index_T2'succ (B2);
1623    --              end loop;
1624    --           end;
1625
1626    --           exit when A1 = A'last (1);
1627    --           A1 := Index_T1'succ (A1);
1628    --           B1 := Index_T1'succ (B1);
1629    --        end loop;
1630    --     end;
1631
1632    --     return true;
1633    --  end Enn;
1634
1635    --  Note on the formal types used (atyp and btyp). If either of the arrays
1636    --  is of a private type, we use the underlying type, and do an unchecked
1637    --  conversion of the actual. If either of the arrays has a bound depending
1638    --  on a discriminant, then we use the base type since otherwise we have an
1639    --  escaped discriminant in the function.
1640
1641    --  If both arrays are constrained and have the same bounds, we can generate
1642    --  a loop with an explicit iteration scheme using a 'Range attribute over
1643    --  the first array.
1644
1645    function Expand_Array_Equality
1646      (Nod    : Node_Id;
1647       Lhs    : Node_Id;
1648       Rhs    : Node_Id;
1649       Bodies : List_Id;
1650       Typ    : Entity_Id) return Node_Id
1651    is
1652       Loc         : constant Source_Ptr := Sloc (Nod);
1653       Decls       : constant List_Id    := New_List;
1654       Index_List1 : constant List_Id    := New_List;
1655       Index_List2 : constant List_Id    := New_List;
1656
1657       Actuals   : List_Id;
1658       Formals   : List_Id;
1659       Func_Name : Entity_Id;
1660       Func_Body : Node_Id;
1661
1662       A : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uA);
1663       B : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uB);
1664
1665       Ltyp : Entity_Id;
1666       Rtyp : Entity_Id;
1667       --  The parameter types to be used for the formals
1668
1669       function Arr_Attr
1670         (Arr : Entity_Id;
1671          Nam : Name_Id;
1672          Num : Int) return Node_Id;
1673       --  This builds the attribute reference Arr'Nam (Expr)
1674
1675       function Component_Equality (Typ : Entity_Id) return Node_Id;
1676       --  Create one statement to compare corresponding components, designated
1677       --  by a full set of indexes.
1678
1679       function Get_Arg_Type (N : Node_Id) return Entity_Id;
1680       --  Given one of the arguments, computes the appropriate type to be used
1681       --  for that argument in the corresponding function formal
1682
1683       function Handle_One_Dimension
1684         (N     : Int;
1685          Index : Node_Id) return Node_Id;
1686       --  This procedure returns the following code
1687       --
1688       --    declare
1689       --       Bn : Index_T := B'First (N);
1690       --    begin
1691       --       loop
1692       --          xxx
1693       --          exit when An = A'Last (N);
1694       --          An := Index_T'Succ (An)
1695       --          Bn := Index_T'Succ (Bn)
1696       --       end loop;
1697       --    end;
1698       --
1699       --  If both indexes are constrained and identical, the procedure
1700       --  returns a simpler loop:
1701       --
1702       --      for An in A'Range (N) loop
1703       --         xxx
1704       --      end loop
1705       --
1706       --  N is the dimension for which we are generating a loop. Index is the
1707       --  N'th index node, whose Etype is Index_Type_n in the above code. The
1708       --  xxx statement is either the loop or declare for the next dimension
1709       --  or if this is the last dimension the comparison of corresponding
1710       --  components of the arrays.
1711       --
1712       --  The actual way the code works is to return the comparison of
1713       --  corresponding components for the N+1 call. That's neater!
1714
1715       function Test_Empty_Arrays return Node_Id;
1716       --  This function constructs the test for both arrays being empty
1717       --    (A'length (1) = 0 or else A'length (2) = 0 or else ...)
1718       --      and then
1719       --    (B'length (1) = 0 or else B'length (2) = 0 or else ...)
1720
1721       function Test_Lengths_Correspond return Node_Id;
1722       --  This function constructs the test for arrays having different lengths
1723       --  in at least one index position, in which case the resulting code is:
1724
1725       --     A'length (1) /= B'length (1)
1726       --       or else
1727       --     A'length (2) /= B'length (2)
1728       --       or else
1729       --       ...
1730
1731       --------------
1732       -- Arr_Attr --
1733       --------------
1734
1735       function Arr_Attr
1736         (Arr : Entity_Id;
1737          Nam : Name_Id;
1738          Num : Int) return Node_Id
1739       is
1740       begin
1741          return
1742            Make_Attribute_Reference (Loc,
1743             Attribute_Name => Nam,
1744             Prefix => New_Reference_To (Arr, Loc),
1745             Expressions => New_List (Make_Integer_Literal (Loc, Num)));
1746       end Arr_Attr;
1747
1748       ------------------------
1749       -- Component_Equality --
1750       ------------------------
1751
1752       function Component_Equality (Typ : Entity_Id) return Node_Id is
1753          Test : Node_Id;
1754          L, R : Node_Id;
1755
1756       begin
1757          --  if a(i1...) /= b(j1...) then return false; end if;
1758
1759          L :=
1760            Make_Indexed_Component (Loc,
1761              Prefix      => Make_Identifier (Loc, Chars (A)),
1762              Expressions => Index_List1);
1763
1764          R :=
1765            Make_Indexed_Component (Loc,
1766              Prefix      => Make_Identifier (Loc, Chars (B)),
1767              Expressions => Index_List2);
1768
1769          Test := Expand_Composite_Equality
1770                    (Nod, Component_Type (Typ), L, R, Decls);
1771
1772          --  If some (sub)component is an unchecked_union, the whole operation
1773          --  will raise program error.
1774
1775          if Nkind (Test) = N_Raise_Program_Error then
1776
1777             --  This node is going to be inserted at a location where a
1778             --  statement is expected: clear its Etype so analysis will set
1779             --  it to the expected Standard_Void_Type.
1780
1781             Set_Etype (Test, Empty);
1782             return Test;
1783
1784          else
1785             return
1786               Make_Implicit_If_Statement (Nod,
1787                 Condition => Make_Op_Not (Loc, Right_Opnd => Test),
1788                 Then_Statements => New_List (
1789                   Make_Simple_Return_Statement (Loc,
1790                     Expression => New_Occurrence_Of (Standard_False, Loc))));
1791          end if;
1792       end Component_Equality;
1793
1794       ------------------
1795       -- Get_Arg_Type --
1796       ------------------
1797
1798       function Get_Arg_Type (N : Node_Id) return Entity_Id is
1799          T : Entity_Id;
1800          X : Node_Id;
1801
1802       begin
1803          T := Etype (N);
1804
1805          if No (T) then
1806             return Typ;
1807
1808          else
1809             T := Underlying_Type (T);
1810
1811             X := First_Index (T);
1812             while Present (X) loop
1813                if Denotes_Discriminant (Type_Low_Bound (Etype (X)))
1814                  or else
1815                    Denotes_Discriminant (Type_High_Bound (Etype (X)))
1816                then
1817                   T := Base_Type (T);
1818                   exit;
1819                end if;
1820
1821                Next_Index (X);
1822             end loop;
1823
1824             return T;
1825          end if;
1826       end Get_Arg_Type;
1827
1828       --------------------------
1829       -- Handle_One_Dimension --
1830       ---------------------------
1831
1832       function Handle_One_Dimension
1833         (N     : Int;
1834          Index : Node_Id) return Node_Id
1835       is
1836          Need_Separate_Indexes : constant Boolean :=
1837                                    Ltyp /= Rtyp
1838                                      or else not Is_Constrained (Ltyp);
1839          --  If the index types are identical, and we are working with
1840          --  constrained types, then we can use the same index for both
1841          --  of the arrays.
1842
1843          An : constant Entity_Id := Make_Temporary (Loc, 'A');
1844
1845          Bn       : Entity_Id;
1846          Index_T  : Entity_Id;
1847          Stm_List : List_Id;
1848          Loop_Stm : Node_Id;
1849
1850       begin
1851          if N > Number_Dimensions (Ltyp) then
1852             return Component_Equality (Ltyp);
1853          end if;
1854
1855          --  Case where we generate a loop
1856
1857          Index_T := Base_Type (Etype (Index));
1858
1859          if Need_Separate_Indexes then
1860             Bn := Make_Temporary (Loc, 'B');
1861          else
1862             Bn := An;
1863          end if;
1864
1865          Append (New_Reference_To (An, Loc), Index_List1);
1866          Append (New_Reference_To (Bn, Loc), Index_List2);
1867
1868          Stm_List := New_List (
1869            Handle_One_Dimension (N + 1, Next_Index (Index)));
1870
1871          if Need_Separate_Indexes then
1872
1873             --  Generate guard for loop, followed by increments of indexes
1874
1875             Append_To (Stm_List,
1876                Make_Exit_Statement (Loc,
1877                  Condition =>
1878                    Make_Op_Eq (Loc,
1879                       Left_Opnd => New_Reference_To (An, Loc),
1880                       Right_Opnd => Arr_Attr (A, Name_Last, N))));
1881
1882             Append_To (Stm_List,
1883               Make_Assignment_Statement (Loc,
1884                 Name       => New_Reference_To (An, Loc),
1885                 Expression =>
1886                   Make_Attribute_Reference (Loc,
1887                     Prefix         => New_Reference_To (Index_T, Loc),
1888                     Attribute_Name => Name_Succ,
1889                     Expressions    => New_List (New_Reference_To (An, Loc)))));
1890
1891             Append_To (Stm_List,
1892               Make_Assignment_Statement (Loc,
1893                 Name       => New_Reference_To (Bn, Loc),
1894                 Expression =>
1895                   Make_Attribute_Reference (Loc,
1896                     Prefix         => New_Reference_To (Index_T, Loc),
1897                     Attribute_Name => Name_Succ,
1898                     Expressions    => New_List (New_Reference_To (Bn, Loc)))));
1899          end if;
1900
1901          --  If separate indexes, we need a declare block for An and Bn, and a
1902          --  loop without an iteration scheme.
1903
1904          if Need_Separate_Indexes then
1905             Loop_Stm :=
1906               Make_Implicit_Loop_Statement (Nod, Statements => Stm_List);
1907
1908             return
1909               Make_Block_Statement (Loc,
1910                 Declarations => New_List (
1911                   Make_Object_Declaration (Loc,
1912                     Defining_Identifier => An,
1913                     Object_Definition   => New_Reference_To (Index_T, Loc),
1914                     Expression          => Arr_Attr (A, Name_First, N)),
1915
1916                   Make_Object_Declaration (Loc,
1917                     Defining_Identifier => Bn,
1918                     Object_Definition   => New_Reference_To (Index_T, Loc),
1919                     Expression          => Arr_Attr (B, Name_First, N))),
1920
1921                 Handled_Statement_Sequence =>
1922                   Make_Handled_Sequence_Of_Statements (Loc,
1923                     Statements => New_List (Loop_Stm)));
1924
1925          --  If no separate indexes, return loop statement with explicit
1926          --  iteration scheme on its own
1927
1928          else
1929             Loop_Stm :=
1930               Make_Implicit_Loop_Statement (Nod,
1931                 Statements       => Stm_List,
1932                 Iteration_Scheme =>
1933                   Make_Iteration_Scheme (Loc,
1934                     Loop_Parameter_Specification =>
1935                       Make_Loop_Parameter_Specification (Loc,
1936                         Defining_Identifier         => An,
1937                         Discrete_Subtype_Definition =>
1938                           Arr_Attr (A, Name_Range, N))));
1939             return Loop_Stm;
1940          end if;
1941       end Handle_One_Dimension;
1942
1943       -----------------------
1944       -- Test_Empty_Arrays --
1945       -----------------------
1946
1947       function Test_Empty_Arrays return Node_Id is
1948          Alist : Node_Id;
1949          Blist : Node_Id;
1950
1951          Atest : Node_Id;
1952          Btest : Node_Id;
1953
1954       begin
1955          Alist := Empty;
1956          Blist := Empty;
1957          for J in 1 .. Number_Dimensions (Ltyp) loop
1958             Atest :=
1959               Make_Op_Eq (Loc,
1960                 Left_Opnd  => Arr_Attr (A, Name_Length, J),
1961                 Right_Opnd => Make_Integer_Literal (Loc, 0));
1962
1963             Btest :=
1964               Make_Op_Eq (Loc,
1965                 Left_Opnd  => Arr_Attr (B, Name_Length, J),
1966                 Right_Opnd => Make_Integer_Literal (Loc, 0));
1967
1968             if No (Alist) then
1969                Alist := Atest;
1970                Blist := Btest;
1971
1972             else
1973                Alist :=
1974                  Make_Or_Else (Loc,
1975                    Left_Opnd  => Relocate_Node (Alist),
1976                    Right_Opnd => Atest);
1977
1978                Blist :=
1979                  Make_Or_Else (Loc,
1980                    Left_Opnd  => Relocate_Node (Blist),
1981                    Right_Opnd => Btest);
1982             end if;
1983          end loop;
1984
1985          return
1986            Make_And_Then (Loc,
1987              Left_Opnd  => Alist,
1988              Right_Opnd => Blist);
1989       end Test_Empty_Arrays;
1990
1991       -----------------------------
1992       -- Test_Lengths_Correspond --
1993       -----------------------------
1994
1995       function Test_Lengths_Correspond return Node_Id is
1996          Result : Node_Id;
1997          Rtest  : Node_Id;
1998
1999       begin
2000          Result := Empty;
2001          for J in 1 .. Number_Dimensions (Ltyp) loop
2002             Rtest :=
2003               Make_Op_Ne (Loc,
2004                 Left_Opnd  => Arr_Attr (A, Name_Length, J),
2005                 Right_Opnd => Arr_Attr (B, Name_Length, J));
2006
2007             if No (Result) then
2008                Result := Rtest;
2009             else
2010                Result :=
2011                  Make_Or_Else (Loc,
2012                    Left_Opnd  => Relocate_Node (Result),
2013                    Right_Opnd => Rtest);
2014             end if;
2015          end loop;
2016
2017          return Result;
2018       end Test_Lengths_Correspond;
2019
2020    --  Start of processing for Expand_Array_Equality
2021
2022    begin
2023       Ltyp := Get_Arg_Type (Lhs);
2024       Rtyp := Get_Arg_Type (Rhs);
2025
2026       --  For now, if the argument types are not the same, go to the base type,
2027       --  since the code assumes that the formals have the same type. This is
2028       --  fixable in future ???
2029
2030       if Ltyp /= Rtyp then
2031          Ltyp := Base_Type (Ltyp);
2032          Rtyp := Base_Type (Rtyp);
2033          pragma Assert (Ltyp = Rtyp);
2034       end if;
2035
2036       --  Build list of formals for function
2037
2038       Formals := New_List (
2039         Make_Parameter_Specification (Loc,
2040           Defining_Identifier => A,
2041           Parameter_Type      => New_Reference_To (Ltyp, Loc)),
2042
2043         Make_Parameter_Specification (Loc,
2044           Defining_Identifier => B,
2045           Parameter_Type      => New_Reference_To (Rtyp, Loc)));
2046
2047       Func_Name := Make_Temporary (Loc, 'E');
2048
2049       --  Build statement sequence for function
2050
2051       Func_Body :=
2052         Make_Subprogram_Body (Loc,
2053           Specification =>
2054             Make_Function_Specification (Loc,
2055               Defining_Unit_Name       => Func_Name,
2056               Parameter_Specifications => Formals,
2057               Result_Definition => New_Reference_To (Standard_Boolean, Loc)),
2058
2059           Declarations =>  Decls,
2060
2061           Handled_Statement_Sequence =>
2062             Make_Handled_Sequence_Of_Statements (Loc,
2063               Statements => New_List (
2064
2065                 Make_Implicit_If_Statement (Nod,
2066                   Condition => Test_Empty_Arrays,
2067                   Then_Statements => New_List (
2068                     Make_Simple_Return_Statement (Loc,
2069                       Expression =>
2070                         New_Occurrence_Of (Standard_True, Loc)))),
2071
2072                 Make_Implicit_If_Statement (Nod,
2073                   Condition => Test_Lengths_Correspond,
2074                   Then_Statements => New_List (
2075                     Make_Simple_Return_Statement (Loc,
2076                       Expression =>
2077                         New_Occurrence_Of (Standard_False, Loc)))),
2078
2079                 Handle_One_Dimension (1, First_Index (Ltyp)),
2080
2081                 Make_Simple_Return_Statement (Loc,
2082                   Expression => New_Occurrence_Of (Standard_True, Loc)))));
2083
2084          Set_Has_Completion (Func_Name, True);
2085          Set_Is_Inlined (Func_Name);
2086
2087          --  If the array type is distinct from the type of the arguments, it
2088          --  is the full view of a private type. Apply an unchecked conversion
2089          --  to insure that analysis of the call succeeds.
2090
2091          declare
2092             L, R : Node_Id;
2093
2094          begin
2095             L := Lhs;
2096             R := Rhs;
2097
2098             if No (Etype (Lhs))
2099               or else Base_Type (Etype (Lhs)) /= Base_Type (Ltyp)
2100             then
2101                L := OK_Convert_To (Ltyp, Lhs);
2102             end if;
2103
2104             if No (Etype (Rhs))
2105               or else Base_Type (Etype (Rhs)) /= Base_Type (Rtyp)
2106             then
2107                R := OK_Convert_To (Rtyp, Rhs);
2108             end if;
2109
2110             Actuals := New_List (L, R);
2111          end;
2112
2113          Append_To (Bodies, Func_Body);
2114
2115          return
2116            Make_Function_Call (Loc,
2117              Name                   => New_Reference_To (Func_Name, Loc),
2118              Parameter_Associations => Actuals);
2119    end Expand_Array_Equality;
2120
2121    -----------------------------
2122    -- Expand_Boolean_Operator --
2123    -----------------------------
2124
2125    --  Note that we first get the actual subtypes of the operands, since we
2126    --  always want to deal with types that have bounds.
2127
2128    procedure Expand_Boolean_Operator (N : Node_Id) is
2129       Typ : constant Entity_Id  := Etype (N);
2130
2131    begin
2132       --  Special case of bit packed array where both operands are known to be
2133       --  properly aligned. In this case we use an efficient run time routine
2134       --  to carry out the operation (see System.Bit_Ops).
2135
2136       if Is_Bit_Packed_Array (Typ)
2137         and then not Is_Possibly_Unaligned_Object (Left_Opnd (N))
2138         and then not Is_Possibly_Unaligned_Object (Right_Opnd (N))
2139       then
2140          Expand_Packed_Boolean_Operator (N);
2141          return;
2142       end if;
2143
2144       --  For the normal non-packed case, the general expansion is to build
2145       --  function for carrying out the comparison (use Make_Boolean_Array_Op)
2146       --  and then inserting it into the tree. The original operator node is
2147       --  then rewritten as a call to this function. We also use this in the
2148       --  packed case if either operand is a possibly unaligned object.
2149
2150       declare
2151          Loc       : constant Source_Ptr := Sloc (N);
2152          L         : constant Node_Id    := Relocate_Node (Left_Opnd  (N));
2153          R         : constant Node_Id    := Relocate_Node (Right_Opnd (N));
2154          Func_Body : Node_Id;
2155          Func_Name : Entity_Id;
2156
2157       begin
2158          Convert_To_Actual_Subtype (L);
2159          Convert_To_Actual_Subtype (R);
2160          Ensure_Defined (Etype (L), N);
2161          Ensure_Defined (Etype (R), N);
2162          Apply_Length_Check (R, Etype (L));
2163
2164          if Nkind (N) = N_Op_Xor then
2165             Silly_Boolean_Array_Xor_Test (N, Etype (L));
2166          end if;
2167
2168          if Nkind (Parent (N)) = N_Assignment_Statement
2169            and then Safe_In_Place_Array_Op (Name (Parent (N)), L, R)
2170          then
2171             Build_Boolean_Array_Proc_Call (Parent (N), L, R);
2172
2173          elsif Nkind (Parent (N)) = N_Op_Not
2174            and then Nkind (N) = N_Op_And
2175            and then
2176              Safe_In_Place_Array_Op (Name (Parent (Parent (N))), L, R)
2177          then
2178             return;
2179          else
2180
2181             Func_Body := Make_Boolean_Array_Op (Etype (L), N);
2182             Func_Name := Defining_Unit_Name (Specification (Func_Body));
2183             Insert_Action (N, Func_Body);
2184
2185             --  Now rewrite the expression with a call
2186
2187             Rewrite (N,
2188               Make_Function_Call (Loc,
2189                 Name                   => New_Reference_To (Func_Name, Loc),
2190                 Parameter_Associations =>
2191                   New_List (
2192                     L,
2193                     Make_Type_Conversion
2194                       (Loc, New_Reference_To (Etype (L), Loc), R))));
2195
2196             Analyze_And_Resolve (N, Typ);
2197          end if;
2198       end;
2199    end Expand_Boolean_Operator;
2200
2201    -------------------------------
2202    -- Expand_Composite_Equality --
2203    -------------------------------
2204
2205    --  This function is only called for comparing internal fields of composite
2206    --  types when these fields are themselves composites. This is a special
2207    --  case because it is not possible to respect normal Ada visibility rules.
2208
2209    function Expand_Composite_Equality
2210      (Nod    : Node_Id;
2211       Typ    : Entity_Id;
2212       Lhs    : Node_Id;
2213       Rhs    : Node_Id;
2214       Bodies : List_Id) return Node_Id
2215    is
2216       Loc       : constant Source_Ptr := Sloc (Nod);
2217       Full_Type : Entity_Id;
2218       Prim      : Elmt_Id;
2219       Eq_Op     : Entity_Id;
2220
2221       function Find_Primitive_Eq return Node_Id;
2222       --  AI05-0123: Locate primitive equality for type if it exists, and
2223       --  build the corresponding call. If operation is abstract, replace
2224       --  call with an explicit raise. Return Empty if there is no primitive.
2225
2226       -----------------------
2227       -- Find_Primitive_Eq --
2228       -----------------------
2229
2230       function Find_Primitive_Eq return Node_Id is
2231          Prim_E : Elmt_Id;
2232          Prim   : Node_Id;
2233
2234       begin
2235          Prim_E := First_Elmt (Collect_Primitive_Operations (Typ));
2236          while Present (Prim_E) loop
2237             Prim := Node (Prim_E);
2238
2239             --  Locate primitive equality with the right signature
2240
2241             if Chars (Prim) = Name_Op_Eq
2242               and then Etype (First_Formal (Prim)) =
2243                        Etype (Next_Formal (First_Formal (Prim)))
2244               and then Etype (Prim) = Standard_Boolean
2245             then
2246                if Is_Abstract_Subprogram (Prim) then
2247                   return
2248                     Make_Raise_Program_Error (Loc,
2249                       Reason => PE_Explicit_Raise);
2250
2251                else
2252                   return
2253                     Make_Function_Call (Loc,
2254                       Name                   => New_Reference_To (Prim, Loc),
2255                       Parameter_Associations => New_List (Lhs, Rhs));
2256                end if;
2257             end if;
2258
2259             Next_Elmt (Prim_E);
2260          end loop;
2261
2262          --  If not found, predefined operation will be used
2263
2264          return Empty;
2265       end Find_Primitive_Eq;
2266
2267    --  Start of processing for Expand_Composite_Equality
2268
2269    begin
2270       if Is_Private_Type (Typ) then
2271          Full_Type := Underlying_Type (Typ);
2272       else
2273          Full_Type := Typ;
2274       end if;
2275
2276       --  Defense against malformed private types with no completion the error
2277       --  will be diagnosed later by check_completion
2278
2279       if No (Full_Type) then
2280          return New_Reference_To (Standard_False, Loc);
2281       end if;
2282
2283       Full_Type := Base_Type (Full_Type);
2284
2285       if Is_Array_Type (Full_Type) then
2286
2287          --  If the operand is an elementary type other than a floating-point
2288          --  type, then we can simply use the built-in block bitwise equality,
2289          --  since the predefined equality operators always apply and bitwise
2290          --  equality is fine for all these cases.
2291
2292          if Is_Elementary_Type (Component_Type (Full_Type))
2293            and then not Is_Floating_Point_Type (Component_Type (Full_Type))
2294          then
2295             return Make_Op_Eq (Loc, Left_Opnd => Lhs, Right_Opnd => Rhs);
2296
2297          --  For composite component types, and floating-point types, use the
2298          --  expansion. This deals with tagged component types (where we use
2299          --  the applicable equality routine) and floating-point, (where we
2300          --  need to worry about negative zeroes), and also the case of any
2301          --  composite type recursively containing such fields.
2302
2303          else
2304             return Expand_Array_Equality (Nod, Lhs, Rhs, Bodies, Full_Type);
2305          end if;
2306
2307       elsif Is_Tagged_Type (Full_Type) then
2308
2309          --  Call the primitive operation "=" of this type
2310
2311          if Is_Class_Wide_Type (Full_Type) then
2312             Full_Type := Root_Type (Full_Type);
2313          end if;
2314
2315          --  If this is derived from an untagged private type completed with a
2316          --  tagged type, it does not have a full view, so we use the primitive
2317          --  operations of the private type. This check should no longer be
2318          --  necessary when these types receive their full views ???
2319
2320          if Is_Private_Type (Typ)
2321            and then not Is_Tagged_Type (Typ)
2322            and then not Is_Controlled (Typ)
2323            and then Is_Derived_Type (Typ)
2324            and then No (Full_View (Typ))
2325          then
2326             Prim := First_Elmt (Collect_Primitive_Operations (Typ));
2327          else
2328             Prim := First_Elmt (Primitive_Operations (Full_Type));
2329          end if;
2330
2331          loop
2332             Eq_Op := Node (Prim);
2333             exit when Chars (Eq_Op) = Name_Op_Eq
2334               and then Etype (First_Formal (Eq_Op)) =
2335                        Etype (Next_Formal (First_Formal (Eq_Op)))
2336               and then Base_Type (Etype (Eq_Op)) = Standard_Boolean;
2337             Next_Elmt (Prim);
2338             pragma Assert (Present (Prim));
2339          end loop;
2340
2341          Eq_Op := Node (Prim);
2342
2343          return
2344            Make_Function_Call (Loc,
2345              Name => New_Reference_To (Eq_Op, Loc),
2346              Parameter_Associations =>
2347                New_List
2348                  (Unchecked_Convert_To (Etype (First_Formal (Eq_Op)), Lhs),
2349                   Unchecked_Convert_To (Etype (First_Formal (Eq_Op)), Rhs)));
2350
2351       elsif Is_Record_Type (Full_Type) then
2352          Eq_Op := TSS (Full_Type, TSS_Composite_Equality);
2353
2354          if Present (Eq_Op) then
2355             if Etype (First_Formal (Eq_Op)) /= Full_Type then
2356
2357                --  Inherited equality from parent type. Convert the actuals to
2358                --  match signature of operation.
2359
2360                declare
2361                   T : constant Entity_Id := Etype (First_Formal (Eq_Op));
2362
2363                begin
2364                   return
2365                     Make_Function_Call (Loc,
2366                       Name                  => New_Reference_To (Eq_Op, Loc),
2367                       Parameter_Associations => New_List (
2368                         OK_Convert_To (T, Lhs),
2369                         OK_Convert_To (T, Rhs)));
2370                end;
2371
2372             else
2373                --  Comparison between Unchecked_Union components
2374
2375                if Is_Unchecked_Union (Full_Type) then
2376                   declare
2377                      Lhs_Type      : Node_Id := Full_Type;
2378                      Rhs_Type      : Node_Id := Full_Type;
2379                      Lhs_Discr_Val : Node_Id;
2380                      Rhs_Discr_Val : Node_Id;
2381
2382                   begin
2383                      --  Lhs subtype
2384
2385                      if Nkind (Lhs) = N_Selected_Component then
2386                         Lhs_Type := Etype (Entity (Selector_Name (Lhs)));
2387                      end if;
2388
2389                      --  Rhs subtype
2390
2391                      if Nkind (Rhs) = N_Selected_Component then
2392                         Rhs_Type := Etype (Entity (Selector_Name (Rhs)));
2393                      end if;
2394
2395                      --  Lhs of the composite equality
2396
2397                      if Is_Constrained (Lhs_Type) then
2398
2399                         --  Since the enclosing record type can never be an
2400                         --  Unchecked_Union (this code is executed for records
2401                         --  that do not have variants), we may reference its
2402                         --  discriminant(s).
2403
2404                         if Nkind (Lhs) = N_Selected_Component
2405                           and then Has_Per_Object_Constraint (
2406                                      Entity (Selector_Name (Lhs)))
2407                         then
2408                            Lhs_Discr_Val :=
2409                              Make_Selected_Component (Loc,
2410                                Prefix        => Prefix (Lhs),
2411                                Selector_Name =>
2412                                  New_Copy
2413                                    (Get_Discriminant_Value
2414                                       (First_Discriminant (Lhs_Type),
2415                                        Lhs_Type,
2416                                        Stored_Constraint (Lhs_Type))));
2417
2418                         else
2419                            Lhs_Discr_Val :=
2420                              New_Copy
2421                                (Get_Discriminant_Value
2422                                   (First_Discriminant (Lhs_Type),
2423                                    Lhs_Type,
2424                                    Stored_Constraint (Lhs_Type)));
2425
2426                         end if;
2427                      else
2428                         --  It is not possible to infer the discriminant since
2429                         --  the subtype is not constrained.
2430
2431                         return
2432                           Make_Raise_Program_Error (Loc,
2433                             Reason => PE_Unchecked_Union_Restriction);
2434                      end if;
2435
2436                      --  Rhs of the composite equality
2437
2438                      if Is_Constrained (Rhs_Type) then
2439                         if Nkind (Rhs) = N_Selected_Component
2440                           and then Has_Per_Object_Constraint
2441                                      (Entity (Selector_Name (Rhs)))
2442                         then
2443                            Rhs_Discr_Val :=
2444                              Make_Selected_Component (Loc,
2445                                Prefix        => Prefix (Rhs),
2446                                Selector_Name =>
2447                                  New_Copy
2448                                    (Get_Discriminant_Value
2449                                       (First_Discriminant (Rhs_Type),
2450                                        Rhs_Type,
2451                                        Stored_Constraint (Rhs_Type))));
2452
2453                         else
2454                            Rhs_Discr_Val :=
2455                              New_Copy
2456                                (Get_Discriminant_Value
2457                                   (First_Discriminant (Rhs_Type),
2458                                    Rhs_Type,
2459                                    Stored_Constraint (Rhs_Type)));
2460
2461                         end if;
2462                      else
2463                         return
2464                           Make_Raise_Program_Error (Loc,
2465                             Reason => PE_Unchecked_Union_Restriction);
2466                      end if;
2467
2468                      --  Call the TSS equality function with the inferred
2469                      --  discriminant values.
2470
2471                      return
2472                        Make_Function_Call (Loc,
2473                          Name => New_Reference_To (Eq_Op, Loc),
2474                          Parameter_Associations => New_List (
2475                            Lhs,
2476                            Rhs,
2477                            Lhs_Discr_Val,
2478                            Rhs_Discr_Val));
2479                   end;
2480
2481                else
2482                   return
2483                     Make_Function_Call (Loc,
2484                       Name                   => New_Reference_To (Eq_Op, Loc),
2485                       Parameter_Associations => New_List (Lhs, Rhs));
2486                end if;
2487             end if;
2488
2489          elsif Ada_Version >= Ada_2012 then
2490
2491             --  if no TSS has been created for the type, check whether there is
2492             --  a primitive equality declared for it.
2493
2494             declare
2495                Ada_2012_Op : constant Node_Id := Find_Primitive_Eq;
2496
2497             begin
2498                if Present (Ada_2012_Op) then
2499                   return Ada_2012_Op;
2500                else
2501
2502                --  Use predefined equality if no user-defined primitive exists
2503
2504                   return Make_Op_Eq (Loc, Lhs, Rhs);
2505                end if;
2506             end;
2507
2508          else
2509             return Expand_Record_Equality (Nod, Full_Type, Lhs, Rhs, Bodies);
2510          end if;
2511
2512       else
2513          --  If not array or record type, it is predefined equality.
2514
2515          return Make_Op_Eq (Loc, Left_Opnd => Lhs, Right_Opnd => Rhs);
2516       end if;
2517    end Expand_Composite_Equality;
2518
2519    ------------------------
2520    -- Expand_Concatenate --
2521    ------------------------
2522
2523    procedure Expand_Concatenate (Cnode : Node_Id; Opnds : List_Id) is
2524       Loc : constant Source_Ptr := Sloc (Cnode);
2525
2526       Atyp : constant Entity_Id := Base_Type (Etype (Cnode));
2527       --  Result type of concatenation
2528
2529       Ctyp : constant Entity_Id := Base_Type (Component_Type (Etype (Cnode)));
2530       --  Component type. Elements of this component type can appear as one
2531       --  of the operands of concatenation as well as arrays.
2532
2533       Istyp : constant Entity_Id := Etype (First_Index (Atyp));
2534       --  Index subtype
2535
2536       Ityp : constant Entity_Id := Base_Type (Istyp);
2537       --  Index type. This is the base type of the index subtype, and is used
2538       --  for all computed bounds (which may be out of range of Istyp in the
2539       --  case of null ranges).
2540
2541       Artyp : Entity_Id;
2542       --  This is the type we use to do arithmetic to compute the bounds and
2543       --  lengths of operands. The choice of this type is a little subtle and
2544       --  is discussed in a separate section at the start of the body code.
2545
2546       Concatenation_Error : exception;
2547       --  Raised if concatenation is sure to raise a CE
2548
2549       Result_May_Be_Null : Boolean := True;
2550       --  Reset to False if at least one operand is encountered which is known
2551       --  at compile time to be non-null. Used for handling the special case
2552       --  of setting the high bound to the last operand high bound for a null
2553       --  result, thus ensuring a proper high bound in the super-flat case.
2554
2555       N : constant Nat := List_Length (Opnds);
2556       --  Number of concatenation operands including possibly null operands
2557
2558       NN : Nat := 0;
2559       --  Number of operands excluding any known to be null, except that the
2560       --  last operand is always retained, in case it provides the bounds for
2561       --  a null result.
2562
2563       Opnd : Node_Id;
2564       --  Current operand being processed in the loop through operands. After
2565       --  this loop is complete, always contains the last operand (which is not
2566       --  the same as Operands (NN), since null operands are skipped).
2567
2568       --  Arrays describing the operands, only the first NN entries of each
2569       --  array are set (NN < N when we exclude known null operands).
2570
2571       Is_Fixed_Length : array (1 .. N) of Boolean;
2572       --  True if length of corresponding operand known at compile time
2573
2574       Operands : array (1 .. N) of Node_Id;
2575       --  Set to the corresponding entry in the Opnds list (but note that null
2576       --  operands are excluded, so not all entries in the list are stored).
2577
2578       Fixed_Length : array (1 .. N) of Uint;
2579       --  Set to length of operand. Entries in this array are set only if the
2580       --  corresponding entry in Is_Fixed_Length is True.
2581
2582       Opnd_Low_Bound : array (1 .. N) of Node_Id;
2583       --  Set to lower bound of operand. Either an integer literal in the case
2584       --  where the bound is known at compile time, else actual lower bound.
2585       --  The operand low bound is of type Ityp.
2586
2587       Var_Length : array (1 .. N) of Entity_Id;
2588       --  Set to an entity of type Natural that contains the length of an
2589       --  operand whose length is not known at compile time. Entries in this
2590       --  array are set only if the corresponding entry in Is_Fixed_Length
2591       --  is False. The entity is of type Artyp.
2592
2593       Aggr_Length : array (0 .. N) of Node_Id;
2594       --  The J'th entry in an expression node that represents the total length
2595       --  of operands 1 through J. It is either an integer literal node, or a
2596       --  reference to a constant entity with the right value, so it is fine
2597       --  to just do a Copy_Node to get an appropriate copy. The extra zero'th
2598       --  entry always is set to zero. The length is of type Artyp.
2599
2600       Low_Bound : Node_Id;
2601       --  A tree node representing the low bound of the result (of type Ityp).
2602       --  This is either an integer literal node, or an identifier reference to
2603       --  a constant entity initialized to the appropriate value.
2604
2605       Last_Opnd_High_Bound : Node_Id;
2606       --  A tree node representing the high bound of the last operand. This
2607       --  need only be set if the result could be null. It is used for the
2608       --  special case of setting the right high bound for a null result.
2609       --  This is of type Ityp.
2610
2611       High_Bound : Node_Id;
2612       --  A tree node representing the high bound of the result (of type Ityp)
2613
2614       Result : Node_Id;
2615       --  Result of the concatenation (of type Ityp)
2616
2617       Actions : constant List_Id := New_List;
2618       --  Collect actions to be inserted if Save_Space is False
2619
2620       Save_Space : Boolean;
2621       pragma Warnings (Off, Save_Space);
2622       --  Set to True if we are saving generated code space by calling routines
2623       --  in packages System.Concat_n.
2624
2625       Known_Non_Null_Operand_Seen : Boolean;
2626       --  Set True during generation of the assignments of operands into
2627       --  result once an operand known to be non-null has been seen.
2628
2629       function Make_Artyp_Literal (Val : Nat) return Node_Id;
2630       --  This function makes an N_Integer_Literal node that is returned in
2631       --  analyzed form with the type set to Artyp. Importantly this literal
2632       --  is not flagged as static, so that if we do computations with it that
2633       --  result in statically detected out of range conditions, we will not
2634       --  generate error messages but instead warning messages.
2635
2636       function To_Artyp (X : Node_Id) return Node_Id;
2637       --  Given a node of type Ityp, returns the corresponding value of type
2638       --  Artyp. For non-enumeration types, this is a plain integer conversion.
2639       --  For enum types, the Pos of the value is returned.
2640
2641       function To_Ityp (X : Node_Id) return Node_Id;
2642       --  The inverse function (uses Val in the case of enumeration types)
2643
2644       ------------------------
2645       -- Make_Artyp_Literal --
2646       ------------------------
2647
2648       function Make_Artyp_Literal (Val : Nat) return Node_Id is
2649          Result : constant Node_Id := Make_Integer_Literal (Loc, Val);
2650       begin
2651          Set_Etype (Result, Artyp);
2652          Set_Analyzed (Result, True);
2653          Set_Is_Static_Expression (Result, False);
2654          return Result;
2655       end Make_Artyp_Literal;
2656
2657       --------------
2658       -- To_Artyp --
2659       --------------
2660
2661       function To_Artyp (X : Node_Id) return Node_Id is
2662       begin
2663          if Ityp = Base_Type (Artyp) then
2664             return X;
2665
2666          elsif Is_Enumeration_Type (Ityp) then
2667             return
2668               Make_Attribute_Reference (Loc,
2669                 Prefix         => New_Occurrence_Of (Ityp, Loc),
2670                 Attribute_Name => Name_Pos,
2671                 Expressions    => New_List (X));
2672
2673          else
2674             return Convert_To (Artyp, X);
2675          end if;
2676       end To_Artyp;
2677
2678       -------------
2679       -- To_Ityp --
2680       -------------
2681
2682       function To_Ityp (X : Node_Id) return Node_Id is
2683       begin
2684          if Is_Enumeration_Type (Ityp) then
2685             return
2686               Make_Attribute_Reference (Loc,
2687                 Prefix         => New_Occurrence_Of (Ityp, Loc),
2688                 Attribute_Name => Name_Val,
2689                 Expressions    => New_List (X));
2690
2691          --  Case where we will do a type conversion
2692
2693          else
2694             if Ityp = Base_Type (Artyp) then
2695                return X;
2696             else
2697                return Convert_To (Ityp, X);
2698             end if;
2699          end if;
2700       end To_Ityp;
2701
2702       --  Local Declarations
2703
2704       Opnd_Typ : Entity_Id;
2705       Ent      : Entity_Id;
2706       Len      : Uint;
2707       J        : Nat;
2708       Clen     : Node_Id;
2709       Set      : Boolean;
2710
2711    --  Start of processing for Expand_Concatenate
2712
2713    begin
2714       --  Choose an appropriate computational type
2715
2716       --  We will be doing calculations of lengths and bounds in this routine
2717       --  and computing one from the other in some cases, e.g. getting the high
2718       --  bound by adding the length-1 to the low bound.
2719
2720       --  We can't just use the index type, or even its base type for this
2721       --  purpose for two reasons. First it might be an enumeration type which
2722       --  is not suitable for computations of any kind, and second it may
2723       --  simply not have enough range. For example if the index type is
2724       --  -128..+127 then lengths can be up to 256, which is out of range of
2725       --  the type.
2726
2727       --  For enumeration types, we can simply use Standard_Integer, this is
2728       --  sufficient since the actual number of enumeration literals cannot
2729       --  possibly exceed the range of integer (remember we will be doing the
2730       --  arithmetic with POS values, not representation values).
2731
2732       if Is_Enumeration_Type (Ityp) then
2733          Artyp := Standard_Integer;
2734
2735       --  If index type is Positive, we use the standard unsigned type, to give
2736       --  more room on the top of the range, obviating the need for an overflow
2737       --  check when creating the upper bound. This is needed to avoid junk
2738       --  overflow checks in the common case of String types.
2739
2740       --  ??? Disabled for now
2741
2742       --  elsif Istyp = Standard_Positive then
2743       --     Artyp := Standard_Unsigned;
2744
2745       --  For modular types, we use a 32-bit modular type for types whose size
2746       --  is in the range 1-31 bits. For 32-bit unsigned types, we use the
2747       --  identity type, and for larger unsigned types we use 64-bits.
2748
2749       elsif Is_Modular_Integer_Type (Ityp) then
2750          if RM_Size (Ityp) < RM_Size (Standard_Unsigned) then
2751             Artyp := Standard_Unsigned;
2752          elsif RM_Size (Ityp) = RM_Size (Standard_Unsigned) then
2753             Artyp := Ityp;
2754          else
2755             Artyp := RTE (RE_Long_Long_Unsigned);
2756          end if;
2757
2758       --  Similar treatment for signed types
2759
2760       else
2761          if RM_Size (Ityp) < RM_Size (Standard_Integer) then
2762             Artyp := Standard_Integer;
2763          elsif RM_Size (Ityp) = RM_Size (Standard_Integer) then
2764             Artyp := Ityp;
2765          else
2766             Artyp := Standard_Long_Long_Integer;
2767          end if;
2768       end if;
2769
2770       --  Supply dummy entry at start of length array
2771
2772       Aggr_Length (0) := Make_Artyp_Literal (0);
2773
2774       --  Go through operands setting up the above arrays
2775
2776       J := 1;
2777       while J <= N loop
2778          Opnd := Remove_Head (Opnds);
2779          Opnd_Typ := Etype (Opnd);
2780
2781          --  The parent got messed up when we put the operands in a list,
2782          --  so now put back the proper parent for the saved operand, that
2783          --  is to say the concatenation node, to make sure that each operand
2784          --  is seen as a subexpression, e.g. if actions must be inserted.
2785
2786          Set_Parent (Opnd, Cnode);
2787
2788          --  Set will be True when we have setup one entry in the array
2789
2790          Set := False;
2791
2792          --  Singleton element (or character literal) case
2793
2794          if Base_Type (Opnd_Typ) = Ctyp then
2795             NN := NN + 1;
2796             Operands (NN) := Opnd;
2797             Is_Fixed_Length (NN) := True;
2798             Fixed_Length (NN) := Uint_1;
2799             Result_May_Be_Null := False;
2800
2801             --  Set low bound of operand (no need to set Last_Opnd_High_Bound
2802             --  since we know that the result cannot be null).
2803
2804             Opnd_Low_Bound (NN) :=
2805               Make_Attribute_Reference (Loc,
2806                 Prefix         => New_Reference_To (Istyp, Loc),
2807                 Attribute_Name => Name_First);
2808
2809             Set := True;
2810
2811          --  String literal case (can only occur for strings of course)
2812
2813          elsif Nkind (Opnd) = N_String_Literal then
2814             Len := String_Literal_Length (Opnd_Typ);
2815
2816             if Len /= 0 then
2817                Result_May_Be_Null := False;
2818             end if;
2819
2820             --  Capture last operand high bound if result could be null
2821
2822             if J = N and then Result_May_Be_Null then
2823                Last_Opnd_High_Bound :=
2824                  Make_Op_Add (Loc,
2825                    Left_Opnd  =>
2826                      New_Copy_Tree (String_Literal_Low_Bound (Opnd_Typ)),
2827                    Right_Opnd => Make_Integer_Literal (Loc, 1));
2828             end if;
2829
2830             --  Skip null string literal
2831
2832             if J < N and then Len = 0 then
2833                goto Continue;
2834             end if;
2835
2836             NN := NN + 1;
2837             Operands (NN) := Opnd;
2838             Is_Fixed_Length (NN) := True;
2839
2840             --  Set length and bounds
2841
2842             Fixed_Length (NN) := Len;
2843
2844             Opnd_Low_Bound (NN) :=
2845               New_Copy_Tree (String_Literal_Low_Bound (Opnd_Typ));
2846
2847             Set := True;
2848
2849          --  All other cases
2850
2851          else
2852             --  Check constrained case with known bounds
2853
2854             if Is_Constrained (Opnd_Typ) then
2855                declare
2856                   Index    : constant Node_Id   := First_Index (Opnd_Typ);
2857                   Indx_Typ : constant Entity_Id := Etype (Index);
2858                   Lo       : constant Node_Id   := Type_Low_Bound  (Indx_Typ);
2859                   Hi       : constant Node_Id   := Type_High_Bound (Indx_Typ);
2860
2861                begin
2862                   --  Fixed length constrained array type with known at compile
2863                   --  time bounds is last case of fixed length operand.
2864
2865                   if Compile_Time_Known_Value (Lo)
2866                        and then
2867                      Compile_Time_Known_Value (Hi)
2868                   then
2869                      declare
2870                         Loval : constant Uint := Expr_Value (Lo);
2871                         Hival : constant Uint := Expr_Value (Hi);
2872                         Len   : constant Uint :=
2873                                   UI_Max (Hival - Loval + 1, Uint_0);
2874
2875                      begin
2876                         if Len > 0 then
2877                            Result_May_Be_Null := False;
2878                         end if;
2879
2880                         --  Capture last operand bound if result could be null
2881
2882                         if J = N and then Result_May_Be_Null then
2883                            Last_Opnd_High_Bound :=
2884                              Convert_To (Ityp,
2885                                Make_Integer_Literal (Loc, Expr_Value (Hi)));
2886                         end if;
2887
2888                         --  Exclude null length case unless last operand
2889
2890                         if J < N and then Len = 0 then
2891                            goto Continue;
2892                         end if;
2893
2894                         NN := NN + 1;
2895                         Operands (NN) := Opnd;
2896                         Is_Fixed_Length (NN) := True;
2897                         Fixed_Length (NN)    := Len;
2898
2899                         Opnd_Low_Bound (NN) :=
2900                           To_Ityp
2901                             (Make_Integer_Literal (Loc, Expr_Value (Lo)));
2902                         Set := True;
2903                      end;
2904                   end if;
2905                end;
2906             end if;
2907
2908             --  All cases where the length is not known at compile time, or the
2909             --  special case of an operand which is known to be null but has a
2910             --  lower bound other than 1 or is other than a string type.
2911
2912             if not Set then
2913                NN := NN + 1;
2914
2915                --  Capture operand bounds
2916
2917                Opnd_Low_Bound (NN) :=
2918                  Make_Attribute_Reference (Loc,
2919                    Prefix         =>
2920                      Duplicate_Subexpr (Opnd, Name_Req => True),
2921                    Attribute_Name => Name_First);
2922
2923                if J = N and Result_May_Be_Null then
2924                   Last_Opnd_High_Bound :=
2925                     Convert_To (Ityp,
2926                       Make_Attribute_Reference (Loc,
2927                         Prefix         =>
2928                           Duplicate_Subexpr (Opnd, Name_Req => True),
2929                         Attribute_Name => Name_Last));
2930                end if;
2931
2932                --  Capture length of operand in entity
2933
2934                Operands (NN) := Opnd;
2935                Is_Fixed_Length (NN) := False;
2936
2937                Var_Length (NN) := Make_Temporary (Loc, 'L');
2938
2939                Append_To (Actions,
2940                  Make_Object_Declaration (Loc,
2941                    Defining_Identifier => Var_Length (NN),
2942                    Constant_Present    => True,
2943                    Object_Definition   => New_Occurrence_Of (Artyp, Loc),
2944                    Expression          =>
2945                      Make_Attribute_Reference (Loc,
2946                        Prefix         =>
2947                          Duplicate_Subexpr (Opnd, Name_Req => True),
2948                        Attribute_Name => Name_Length)));
2949             end if;
2950          end if;
2951
2952          --  Set next entry in aggregate length array
2953
2954          --  For first entry, make either integer literal for fixed length
2955          --  or a reference to the saved length for variable length.
2956
2957          if NN = 1 then
2958             if Is_Fixed_Length (1) then
2959                Aggr_Length (1) := Make_Integer_Literal (Loc, Fixed_Length (1));
2960             else
2961                Aggr_Length (1) := New_Reference_To (Var_Length (1), Loc);
2962             end if;
2963
2964          --  If entry is fixed length and only fixed lengths so far, make
2965          --  appropriate new integer literal adding new length.
2966
2967          elsif Is_Fixed_Length (NN)
2968            and then Nkind (Aggr_Length (NN - 1)) = N_Integer_Literal
2969          then
2970             Aggr_Length (NN) :=
2971               Make_Integer_Literal (Loc,
2972                 Intval => Fixed_Length (NN) + Intval (Aggr_Length (NN - 1)));
2973
2974          --  All other cases, construct an addition node for the length and
2975          --  create an entity initialized to this length.
2976
2977          else
2978             Ent := Make_Temporary (Loc, 'L');
2979
2980             if Is_Fixed_Length (NN) then
2981                Clen := Make_Integer_Literal (Loc, Fixed_Length (NN));
2982             else
2983                Clen := New_Reference_To (Var_Length (NN), Loc);
2984             end if;
2985
2986             Append_To (Actions,
2987               Make_Object_Declaration (Loc,
2988                 Defining_Identifier => Ent,
2989                 Constant_Present    => True,
2990                 Object_Definition   => New_Occurrence_Of (Artyp, Loc),
2991                 Expression          =>
2992                   Make_Op_Add (Loc,
2993                     Left_Opnd  => New_Copy (Aggr_Length (NN - 1)),
2994                     Right_Opnd => Clen)));
2995
2996             Aggr_Length (NN) := Make_Identifier (Loc, Chars => Chars (Ent));
2997          end if;
2998
2999       <<Continue>>
3000          J := J + 1;
3001       end loop;
3002
3003       --  If we have only skipped null operands, return the last operand
3004
3005       if NN = 0 then
3006          Result := Opnd;
3007          goto Done;
3008       end if;
3009
3010       --  If we have only one non-null operand, return it and we are done.
3011       --  There is one case in which this cannot be done, and that is when
3012       --  the sole operand is of the element type, in which case it must be
3013       --  converted to an array, and the easiest way of doing that is to go
3014       --  through the normal general circuit.
3015
3016       if NN = 1
3017         and then Base_Type (Etype (Operands (1))) /= Ctyp
3018       then
3019          Result := Operands (1);
3020          goto Done;
3021       end if;
3022
3023       --  Cases where we have a real concatenation
3024
3025       --  Next step is to find the low bound for the result array that we
3026       --  will allocate. The rules for this are in (RM 4.5.6(5-7)).
3027
3028       --  If the ultimate ancestor of the index subtype is a constrained array
3029       --  definition, then the lower bound is that of the index subtype as
3030       --  specified by (RM 4.5.3(6)).
3031
3032       --  The right test here is to go to the root type, and then the ultimate
3033       --  ancestor is the first subtype of this root type.
3034
3035       if Is_Constrained (First_Subtype (Root_Type (Atyp))) then
3036          Low_Bound :=
3037            Make_Attribute_Reference (Loc,
3038              Prefix         =>
3039                New_Occurrence_Of (First_Subtype (Root_Type (Atyp)), Loc),
3040              Attribute_Name => Name_First);
3041
3042       --  If the first operand in the list has known length we know that
3043       --  the lower bound of the result is the lower bound of this operand.
3044
3045       elsif Is_Fixed_Length (1) then
3046          Low_Bound := Opnd_Low_Bound (1);
3047
3048       --  OK, we don't know the lower bound, we have to build a horrible
3049       --  expression actions node of the form
3050
3051       --     if Cond1'Length /= 0 then
3052       --        Opnd1 low bound
3053       --     else
3054       --        if Opnd2'Length /= 0 then
3055       --          Opnd2 low bound
3056       --        else
3057       --           ...
3058
3059       --  The nesting ends either when we hit an operand whose length is known
3060       --  at compile time, or on reaching the last operand, whose low bound we
3061       --  take unconditionally whether or not it is null. It's easiest to do
3062       --  this with a recursive procedure:
3063
3064       else
3065          declare
3066             function Get_Known_Bound (J : Nat) return Node_Id;
3067             --  Returns the lower bound determined by operands J .. NN
3068
3069             ---------------------
3070             -- Get_Known_Bound --
3071             ---------------------
3072
3073             function Get_Known_Bound (J : Nat) return Node_Id is
3074             begin
3075                if Is_Fixed_Length (J) or else J = NN then
3076                   return New_Copy (Opnd_Low_Bound (J));
3077
3078                else
3079                   return
3080                     Make_Conditional_Expression (Loc,
3081                       Expressions => New_List (
3082
3083                         Make_Op_Ne (Loc,
3084                           Left_Opnd  => New_Reference_To (Var_Length (J), Loc),
3085                           Right_Opnd => Make_Integer_Literal (Loc, 0)),
3086
3087                         New_Copy (Opnd_Low_Bound (J)),
3088                         Get_Known_Bound (J + 1)));
3089                end if;
3090             end Get_Known_Bound;
3091
3092          begin
3093             Ent := Make_Temporary (Loc, 'L');
3094
3095             Append_To (Actions,
3096               Make_Object_Declaration (Loc,
3097                 Defining_Identifier => Ent,
3098                 Constant_Present    => True,
3099                 Object_Definition   => New_Occurrence_Of (Ityp, Loc),
3100                 Expression          => Get_Known_Bound (1)));
3101
3102             Low_Bound := New_Reference_To (Ent, Loc);
3103          end;
3104       end if;
3105
3106       --  Now we can safely compute the upper bound, normally
3107       --  Low_Bound + Length - 1.
3108
3109       High_Bound :=
3110         To_Ityp (
3111           Make_Op_Add (Loc,
3112             Left_Opnd  => To_Artyp (New_Copy (Low_Bound)),
3113             Right_Opnd =>
3114               Make_Op_Subtract (Loc,
3115                 Left_Opnd  => New_Copy (Aggr_Length (NN)),
3116                 Right_Opnd => Make_Artyp_Literal (1))));
3117
3118       --  Note that calculation of the high bound may cause overflow in some
3119       --  very weird cases, so in the general case we need an overflow check on
3120       --  the high bound. We can avoid this for the common case of string types
3121       --  and other types whose index is Positive, since we chose a wider range
3122       --  for the arithmetic type.
3123
3124       if Istyp /= Standard_Positive then
3125          Activate_Overflow_Check (High_Bound);
3126       end if;
3127
3128       --  Handle the exceptional case where the result is null, in which case
3129       --  case the bounds come from the last operand (so that we get the proper
3130       --  bounds if the last operand is super-flat).
3131
3132       if Result_May_Be_Null then
3133          High_Bound :=
3134            Make_Conditional_Expression (Loc,
3135              Expressions => New_List (
3136                Make_Op_Eq (Loc,
3137                  Left_Opnd  => New_Copy (Aggr_Length (NN)),
3138                  Right_Opnd => Make_Artyp_Literal (0)),
3139                Last_Opnd_High_Bound,
3140                High_Bound));
3141       end if;
3142
3143       --  Here is where we insert the saved up actions
3144
3145       Insert_Actions (Cnode, Actions, Suppress => All_Checks);
3146
3147       --  Now we construct an array object with appropriate bounds. We mark
3148       --  the target as internal to prevent useless initialization when
3149       --  Initialize_Scalars is enabled. Also since this is the actual result
3150       --  entity, we make sure we have debug information for the result.
3151
3152       Ent := Make_Temporary (Loc, 'S');
3153       Set_Is_Internal (Ent);
3154       Set_Needs_Debug_Info (Ent);
3155
3156       --  If the bound is statically known to be out of range, we do not want
3157       --  to abort, we want a warning and a runtime constraint error. Note that
3158       --  we have arranged that the result will not be treated as a static
3159       --  constant, so we won't get an illegality during this insertion.
3160
3161       Insert_Action (Cnode,
3162         Make_Object_Declaration (Loc,
3163           Defining_Identifier => Ent,
3164           Object_Definition   =>
3165             Make_Subtype_Indication (Loc,
3166               Subtype_Mark => New_Occurrence_Of (Atyp, Loc),
3167               Constraint   =>
3168                 Make_Index_Or_Discriminant_Constraint (Loc,
3169                   Constraints => New_List (
3170                     Make_Range (Loc,
3171                       Low_Bound  => Low_Bound,
3172                       High_Bound => High_Bound))))),
3173         Suppress => All_Checks);
3174
3175       --  If the result of the concatenation appears as the initializing
3176       --  expression of an object declaration, we can just rename the
3177       --  result, rather than copying it.
3178
3179       Set_OK_To_Rename (Ent);
3180
3181       --  Catch the static out of range case now
3182
3183       if Raises_Constraint_Error (High_Bound) then
3184          raise Concatenation_Error;
3185       end if;
3186
3187       --  Now we will generate the assignments to do the actual concatenation
3188
3189       --  There is one case in which we will not do this, namely when all the
3190       --  following conditions are met:
3191
3192       --    The result type is Standard.String
3193
3194       --    There are nine or fewer retained (non-null) operands
3195
3196       --    The optimization level is -O0
3197
3198       --    The corresponding System.Concat_n.Str_Concat_n routine is
3199       --    available in the run time.
3200
3201       --    The debug flag gnatd.c is not set
3202
3203       --  If all these conditions are met then we generate a call to the
3204       --  relevant concatenation routine. The purpose of this is to avoid
3205       --  undesirable code bloat at -O0.
3206
3207       if Atyp = Standard_String
3208         and then NN in 2 .. 9
3209         and then (Opt.Optimization_Level = 0 or else Debug_Flag_Dot_CC)
3210         and then not Debug_Flag_Dot_C
3211       then
3212          declare
3213             RR : constant array (Nat range 2 .. 9) of RE_Id :=
3214                    (RE_Str_Concat_2,
3215                     RE_Str_Concat_3,
3216                     RE_Str_Concat_4,
3217                     RE_Str_Concat_5,
3218                     RE_Str_Concat_6,
3219                     RE_Str_Concat_7,
3220                     RE_Str_Concat_8,
3221                     RE_Str_Concat_9);
3222
3223          begin
3224             if RTE_Available (RR (NN)) then
3225                declare
3226                   Opnds : constant List_Id :=
3227                             New_List (New_Occurrence_Of (Ent, Loc));
3228
3229                begin
3230                   for J in 1 .. NN loop
3231                      if Is_List_Member (Operands (J)) then
3232                         Remove (Operands (J));
3233                      end if;
3234
3235                      if Base_Type (Etype (Operands (J))) = Ctyp then
3236                         Append_To (Opnds,
3237                           Make_Aggregate (Loc,
3238                             Component_Associations => New_List (
3239                               Make_Component_Association (Loc,
3240                                 Choices => New_List (
3241                                   Make_Integer_Literal (Loc, 1)),
3242                                 Expression => Operands (J)))));
3243
3244                      else
3245                         Append_To (Opnds, Operands (J));
3246                      end if;
3247                   end loop;
3248
3249                   Insert_Action (Cnode,
3250                     Make_Procedure_Call_Statement (Loc,
3251                       Name => New_Reference_To (RTE (RR (NN)), Loc),
3252                       Parameter_Associations => Opnds));
3253
3254                   Result := New_Reference_To (Ent, Loc);
3255                   goto Done;
3256                end;
3257             end if;
3258          end;
3259       end if;
3260
3261       --  Not special case so generate the assignments
3262
3263       Known_Non_Null_Operand_Seen := False;
3264
3265       for J in 1 .. NN loop
3266          declare
3267             Lo : constant Node_Id :=
3268                    Make_Op_Add (Loc,
3269                      Left_Opnd  => To_Artyp (New_Copy (Low_Bound)),
3270                      Right_Opnd => Aggr_Length (J - 1));
3271
3272             Hi : constant Node_Id :=
3273                    Make_Op_Add (Loc,
3274                      Left_Opnd  => To_Artyp (New_Copy (Low_Bound)),
3275                      Right_Opnd =>
3276                        Make_Op_Subtract (Loc,
3277                          Left_Opnd  => Aggr_Length (J),
3278                          Right_Opnd => Make_Artyp_Literal (1)));
3279
3280          begin
3281             --  Singleton case, simple assignment
3282
3283             if Base_Type (Etype (Operands (J))) = Ctyp then
3284                Known_Non_Null_Operand_Seen := True;
3285                Insert_Action (Cnode,
3286                  Make_Assignment_Statement (Loc,
3287                    Name       =>
3288                      Make_Indexed_Component (Loc,
3289                        Prefix      => New_Occurrence_Of (Ent, Loc),
3290                        Expressions => New_List (To_Ityp (Lo))),
3291                    Expression => Operands (J)),
3292                  Suppress => All_Checks);
3293
3294             --  Array case, slice assignment, skipped when argument is fixed
3295             --  length and known to be null.
3296
3297             elsif (not Is_Fixed_Length (J)) or else (Fixed_Length (J) > 0) then
3298                declare
3299                   Assign : Node_Id :=
3300                              Make_Assignment_Statement (Loc,
3301                                Name       =>
3302                                  Make_Slice (Loc,
3303                                    Prefix         =>
3304                                      New_Occurrence_Of (Ent, Loc),
3305                                    Discrete_Range =>
3306                                      Make_Range (Loc,
3307                                        Low_Bound  => To_Ityp (Lo),
3308                                        High_Bound => To_Ityp (Hi))),
3309                                Expression => Operands (J));
3310                begin
3311                   if Is_Fixed_Length (J) then
3312                      Known_Non_Null_Operand_Seen := True;
3313
3314                   elsif not Known_Non_Null_Operand_Seen then
3315
3316                      --  Here if operand length is not statically known and no
3317                      --  operand known to be non-null has been processed yet.
3318                      --  If operand length is 0, we do not need to perform the
3319                      --  assignment, and we must avoid the evaluation of the
3320                      --  high bound of the slice, since it may underflow if the
3321                      --  low bound is Ityp'First.
3322
3323                      Assign :=
3324                        Make_Implicit_If_Statement (Cnode,
3325                          Condition       =>
3326                            Make_Op_Ne (Loc,
3327                              Left_Opnd  =>
3328                                New_Occurrence_Of (Var_Length (J), Loc),
3329                              Right_Opnd => Make_Integer_Literal (Loc, 0)),
3330                          Then_Statements => New_List (Assign));
3331                   end if;
3332
3333                   Insert_Action (Cnode, Assign, Suppress => All_Checks);
3334                end;
3335             end if;
3336          end;
3337       end loop;
3338
3339       --  Finally we build the result, which is a reference to the array object
3340
3341       Result := New_Reference_To (Ent, Loc);
3342
3343    <<Done>>
3344       Rewrite (Cnode, Result);
3345       Analyze_And_Resolve (Cnode, Atyp);
3346
3347    exception
3348       when Concatenation_Error =>
3349
3350          --  Kill warning generated for the declaration of the static out of
3351          --  range high bound, and instead generate a Constraint_Error with
3352          --  an appropriate specific message.
3353
3354          Kill_Dead_Code (Declaration_Node (Entity (High_Bound)));
3355          Apply_Compile_Time_Constraint_Error
3356            (N      => Cnode,
3357             Msg    => "concatenation result upper bound out of range?",
3358             Reason => CE_Range_Check_Failed);
3359          --  Set_Etype (Cnode, Atyp);
3360    end Expand_Concatenate;
3361
3362    ------------------------
3363    -- Expand_N_Allocator --
3364    ------------------------
3365
3366    procedure Expand_N_Allocator (N : Node_Id) is
3367       PtrT  : constant Entity_Id  := Etype (N);
3368       Dtyp  : constant Entity_Id  := Available_View (Designated_Type (PtrT));
3369       Etyp  : constant Entity_Id  := Etype (Expression (N));
3370       Loc   : constant Source_Ptr := Sloc (N);
3371       Desig : Entity_Id;
3372       Nod   : Node_Id;
3373       Pool  : Entity_Id;
3374       Temp  : Entity_Id;
3375
3376       procedure Rewrite_Coextension (N : Node_Id);
3377       --  Static coextensions have the same lifetime as the entity they
3378       --  constrain. Such occurrences can be rewritten as aliased objects
3379       --  and their unrestricted access used instead of the coextension.
3380
3381       function Size_In_Storage_Elements (E : Entity_Id) return Node_Id;
3382       --  Given a constrained array type E, returns a node representing the
3383       --  code to compute the size in storage elements for the given type.
3384       --  This is done without using the attribute (which malfunctions for
3385       --  large sizes ???)
3386
3387       -------------------------
3388       -- Rewrite_Coextension --
3389       -------------------------
3390
3391       procedure Rewrite_Coextension (N : Node_Id) is
3392          Temp_Id    : constant Node_Id := Make_Temporary (Loc, 'C');
3393          Temp_Decl  : Node_Id;
3394          Insert_Nod : Node_Id;
3395
3396       begin
3397          --  Generate:
3398          --    Cnn : aliased Etyp;
3399
3400          Temp_Decl :=
3401            Make_Object_Declaration (Loc,
3402              Defining_Identifier => Temp_Id,
3403              Aliased_Present     => True,
3404              Object_Definition   => New_Occurrence_Of (Etyp, Loc));
3405
3406          if Nkind (Expression (N)) = N_Qualified_Expression then
3407             Set_Expression (Temp_Decl, Expression (Expression (N)));
3408          end if;
3409
3410          --  Find the proper insertion node for the declaration
3411
3412          Insert_Nod := Parent (N);
3413          while Present (Insert_Nod) loop
3414             exit when
3415               Nkind (Insert_Nod) in N_Statement_Other_Than_Procedure_Call
3416                 or else Nkind (Insert_Nod) = N_Procedure_Call_Statement
3417                 or else Nkind (Insert_Nod) in N_Declaration;
3418
3419             Insert_Nod := Parent (Insert_Nod);
3420          end loop;
3421
3422          Insert_Before (Insert_Nod, Temp_Decl);
3423          Analyze (Temp_Decl);
3424
3425          Rewrite (N,
3426            Make_Attribute_Reference (Loc,
3427              Prefix         => New_Occurrence_Of (Temp_Id, Loc),
3428              Attribute_Name => Name_Unrestricted_Access));
3429
3430          Analyze_And_Resolve (N, PtrT);
3431       end Rewrite_Coextension;
3432
3433       ------------------------------
3434       -- Size_In_Storage_Elements --
3435       ------------------------------
3436
3437       function Size_In_Storage_Elements (E : Entity_Id) return Node_Id is
3438       begin
3439          --  Logically this just returns E'Max_Size_In_Storage_Elements.
3440          --  However, the reason for the existence of this function is
3441          --  to construct a test for sizes too large, which means near the
3442          --  32-bit limit on a 32-bit machine, and precisely the trouble
3443          --  is that we get overflows when sizes are greater than 2**31.
3444
3445          --  So what we end up doing for array types is to use the expression:
3446
3447          --    number-of-elements * component_type'Max_Size_In_Storage_Elements
3448
3449          --  which avoids this problem. All this is a bit bogus, but it does
3450          --  mean we catch common cases of trying to allocate arrays that
3451          --  are too large, and which in the absence of a check results in
3452          --  undetected chaos ???
3453
3454          declare
3455             Len : Node_Id;
3456             Res : Node_Id;
3457
3458          begin
3459             for J in 1 .. Number_Dimensions (E) loop
3460                Len :=
3461                  Make_Attribute_Reference (Loc,
3462                    Prefix         => New_Occurrence_Of (E, Loc),
3463                    Attribute_Name => Name_Length,
3464                    Expressions    => New_List (Make_Integer_Literal (Loc, J)));
3465
3466                if J = 1 then
3467                   Res := Len;
3468
3469                else
3470                   Res :=
3471                     Make_Op_Multiply (Loc,
3472                       Left_Opnd  => Res,
3473                       Right_Opnd => Len);
3474                end if;
3475             end loop;
3476
3477             return
3478               Make_Op_Multiply (Loc,
3479                 Left_Opnd  => Len,
3480                 Right_Opnd =>
3481                   Make_Attribute_Reference (Loc,
3482                     Prefix => New_Occurrence_Of (Component_Type (E), Loc),
3483                     Attribute_Name => Name_Max_Size_In_Storage_Elements));
3484          end;
3485       end Size_In_Storage_Elements;
3486
3487    --  Start of processing for Expand_N_Allocator
3488
3489    begin
3490       --  RM E.2.3(22). We enforce that the expected type of an allocator
3491       --  shall not be a remote access-to-class-wide-limited-private type
3492
3493       --  Why is this being done at expansion time, seems clearly wrong ???
3494
3495       Validate_Remote_Access_To_Class_Wide_Type (N);
3496
3497       --  Processing for anonymous access-to-controlled types. These access
3498       --  types receive a special finalization master which appears in the
3499       --  declarations of the enclosing semantic unit. This expansion is done
3500       --  now to ensure that any additional types generated by this routine
3501       --  or Expand_Allocator_Expression inherit the proper type attributes.
3502
3503       if Ekind (PtrT) = E_Anonymous_Access_Type
3504         and then Needs_Finalization (Dtyp)
3505       then
3506          --  Anonymous access-to-controlled types allocate on the global pool.
3507          --  Do not set this attribute on .NET/JVM since those targets do not
3508          --  support pools.
3509
3510          if No (Associated_Storage_Pool (PtrT))
3511            and then VM_Target = No_VM
3512          then
3513             Set_Associated_Storage_Pool
3514               (PtrT, Get_Global_Pool_For_Access_Type (PtrT));
3515          end if;
3516
3517          --  The finalization master must be inserted and analyzed as part of
3518          --  the current semantic unit. This form of expansion is not carried
3519          --  out in Alfa mode because it is useless.
3520
3521          if No (Finalization_Master (PtrT))
3522            and then not Alfa_Mode
3523          then
3524             Set_Finalization_Master (PtrT, Current_Anonymous_Master);
3525          end if;
3526       end if;
3527
3528       --  Set the storage pool and find the appropriate version of Allocate to
3529       --  call. Do not overwrite the storage pool if it is already set, which
3530       --  can happen for build-in-place function returns (see
3531       --  Exp_Ch4.Expand_N_Extended_Return_Statement).
3532
3533       if No (Storage_Pool (N)) then
3534          Pool := Associated_Storage_Pool (Root_Type (PtrT));
3535
3536          if Present (Pool) then
3537             Set_Storage_Pool (N, Pool);
3538
3539             if Is_RTE (Pool, RE_SS_Pool) then
3540                if VM_Target = No_VM then
3541                   Set_Procedure_To_Call (N, RTE (RE_SS_Allocate));
3542                end if;
3543
3544             elsif Is_Class_Wide_Type (Etype (Pool)) then
3545                Set_Procedure_To_Call (N, RTE (RE_Allocate_Any));
3546
3547             else
3548                Set_Procedure_To_Call (N,
3549                  Find_Prim_Op (Etype (Pool), Name_Allocate));
3550             end if;
3551          end if;
3552       end if;
3553
3554       --  Under certain circumstances we can replace an allocator by an access
3555       --  to statically allocated storage. The conditions, as noted in AARM
3556       --  3.10 (10c) are as follows:
3557
3558       --    Size and initial value is known at compile time
3559       --    Access type is access-to-constant
3560
3561       --  The allocator is not part of a constraint on a record component,
3562       --  because in that case the inserted actions are delayed until the
3563       --  record declaration is fully analyzed, which is too late for the
3564       --  analysis of the rewritten allocator.
3565
3566       if Is_Access_Constant (PtrT)
3567         and then Nkind (Expression (N)) = N_Qualified_Expression
3568         and then Compile_Time_Known_Value (Expression (Expression (N)))
3569         and then Size_Known_At_Compile_Time
3570                    (Etype (Expression (Expression (N))))
3571         and then not Is_Record_Type (Current_Scope)
3572       then
3573          --  Here we can do the optimization. For the allocator
3574
3575          --    new x'(y)
3576
3577          --  We insert an object declaration
3578
3579          --    Tnn : aliased x := y;
3580
3581          --  and replace the allocator by Tnn'Unrestricted_Access. Tnn is
3582          --  marked as requiring static allocation.
3583
3584          Temp  := Make_Temporary (Loc, 'T', Expression (Expression (N)));
3585          Desig := Subtype_Mark (Expression (N));
3586
3587          --  If context is constrained, use constrained subtype directly,
3588          --  so that the constant is not labelled as having a nominally
3589          --  unconstrained subtype.
3590
3591          if Entity (Desig) = Base_Type (Dtyp) then
3592             Desig := New_Occurrence_Of (Dtyp, Loc);
3593          end if;
3594
3595          Insert_Action (N,
3596            Make_Object_Declaration (Loc,
3597              Defining_Identifier => Temp,
3598              Aliased_Present     => True,
3599              Constant_Present    => Is_Access_Constant (PtrT),
3600              Object_Definition   => Desig,
3601              Expression          => Expression (Expression (N))));
3602
3603          Rewrite (N,
3604            Make_Attribute_Reference (Loc,
3605              Prefix         => New_Occurrence_Of (Temp, Loc),
3606              Attribute_Name => Name_Unrestricted_Access));
3607
3608          Analyze_And_Resolve (N, PtrT);
3609
3610          --  We set the variable as statically allocated, since we don't want
3611          --  it going on the stack of the current procedure!
3612
3613          Set_Is_Statically_Allocated (Temp);
3614          return;
3615       end if;
3616
3617       --  Same if the allocator is an access discriminant for a local object:
3618       --  instead of an allocator we create a local value and constrain the
3619       --  enclosing object with the corresponding access attribute.
3620
3621       if Is_Static_Coextension (N) then
3622          Rewrite_Coextension (N);
3623          return;
3624       end if;
3625
3626       --  Check for size too large, we do this because the back end misses
3627       --  proper checks here and can generate rubbish allocation calls when
3628       --  we are near the limit. We only do this for the 32-bit address case
3629       --  since that is from a practical point of view where we see a problem.
3630
3631       if System_Address_Size = 32
3632         and then not Storage_Checks_Suppressed (PtrT)
3633         and then not Storage_Checks_Suppressed (Dtyp)
3634         and then not Storage_Checks_Suppressed (Etyp)
3635       then
3636          --  The check we want to generate should look like
3637
3638          --  if Etyp'Max_Size_In_Storage_Elements > 3.5 gigabytes then
3639          --    raise Storage_Error;
3640          --  end if;
3641
3642          --  where 3.5 gigabytes is a constant large enough to accommodate any
3643          --  reasonable request for. But we can't do it this way because at
3644          --  least at the moment we don't compute this attribute right, and
3645          --  can silently give wrong results when the result gets large. Since
3646          --  this is all about large results, that's bad, so instead we only
3647          --  apply the check for constrained arrays, and manually compute the
3648          --  value of the attribute ???
3649
3650          if Is_Array_Type (Etyp) and then Is_Constrained (Etyp) then
3651             Insert_Action (N,
3652               Make_Raise_Storage_Error (Loc,
3653                 Condition =>
3654                   Make_Op_Gt (Loc,
3655                     Left_Opnd  => Size_In_Storage_Elements (Etyp),
3656                     Right_Opnd =>
3657                       Make_Integer_Literal (Loc, Uint_7 * (Uint_2 ** 29))),
3658                 Reason    => SE_Object_Too_Large));
3659          end if;
3660       end if;
3661
3662       --  Handle case of qualified expression (other than optimization above)
3663       --  First apply constraint checks, because the bounds or discriminants
3664       --  in the aggregate might not match the subtype mark in the allocator.
3665
3666       if Nkind (Expression (N)) = N_Qualified_Expression then
3667          Apply_Constraint_Check
3668            (Expression (Expression (N)), Etype (Expression (N)));
3669
3670          Expand_Allocator_Expression (N);
3671          return;
3672       end if;
3673
3674       --  If the allocator is for a type which requires initialization, and
3675       --  there is no initial value (i.e. operand is a subtype indication
3676       --  rather than a qualified expression), then we must generate a call to
3677       --  the initialization routine using an expressions action node:
3678
3679       --     [Pnnn : constant ptr_T := new (T); Init (Pnnn.all,...); Pnnn]
3680
3681       --  Here ptr_T is the pointer type for the allocator, and T is the
3682       --  subtype of the allocator. A special case arises if the designated
3683       --  type of the access type is a task or contains tasks. In this case
3684       --  the call to Init (Temp.all ...) is replaced by code that ensures
3685       --  that tasks get activated (see Exp_Ch9.Build_Task_Allocate_Block
3686       --  for details). In addition, if the type T is a task T, then the
3687       --  first argument to Init must be converted to the task record type.
3688
3689       declare
3690          T         : constant Entity_Id := Entity (Expression (N));
3691          Args      : List_Id;
3692          Decls     : List_Id;
3693          Decl      : Node_Id;
3694          Discr     : Elmt_Id;
3695          Init      : Entity_Id;
3696          Init_Arg1 : Node_Id;
3697          Temp_Decl : Node_Id;
3698          Temp_Type : Entity_Id;
3699
3700       begin
3701          if No_Initialization (N) then
3702
3703             --  Even though this might be a simple allocation, create a custom
3704             --  Allocate if the context requires it. Since .NET/JVM compilers
3705             --  do not support pools, this step is skipped.
3706
3707             if VM_Target = No_VM
3708               and then Present (Finalization_Master (PtrT))
3709             then
3710                Build_Allocate_Deallocate_Proc
3711                  (N           => N,
3712                   Is_Allocate => True);
3713             end if;
3714
3715          --  Case of no initialization procedure present
3716
3717          elsif not Has_Non_Null_Base_Init_Proc (T) then
3718
3719             --  Case of simple initialization required
3720
3721             if Needs_Simple_Initialization (T) then
3722                Check_Restriction (No_Default_Initialization, N);
3723                Rewrite (Expression (N),
3724                  Make_Qualified_Expression (Loc,
3725                    Subtype_Mark => New_Occurrence_Of (T, Loc),
3726                    Expression   => Get_Simple_Init_Val (T, N)));
3727
3728                Analyze_And_Resolve (Expression (Expression (N)), T);
3729                Analyze_And_Resolve (Expression (N), T);
3730                Set_Paren_Count     (Expression (Expression (N)), 1);
3731                Expand_N_Allocator  (N);
3732
3733             --  No initialization required
3734
3735             else
3736                null;
3737             end if;
3738
3739          --  Case of initialization procedure present, must be called
3740
3741          else
3742             Check_Restriction (No_Default_Initialization, N);
3743
3744             if not Restriction_Active (No_Default_Initialization) then
3745                Init := Base_Init_Proc (T);
3746                Nod  := N;
3747                Temp := Make_Temporary (Loc, 'P');
3748
3749                --  Construct argument list for the initialization routine call
3750
3751                Init_Arg1 :=
3752                  Make_Explicit_Dereference (Loc,
3753                    Prefix =>
3754                      New_Reference_To (Temp, Loc));
3755
3756                Set_Assignment_OK (Init_Arg1);
3757                Temp_Type := PtrT;
3758
3759                --  The initialization procedure expects a specific type. if the
3760                --  context is access to class wide, indicate that the object
3761                --  being allocated has the right specific type.
3762
3763                if Is_Class_Wide_Type (Dtyp) then
3764                   Init_Arg1 := Unchecked_Convert_To (T, Init_Arg1);
3765                end if;
3766
3767                --  If designated type is a concurrent type or if it is private
3768                --  type whose definition is a concurrent type, the first
3769                --  argument in the Init routine has to be unchecked conversion
3770                --  to the corresponding record type. If the designated type is
3771                --  a derived type, also convert the argument to its root type.
3772
3773                if Is_Concurrent_Type (T) then
3774                   Init_Arg1 :=
3775                     Unchecked_Convert_To (
3776                       Corresponding_Record_Type (T), Init_Arg1);
3777
3778                elsif Is_Private_Type (T)
3779                  and then Present (Full_View (T))
3780                  and then Is_Concurrent_Type (Full_View (T))
3781                then
3782                   Init_Arg1 :=
3783                     Unchecked_Convert_To
3784                       (Corresponding_Record_Type (Full_View (T)), Init_Arg1);
3785
3786                elsif Etype (First_Formal (Init)) /= Base_Type (T) then
3787                   declare
3788                      Ftyp : constant Entity_Id := Etype (First_Formal (Init));
3789
3790                   begin
3791                      Init_Arg1 := OK_Convert_To (Etype (Ftyp), Init_Arg1);
3792                      Set_Etype (Init_Arg1, Ftyp);
3793                   end;
3794                end if;
3795
3796                Args := New_List (Init_Arg1);
3797
3798                --  For the task case, pass the Master_Id of the access type as
3799                --  the value of the _Master parameter, and _Chain as the value
3800                --  of the _Chain parameter (_Chain will be defined as part of
3801                --  the generated code for the allocator).
3802
3803                --  In Ada 2005, the context may be a function that returns an
3804                --  anonymous access type. In that case the Master_Id has been
3805                --  created when expanding the function declaration.
3806
3807                if Has_Task (T) then
3808                   if No (Master_Id (Base_Type (PtrT))) then
3809
3810                      --  The designated type was an incomplete type, and the
3811                      --  access type did not get expanded. Salvage it now.
3812
3813                      if not Restriction_Active (No_Task_Hierarchy) then
3814                         pragma Assert (Present (Parent (Base_Type (PtrT))));
3815                         Expand_N_Full_Type_Declaration
3816                           (Parent (Base_Type (PtrT)));
3817                      end if;
3818                   end if;
3819
3820                   --  If the context of the allocator is a declaration or an
3821                   --  assignment, we can generate a meaningful image for it,
3822                   --  even though subsequent assignments might remove the
3823                   --  connection between task and entity. We build this image
3824                   --  when the left-hand side is a simple variable, a simple
3825                   --  indexed assignment or a simple selected component.
3826
3827                   if Nkind (Parent (N)) = N_Assignment_Statement then
3828                      declare
3829                         Nam : constant Node_Id := Name (Parent (N));
3830
3831                      begin
3832                         if Is_Entity_Name (Nam) then
3833                            Decls :=
3834                              Build_Task_Image_Decls
3835                                (Loc,
3836                                 New_Occurrence_Of
3837                                   (Entity (Nam), Sloc (Nam)), T);
3838
3839                         elsif Nkind_In (Nam, N_Indexed_Component,
3840                                              N_Selected_Component)
3841                           and then Is_Entity_Name (Prefix (Nam))
3842                         then
3843                            Decls :=
3844                              Build_Task_Image_Decls
3845                                (Loc, Nam, Etype (Prefix (Nam)));
3846                         else
3847                            Decls := Build_Task_Image_Decls (Loc, T, T);
3848                         end if;
3849                      end;
3850
3851                   elsif Nkind (Parent (N)) = N_Object_Declaration then
3852                      Decls :=
3853                        Build_Task_Image_Decls
3854                          (Loc, Defining_Identifier (Parent (N)), T);
3855
3856                   else
3857                      Decls := Build_Task_Image_Decls (Loc, T, T);
3858                   end if;
3859
3860                   if Restriction_Active (No_Task_Hierarchy) then
3861                      Append_To (Args,
3862                        New_Occurrence_Of (RTE (RE_Library_Task_Level), Loc));
3863                   else
3864                      Append_To (Args,
3865                        New_Reference_To
3866                          (Master_Id (Base_Type (Root_Type (PtrT))), Loc));
3867                   end if;
3868
3869                   Append_To (Args, Make_Identifier (Loc, Name_uChain));
3870
3871                   Decl := Last (Decls);
3872                   Append_To (Args,
3873                     New_Occurrence_Of (Defining_Identifier (Decl), Loc));
3874
3875                --  Has_Task is false, Decls not used
3876
3877                else
3878                   Decls := No_List;
3879                end if;
3880
3881                --  Add discriminants if discriminated type
3882
3883                declare
3884                   Dis : Boolean := False;
3885                   Typ : Entity_Id;
3886
3887                begin
3888                   if Has_Discriminants (T) then
3889                      Dis := True;
3890                      Typ := T;
3891
3892                   elsif Is_Private_Type (T)
3893                     and then Present (Full_View (T))
3894                     and then Has_Discriminants (Full_View (T))
3895                   then
3896                      Dis := True;
3897                      Typ := Full_View (T);
3898                   end if;
3899
3900                   if Dis then
3901
3902                      --  If the allocated object will be constrained by the
3903                      --  default values for discriminants, then build a subtype
3904                      --  with those defaults, and change the allocated subtype
3905                      --  to that. Note that this happens in fewer cases in Ada
3906                      --  2005 (AI-363).
3907
3908                      if not Is_Constrained (Typ)
3909                        and then Present (Discriminant_Default_Value
3910                                           (First_Discriminant (Typ)))
3911                        and then (Ada_Version < Ada_2005
3912                                   or else
3913                                     not Has_Constrained_Partial_View (Typ))
3914                      then
3915                         Typ := Build_Default_Subtype (Typ, N);
3916                         Set_Expression (N, New_Reference_To (Typ, Loc));
3917                      end if;
3918
3919                      Discr := First_Elmt (Discriminant_Constraint (Typ));
3920                      while Present (Discr) loop
3921                         Nod := Node (Discr);
3922                         Append (New_Copy_Tree (Node (Discr)), Args);
3923
3924                         --  AI-416: when the discriminant constraint is an
3925                         --  anonymous access type make sure an accessibility
3926                         --  check is inserted if necessary (3.10.2(22.q/2))
3927
3928                         if Ada_Version >= Ada_2005
3929                           and then
3930                             Ekind (Etype (Nod)) = E_Anonymous_Access_Type
3931                         then
3932                            Apply_Accessibility_Check
3933                              (Nod, Typ, Insert_Node => Nod);
3934                         end if;
3935
3936                         Next_Elmt (Discr);
3937                      end loop;
3938                   end if;
3939                end;
3940
3941                --  We set the allocator as analyzed so that when we analyze the
3942                --  expression actions node, we do not get an unwanted recursive
3943                --  expansion of the allocator expression.
3944
3945                Set_Analyzed (N, True);
3946                Nod := Relocate_Node (N);
3947
3948                --  Here is the transformation:
3949                --    input:  new Ctrl_Typ
3950                --    output: Temp : constant Ctrl_Typ_Ptr := new Ctrl_Typ;
3951                --            Ctrl_TypIP (Temp.all, ...);
3952                --            [Deep_]Initialize (Temp.all);
3953
3954                --  Here Ctrl_Typ_Ptr is the pointer type for the allocator, and
3955                --  is the subtype of the allocator.
3956
3957                Temp_Decl :=
3958                  Make_Object_Declaration (Loc,
3959                    Defining_Identifier => Temp,
3960                    Constant_Present    => True,
3961                    Object_Definition   => New_Reference_To (Temp_Type, Loc),
3962                    Expression          => Nod);
3963
3964                Set_Assignment_OK (Temp_Decl);
3965                Insert_Action (N, Temp_Decl, Suppress => All_Checks);
3966
3967                Build_Allocate_Deallocate_Proc (Temp_Decl, True);
3968
3969                --  If the designated type is a task type or contains tasks,
3970                --  create block to activate created tasks, and insert
3971                --  declaration for Task_Image variable ahead of call.
3972
3973                if Has_Task (T) then
3974                   declare
3975                      L   : constant List_Id := New_List;
3976                      Blk : Node_Id;
3977                   begin
3978                      Build_Task_Allocate_Block (L, Nod, Args);
3979                      Blk := Last (L);
3980                      Insert_List_Before (First (Declarations (Blk)), Decls);
3981                      Insert_Actions (N, L);
3982                   end;
3983
3984                else
3985                   Insert_Action (N,
3986                     Make_Procedure_Call_Statement (Loc,
3987                       Name                   => New_Reference_To (Init, Loc),
3988                       Parameter_Associations => Args));
3989                end if;
3990
3991                if Needs_Finalization (T) then
3992
3993                   --  Generate:
3994                   --    [Deep_]Initialize (Init_Arg1);
3995
3996                   Insert_Action (N,
3997                     Make_Init_Call
3998                       (Obj_Ref => New_Copy_Tree (Init_Arg1),
3999                        Typ     => T));
4000
4001                   if Present (Finalization_Master (PtrT)) then
4002
4003                      --  Special processing for .NET/JVM, the allocated object
4004                      --  is attached to the finalization master. Generate:
4005
4006                      --    Attach (<PtrT>FM, Root_Controlled_Ptr (Init_Arg1));
4007
4008                      --  Types derived from [Limited_]Controlled are the only
4009                      --  ones considered since they have fields Prev and Next.
4010
4011                      if VM_Target /= No_VM then
4012                         if Is_Controlled (T) then
4013                            Insert_Action (N,
4014                              Make_Attach_Call
4015                                (Obj_Ref => New_Copy_Tree (Init_Arg1),
4016                                 Ptr_Typ => PtrT));
4017                         end if;
4018
4019                      --  Default case, generate:
4020
4021                      --    Set_Finalize_Address
4022                      --      (<PtrT>FM, <T>FD'Unrestricted_Access);
4023
4024                      --  Do not generate this call in the following cases:
4025                      --
4026                      --    * Alfa mode - the call is useless and results in
4027                      --    unwanted expansion.
4028                      --
4029                      --    * CodePeer mode - TSS primitive Finalize_Address is
4030                      --    not created in this mode.
4031
4032                      elsif not Alfa_Mode
4033                        and then not CodePeer_Mode
4034                      then
4035                         Insert_Action (N,
4036                           Make_Set_Finalize_Address_Call
4037                             (Loc     => Loc,
4038                              Typ     => T,
4039                              Ptr_Typ => PtrT));
4040                      end if;
4041                   end if;
4042                end if;
4043
4044                Rewrite (N, New_Reference_To (Temp, Loc));
4045                Analyze_And_Resolve (N, PtrT);
4046             end if;
4047          end if;
4048       end;
4049
4050       --  Ada 2005 (AI-251): If the allocator is for a class-wide interface
4051       --  object that has been rewritten as a reference, we displace "this"
4052       --  to reference properly its secondary dispatch table.
4053
4054       if Nkind (N) = N_Identifier
4055         and then Is_Interface (Dtyp)
4056       then
4057          Displace_Allocator_Pointer (N);
4058       end if;
4059
4060    exception
4061       when RE_Not_Available =>
4062          return;
4063    end Expand_N_Allocator;
4064
4065    -----------------------
4066    -- Expand_N_And_Then --
4067    -----------------------
4068
4069    procedure Expand_N_And_Then (N : Node_Id)
4070      renames Expand_Short_Circuit_Operator;
4071
4072    ------------------------------
4073    -- Expand_N_Case_Expression --
4074    ------------------------------
4075
4076    procedure Expand_N_Case_Expression (N : Node_Id) is
4077       Loc     : constant Source_Ptr := Sloc (N);
4078       Typ     : constant Entity_Id  := Etype (N);
4079       Cstmt   : Node_Id;
4080       Tnn     : Entity_Id;
4081       Pnn     : Entity_Id;
4082       Actions : List_Id;
4083       Ttyp    : Entity_Id;
4084       Alt     : Node_Id;
4085       Fexp    : Node_Id;
4086
4087    begin
4088       --  We expand
4089
4090       --    case X is when A => AX, when B => BX ...
4091
4092       --  to
4093
4094       --    do
4095       --       Tnn : typ;
4096       --       case X is
4097       --          when A =>
4098       --             Tnn := AX;
4099       --          when B =>
4100       --             Tnn := BX;
4101       --          ...
4102       --       end case;
4103       --    in Tnn end;
4104
4105       --  However, this expansion is wrong for limited types, and also
4106       --  wrong for unconstrained types (since the bounds may not be the
4107       --  same in all branches). Furthermore it involves an extra copy
4108       --  for large objects. So we take care of this by using the following
4109       --  modified expansion for non-scalar types:
4110
4111       --    do
4112       --       type Pnn is access all typ;
4113       --       Tnn : Pnn;
4114       --       case X is
4115       --          when A =>
4116       --             T := AX'Unrestricted_Access;
4117       --          when B =>
4118       --             T := BX'Unrestricted_Access;
4119       --          ...
4120       --       end case;
4121       --    in Tnn.all end;
4122
4123       Cstmt :=
4124         Make_Case_Statement (Loc,
4125           Expression   => Expression (N),
4126           Alternatives => New_List);
4127
4128       Actions := New_List;
4129
4130       --  Scalar case
4131
4132       if Is_Scalar_Type (Typ) then
4133          Ttyp := Typ;
4134
4135       else
4136          Pnn := Make_Temporary (Loc, 'P');
4137          Append_To (Actions,
4138            Make_Full_Type_Declaration (Loc,
4139              Defining_Identifier => Pnn,
4140              Type_Definition =>
4141                Make_Access_To_Object_Definition (Loc,
4142                  All_Present => True,
4143                  Subtype_Indication =>
4144                    New_Reference_To (Typ, Loc))));
4145          Ttyp := Pnn;
4146       end if;
4147
4148       Tnn := Make_Temporary (Loc, 'T');
4149       Append_To (Actions,
4150         Make_Object_Declaration (Loc,
4151           Defining_Identifier => Tnn,
4152           Object_Definition   => New_Occurrence_Of (Ttyp, Loc)));
4153
4154       --  Now process the alternatives
4155
4156       Alt := First (Alternatives (N));
4157       while Present (Alt) loop
4158          declare
4159             Aexp  : Node_Id             := Expression (Alt);
4160             Aloc  : constant Source_Ptr := Sloc (Aexp);
4161             Stats : List_Id;
4162
4163          begin
4164             --  As described above, take Unrestricted_Access for case of non-
4165             --  scalar types, to avoid big copies, and special cases.
4166
4167             if not Is_Scalar_Type (Typ) then
4168                Aexp :=
4169                  Make_Attribute_Reference (Aloc,
4170                    Prefix         => Relocate_Node (Aexp),
4171                    Attribute_Name => Name_Unrestricted_Access);
4172             end if;
4173
4174             Stats := New_List (
4175               Make_Assignment_Statement (Aloc,
4176                 Name       => New_Occurrence_Of (Tnn, Loc),
4177                 Expression => Aexp));
4178
4179             --  Propagate declarations inserted in the node by Insert_Actions
4180             --  (for example, temporaries generated to remove side effects).
4181             --  These actions must remain attached to the alternative, given
4182             --  that they are generated by the corresponding expression.
4183
4184             if Present (Sinfo.Actions (Alt)) then
4185                Prepend_List (Sinfo.Actions (Alt), Stats);
4186             end if;
4187
4188             Append_To
4189               (Alternatives (Cstmt),
4190                Make_Case_Statement_Alternative (Sloc (Alt),
4191                  Discrete_Choices => Discrete_Choices (Alt),
4192                  Statements       => Stats));
4193          end;
4194
4195          Next (Alt);
4196       end loop;
4197
4198       Append_To (Actions, Cstmt);
4199
4200       --  Construct and return final expression with actions
4201
4202       if Is_Scalar_Type (Typ) then
4203          Fexp := New_Occurrence_Of (Tnn, Loc);
4204       else
4205          Fexp :=
4206            Make_Explicit_Dereference (Loc,
4207              Prefix => New_Occurrence_Of (Tnn, Loc));
4208       end if;
4209
4210       Rewrite (N,
4211         Make_Expression_With_Actions (Loc,
4212           Expression => Fexp,
4213           Actions    => Actions));
4214
4215       Analyze_And_Resolve (N, Typ);
4216    end Expand_N_Case_Expression;
4217
4218    -------------------------------------
4219    -- Expand_N_Conditional_Expression --
4220    -------------------------------------
4221
4222    --  Deal with limited types and expression actions
4223
4224    procedure Expand_N_Conditional_Expression (N : Node_Id) is
4225       Loc    : constant Source_Ptr := Sloc (N);
4226       Cond   : constant Node_Id    := First (Expressions (N));
4227       Thenx  : constant Node_Id    := Next (Cond);
4228       Elsex  : constant Node_Id    := Next (Thenx);
4229       Typ    : constant Entity_Id  := Etype (N);
4230
4231       Cnn     : Entity_Id;
4232       Decl    : Node_Id;
4233       New_If  : Node_Id;
4234       New_N   : Node_Id;
4235       P_Decl  : Node_Id;
4236       Expr    : Node_Id;
4237       Actions : List_Id;
4238
4239    begin
4240       --  Fold at compile time if condition known. We have already folded
4241       --  static conditional expressions, but it is possible to fold any
4242       --  case in which the condition is known at compile time, even though
4243       --  the result is non-static.
4244
4245       --  Note that we don't do the fold of such cases in Sem_Elab because
4246       --  it can cause infinite loops with the expander adding a conditional
4247       --  expression, and Sem_Elab circuitry removing it repeatedly.
4248
4249       if Compile_Time_Known_Value (Cond) then
4250          if Is_True (Expr_Value (Cond)) then
4251             Expr := Thenx;
4252             Actions := Then_Actions (N);
4253          else
4254             Expr := Elsex;
4255             Actions := Else_Actions (N);
4256          end if;
4257
4258          Remove (Expr);
4259
4260          if Present (Actions) then
4261
4262             --  If we are not allowed to use Expression_With_Actions, just skip
4263             --  the optimization, it is not critical for correctness.
4264
4265             if not Use_Expression_With_Actions then
4266                goto Skip_Optimization;
4267             end if;
4268
4269             Rewrite (N,
4270               Make_Expression_With_Actions (Loc,
4271                 Expression => Relocate_Node (Expr),
4272                 Actions    => Actions));
4273             Analyze_And_Resolve (N, Typ);
4274
4275          else
4276             Rewrite (N, Relocate_Node (Expr));
4277          end if;
4278
4279          --  Note that the result is never static (legitimate cases of static
4280          --  conditional expressions were folded in Sem_Eval).
4281
4282          Set_Is_Static_Expression (N, False);
4283          return;
4284       end if;
4285
4286       <<Skip_Optimization>>
4287
4288       --  If the type is limited or unconstrained, we expand as follows to
4289       --  avoid any possibility of improper copies.
4290
4291       --  Note: it may be possible to avoid this special processing if the
4292       --  back end uses its own mechanisms for handling by-reference types ???
4293
4294       --      type Ptr is access all Typ;
4295       --      Cnn : Ptr;
4296       --      if cond then
4297       --         <<then actions>>
4298       --         Cnn := then-expr'Unrestricted_Access;
4299       --      else
4300       --         <<else actions>>
4301       --         Cnn := else-expr'Unrestricted_Access;
4302       --      end if;
4303
4304       --  and replace the conditional expression by a reference to Cnn.all.
4305
4306       --  This special case can be skipped if the back end handles limited
4307       --  types properly and ensures that no incorrect copies are made.
4308
4309       if Is_By_Reference_Type (Typ)
4310         and then not Back_End_Handles_Limited_Types
4311       then
4312          Cnn := Make_Temporary (Loc, 'C', N);
4313
4314          P_Decl :=
4315            Make_Full_Type_Declaration (Loc,
4316              Defining_Identifier =>
4317                Make_Temporary (Loc, 'A'),
4318              Type_Definition =>
4319                Make_Access_To_Object_Definition (Loc,
4320                  All_Present        => True,
4321                  Subtype_Indication => New_Reference_To (Typ, Loc)));
4322
4323          Insert_Action (N, P_Decl);
4324
4325          Decl :=
4326             Make_Object_Declaration (Loc,
4327               Defining_Identifier => Cnn,
4328               Object_Definition   =>
4329                    New_Occurrence_Of (Defining_Identifier (P_Decl), Loc));
4330
4331          New_If :=
4332            Make_Implicit_If_Statement (N,
4333              Condition => Relocate_Node (Cond),
4334
4335              Then_Statements => New_List (
4336                Make_Assignment_Statement (Sloc (Thenx),
4337                  Name       => New_Occurrence_Of (Cnn, Sloc (Thenx)),
4338                  Expression =>
4339                    Make_Attribute_Reference (Loc,
4340                      Attribute_Name => Name_Unrestricted_Access,
4341                      Prefix         =>  Relocate_Node (Thenx)))),
4342
4343              Else_Statements => New_List (
4344                Make_Assignment_Statement (Sloc (Elsex),
4345                  Name       => New_Occurrence_Of (Cnn, Sloc (Elsex)),
4346                  Expression =>
4347                    Make_Attribute_Reference (Loc,
4348                      Attribute_Name => Name_Unrestricted_Access,
4349                      Prefix         => Relocate_Node (Elsex)))));
4350
4351          New_N :=
4352            Make_Explicit_Dereference (Loc,
4353              Prefix => New_Occurrence_Of (Cnn, Loc));
4354
4355       --  For other types, we only need to expand if there are other actions
4356       --  associated with either branch.
4357
4358       elsif Present (Then_Actions (N)) or else Present (Else_Actions (N)) then
4359
4360          --  We have two approaches to handling this. If we are allowed to use
4361          --  N_Expression_With_Actions, then we can just wrap the actions into
4362          --  the appropriate expression.
4363
4364          if Use_Expression_With_Actions then
4365             if Present (Then_Actions (N)) then
4366                Rewrite (Thenx,
4367                  Make_Expression_With_Actions (Sloc (Thenx),
4368                    Actions    => Then_Actions (N),
4369                    Expression => Relocate_Node (Thenx)));
4370                Set_Then_Actions (N, No_List);
4371                Analyze_And_Resolve (Thenx, Typ);
4372             end if;
4373
4374             if Present (Else_Actions (N)) then
4375                Rewrite (Elsex,
4376                  Make_Expression_With_Actions (Sloc (Elsex),
4377                    Actions    => Else_Actions (N),
4378                    Expression => Relocate_Node (Elsex)));
4379                Set_Else_Actions (N, No_List);
4380                Analyze_And_Resolve (Elsex, Typ);
4381             end if;
4382
4383             return;
4384
4385             --  if we can't use N_Expression_With_Actions nodes, then we insert
4386             --  the following sequence of actions (using Insert_Actions):
4387
4388             --      Cnn : typ;
4389             --      if cond then
4390             --         <<then actions>>
4391             --         Cnn := then-expr;
4392             --      else
4393             --         <<else actions>>
4394             --         Cnn := else-expr
4395             --      end if;
4396
4397             --  and replace the conditional expression by a reference to Cnn
4398
4399          else
4400             Cnn := Make_Temporary (Loc, 'C', N);
4401
4402             Decl :=
4403               Make_Object_Declaration (Loc,
4404                 Defining_Identifier => Cnn,
4405                 Object_Definition   => New_Occurrence_Of (Typ, Loc));
4406
4407             New_If :=
4408               Make_Implicit_If_Statement (N,
4409                 Condition       => Relocate_Node (Cond),
4410
4411                 Then_Statements => New_List (
4412                   Make_Assignment_Statement (Sloc (Thenx),
4413                     Name       => New_Occurrence_Of (Cnn, Sloc (Thenx)),
4414                     Expression => Relocate_Node (Thenx))),
4415
4416                 Else_Statements => New_List (
4417                   Make_Assignment_Statement (Sloc (Elsex),
4418                     Name       => New_Occurrence_Of (Cnn, Sloc (Elsex)),
4419                     Expression => Relocate_Node (Elsex))));
4420
4421             Set_Assignment_OK (Name (First (Then_Statements (New_If))));
4422             Set_Assignment_OK (Name (First (Else_Statements (New_If))));
4423
4424             New_N := New_Occurrence_Of (Cnn, Loc);
4425          end if;
4426
4427          --  If no actions then no expansion needed, gigi will handle it using
4428          --  the same approach as a C conditional expression.
4429
4430       else
4431          return;
4432       end if;
4433
4434       --  Fall through here for either the limited expansion, or the case of
4435       --  inserting actions for non-limited types. In both these cases, we must
4436       --  move the SLOC of the parent If statement to the newly created one and
4437       --  change it to the SLOC of the expression which, after expansion, will
4438       --  correspond to what is being evaluated.
4439
4440       if Present (Parent (N))
4441         and then Nkind (Parent (N)) = N_If_Statement
4442       then
4443          Set_Sloc (New_If, Sloc (Parent (N)));
4444          Set_Sloc (Parent (N), Loc);
4445       end if;
4446
4447       --  Make sure Then_Actions and Else_Actions are appropriately moved
4448       --  to the new if statement.
4449
4450       if Present (Then_Actions (N)) then
4451          Insert_List_Before
4452            (First (Then_Statements (New_If)), Then_Actions (N));
4453       end if;
4454
4455       if Present (Else_Actions (N)) then
4456          Insert_List_Before
4457            (First (Else_Statements (New_If)), Else_Actions (N));
4458       end if;
4459
4460       Insert_Action (N, Decl);
4461       Insert_Action (N, New_If);
4462       Rewrite (N, New_N);
4463       Analyze_And_Resolve (N, Typ);
4464    end Expand_N_Conditional_Expression;
4465
4466    -----------------------------------
4467    -- Expand_N_Explicit_Dereference --
4468    -----------------------------------
4469
4470    procedure Expand_N_Explicit_Dereference (N : Node_Id) is
4471    begin
4472       --  Insert explicit dereference call for the checked storage pool case
4473
4474       Insert_Dereference_Action (Prefix (N));
4475    end Expand_N_Explicit_Dereference;
4476
4477    --------------------------------------
4478    -- Expand_N_Expression_With_Actions --
4479    --------------------------------------
4480
4481    procedure Expand_N_Expression_With_Actions (N : Node_Id) is
4482
4483       procedure Process_Transient_Object (Decl : Node_Id);
4484       --  Given the declaration of a controlled transient declared inside the
4485       --  Actions list of an Expression_With_Actions, generate all necessary
4486       --  types and hooks in order to properly finalize the transient. This
4487       --  mechanism works in conjunction with Build_Finalizer.
4488
4489       ------------------------------
4490       -- Process_Transient_Object --
4491       ------------------------------
4492
4493       procedure Process_Transient_Object (Decl : Node_Id) is
4494
4495          function Find_Insertion_Node return Node_Id;
4496          --  Complex conditions in if statements may be converted into nested
4497          --  EWAs. In this case, any generated code must be inserted before the
4498          --  if statement to ensure proper visibility of the hook objects. This
4499          --  routine returns the top most short circuit operator or the parent
4500          --  of the EWA if no nesting was detected.
4501
4502          -------------------------
4503          -- Find_Insertion_Node --
4504          -------------------------
4505
4506          function Find_Insertion_Node return Node_Id is
4507             Par : Node_Id;
4508
4509          begin
4510             --  Climb up the branches of a complex condition
4511
4512             Par := N;
4513             while Nkind_In (Parent (Par), N_And_Then, N_Op_Not, N_Or_Else) loop
4514                Par := Parent (Par);
4515             end loop;
4516
4517             return Par;
4518          end Find_Insertion_Node;
4519
4520          --  Local variables
4521
4522          Ins_Node  : constant Node_Id    := Find_Insertion_Node;
4523          Loc       : constant Source_Ptr := Sloc (Decl);
4524          Obj_Id    : constant Entity_Id  := Defining_Identifier (Decl);
4525          Obj_Typ   : constant Entity_Id  := Etype (Obj_Id);
4526          Desig_Typ : Entity_Id;
4527          Expr      : Node_Id;
4528          Ptr_Decl  : Node_Id;
4529          Ptr_Id    : Entity_Id;
4530          Temp_Decl : Node_Id;
4531          Temp_Id   : Node_Id;
4532
4533       --  Start of processing for Process_Transient_Object
4534
4535       begin
4536          --  Step 1: Create the access type which provides a reference to the
4537          --  transient object.
4538
4539          if Is_Access_Type (Obj_Typ) then
4540             Desig_Typ := Directly_Designated_Type (Obj_Typ);
4541          else
4542             Desig_Typ := Obj_Typ;
4543          end if;
4544
4545          --  Generate:
4546          --    Ann : access [all] <Desig_Typ>;
4547
4548          Ptr_Id := Make_Temporary (Loc, 'A');
4549
4550          Ptr_Decl :=
4551            Make_Full_Type_Declaration (Loc,
4552              Defining_Identifier => Ptr_Id,
4553              Type_Definition     =>
4554                Make_Access_To_Object_Definition (Loc,
4555                  All_Present        =>
4556                    Ekind (Obj_Typ) = E_General_Access_Type,
4557                  Subtype_Indication => New_Reference_To (Desig_Typ, Loc)));
4558
4559          Insert_Action (Ins_Node, Ptr_Decl);
4560          Analyze (Ptr_Decl);
4561
4562          --  Step 2: Create a temporary which acts as a hook to the transient
4563          --  object. Generate:
4564
4565          --    Temp : Ptr_Id := null;
4566
4567          Temp_Id := Make_Temporary (Loc, 'T');
4568
4569          Temp_Decl :=
4570            Make_Object_Declaration (Loc,
4571              Defining_Identifier => Temp_Id,
4572              Object_Definition   => New_Reference_To (Ptr_Id, Loc));
4573
4574          Insert_Action (Ins_Node, Temp_Decl);
4575          Analyze (Temp_Decl);
4576
4577          --  Mark this temporary as created for the purposes of exporting the
4578          --  transient declaration out of the Actions list. This signals the
4579          --  machinery in Build_Finalizer to recognize this special case.
4580
4581          Set_Return_Flag_Or_Transient_Decl (Temp_Id, Decl);
4582
4583          --  Step 3: Hook the transient object to the temporary
4584
4585          if Is_Access_Type (Obj_Typ) then
4586             Expr := Convert_To (Ptr_Id, New_Reference_To (Obj_Id, Loc));
4587          else
4588             Expr :=
4589               Make_Attribute_Reference (Loc,
4590                 Prefix         => New_Reference_To (Obj_Id, Loc),
4591                 Attribute_Name => Name_Unrestricted_Access);
4592          end if;
4593
4594          --  Generate:
4595          --    Temp := Ptr_Id (Obj_Id);
4596          --      <or>
4597          --    Temp := Obj_Id'Unrestricted_Access;
4598
4599          Insert_After_And_Analyze (Decl,
4600            Make_Assignment_Statement (Loc,
4601              Name       => New_Reference_To (Temp_Id, Loc),
4602              Expression => Expr));
4603       end Process_Transient_Object;
4604
4605       --  Local variables
4606
4607       Decl : Node_Id;
4608
4609    --  Start of processing for Expand_N_Expression_With_Actions
4610
4611    begin
4612       Decl := First (Actions (N));
4613       while Present (Decl) loop
4614          if Nkind (Decl) = N_Object_Declaration
4615            and then Is_Finalizable_Transient (Decl, N)
4616          then
4617             Process_Transient_Object (Decl);
4618          end if;
4619
4620          Next (Decl);
4621       end loop;
4622    end Expand_N_Expression_With_Actions;
4623
4624    -----------------
4625    -- Expand_N_In --
4626    -----------------
4627
4628    procedure Expand_N_In (N : Node_Id) is
4629       Loc    : constant Source_Ptr := Sloc (N);
4630       Restyp : constant Entity_Id  := Etype (N);
4631       Lop    : constant Node_Id    := Left_Opnd (N);
4632       Rop    : constant Node_Id    := Right_Opnd (N);
4633       Static : constant Boolean    := Is_OK_Static_Expression (N);
4634
4635       Ltyp  : Entity_Id;
4636       Rtyp  : Entity_Id;
4637
4638       procedure Substitute_Valid_Check;
4639       --  Replaces node N by Lop'Valid. This is done when we have an explicit
4640       --  test for the left operand being in range of its subtype.
4641
4642       ----------------------------
4643       -- Substitute_Valid_Check --
4644       ----------------------------
4645
4646       procedure Substitute_Valid_Check is
4647       begin
4648          Rewrite (N,
4649            Make_Attribute_Reference (Loc,
4650              Prefix         => Relocate_Node (Lop),
4651              Attribute_Name => Name_Valid));
4652
4653          Analyze_And_Resolve (N, Restyp);
4654
4655          Error_Msg_N ("?explicit membership test may be optimized away", N);
4656          Error_Msg_N -- CODEFIX
4657            ("\?use ''Valid attribute instead", N);
4658          return;
4659       end Substitute_Valid_Check;
4660
4661    --  Start of processing for Expand_N_In
4662
4663    begin
4664       --  If set membership case, expand with separate procedure
4665
4666       if Present (Alternatives (N)) then
4667          Expand_Set_Membership (N);
4668          return;
4669       end if;
4670
4671       --  Not set membership, proceed with expansion
4672
4673       Ltyp := Etype (Left_Opnd  (N));
4674       Rtyp := Etype (Right_Opnd (N));
4675
4676       --  Check case of explicit test for an expression in range of its
4677       --  subtype. This is suspicious usage and we replace it with a 'Valid
4678       --  test and give a warning. For floating point types however, this is a
4679       --  standard way to check for finite numbers, and using 'Valid would
4680       --  typically be a pessimization. Also skip this test for predicated
4681       --  types, since it is perfectly reasonable to check if a value meets
4682       --  its predicate.
4683
4684       if Is_Scalar_Type (Ltyp)
4685         and then not Is_Floating_Point_Type (Ltyp)
4686         and then Nkind (Rop) in N_Has_Entity
4687         and then Ltyp = Entity (Rop)
4688         and then Comes_From_Source (N)
4689         and then VM_Target = No_VM
4690         and then not (Is_Discrete_Type (Ltyp)
4691                        and then Present (Predicate_Function (Ltyp)))
4692       then
4693          Substitute_Valid_Check;
4694          return;
4695       end if;
4696
4697       --  Do validity check on operands
4698
4699       if Validity_Checks_On and Validity_Check_Operands then
4700          Ensure_Valid (Left_Opnd (N));
4701          Validity_Check_Range (Right_Opnd (N));
4702       end if;
4703
4704       --  Case of explicit range
4705
4706       if Nkind (Rop) = N_Range then
4707          declare
4708             Lo : constant Node_Id := Low_Bound (Rop);
4709             Hi : constant Node_Id := High_Bound (Rop);
4710
4711             Lo_Orig : constant Node_Id := Original_Node (Lo);
4712             Hi_Orig : constant Node_Id := Original_Node (Hi);
4713
4714             Lcheck : Compare_Result;
4715             Ucheck : Compare_Result;
4716
4717             Warn1 : constant Boolean :=
4718                       Constant_Condition_Warnings
4719                         and then Comes_From_Source (N)
4720                         and then not In_Instance;
4721             --  This must be true for any of the optimization warnings, we
4722             --  clearly want to give them only for source with the flag on. We
4723             --  also skip these warnings in an instance since it may be the
4724             --  case that different instantiations have different ranges.
4725
4726             Warn2 : constant Boolean :=
4727                       Warn1
4728                         and then Nkind (Original_Node (Rop)) = N_Range
4729                         and then Is_Integer_Type (Etype (Lo));
4730             --  For the case where only one bound warning is elided, we also
4731             --  insist on an explicit range and an integer type. The reason is
4732             --  that the use of enumeration ranges including an end point is
4733             --  common, as is the use of a subtype name, one of whose bounds is
4734             --  the same as the type of the expression.
4735
4736          begin
4737             --  If test is explicit x'First .. x'Last, replace by valid check
4738
4739             --  Could use some individual comments for this complex test ???
4740
4741             if Is_Scalar_Type (Ltyp)
4742               and then Nkind (Lo_Orig) = N_Attribute_Reference
4743               and then Attribute_Name (Lo_Orig) = Name_First
4744               and then Nkind (Prefix (Lo_Orig)) in N_Has_Entity
4745               and then Entity (Prefix (Lo_Orig)) = Ltyp
4746               and then Nkind (Hi_Orig) = N_Attribute_Reference
4747               and then Attribute_Name (Hi_Orig) = Name_Last
4748               and then Nkind (Prefix (Hi_Orig)) in N_Has_Entity
4749               and then Entity (Prefix (Hi_Orig)) = Ltyp
4750               and then Comes_From_Source (N)
4751               and then VM_Target = No_VM
4752             then
4753                Substitute_Valid_Check;
4754                goto Leave;
4755             end if;
4756
4757             --  If bounds of type are known at compile time, and the end points
4758             --  are known at compile time and identical, this is another case
4759             --  for substituting a valid test. We only do this for discrete
4760             --  types, since it won't arise in practice for float types.
4761
4762             if Comes_From_Source (N)
4763               and then Is_Discrete_Type (Ltyp)
4764               and then Compile_Time_Known_Value (Type_High_Bound (Ltyp))
4765               and then Compile_Time_Known_Value (Type_Low_Bound  (Ltyp))
4766               and then Compile_Time_Known_Value (Lo)
4767               and then Compile_Time_Known_Value (Hi)
4768               and then Expr_Value (Type_High_Bound (Ltyp)) = Expr_Value (Hi)
4769               and then Expr_Value (Type_Low_Bound  (Ltyp)) = Expr_Value (Lo)
4770
4771                --  Kill warnings in instances, since they may be cases where we
4772                --  have a test in the generic that makes sense with some types
4773                --  and not with other types.
4774
4775               and then not In_Instance
4776             then
4777                Substitute_Valid_Check;
4778                goto Leave;
4779             end if;
4780
4781             --  If we have an explicit range, do a bit of optimization based on
4782             --  range analysis (we may be able to kill one or both checks).
4783
4784             Lcheck := Compile_Time_Compare (Lop, Lo, Assume_Valid => False);
4785             Ucheck := Compile_Time_Compare (Lop, Hi, Assume_Valid => False);
4786
4787             --  If either check is known to fail, replace result by False since
4788             --  the other check does not matter. Preserve the static flag for
4789             --  legality checks, because we are constant-folding beyond RM 4.9.
4790
4791             if Lcheck = LT or else Ucheck = GT then
4792                if Warn1 then
4793                   Error_Msg_N ("?range test optimized away", N);
4794                   Error_Msg_N ("\?value is known to be out of range", N);
4795                end if;
4796
4797                Rewrite (N, New_Reference_To (Standard_False, Loc));
4798                Analyze_And_Resolve (N, Restyp);
4799                Set_Is_Static_Expression (N, Static);
4800                goto Leave;
4801
4802             --  If both checks are known to succeed, replace result by True,
4803             --  since we know we are in range.
4804
4805             elsif Lcheck in Compare_GE and then Ucheck in Compare_LE then
4806                if Warn1 then
4807                   Error_Msg_N ("?range test optimized away", N);
4808                   Error_Msg_N ("\?value is known to be in range", N);
4809                end if;
4810
4811                Rewrite (N, New_Reference_To (Standard_True, Loc));
4812                Analyze_And_Resolve (N, Restyp);
4813                Set_Is_Static_Expression (N, Static);
4814                goto Leave;
4815
4816             --  If lower bound check succeeds and upper bound check is not
4817             --  known to succeed or fail, then replace the range check with
4818             --  a comparison against the upper bound.
4819
4820             elsif Lcheck in Compare_GE then
4821                if Warn2 and then not In_Instance then
4822                   Error_Msg_N ("?lower bound test optimized away", Lo);
4823                   Error_Msg_N ("\?value is known to be in range", Lo);
4824                end if;
4825
4826                Rewrite (N,
4827                  Make_Op_Le (Loc,
4828                    Left_Opnd  => Lop,
4829                    Right_Opnd => High_Bound (Rop)));
4830                Analyze_And_Resolve (N, Restyp);
4831                goto Leave;
4832
4833             --  If upper bound check succeeds and lower bound check is not
4834             --  known to succeed or fail, then replace the range check with
4835             --  a comparison against the lower bound.
4836
4837             elsif Ucheck in Compare_LE then
4838                if Warn2 and then not In_Instance then
4839                   Error_Msg_N ("?upper bound test optimized away", Hi);
4840                   Error_Msg_N ("\?value is known to be in range", Hi);
4841                end if;
4842
4843                Rewrite (N,
4844                  Make_Op_Ge (Loc,
4845                    Left_Opnd  => Lop,
4846                    Right_Opnd => Low_Bound (Rop)));
4847                Analyze_And_Resolve (N, Restyp);
4848                goto Leave;
4849             end if;
4850
4851             --  We couldn't optimize away the range check, but there is one
4852             --  more issue. If we are checking constant conditionals, then we
4853             --  see if we can determine the outcome assuming everything is
4854             --  valid, and if so give an appropriate warning.
4855
4856             if Warn1 and then not Assume_No_Invalid_Values then
4857                Lcheck := Compile_Time_Compare (Lop, Lo, Assume_Valid => True);
4858                Ucheck := Compile_Time_Compare (Lop, Hi, Assume_Valid => True);
4859
4860                --  Result is out of range for valid value
4861
4862                if Lcheck = LT or else Ucheck = GT then
4863                   Error_Msg_N
4864                     ("?value can only be in range if it is invalid", N);
4865
4866                --  Result is in range for valid value
4867
4868                elsif Lcheck in Compare_GE and then Ucheck in Compare_LE then
4869                   Error_Msg_N
4870                     ("?value can only be out of range if it is invalid", N);
4871
4872                --  Lower bound check succeeds if value is valid
4873
4874                elsif Warn2 and then Lcheck in Compare_GE then
4875                   Error_Msg_N
4876                     ("?lower bound check only fails if it is invalid", Lo);
4877
4878                --  Upper bound  check succeeds if value is valid
4879
4880                elsif Warn2 and then Ucheck in Compare_LE then
4881                   Error_Msg_N
4882                     ("?upper bound check only fails for invalid values", Hi);
4883                end if;
4884             end if;
4885          end;
4886
4887          --  For all other cases of an explicit range, nothing to be done
4888
4889          goto Leave;
4890
4891       --  Here right operand is a subtype mark
4892
4893       else
4894          declare
4895             Typ       : Entity_Id        := Etype (Rop);
4896             Is_Acc    : constant Boolean := Is_Access_Type (Typ);
4897             Cond      : Node_Id          := Empty;
4898             New_N     : Node_Id;
4899             Obj       : Node_Id          := Lop;
4900             SCIL_Node : Node_Id;
4901
4902          begin
4903             Remove_Side_Effects (Obj);
4904
4905             --  For tagged type, do tagged membership operation
4906
4907             if Is_Tagged_Type (Typ) then
4908
4909                --  No expansion will be performed when VM_Target, as the VM
4910                --  back-ends will handle the membership tests directly (tags
4911                --  are not explicitly represented in Java objects, so the
4912                --  normal tagged membership expansion is not what we want).
4913
4914                if Tagged_Type_Expansion then
4915                   Tagged_Membership (N, SCIL_Node, New_N);
4916                   Rewrite (N, New_N);
4917                   Analyze_And_Resolve (N, Restyp);
4918
4919                   --  Update decoration of relocated node referenced by the
4920                   --  SCIL node.
4921
4922                   if Generate_SCIL and then Present (SCIL_Node) then
4923                      Set_SCIL_Node (N, SCIL_Node);
4924                   end if;
4925                end if;
4926
4927                goto Leave;
4928
4929             --  If type is scalar type, rewrite as x in t'First .. t'Last.
4930             --  This reason we do this is that the bounds may have the wrong
4931             --  type if they come from the original type definition. Also this
4932             --  way we get all the processing above for an explicit range.
4933
4934                --  Don't do this for predicated types, since in this case we
4935                --  want to check the predicate!
4936
4937             elsif Is_Scalar_Type (Typ) then
4938                if No (Predicate_Function (Typ)) then
4939                   Rewrite (Rop,
4940                     Make_Range (Loc,
4941                       Low_Bound =>
4942                         Make_Attribute_Reference (Loc,
4943                           Attribute_Name => Name_First,
4944                           Prefix => New_Reference_To (Typ, Loc)),
4945
4946                       High_Bound =>
4947                         Make_Attribute_Reference (Loc,
4948                           Attribute_Name => Name_Last,
4949                           Prefix => New_Reference_To (Typ, Loc))));
4950                   Analyze_And_Resolve (N, Restyp);
4951                end if;
4952
4953                goto Leave;
4954
4955             --  Ada 2005 (AI-216): Program_Error is raised when evaluating
4956             --  a membership test if the subtype mark denotes a constrained
4957             --  Unchecked_Union subtype and the expression lacks inferable
4958             --  discriminants.
4959
4960             elsif Is_Unchecked_Union (Base_Type (Typ))
4961               and then Is_Constrained (Typ)
4962               and then not Has_Inferable_Discriminants (Lop)
4963             then
4964                Insert_Action (N,
4965                  Make_Raise_Program_Error (Loc,
4966                    Reason => PE_Unchecked_Union_Restriction));
4967
4968                --  Prevent Gigi from generating incorrect code by rewriting the
4969                --  test as False.
4970
4971                Rewrite (N, New_Occurrence_Of (Standard_False, Loc));
4972                goto Leave;
4973             end if;
4974
4975             --  Here we have a non-scalar type
4976
4977             if Is_Acc then
4978                Typ := Designated_Type (Typ);
4979             end if;
4980
4981             if not Is_Constrained (Typ) then
4982                Rewrite (N, New_Reference_To (Standard_True, Loc));
4983                Analyze_And_Resolve (N, Restyp);
4984
4985             --  For the constrained array case, we have to check the subscripts
4986             --  for an exact match if the lengths are non-zero (the lengths
4987             --  must match in any case).
4988
4989             elsif Is_Array_Type (Typ) then
4990                Check_Subscripts : declare
4991                   function Build_Attribute_Reference
4992                     (E   : Node_Id;
4993                      Nam : Name_Id;
4994                      Dim : Nat) return Node_Id;
4995                   --  Build attribute reference E'Nam (Dim)
4996
4997                   -------------------------------
4998                   -- Build_Attribute_Reference --
4999                   -------------------------------
5000
5001                   function Build_Attribute_Reference
5002                     (E   : Node_Id;
5003                      Nam : Name_Id;
5004                      Dim : Nat) return Node_Id
5005                   is
5006                   begin
5007                      return
5008                        Make_Attribute_Reference (Loc,
5009                          Prefix         => E,
5010                          Attribute_Name => Nam,
5011                          Expressions    => New_List (
5012                            Make_Integer_Literal (Loc, Dim)));
5013                   end Build_Attribute_Reference;
5014
5015                --  Start of processing for Check_Subscripts
5016
5017                begin
5018                   for J in 1 .. Number_Dimensions (Typ) loop
5019                      Evolve_And_Then (Cond,
5020                        Make_Op_Eq (Loc,
5021                          Left_Opnd  =>
5022                            Build_Attribute_Reference
5023                              (Duplicate_Subexpr_No_Checks (Obj),
5024                               Name_First, J),
5025                          Right_Opnd =>
5026                            Build_Attribute_Reference
5027                              (New_Occurrence_Of (Typ, Loc), Name_First, J)));
5028
5029                      Evolve_And_Then (Cond,
5030                        Make_Op_Eq (Loc,
5031                          Left_Opnd  =>
5032                            Build_Attribute_Reference
5033                              (Duplicate_Subexpr_No_Checks (Obj),
5034                               Name_Last, J),
5035                          Right_Opnd =>
5036                            Build_Attribute_Reference
5037                              (New_Occurrence_Of (Typ, Loc), Name_Last, J)));
5038                   end loop;
5039
5040                   if Is_Acc then
5041                      Cond :=
5042                        Make_Or_Else (Loc,
5043                          Left_Opnd =>
5044                            Make_Op_Eq (Loc,
5045                              Left_Opnd  => Obj,
5046                              Right_Opnd => Make_Null (Loc)),
5047                          Right_Opnd => Cond);
5048                   end if;
5049
5050                   Rewrite (N, Cond);
5051                   Analyze_And_Resolve (N, Restyp);
5052                end Check_Subscripts;
5053
5054             --  These are the cases where constraint checks may be required,
5055             --  e.g. records with possible discriminants
5056
5057             else
5058                --  Expand the test into a series of discriminant comparisons.
5059                --  The expression that is built is the negation of the one that
5060                --  is used for checking discriminant constraints.
5061
5062                Obj := Relocate_Node (Left_Opnd (N));
5063
5064                if Has_Discriminants (Typ) then
5065                   Cond := Make_Op_Not (Loc,
5066                     Right_Opnd => Build_Discriminant_Checks (Obj, Typ));
5067
5068                   if Is_Acc then
5069                      Cond := Make_Or_Else (Loc,
5070                        Left_Opnd =>
5071                          Make_Op_Eq (Loc,
5072                            Left_Opnd  => Obj,
5073                            Right_Opnd => Make_Null (Loc)),
5074                        Right_Opnd => Cond);
5075                   end if;
5076
5077                else
5078                   Cond := New_Occurrence_Of (Standard_True, Loc);
5079                end if;
5080
5081                Rewrite (N, Cond);
5082                Analyze_And_Resolve (N, Restyp);
5083             end if;
5084
5085             --  Ada 2012 (AI05-0149): Handle membership tests applied to an
5086             --  expression of an anonymous access type. This can involve an
5087             --  accessibility test and a tagged type membership test in the
5088             --  case of tagged designated types.
5089
5090             if Ada_Version >= Ada_2012
5091               and then Is_Acc
5092               and then Ekind (Ltyp) = E_Anonymous_Access_Type
5093             then
5094                declare
5095                   Expr_Entity : Entity_Id := Empty;
5096                   New_N       : Node_Id;
5097                   Param_Level : Node_Id;
5098                   Type_Level  : Node_Id;
5099
5100                begin
5101                   if Is_Entity_Name (Lop) then
5102                      Expr_Entity := Param_Entity (Lop);
5103
5104                      if not Present (Expr_Entity) then
5105                         Expr_Entity := Entity (Lop);
5106                      end if;
5107                   end if;
5108
5109                   --  If a conversion of the anonymous access value to the
5110                   --  tested type would be illegal, then the result is False.
5111
5112                   if not Valid_Conversion
5113                            (Lop, Rtyp, Lop, Report_Errs => False)
5114                   then
5115                      Rewrite (N, New_Occurrence_Of (Standard_False, Loc));
5116                      Analyze_And_Resolve (N, Restyp);
5117
5118                   --  Apply an accessibility check if the access object has an
5119                   --  associated access level and when the level of the type is
5120                   --  less deep than the level of the access parameter. This
5121                   --  only occur for access parameters and stand-alone objects
5122                   --  of an anonymous access type.
5123
5124                   else
5125                      if Present (Expr_Entity)
5126                        and then
5127                          Present
5128                            (Effective_Extra_Accessibility (Expr_Entity))
5129                        and then UI_Gt (Object_Access_Level (Lop),
5130                                        Type_Access_Level (Rtyp))
5131                      then
5132                         Param_Level :=
5133                           New_Occurrence_Of
5134                             (Effective_Extra_Accessibility (Expr_Entity), Loc);
5135
5136                         Type_Level :=
5137                           Make_Integer_Literal (Loc, Type_Access_Level (Rtyp));
5138
5139                         --  Return True only if the accessibility level of the
5140                         --  expression entity is not deeper than the level of
5141                         --  the tested access type.
5142
5143                         Rewrite (N,
5144                           Make_And_Then (Loc,
5145                             Left_Opnd  => Relocate_Node (N),
5146                             Right_Opnd => Make_Op_Le (Loc,
5147                                             Left_Opnd  => Param_Level,
5148                                             Right_Opnd => Type_Level)));
5149
5150                         Analyze_And_Resolve (N);
5151                      end if;
5152
5153                      --  If the designated type is tagged, do tagged membership
5154                      --  operation.
5155
5156                      --  *** NOTE: we have to check not null before doing the
5157                      --  tagged membership test (but maybe that can be done
5158                      --  inside Tagged_Membership?).
5159
5160                      if Is_Tagged_Type (Typ) then
5161                         Rewrite (N,
5162                           Make_And_Then (Loc,
5163                             Left_Opnd  => Relocate_Node (N),
5164                             Right_Opnd =>
5165                               Make_Op_Ne (Loc,
5166                                 Left_Opnd  => Obj,
5167                                 Right_Opnd => Make_Null (Loc))));
5168
5169                         --  No expansion will be performed when VM_Target, as
5170                         --  the VM back-ends will handle the membership tests
5171                         --  directly (tags are not explicitly represented in
5172                         --  Java objects, so the normal tagged membership
5173                         --  expansion is not what we want).
5174
5175                         if Tagged_Type_Expansion then
5176
5177                            --  Note that we have to pass Original_Node, because
5178                            --  the membership test might already have been
5179                            --  rewritten by earlier parts of membership test.
5180
5181                            Tagged_Membership
5182                              (Original_Node (N), SCIL_Node, New_N);
5183
5184                            --  Update decoration of relocated node referenced
5185                            --  by the SCIL node.
5186
5187                            if Generate_SCIL and then Present (SCIL_Node) then
5188                               Set_SCIL_Node (New_N, SCIL_Node);
5189                            end if;
5190
5191                            Rewrite (N,
5192                              Make_And_Then (Loc,
5193                                Left_Opnd  => Relocate_Node (N),
5194                                Right_Opnd => New_N));
5195
5196                            Analyze_And_Resolve (N, Restyp);
5197                         end if;
5198                      end if;
5199                   end if;
5200                end;
5201             end if;
5202          end;
5203       end if;
5204
5205    --  At this point, we have done the processing required for the basic
5206    --  membership test, but not yet dealt with the predicate.
5207
5208    <<Leave>>
5209
5210       --  If a predicate is present, then we do the predicate test, but we
5211       --  most certainly want to omit this if we are within the predicate
5212       --  function itself, since otherwise we have an infinite recursion!
5213
5214       declare
5215          PFunc : constant Entity_Id := Predicate_Function (Rtyp);
5216
5217       begin
5218          if Present (PFunc)
5219            and then Current_Scope /= PFunc
5220          then
5221             Rewrite (N,
5222               Make_And_Then (Loc,
5223                 Left_Opnd  => Relocate_Node (N),
5224                 Right_Opnd => Make_Predicate_Call (Rtyp, Lop)));
5225
5226             --  Analyze new expression, mark left operand as analyzed to
5227             --  avoid infinite recursion adding predicate calls.
5228
5229             Set_Analyzed (Left_Opnd (N));
5230             Analyze_And_Resolve (N, Standard_Boolean);
5231
5232             --  All done, skip attempt at compile time determination of result
5233
5234             return;
5235          end if;
5236       end;
5237    end Expand_N_In;
5238
5239    --------------------------------
5240    -- Expand_N_Indexed_Component --
5241    --------------------------------
5242
5243    procedure Expand_N_Indexed_Component (N : Node_Id) is
5244       Loc : constant Source_Ptr := Sloc (N);
5245       Typ : constant Entity_Id  := Etype (N);
5246       P   : constant Node_Id    := Prefix (N);
5247       T   : constant Entity_Id  := Etype (P);
5248
5249    begin
5250       --  A special optimization, if we have an indexed component that is
5251       --  selecting from a slice, then we can eliminate the slice, since, for
5252       --  example, x (i .. j)(k) is identical to x(k). The only difference is
5253       --  the range check required by the slice. The range check for the slice
5254       --  itself has already been generated. The range check for the
5255       --  subscripting operation is ensured by converting the subject to
5256       --  the subtype of the slice.
5257
5258       --  This optimization not only generates better code, avoiding slice
5259       --  messing especially in the packed case, but more importantly bypasses
5260       --  some problems in handling this peculiar case, for example, the issue
5261       --  of dealing specially with object renamings.
5262
5263       if Nkind (P) = N_Slice then
5264          Rewrite (N,
5265            Make_Indexed_Component (Loc,
5266              Prefix => Prefix (P),
5267              Expressions => New_List (
5268                Convert_To
5269                  (Etype (First_Index (Etype (P))),
5270                   First (Expressions (N))))));
5271          Analyze_And_Resolve (N, Typ);
5272          return;
5273       end if;
5274
5275       --  Ada 2005 (AI-318-02): If the prefix is a call to a build-in-place
5276       --  function, then additional actuals must be passed.
5277
5278       if Ada_Version >= Ada_2005
5279         and then Is_Build_In_Place_Function_Call (P)
5280       then
5281          Make_Build_In_Place_Call_In_Anonymous_Context (P);
5282       end if;
5283
5284       --  If the prefix is an access type, then we unconditionally rewrite if
5285       --  as an explicit dereference. This simplifies processing for several
5286       --  cases, including packed array cases and certain cases in which checks
5287       --  must be generated. We used to try to do this only when it was
5288       --  necessary, but it cleans up the code to do it all the time.
5289
5290       if Is_Access_Type (T) then
5291          Insert_Explicit_Dereference (P);
5292          Analyze_And_Resolve (P, Designated_Type (T));
5293       end if;
5294
5295       --  Generate index and validity checks
5296
5297       Generate_Index_Checks (N);
5298
5299       if Validity_Checks_On and then Validity_Check_Subscripts then
5300          Apply_Subscript_Validity_Checks (N);
5301       end if;
5302
5303       --  All done for the non-packed case
5304
5305       if not Is_Packed (Etype (Prefix (N))) then
5306          return;
5307       end if;
5308
5309       --  For packed arrays that are not bit-packed (i.e. the case of an array
5310       --  with one or more index types with a non-contiguous enumeration type),
5311       --  we can always use the normal packed element get circuit.
5312
5313       if not Is_Bit_Packed_Array (Etype (Prefix (N))) then
5314          Expand_Packed_Element_Reference (N);
5315          return;
5316       end if;
5317
5318       --  For a reference to a component of a bit packed array, we have to
5319       --  convert it to a reference to the corresponding Packed_Array_Type.
5320       --  We only want to do this for simple references, and not for:
5321
5322       --    Left side of assignment, or prefix of left side of assignment, or
5323       --    prefix of the prefix, to handle packed arrays of packed arrays,
5324       --      This case is handled in Exp_Ch5.Expand_N_Assignment_Statement
5325
5326       --    Renaming objects in renaming associations
5327       --      This case is handled when a use of the renamed variable occurs
5328
5329       --    Actual parameters for a procedure call
5330       --      This case is handled in Exp_Ch6.Expand_Actuals
5331
5332       --    The second expression in a 'Read attribute reference
5333
5334       --    The prefix of an address or bit or size attribute reference
5335
5336       --  The following circuit detects these exceptions
5337
5338       declare
5339          Child : Node_Id := N;
5340          Parnt : Node_Id := Parent (N);
5341
5342       begin
5343          loop
5344             if Nkind (Parnt) = N_Unchecked_Expression then
5345                null;
5346
5347             elsif Nkind_In (Parnt, N_Object_Renaming_Declaration,
5348                                    N_Procedure_Call_Statement)
5349               or else (Nkind (Parnt) = N_Parameter_Association
5350                         and then
5351                           Nkind (Parent (Parnt)) =  N_Procedure_Call_Statement)
5352             then
5353                return;
5354
5355             elsif Nkind (Parnt) = N_Attribute_Reference
5356               and then (Attribute_Name (Parnt) = Name_Address
5357                          or else
5358                         Attribute_Name (Parnt) = Name_Bit
5359                          or else
5360                         Attribute_Name (Parnt) = Name_Size)
5361               and then Prefix (Parnt) = Child
5362             then
5363                return;
5364
5365             elsif Nkind (Parnt) = N_Assignment_Statement
5366               and then Name (Parnt) = Child
5367             then
5368                return;
5369
5370             --  If the expression is an index of an indexed component, it must
5371             --  be expanded regardless of context.
5372
5373             elsif Nkind (Parnt) = N_Indexed_Component
5374               and then Child /= Prefix (Parnt)
5375             then
5376                Expand_Packed_Element_Reference (N);
5377                return;
5378
5379             elsif Nkind (Parent (Parnt)) = N_Assignment_Statement
5380               and then Name (Parent (Parnt)) = Parnt
5381             then
5382                return;
5383
5384             elsif Nkind (Parnt) = N_Attribute_Reference
5385               and then Attribute_Name (Parnt) = Name_Read
5386               and then Next (First (Expressions (Parnt))) = Child
5387             then
5388                return;
5389
5390             elsif Nkind_In (Parnt, N_Indexed_Component, N_Selected_Component)
5391                and then Prefix (Parnt) = Child
5392             then
5393                null;
5394
5395             else
5396                Expand_Packed_Element_Reference (N);
5397                return;
5398             end if;
5399
5400             --  Keep looking up tree for unchecked expression, or if we are the
5401             --  prefix of a possible assignment left side.
5402
5403             Child := Parnt;
5404             Parnt := Parent (Child);
5405          end loop;
5406       end;
5407    end Expand_N_Indexed_Component;
5408
5409    ---------------------
5410    -- Expand_N_Not_In --
5411    ---------------------
5412
5413    --  Replace a not in b by not (a in b) so that the expansions for (a in b)
5414    --  can be done. This avoids needing to duplicate this expansion code.
5415
5416    procedure Expand_N_Not_In (N : Node_Id) is
5417       Loc : constant Source_Ptr := Sloc (N);
5418       Typ : constant Entity_Id  := Etype (N);
5419       Cfs : constant Boolean    := Comes_From_Source (N);
5420
5421    begin
5422       Rewrite (N,
5423         Make_Op_Not (Loc,
5424           Right_Opnd =>
5425             Make_In (Loc,
5426               Left_Opnd  => Left_Opnd (N),
5427               Right_Opnd => Right_Opnd (N))));
5428
5429       --  If this is a set membership, preserve list of alternatives
5430
5431       Set_Alternatives (Right_Opnd (N), Alternatives (Original_Node (N)));
5432
5433       --  We want this to appear as coming from source if original does (see
5434       --  transformations in Expand_N_In).
5435
5436       Set_Comes_From_Source (N, Cfs);
5437       Set_Comes_From_Source (Right_Opnd (N), Cfs);
5438
5439       --  Now analyze transformed node
5440
5441       Analyze_And_Resolve (N, Typ);
5442    end Expand_N_Not_In;
5443
5444    -------------------
5445    -- Expand_N_Null --
5446    -------------------
5447
5448    --  The only replacement required is for the case of a null of a type that
5449    --  is an access to protected subprogram, or a subtype thereof. We represent
5450    --  such access values as a record, and so we must replace the occurrence of
5451    --  null by the equivalent record (with a null address and a null pointer in
5452    --  it), so that the backend creates the proper value.
5453
5454    procedure Expand_N_Null (N : Node_Id) is
5455       Loc : constant Source_Ptr := Sloc (N);
5456       Typ : constant Entity_Id  := Base_Type (Etype (N));
5457       Agg : Node_Id;
5458
5459    begin
5460       if Is_Access_Protected_Subprogram_Type (Typ) then
5461          Agg :=
5462            Make_Aggregate (Loc,
5463              Expressions => New_List (
5464                New_Occurrence_Of (RTE (RE_Null_Address), Loc),
5465                Make_Null (Loc)));
5466
5467          Rewrite (N, Agg);
5468          Analyze_And_Resolve (N, Equivalent_Type (Typ));
5469
5470          --  For subsequent semantic analysis, the node must retain its type.
5471          --  Gigi in any case replaces this type by the corresponding record
5472          --  type before processing the node.
5473
5474          Set_Etype (N, Typ);
5475       end if;
5476
5477    exception
5478       when RE_Not_Available =>
5479          return;
5480    end Expand_N_Null;
5481
5482    ---------------------
5483    -- Expand_N_Op_Abs --
5484    ---------------------
5485
5486    procedure Expand_N_Op_Abs (N : Node_Id) is
5487       Loc  : constant Source_Ptr := Sloc (N);
5488       Expr : constant Node_Id := Right_Opnd (N);
5489
5490    begin
5491       Unary_Op_Validity_Checks (N);
5492
5493       --  Deal with software overflow checking
5494
5495       if not Backend_Overflow_Checks_On_Target
5496          and then Is_Signed_Integer_Type (Etype (N))
5497          and then Do_Overflow_Check (N)
5498       then
5499          --  The only case to worry about is when the argument is equal to the
5500          --  largest negative number, so what we do is to insert the check:
5501
5502          --     [constraint_error when Expr = typ'Base'First]
5503
5504          --  with the usual Duplicate_Subexpr use coding for expr
5505
5506          Insert_Action (N,
5507            Make_Raise_Constraint_Error (Loc,
5508              Condition =>
5509                Make_Op_Eq (Loc,
5510                  Left_Opnd  => Duplicate_Subexpr (Expr),
5511                  Right_Opnd =>
5512                    Make_Attribute_Reference (Loc,
5513                      Prefix =>
5514                        New_Occurrence_Of (Base_Type (Etype (Expr)), Loc),
5515                      Attribute_Name => Name_First)),
5516              Reason => CE_Overflow_Check_Failed));
5517       end if;
5518
5519       --  Vax floating-point types case
5520
5521       if Vax_Float (Etype (N)) then
5522          Expand_Vax_Arith (N);
5523       end if;
5524    end Expand_N_Op_Abs;
5525
5526    ---------------------
5527    -- Expand_N_Op_Add --
5528    ---------------------
5529
5530    procedure Expand_N_Op_Add (N : Node_Id) is
5531       Typ : constant Entity_Id := Etype (N);
5532
5533    begin
5534       Binary_Op_Validity_Checks (N);
5535
5536       --  N + 0 = 0 + N = N for integer types
5537
5538       if Is_Integer_Type (Typ) then
5539          if Compile_Time_Known_Value (Right_Opnd (N))
5540            and then Expr_Value (Right_Opnd (N)) = Uint_0
5541          then
5542             Rewrite (N, Left_Opnd (N));
5543             return;
5544
5545          elsif Compile_Time_Known_Value (Left_Opnd (N))
5546            and then Expr_Value (Left_Opnd (N)) = Uint_0
5547          then
5548             Rewrite (N, Right_Opnd (N));
5549             return;
5550          end if;
5551       end if;
5552
5553       --  Arithmetic overflow checks for signed integer/fixed point types
5554
5555       if Is_Signed_Integer_Type (Typ)
5556         or else Is_Fixed_Point_Type (Typ)
5557       then
5558          Apply_Arithmetic_Overflow_Check (N);
5559          return;
5560
5561       --  Vax floating-point types case
5562
5563       elsif Vax_Float (Typ) then
5564          Expand_Vax_Arith (N);
5565       end if;
5566    end Expand_N_Op_Add;
5567
5568    ---------------------
5569    -- Expand_N_Op_And --
5570    ---------------------
5571
5572    procedure Expand_N_Op_And (N : Node_Id) is
5573       Typ : constant Entity_Id := Etype (N);
5574
5575    begin
5576       Binary_Op_Validity_Checks (N);
5577
5578       if Is_Array_Type (Etype (N)) then
5579          Expand_Boolean_Operator (N);
5580
5581       elsif Is_Boolean_Type (Etype (N)) then
5582          Adjust_Condition (Left_Opnd (N));
5583          Adjust_Condition (Right_Opnd (N));
5584          Set_Etype (N, Standard_Boolean);
5585          Adjust_Result_Type (N, Typ);
5586
5587       elsif Is_Intrinsic_Subprogram (Entity (N)) then
5588          Expand_Intrinsic_Call (N, Entity (N));
5589
5590       end if;
5591    end Expand_N_Op_And;
5592
5593    ------------------------
5594    -- Expand_N_Op_Concat --
5595    ------------------------
5596
5597    procedure Expand_N_Op_Concat (N : Node_Id) is
5598       Opnds : List_Id;
5599       --  List of operands to be concatenated
5600
5601       Cnode : Node_Id;
5602       --  Node which is to be replaced by the result of concatenating the nodes
5603       --  in the list Opnds.
5604
5605    begin
5606       --  Ensure validity of both operands
5607
5608       Binary_Op_Validity_Checks (N);
5609
5610       --  If we are the left operand of a concatenation higher up the tree,
5611       --  then do nothing for now, since we want to deal with a series of
5612       --  concatenations as a unit.
5613
5614       if Nkind (Parent (N)) = N_Op_Concat
5615         and then N = Left_Opnd (Parent (N))
5616       then
5617          return;
5618       end if;
5619
5620       --  We get here with a concatenation whose left operand may be a
5621       --  concatenation itself with a consistent type. We need to process
5622       --  these concatenation operands from left to right, which means
5623       --  from the deepest node in the tree to the highest node.
5624
5625       Cnode := N;
5626       while Nkind (Left_Opnd (Cnode)) = N_Op_Concat loop
5627          Cnode := Left_Opnd (Cnode);
5628       end loop;
5629
5630       --  Now Cnode is the deepest concatenation, and its parents are the
5631       --  concatenation nodes above, so now we process bottom up, doing the
5632       --  operations. We gather a string that is as long as possible up to five
5633       --  operands.
5634
5635       --  The outer loop runs more than once if more than one concatenation
5636       --  type is involved.
5637
5638       Outer : loop
5639          Opnds := New_List (Left_Opnd (Cnode), Right_Opnd (Cnode));
5640          Set_Parent (Opnds, N);
5641
5642          --  The inner loop gathers concatenation operands
5643
5644          Inner : while Cnode /= N
5645                    and then Base_Type (Etype (Cnode)) =
5646                             Base_Type (Etype (Parent (Cnode)))
5647          loop
5648             Cnode := Parent (Cnode);
5649             Append (Right_Opnd (Cnode), Opnds);
5650          end loop Inner;
5651
5652          Expand_Concatenate (Cnode, Opnds);
5653
5654          exit Outer when Cnode = N;
5655          Cnode := Parent (Cnode);
5656       end loop Outer;
5657    end Expand_N_Op_Concat;
5658
5659    ------------------------
5660    -- Expand_N_Op_Divide --
5661    ------------------------
5662
5663    procedure Expand_N_Op_Divide (N : Node_Id) is
5664       Loc   : constant Source_Ptr := Sloc (N);
5665       Lopnd : constant Node_Id    := Left_Opnd (N);
5666       Ropnd : constant Node_Id    := Right_Opnd (N);
5667       Ltyp  : constant Entity_Id  := Etype (Lopnd);
5668       Rtyp  : constant Entity_Id  := Etype (Ropnd);
5669       Typ   : Entity_Id           := Etype (N);
5670       Rknow : constant Boolean    := Is_Integer_Type (Typ)
5671                                        and then
5672                                          Compile_Time_Known_Value (Ropnd);
5673       Rval  : Uint;
5674
5675    begin
5676       Binary_Op_Validity_Checks (N);
5677
5678       if Rknow then
5679          Rval := Expr_Value (Ropnd);
5680       end if;
5681
5682       --  N / 1 = N for integer types
5683
5684       if Rknow and then Rval = Uint_1 then
5685          Rewrite (N, Lopnd);
5686          return;
5687       end if;
5688
5689       --  Convert x / 2 ** y to Shift_Right (x, y). Note that the fact that
5690       --  Is_Power_Of_2_For_Shift is set means that we know that our left
5691       --  operand is an unsigned integer, as required for this to work.
5692
5693       if Nkind (Ropnd) = N_Op_Expon
5694         and then Is_Power_Of_2_For_Shift (Ropnd)
5695
5696       --  We cannot do this transformation in configurable run time mode if we
5697       --  have 64-bit integers and long shifts are not available.
5698
5699         and then
5700           (Esize (Ltyp) <= 32
5701              or else Support_Long_Shifts_On_Target)
5702       then
5703          Rewrite (N,
5704            Make_Op_Shift_Right (Loc,
5705              Left_Opnd  => Lopnd,
5706              Right_Opnd =>
5707                Convert_To (Standard_Natural, Right_Opnd (Ropnd))));
5708          Analyze_And_Resolve (N, Typ);
5709          return;
5710       end if;
5711
5712       --  Do required fixup of universal fixed operation
5713
5714       if Typ = Universal_Fixed then
5715          Fixup_Universal_Fixed_Operation (N);
5716          Typ := Etype (N);
5717       end if;
5718
5719       --  Divisions with fixed-point results
5720
5721       if Is_Fixed_Point_Type (Typ) then
5722
5723          --  No special processing if Treat_Fixed_As_Integer is set, since
5724          --  from a semantic point of view such operations are simply integer
5725          --  operations and will be treated that way.
5726
5727          if not Treat_Fixed_As_Integer (N) then
5728             if Is_Integer_Type (Rtyp) then
5729                Expand_Divide_Fixed_By_Integer_Giving_Fixed (N);
5730             else
5731                Expand_Divide_Fixed_By_Fixed_Giving_Fixed (N);
5732             end if;
5733          end if;
5734
5735       --  Other cases of division of fixed-point operands. Again we exclude the
5736       --  case where Treat_Fixed_As_Integer is set.
5737
5738       elsif (Is_Fixed_Point_Type (Ltyp) or else
5739              Is_Fixed_Point_Type (Rtyp))
5740         and then not Treat_Fixed_As_Integer (N)
5741       then
5742          if Is_Integer_Type (Typ) then
5743             Expand_Divide_Fixed_By_Fixed_Giving_Integer (N);
5744          else
5745             pragma Assert (Is_Floating_Point_Type (Typ));
5746             Expand_Divide_Fixed_By_Fixed_Giving_Float (N);
5747          end if;
5748
5749       --  Mixed-mode operations can appear in a non-static universal context,
5750       --  in which case the integer argument must be converted explicitly.
5751
5752       elsif Typ = Universal_Real
5753         and then Is_Integer_Type (Rtyp)
5754       then
5755          Rewrite (Ropnd,
5756            Convert_To (Universal_Real, Relocate_Node (Ropnd)));
5757
5758          Analyze_And_Resolve (Ropnd, Universal_Real);
5759
5760       elsif Typ = Universal_Real
5761         and then Is_Integer_Type (Ltyp)
5762       then
5763          Rewrite (Lopnd,
5764            Convert_To (Universal_Real, Relocate_Node (Lopnd)));
5765
5766          Analyze_And_Resolve (Lopnd, Universal_Real);
5767
5768       --  Non-fixed point cases, do integer zero divide and overflow checks
5769
5770       elsif Is_Integer_Type (Typ) then
5771          Apply_Divide_Check (N);
5772
5773       --  Deal with Vax_Float
5774
5775       elsif Vax_Float (Typ) then
5776          Expand_Vax_Arith (N);
5777          return;
5778       end if;
5779    end Expand_N_Op_Divide;
5780
5781    --------------------
5782    -- Expand_N_Op_Eq --
5783    --------------------
5784
5785    procedure Expand_N_Op_Eq (N : Node_Id) is
5786       Loc    : constant Source_Ptr := Sloc (N);
5787       Typ    : constant Entity_Id  := Etype (N);
5788       Lhs    : constant Node_Id    := Left_Opnd (N);
5789       Rhs    : constant Node_Id    := Right_Opnd (N);
5790       Bodies : constant List_Id    := New_List;
5791       A_Typ  : constant Entity_Id  := Etype (Lhs);
5792
5793       Typl    : Entity_Id := A_Typ;
5794       Op_Name : Entity_Id;
5795       Prim    : Elmt_Id;
5796
5797       procedure Build_Equality_Call (Eq : Entity_Id);
5798       --  If a constructed equality exists for the type or for its parent,
5799       --  build and analyze call, adding conversions if the operation is
5800       --  inherited.
5801
5802       function Has_Unconstrained_UU_Component (Typ : Node_Id) return Boolean;
5803       --  Determines whether a type has a subcomponent of an unconstrained
5804       --  Unchecked_Union subtype. Typ is a record type.
5805
5806       -------------------------
5807       -- Build_Equality_Call --
5808       -------------------------
5809
5810       procedure Build_Equality_Call (Eq : Entity_Id) is
5811          Op_Type : constant Entity_Id := Etype (First_Formal (Eq));
5812          L_Exp   : Node_Id := Relocate_Node (Lhs);
5813          R_Exp   : Node_Id := Relocate_Node (Rhs);
5814
5815       begin
5816          if Base_Type (Op_Type) /= Base_Type (A_Typ)
5817            and then not Is_Class_Wide_Type (A_Typ)
5818          then
5819             L_Exp := OK_Convert_To (Op_Type, L_Exp);
5820             R_Exp := OK_Convert_To (Op_Type, R_Exp);
5821          end if;
5822
5823          --  If we have an Unchecked_Union, we need to add the inferred
5824          --  discriminant values as actuals in the function call. At this
5825          --  point, the expansion has determined that both operands have
5826          --  inferable discriminants.
5827
5828          if Is_Unchecked_Union (Op_Type) then
5829             declare
5830                Lhs_Type      : constant Node_Id := Etype (L_Exp);
5831                Rhs_Type      : constant Node_Id := Etype (R_Exp);
5832                Lhs_Discr_Val : Node_Id;
5833                Rhs_Discr_Val : Node_Id;
5834
5835             begin
5836                --  Per-object constrained selected components require special
5837                --  attention. If the enclosing scope of the component is an
5838                --  Unchecked_Union, we cannot reference its discriminants
5839                --  directly. This is why we use the two extra parameters of
5840                --  the equality function of the enclosing Unchecked_Union.
5841
5842                --  type UU_Type (Discr : Integer := 0) is
5843                --     . . .
5844                --  end record;
5845                --  pragma Unchecked_Union (UU_Type);
5846
5847                --  1. Unchecked_Union enclosing record:
5848
5849                --     type Enclosing_UU_Type (Discr : Integer := 0) is record
5850                --        . . .
5851                --        Comp : UU_Type (Discr);
5852                --        . . .
5853                --     end Enclosing_UU_Type;
5854                --     pragma Unchecked_Union (Enclosing_UU_Type);
5855
5856                --     Obj1 : Enclosing_UU_Type;
5857                --     Obj2 : Enclosing_UU_Type (1);
5858
5859                --     [. . .] Obj1 = Obj2 [. . .]
5860
5861                --     Generated code:
5862
5863                --     if not (uu_typeEQ (obj1.comp, obj2.comp, a, b)) then
5864
5865                --  A and B are the formal parameters of the equality function
5866                --  of Enclosing_UU_Type. The function always has two extra
5867                --  formals to capture the inferred discriminant values.
5868
5869                --  2. Non-Unchecked_Union enclosing record:
5870
5871                --     type
5872                --       Enclosing_Non_UU_Type (Discr : Integer := 0)
5873                --     is record
5874                --        . . .
5875                --        Comp : UU_Type (Discr);
5876                --        . . .
5877                --     end Enclosing_Non_UU_Type;
5878
5879                --     Obj1 : Enclosing_Non_UU_Type;
5880                --     Obj2 : Enclosing_Non_UU_Type (1);
5881
5882                --     ...  Obj1 = Obj2 ...
5883
5884                --     Generated code:
5885
5886                --     if not (uu_typeEQ (obj1.comp, obj2.comp,
5887                --                        obj1.discr, obj2.discr)) then
5888
5889                --  In this case we can directly reference the discriminants of
5890                --  the enclosing record.
5891
5892                --  Lhs of equality
5893
5894                if Nkind (Lhs) = N_Selected_Component
5895                  and then Has_Per_Object_Constraint
5896                             (Entity (Selector_Name (Lhs)))
5897                then
5898                   --  Enclosing record is an Unchecked_Union, use formal A
5899
5900                   if Is_Unchecked_Union
5901                        (Scope (Entity (Selector_Name (Lhs))))
5902                   then
5903                      Lhs_Discr_Val := Make_Identifier (Loc, Name_A);
5904
5905                   --  Enclosing record is of a non-Unchecked_Union type, it is
5906                   --  possible to reference the discriminant.
5907
5908                   else
5909                      Lhs_Discr_Val :=
5910                        Make_Selected_Component (Loc,
5911                          Prefix => Prefix (Lhs),
5912                          Selector_Name =>
5913                            New_Copy
5914                              (Get_Discriminant_Value
5915                                 (First_Discriminant (Lhs_Type),
5916                                  Lhs_Type,
5917                                  Stored_Constraint (Lhs_Type))));
5918                   end if;
5919
5920                --  Comment needed here ???
5921
5922                else
5923                   --  Infer the discriminant value
5924
5925                   Lhs_Discr_Val :=
5926                     New_Copy
5927                       (Get_Discriminant_Value
5928                          (First_Discriminant (Lhs_Type),
5929                           Lhs_Type,
5930                           Stored_Constraint (Lhs_Type)));
5931                end if;
5932
5933                --  Rhs of equality
5934
5935                if Nkind (Rhs) = N_Selected_Component
5936                  and then Has_Per_Object_Constraint
5937                             (Entity (Selector_Name (Rhs)))
5938                then
5939                   if Is_Unchecked_Union
5940                        (Scope (Entity (Selector_Name (Rhs))))
5941                   then
5942                      Rhs_Discr_Val := Make_Identifier (Loc, Name_B);
5943
5944                   else
5945                      Rhs_Discr_Val :=
5946                        Make_Selected_Component (Loc,
5947                          Prefix => Prefix (Rhs),
5948                          Selector_Name =>
5949                            New_Copy (Get_Discriminant_Value (
5950                              First_Discriminant (Rhs_Type),
5951                              Rhs_Type,
5952                              Stored_Constraint (Rhs_Type))));
5953
5954                   end if;
5955                else
5956                   Rhs_Discr_Val :=
5957                     New_Copy (Get_Discriminant_Value (
5958                       First_Discriminant (Rhs_Type),
5959                       Rhs_Type,
5960                       Stored_Constraint (Rhs_Type)));
5961
5962                end if;
5963
5964                Rewrite (N,
5965                  Make_Function_Call (Loc,
5966                    Name => New_Reference_To (Eq, Loc),
5967                    Parameter_Associations => New_List (
5968                      L_Exp,
5969                      R_Exp,
5970                      Lhs_Discr_Val,
5971                      Rhs_Discr_Val)));
5972             end;
5973
5974          --  Normal case, not an unchecked union
5975
5976          else
5977             Rewrite (N,
5978               Make_Function_Call (Loc,
5979                 Name => New_Reference_To (Eq, Loc),
5980                 Parameter_Associations => New_List (L_Exp, R_Exp)));
5981          end if;
5982
5983          Analyze_And_Resolve (N, Standard_Boolean, Suppress => All_Checks);
5984       end Build_Equality_Call;
5985
5986       ------------------------------------
5987       -- Has_Unconstrained_UU_Component --
5988       ------------------------------------
5989
5990       function Has_Unconstrained_UU_Component
5991         (Typ : Node_Id) return Boolean
5992       is
5993          Tdef  : constant Node_Id :=
5994                    Type_Definition (Declaration_Node (Base_Type (Typ)));
5995          Clist : Node_Id;
5996          Vpart : Node_Id;
5997
5998          function Component_Is_Unconstrained_UU
5999            (Comp : Node_Id) return Boolean;
6000          --  Determines whether the subtype of the component is an
6001          --  unconstrained Unchecked_Union.
6002
6003          function Variant_Is_Unconstrained_UU
6004            (Variant : Node_Id) return Boolean;
6005          --  Determines whether a component of the variant has an unconstrained
6006          --  Unchecked_Union subtype.
6007
6008          -----------------------------------
6009          -- Component_Is_Unconstrained_UU --
6010          -----------------------------------
6011
6012          function Component_Is_Unconstrained_UU
6013            (Comp : Node_Id) return Boolean
6014          is
6015          begin
6016             if Nkind (Comp) /= N_Component_Declaration then
6017                return False;
6018             end if;
6019
6020             declare
6021                Sindic : constant Node_Id :=
6022                           Subtype_Indication (Component_Definition (Comp));
6023
6024             begin
6025                --  Unconstrained nominal type. In the case of a constraint
6026                --  present, the node kind would have been N_Subtype_Indication.
6027
6028                if Nkind (Sindic) = N_Identifier then
6029                   return Is_Unchecked_Union (Base_Type (Etype (Sindic)));
6030                end if;
6031
6032                return False;
6033             end;
6034          end Component_Is_Unconstrained_UU;
6035
6036          ---------------------------------
6037          -- Variant_Is_Unconstrained_UU --
6038          ---------------------------------
6039
6040          function Variant_Is_Unconstrained_UU
6041            (Variant : Node_Id) return Boolean
6042          is
6043             Clist : constant Node_Id := Component_List (Variant);
6044
6045          begin
6046             if Is_Empty_List (Component_Items (Clist)) then
6047                return False;
6048             end if;
6049
6050             --  We only need to test one component
6051
6052             declare
6053                Comp : Node_Id := First (Component_Items (Clist));
6054
6055             begin
6056                while Present (Comp) loop
6057                   if Component_Is_Unconstrained_UU (Comp) then
6058                      return True;
6059                   end if;
6060
6061                   Next (Comp);
6062                end loop;
6063             end;
6064
6065             --  None of the components withing the variant were of
6066             --  unconstrained Unchecked_Union type.
6067
6068             return False;
6069          end Variant_Is_Unconstrained_UU;
6070
6071       --  Start of processing for Has_Unconstrained_UU_Component
6072
6073       begin
6074          if Null_Present (Tdef) then
6075             return False;
6076          end if;
6077
6078          Clist := Component_List (Tdef);
6079          Vpart := Variant_Part (Clist);
6080
6081          --  Inspect available components
6082
6083          if Present (Component_Items (Clist)) then
6084             declare
6085                Comp : Node_Id := First (Component_Items (Clist));
6086
6087             begin
6088                while Present (Comp) loop
6089
6090                   --  One component is sufficient
6091
6092                   if Component_Is_Unconstrained_UU (Comp) then
6093                      return True;
6094                   end if;
6095
6096                   Next (Comp);
6097                end loop;
6098             end;
6099          end if;
6100
6101          --  Inspect available components withing variants
6102
6103          if Present (Vpart) then
6104             declare
6105                Variant : Node_Id := First (Variants (Vpart));
6106
6107             begin
6108                while Present (Variant) loop
6109
6110                   --  One component within a variant is sufficient
6111
6112                   if Variant_Is_Unconstrained_UU (Variant) then
6113                      return True;
6114                   end if;
6115
6116                   Next (Variant);
6117                end loop;
6118             end;
6119          end if;
6120
6121          --  Neither the available components, nor the components inside the
6122          --  variant parts were of an unconstrained Unchecked_Union subtype.
6123
6124          return False;
6125       end Has_Unconstrained_UU_Component;
6126
6127    --  Start of processing for Expand_N_Op_Eq
6128
6129    begin
6130       Binary_Op_Validity_Checks (N);
6131
6132       if Ekind (Typl) = E_Private_Type then
6133          Typl := Underlying_Type (Typl);
6134       elsif Ekind (Typl) = E_Private_Subtype then
6135          Typl := Underlying_Type (Base_Type (Typl));
6136       else
6137          null;
6138       end if;
6139
6140       --  It may happen in error situations that the underlying type is not
6141       --  set. The error will be detected later, here we just defend the
6142       --  expander code.
6143
6144       if No (Typl) then
6145          return;
6146       end if;
6147
6148       Typl := Base_Type (Typl);
6149
6150       --  Boolean types (requiring handling of non-standard case)
6151
6152       if Is_Boolean_Type (Typl) then
6153          Adjust_Condition (Left_Opnd (N));
6154          Adjust_Condition (Right_Opnd (N));
6155          Set_Etype (N, Standard_Boolean);
6156          Adjust_Result_Type (N, Typ);
6157
6158       --  Array types
6159
6160       elsif Is_Array_Type (Typl) then
6161
6162          --  If we are doing full validity checking, and it is possible for the
6163          --  array elements to be invalid then expand out array comparisons to
6164          --  make sure that we check the array elements.
6165
6166          if Validity_Check_Operands
6167            and then not Is_Known_Valid (Component_Type (Typl))
6168          then
6169             declare
6170                Save_Force_Validity_Checks : constant Boolean :=
6171                                               Force_Validity_Checks;
6172             begin
6173                Force_Validity_Checks := True;
6174                Rewrite (N,
6175                  Expand_Array_Equality
6176                   (N,
6177                    Relocate_Node (Lhs),
6178                    Relocate_Node (Rhs),
6179                    Bodies,
6180                    Typl));
6181                Insert_Actions (N, Bodies);
6182                Analyze_And_Resolve (N, Standard_Boolean);
6183                Force_Validity_Checks := Save_Force_Validity_Checks;
6184             end;
6185
6186          --  Packed case where both operands are known aligned
6187
6188          elsif Is_Bit_Packed_Array (Typl)
6189            and then not Is_Possibly_Unaligned_Object (Lhs)
6190            and then not Is_Possibly_Unaligned_Object (Rhs)
6191          then
6192             Expand_Packed_Eq (N);
6193
6194          --  Where the component type is elementary we can use a block bit
6195          --  comparison (if supported on the target) exception in the case
6196          --  of floating-point (negative zero issues require element by
6197          --  element comparison), and atomic types (where we must be sure
6198          --  to load elements independently) and possibly unaligned arrays.
6199
6200          elsif Is_Elementary_Type (Component_Type (Typl))
6201            and then not Is_Floating_Point_Type (Component_Type (Typl))
6202            and then not Is_Atomic (Component_Type (Typl))
6203            and then not Is_Possibly_Unaligned_Object (Lhs)
6204            and then not Is_Possibly_Unaligned_Object (Rhs)
6205            and then Support_Composite_Compare_On_Target
6206          then
6207             null;
6208
6209          --  For composite and floating-point cases, expand equality loop to
6210          --  make sure of using proper comparisons for tagged types, and
6211          --  correctly handling the floating-point case.
6212
6213          else
6214             Rewrite (N,
6215               Expand_Array_Equality
6216                 (N,
6217                  Relocate_Node (Lhs),
6218                  Relocate_Node (Rhs),
6219                  Bodies,
6220                  Typl));
6221             Insert_Actions      (N, Bodies,           Suppress => All_Checks);
6222             Analyze_And_Resolve (N, Standard_Boolean, Suppress => All_Checks);
6223          end if;
6224
6225       --  Record Types
6226
6227       elsif Is_Record_Type (Typl) then
6228
6229          --  For tagged types, use the primitive "="
6230
6231          if Is_Tagged_Type (Typl) then
6232
6233             --  No need to do anything else compiling under restriction
6234             --  No_Dispatching_Calls. During the semantic analysis we
6235             --  already notified such violation.
6236
6237             if Restriction_Active (No_Dispatching_Calls) then
6238                return;
6239             end if;
6240
6241             --  If this is derived from an untagged private type completed with
6242             --  a tagged type, it does not have a full view, so we use the
6243             --  primitive operations of the private type. This check should no
6244             --  longer be necessary when these types get their full views???
6245
6246             if Is_Private_Type (A_Typ)
6247               and then not Is_Tagged_Type (A_Typ)
6248               and then Is_Derived_Type (A_Typ)
6249               and then No (Full_View (A_Typ))
6250             then
6251                --  Search for equality operation, checking that the operands
6252                --  have the same type. Note that we must find a matching entry,
6253                --  or something is very wrong!
6254
6255                Prim := First_Elmt (Collect_Primitive_Operations (A_Typ));
6256
6257                while Present (Prim) loop
6258                   exit when Chars (Node (Prim)) = Name_Op_Eq
6259                     and then Etype (First_Formal (Node (Prim))) =
6260                              Etype (Next_Formal (First_Formal (Node (Prim))))
6261                     and then
6262                       Base_Type (Etype (Node (Prim))) = Standard_Boolean;
6263
6264                   Next_Elmt (Prim);
6265                end loop;
6266
6267                pragma Assert (Present (Prim));
6268                Op_Name := Node (Prim);
6269
6270             --  Find the type's predefined equality or an overriding
6271             --  user- defined equality. The reason for not simply calling
6272             --  Find_Prim_Op here is that there may be a user-defined
6273             --  overloaded equality op that precedes the equality that we want,
6274             --  so we have to explicitly search (e.g., there could be an
6275             --  equality with two different parameter types).
6276
6277             else
6278                if Is_Class_Wide_Type (Typl) then
6279                   Typl := Root_Type (Typl);
6280                end if;
6281
6282                Prim := First_Elmt (Primitive_Operations (Typl));
6283                while Present (Prim) loop
6284                   exit when Chars (Node (Prim)) = Name_Op_Eq
6285                     and then Etype (First_Formal (Node (Prim))) =
6286                              Etype (Next_Formal (First_Formal (Node (Prim))))
6287                     and then
6288                       Base_Type (Etype (Node (Prim))) = Standard_Boolean;
6289
6290                   Next_Elmt (Prim);
6291                end loop;
6292
6293                pragma Assert (Present (Prim));
6294                Op_Name := Node (Prim);
6295             end if;
6296
6297             Build_Equality_Call (Op_Name);
6298
6299          --  Ada 2005 (AI-216): Program_Error is raised when evaluating the
6300          --  predefined equality operator for a type which has a subcomponent
6301          --  of an Unchecked_Union type whose nominal subtype is unconstrained.
6302
6303          elsif Has_Unconstrained_UU_Component (Typl) then
6304             Insert_Action (N,
6305               Make_Raise_Program_Error (Loc,
6306                 Reason => PE_Unchecked_Union_Restriction));
6307
6308             --  Prevent Gigi from generating incorrect code by rewriting the
6309             --  equality as a standard False.
6310
6311             Rewrite (N,
6312               New_Occurrence_Of (Standard_False, Loc));
6313
6314          elsif Is_Unchecked_Union (Typl) then
6315
6316             --  If we can infer the discriminants of the operands, we make a
6317             --  call to the TSS equality function.
6318
6319             if Has_Inferable_Discriminants (Lhs)
6320                  and then
6321                Has_Inferable_Discriminants (Rhs)
6322             then
6323                Build_Equality_Call
6324                  (TSS (Root_Type (Typl), TSS_Composite_Equality));
6325
6326             else
6327                --  Ada 2005 (AI-216): Program_Error is raised when evaluating
6328                --  the predefined equality operator for an Unchecked_Union type
6329                --  if either of the operands lack inferable discriminants.
6330
6331                Insert_Action (N,
6332                  Make_Raise_Program_Error (Loc,
6333                    Reason => PE_Unchecked_Union_Restriction));
6334
6335                --  Prevent Gigi from generating incorrect code by rewriting
6336                --  the equality as a standard False.
6337
6338                Rewrite (N,
6339                  New_Occurrence_Of (Standard_False, Loc));
6340
6341             end if;
6342
6343          --  If a type support function is present (for complex cases), use it
6344
6345          elsif Present (TSS (Root_Type (Typl), TSS_Composite_Equality)) then
6346             Build_Equality_Call
6347               (TSS (Root_Type (Typl), TSS_Composite_Equality));
6348
6349          --  Otherwise expand the component by component equality. Note that
6350          --  we never use block-bit comparisons for records, because of the
6351          --  problems with gaps. The backend will often be able to recombine
6352          --  the separate comparisons that we generate here.
6353
6354          else
6355             Remove_Side_Effects (Lhs);
6356             Remove_Side_Effects (Rhs);
6357             Rewrite (N,
6358               Expand_Record_Equality (N, Typl, Lhs, Rhs, Bodies));
6359
6360             Insert_Actions      (N, Bodies,           Suppress => All_Checks);
6361             Analyze_And_Resolve (N, Standard_Boolean, Suppress => All_Checks);
6362          end if;
6363       end if;
6364
6365       --  Test if result is known at compile time
6366
6367       Rewrite_Comparison (N);
6368
6369       --  If we still have comparison for Vax_Float, process it
6370
6371       if Vax_Float (Typl) and then Nkind (N) in N_Op_Compare  then
6372          Expand_Vax_Comparison (N);
6373          return;
6374       end if;
6375
6376       Optimize_Length_Comparison (N);
6377    end Expand_N_Op_Eq;
6378
6379    -----------------------
6380    -- Expand_N_Op_Expon --
6381    -----------------------
6382
6383    procedure Expand_N_Op_Expon (N : Node_Id) is
6384       Loc    : constant Source_Ptr := Sloc (N);
6385       Typ    : constant Entity_Id  := Etype (N);
6386       Rtyp   : constant Entity_Id  := Root_Type (Typ);
6387       Base   : constant Node_Id    := Relocate_Node (Left_Opnd (N));
6388       Bastyp : constant Node_Id    := Etype (Base);
6389       Exp    : constant Node_Id    := Relocate_Node (Right_Opnd (N));
6390       Exptyp : constant Entity_Id  := Etype (Exp);
6391       Ovflo  : constant Boolean    := Do_Overflow_Check (N);
6392       Expv   : Uint;
6393       Xnode  : Node_Id;
6394       Temp   : Node_Id;
6395       Rent   : RE_Id;
6396       Ent    : Entity_Id;
6397       Etyp   : Entity_Id;
6398
6399    begin
6400       Binary_Op_Validity_Checks (N);
6401
6402       --  CodePeer and GNATprove want to see the unexpanded N_Op_Expon node
6403
6404       if CodePeer_Mode or Alfa_Mode then
6405          return;
6406       end if;
6407
6408       --  If either operand is of a private type, then we have the use of an
6409       --  intrinsic operator, and we get rid of the privateness, by using root
6410       --  types of underlying types for the actual operation. Otherwise the
6411       --  private types will cause trouble if we expand multiplications or
6412       --  shifts etc. We also do this transformation if the result type is
6413       --  different from the base type.
6414
6415       if Is_Private_Type (Etype (Base))
6416         or else Is_Private_Type (Typ)
6417         or else Is_Private_Type (Exptyp)
6418         or else Rtyp /= Root_Type (Bastyp)
6419       then
6420          declare
6421             Bt : constant Entity_Id := Root_Type (Underlying_Type (Bastyp));
6422             Et : constant Entity_Id := Root_Type (Underlying_Type (Exptyp));
6423
6424          begin
6425             Rewrite (N,
6426               Unchecked_Convert_To (Typ,
6427                 Make_Op_Expon (Loc,
6428                   Left_Opnd  => Unchecked_Convert_To (Bt, Base),
6429                   Right_Opnd => Unchecked_Convert_To (Et, Exp))));
6430             Analyze_And_Resolve (N, Typ);
6431             return;
6432          end;
6433       end if;
6434
6435       --  Test for case of known right argument
6436
6437       if Compile_Time_Known_Value (Exp) then
6438          Expv := Expr_Value (Exp);
6439
6440          --  We only fold small non-negative exponents. You might think we
6441          --  could fold small negative exponents for the real case, but we
6442          --  can't because we are required to raise Constraint_Error for
6443          --  the case of 0.0 ** (negative) even if Machine_Overflows = False.
6444          --  See ACVC test C4A012B.
6445
6446          if Expv >= 0 and then Expv <= 4 then
6447
6448             --  X ** 0 = 1 (or 1.0)
6449
6450             if Expv = 0 then
6451
6452                --  Call Remove_Side_Effects to ensure that any side effects
6453                --  in the ignored left operand (in particular function calls
6454                --  to user defined functions) are properly executed.
6455
6456                Remove_Side_Effects (Base);
6457
6458                if Ekind (Typ) in Integer_Kind then
6459                   Xnode := Make_Integer_Literal (Loc, Intval => 1);
6460                else
6461                   Xnode := Make_Real_Literal (Loc, Ureal_1);
6462                end if;
6463
6464             --  X ** 1 = X
6465
6466             elsif Expv = 1 then
6467                Xnode := Base;
6468
6469             --  X ** 2 = X * X
6470
6471             elsif Expv = 2 then
6472                Xnode :=
6473                  Make_Op_Multiply (Loc,
6474                    Left_Opnd  => Duplicate_Subexpr (Base),
6475                    Right_Opnd => Duplicate_Subexpr_No_Checks (Base));
6476
6477             --  X ** 3 = X * X * X
6478
6479             elsif Expv = 3 then
6480                Xnode :=
6481                  Make_Op_Multiply (Loc,
6482                    Left_Opnd =>
6483                      Make_Op_Multiply (Loc,
6484                        Left_Opnd  => Duplicate_Subexpr (Base),
6485                        Right_Opnd => Duplicate_Subexpr_No_Checks (Base)),
6486                    Right_Opnd  => Duplicate_Subexpr_No_Checks (Base));
6487
6488             --  X ** 4  ->
6489             --    En : constant base'type := base * base;
6490             --    ...
6491             --    En * En
6492
6493             else -- Expv = 4
6494                Temp := Make_Temporary (Loc, 'E', Base);
6495
6496                Insert_Actions (N, New_List (
6497                  Make_Object_Declaration (Loc,
6498                    Defining_Identifier => Temp,
6499                    Constant_Present    => True,
6500                    Object_Definition   => New_Reference_To (Typ, Loc),
6501                    Expression =>
6502                      Make_Op_Multiply (Loc,
6503                        Left_Opnd  => Duplicate_Subexpr (Base),
6504                        Right_Opnd => Duplicate_Subexpr_No_Checks (Base)))));
6505
6506                Xnode :=
6507                  Make_Op_Multiply (Loc,
6508                    Left_Opnd  => New_Reference_To (Temp, Loc),
6509                    Right_Opnd => New_Reference_To (Temp, Loc));
6510             end if;
6511
6512             Rewrite (N, Xnode);
6513             Analyze_And_Resolve (N, Typ);
6514             return;
6515          end if;
6516       end if;
6517
6518       --  Case of (2 ** expression) appearing as an argument of an integer
6519       --  multiplication, or as the right argument of a division of a non-
6520       --  negative integer. In such cases we leave the node untouched, setting
6521       --  the flag Is_Natural_Power_Of_2_for_Shift set, then the expansion
6522       --  of the higher level node converts it into a shift.
6523
6524       --  Another case is 2 ** N in any other context. We simply convert
6525       --  this to 1 * 2 ** N, and then the above transformation applies.
6526
6527       --  Note: this transformation is not applicable for a modular type with
6528       --  a non-binary modulus in the multiplication case, since we get a wrong
6529       --  result if the shift causes an overflow before the modular reduction.
6530
6531       if Nkind (Base) = N_Integer_Literal
6532         and then Intval (Base) = 2
6533         and then Is_Integer_Type (Root_Type (Exptyp))
6534         and then Esize (Root_Type (Exptyp)) <= Esize (Standard_Integer)
6535         and then Is_Unsigned_Type (Exptyp)
6536         and then not Ovflo
6537       then
6538          --  First the multiply and divide cases
6539
6540          if Nkind_In (Parent (N), N_Op_Divide, N_Op_Multiply) then
6541             declare
6542                P : constant Node_Id := Parent (N);
6543                L : constant Node_Id := Left_Opnd (P);
6544                R : constant Node_Id := Right_Opnd (P);
6545
6546             begin
6547                if (Nkind (P) = N_Op_Multiply
6548                    and then not Non_Binary_Modulus (Typ)
6549                    and then
6550                      ((Is_Integer_Type (Etype (L)) and then R = N)
6551                          or else
6552                       (Is_Integer_Type (Etype (R)) and then L = N))
6553                    and then not Do_Overflow_Check (P))
6554                  or else
6555                   (Nkind (P) = N_Op_Divide
6556                      and then Is_Integer_Type (Etype (L))
6557                      and then Is_Unsigned_Type (Etype (L))
6558                      and then R = N
6559                      and then not Do_Overflow_Check (P))
6560                then
6561                   Set_Is_Power_Of_2_For_Shift (N);
6562                   return;
6563                end if;
6564             end;
6565
6566          --  Now the other cases
6567
6568          elsif not Non_Binary_Modulus (Typ) then
6569             Rewrite (N,
6570               Make_Op_Multiply (Loc,
6571                 Left_Opnd  => Make_Integer_Literal (Loc, 1),
6572                 Right_Opnd => Relocate_Node (N)));
6573             Analyze_And_Resolve (N, Typ);
6574             return;
6575          end if;
6576       end if;
6577
6578       --  Fall through if exponentiation must be done using a runtime routine
6579
6580       --  First deal with modular case
6581
6582       if Is_Modular_Integer_Type (Rtyp) then
6583
6584          --  Non-binary case, we call the special exponentiation routine for
6585          --  the non-binary case, converting the argument to Long_Long_Integer
6586          --  and passing the modulus value. Then the result is converted back
6587          --  to the base type.
6588
6589          if Non_Binary_Modulus (Rtyp) then
6590             Rewrite (N,
6591               Convert_To (Typ,
6592                 Make_Function_Call (Loc,
6593                   Name => New_Reference_To (RTE (RE_Exp_Modular), Loc),
6594                   Parameter_Associations => New_List (
6595                     Convert_To (Standard_Integer, Base),
6596                     Make_Integer_Literal (Loc, Modulus (Rtyp)),
6597                     Exp))));
6598
6599          --  Binary case, in this case, we call one of two routines, either the
6600          --  unsigned integer case, or the unsigned long long integer case,
6601          --  with a final "and" operation to do the required mod.
6602
6603          else
6604             if UI_To_Int (Esize (Rtyp)) <= Standard_Integer_Size then
6605                Ent := RTE (RE_Exp_Unsigned);
6606             else
6607                Ent := RTE (RE_Exp_Long_Long_Unsigned);
6608             end if;
6609
6610             Rewrite (N,
6611               Convert_To (Typ,
6612                 Make_Op_And (Loc,
6613                   Left_Opnd =>
6614                     Make_Function_Call (Loc,
6615                       Name => New_Reference_To (Ent, Loc),
6616                       Parameter_Associations => New_List (
6617                         Convert_To (Etype (First_Formal (Ent)), Base),
6618                         Exp)),
6619                    Right_Opnd =>
6620                      Make_Integer_Literal (Loc, Modulus (Rtyp) - 1))));
6621
6622          end if;
6623
6624          --  Common exit point for modular type case
6625
6626          Analyze_And_Resolve (N, Typ);
6627          return;
6628
6629       --  Signed integer cases, done using either Integer or Long_Long_Integer.
6630       --  It is not worth having routines for Short_[Short_]Integer, since for
6631       --  most machines it would not help, and it would generate more code that
6632       --  might need certification when a certified run time is required.
6633
6634       --  In the integer cases, we have two routines, one for when overflow
6635       --  checks are required, and one when they are not required, since there
6636       --  is a real gain in omitting checks on many machines.
6637
6638       elsif Rtyp = Base_Type (Standard_Long_Long_Integer)
6639         or else (Rtyp = Base_Type (Standard_Long_Integer)
6640                    and then
6641                      Esize (Standard_Long_Integer) > Esize (Standard_Integer))
6642         or else (Rtyp = Universal_Integer)
6643       then
6644          Etyp := Standard_Long_Long_Integer;
6645
6646          if Ovflo then
6647             Rent := RE_Exp_Long_Long_Integer;
6648          else
6649             Rent := RE_Exn_Long_Long_Integer;
6650          end if;
6651
6652       elsif Is_Signed_Integer_Type (Rtyp) then
6653          Etyp := Standard_Integer;
6654
6655          if Ovflo then
6656             Rent := RE_Exp_Integer;
6657          else
6658             Rent := RE_Exn_Integer;
6659          end if;
6660
6661       --  Floating-point cases, always done using Long_Long_Float. We do not
6662       --  need separate routines for the overflow case here, since in the case
6663       --  of floating-point, we generate infinities anyway as a rule (either
6664       --  that or we automatically trap overflow), and if there is an infinity
6665       --  generated and a range check is required, the check will fail anyway.
6666
6667       else
6668          pragma Assert (Is_Floating_Point_Type (Rtyp));
6669          Etyp := Standard_Long_Long_Float;
6670          Rent := RE_Exn_Long_Long_Float;
6671       end if;
6672
6673       --  Common processing for integer cases and floating-point cases.
6674       --  If we are in the right type, we can call runtime routine directly
6675
6676       if Typ = Etyp
6677         and then Rtyp /= Universal_Integer
6678         and then Rtyp /= Universal_Real
6679       then
6680          Rewrite (N,
6681            Make_Function_Call (Loc,
6682              Name => New_Reference_To (RTE (Rent), Loc),
6683              Parameter_Associations => New_List (Base, Exp)));
6684
6685       --  Otherwise we have to introduce conversions (conversions are also
6686       --  required in the universal cases, since the runtime routine is
6687       --  typed using one of the standard types).
6688
6689       else
6690          Rewrite (N,
6691            Convert_To (Typ,
6692              Make_Function_Call (Loc,
6693                Name => New_Reference_To (RTE (Rent), Loc),
6694                Parameter_Associations => New_List (
6695                  Convert_To (Etyp, Base),
6696                  Exp))));
6697       end if;
6698
6699       Analyze_And_Resolve (N, Typ);
6700       return;
6701
6702    exception
6703       when RE_Not_Available =>
6704          return;
6705    end Expand_N_Op_Expon;
6706
6707    --------------------
6708    -- Expand_N_Op_Ge --
6709    --------------------
6710
6711    procedure Expand_N_Op_Ge (N : Node_Id) is
6712       Typ  : constant Entity_Id := Etype (N);
6713       Op1  : constant Node_Id   := Left_Opnd (N);
6714       Op2  : constant Node_Id   := Right_Opnd (N);
6715       Typ1 : constant Entity_Id := Base_Type (Etype (Op1));
6716
6717    begin
6718       Binary_Op_Validity_Checks (N);
6719
6720       if Is_Array_Type (Typ1) then
6721          Expand_Array_Comparison (N);
6722          return;
6723       end if;
6724
6725       if Is_Boolean_Type (Typ1) then
6726          Adjust_Condition (Op1);
6727          Adjust_Condition (Op2);
6728          Set_Etype (N, Standard_Boolean);
6729          Adjust_Result_Type (N, Typ);
6730       end if;
6731
6732       Rewrite_Comparison (N);
6733
6734       --  If we still have comparison, and Vax_Float type, process it
6735
6736       if Vax_Float (Typ1) and then Nkind (N) in N_Op_Compare then
6737          Expand_Vax_Comparison (N);
6738          return;
6739       end if;
6740
6741       Optimize_Length_Comparison (N);
6742    end Expand_N_Op_Ge;
6743
6744    --------------------
6745    -- Expand_N_Op_Gt --
6746    --------------------
6747
6748    procedure Expand_N_Op_Gt (N : Node_Id) is
6749       Typ  : constant Entity_Id := Etype (N);
6750       Op1  : constant Node_Id   := Left_Opnd (N);
6751       Op2  : constant Node_Id   := Right_Opnd (N);
6752       Typ1 : constant Entity_Id := Base_Type (Etype (Op1));
6753
6754    begin
6755       Binary_Op_Validity_Checks (N);
6756
6757       if Is_Array_Type (Typ1) then
6758          Expand_Array_Comparison (N);
6759          return;
6760       end if;
6761
6762       if Is_Boolean_Type (Typ1) then
6763          Adjust_Condition (Op1);
6764          Adjust_Condition (Op2);
6765          Set_Etype (N, Standard_Boolean);
6766          Adjust_Result_Type (N, Typ);
6767       end if;
6768
6769       Rewrite_Comparison (N);
6770
6771       --  If we still have comparison, and Vax_Float type, process it
6772
6773       if Vax_Float (Typ1) and then Nkind (N) in N_Op_Compare then
6774          Expand_Vax_Comparison (N);
6775          return;
6776       end if;
6777
6778       Optimize_Length_Comparison (N);
6779    end Expand_N_Op_Gt;
6780
6781    --------------------
6782    -- Expand_N_Op_Le --
6783    --------------------
6784
6785    procedure Expand_N_Op_Le (N : Node_Id) is
6786       Typ  : constant Entity_Id := Etype (N);
6787       Op1  : constant Node_Id   := Left_Opnd (N);
6788       Op2  : constant Node_Id   := Right_Opnd (N);
6789       Typ1 : constant Entity_Id := Base_Type (Etype (Op1));
6790
6791    begin
6792       Binary_Op_Validity_Checks (N);
6793
6794       if Is_Array_Type (Typ1) then
6795          Expand_Array_Comparison (N);
6796          return;
6797       end if;
6798
6799       if Is_Boolean_Type (Typ1) then
6800          Adjust_Condition (Op1);
6801          Adjust_Condition (Op2);
6802          Set_Etype (N, Standard_Boolean);
6803          Adjust_Result_Type (N, Typ);
6804       end if;
6805
6806       Rewrite_Comparison (N);
6807
6808       --  If we still have comparison, and Vax_Float type, process it
6809
6810       if Vax_Float (Typ1) and then Nkind (N) in N_Op_Compare then
6811          Expand_Vax_Comparison (N);
6812          return;
6813       end if;
6814
6815       Optimize_Length_Comparison (N);
6816    end Expand_N_Op_Le;
6817
6818    --------------------
6819    -- Expand_N_Op_Lt --
6820    --------------------
6821
6822    procedure Expand_N_Op_Lt (N : Node_Id) is
6823       Typ  : constant Entity_Id := Etype (N);
6824       Op1  : constant Node_Id   := Left_Opnd (N);
6825       Op2  : constant Node_Id   := Right_Opnd (N);
6826       Typ1 : constant Entity_Id := Base_Type (Etype (Op1));
6827
6828    begin
6829       Binary_Op_Validity_Checks (N);
6830
6831       if Is_Array_Type (Typ1) then
6832          Expand_Array_Comparison (N);
6833          return;
6834       end if;
6835
6836       if Is_Boolean_Type (Typ1) then
6837          Adjust_Condition (Op1);
6838          Adjust_Condition (Op2);
6839          Set_Etype (N, Standard_Boolean);
6840          Adjust_Result_Type (N, Typ);
6841       end if;
6842
6843       Rewrite_Comparison (N);
6844
6845       --  If we still have comparison, and Vax_Float type, process it
6846
6847       if Vax_Float (Typ1) and then Nkind (N) in N_Op_Compare then
6848          Expand_Vax_Comparison (N);
6849          return;
6850       end if;
6851
6852       Optimize_Length_Comparison (N);
6853    end Expand_N_Op_Lt;
6854
6855    -----------------------
6856    -- Expand_N_Op_Minus --
6857    -----------------------
6858
6859    procedure Expand_N_Op_Minus (N : Node_Id) is
6860       Loc : constant Source_Ptr := Sloc (N);
6861       Typ : constant Entity_Id  := Etype (N);
6862
6863    begin
6864       Unary_Op_Validity_Checks (N);
6865
6866       if not Backend_Overflow_Checks_On_Target
6867          and then Is_Signed_Integer_Type (Etype (N))
6868          and then Do_Overflow_Check (N)
6869       then
6870          --  Software overflow checking expands -expr into (0 - expr)
6871
6872          Rewrite (N,
6873            Make_Op_Subtract (Loc,
6874              Left_Opnd  => Make_Integer_Literal (Loc, 0),
6875              Right_Opnd => Right_Opnd (N)));
6876
6877          Analyze_And_Resolve (N, Typ);
6878
6879       --  Vax floating-point types case
6880
6881       elsif Vax_Float (Etype (N)) then
6882          Expand_Vax_Arith (N);
6883       end if;
6884    end Expand_N_Op_Minus;
6885
6886    ---------------------
6887    -- Expand_N_Op_Mod --
6888    ---------------------
6889
6890    procedure Expand_N_Op_Mod (N : Node_Id) is
6891       Loc   : constant Source_Ptr := Sloc (N);
6892       Typ   : constant Entity_Id  := Etype (N);
6893       Left  : constant Node_Id    := Left_Opnd (N);
6894       Right : constant Node_Id    := Right_Opnd (N);
6895       DOC   : constant Boolean    := Do_Overflow_Check (N);
6896       DDC   : constant Boolean    := Do_Division_Check (N);
6897
6898       LLB : Uint;
6899       Llo : Uint;
6900       Lhi : Uint;
6901       LOK : Boolean;
6902       Rlo : Uint;
6903       Rhi : Uint;
6904       ROK : Boolean;
6905
6906       pragma Warnings (Off, Lhi);
6907
6908    begin
6909       Binary_Op_Validity_Checks (N);
6910
6911       Determine_Range (Right, ROK, Rlo, Rhi, Assume_Valid => True);
6912       Determine_Range (Left,  LOK, Llo, Lhi, Assume_Valid => True);
6913
6914       --  Convert mod to rem if operands are known non-negative. We do this
6915       --  since it is quite likely that this will improve the quality of code,
6916       --  (the operation now corresponds to the hardware remainder), and it
6917       --  does not seem likely that it could be harmful.
6918
6919       if LOK and then Llo >= 0
6920            and then
6921          ROK and then Rlo >= 0
6922       then
6923          Rewrite (N,
6924            Make_Op_Rem (Sloc (N),
6925              Left_Opnd  => Left_Opnd (N),
6926              Right_Opnd => Right_Opnd (N)));
6927
6928          --  Instead of reanalyzing the node we do the analysis manually. This
6929          --  avoids anomalies when the replacement is done in an instance and
6930          --  is epsilon more efficient.
6931
6932          Set_Entity            (N, Standard_Entity (S_Op_Rem));
6933          Set_Etype             (N, Typ);
6934          Set_Do_Overflow_Check (N, DOC);
6935          Set_Do_Division_Check (N, DDC);
6936          Expand_N_Op_Rem (N);
6937          Set_Analyzed (N);
6938
6939       --  Otherwise, normal mod processing
6940
6941       else
6942          if Is_Integer_Type (Etype (N)) then
6943             Apply_Divide_Check (N);
6944          end if;
6945
6946          --  Apply optimization x mod 1 = 0. We don't really need that with
6947          --  gcc, but it is useful with other back ends (e.g. AAMP), and is
6948          --  certainly harmless.
6949
6950          if Is_Integer_Type (Etype (N))
6951            and then Compile_Time_Known_Value (Right)
6952            and then Expr_Value (Right) = Uint_1
6953          then
6954             --  Call Remove_Side_Effects to ensure that any side effects in
6955             --  the ignored left operand (in particular function calls to
6956             --  user defined functions) are properly executed.
6957
6958             Remove_Side_Effects (Left);
6959
6960             Rewrite (N, Make_Integer_Literal (Loc, 0));
6961             Analyze_And_Resolve (N, Typ);
6962             return;
6963          end if;
6964
6965          --  Deal with annoying case of largest negative number remainder
6966          --  minus one. Gigi does not handle this case correctly, because
6967          --  it generates a divide instruction which may trap in this case.
6968
6969          --  In fact the check is quite easy, if the right operand is -1, then
6970          --  the mod value is always 0, and we can just ignore the left operand
6971          --  completely in this case.
6972
6973          --  The operand type may be private (e.g. in the expansion of an
6974          --  intrinsic operation) so we must use the underlying type to get the
6975          --  bounds, and convert the literals explicitly.
6976
6977          LLB :=
6978            Expr_Value
6979              (Type_Low_Bound (Base_Type (Underlying_Type (Etype (Left)))));
6980
6981          if ((not ROK) or else (Rlo <= (-1) and then (-1) <= Rhi))
6982            and then
6983             ((not LOK) or else (Llo = LLB))
6984          then
6985             Rewrite (N,
6986               Make_Conditional_Expression (Loc,
6987                 Expressions => New_List (
6988                   Make_Op_Eq (Loc,
6989                     Left_Opnd => Duplicate_Subexpr (Right),
6990                     Right_Opnd =>
6991                       Unchecked_Convert_To (Typ,
6992                         Make_Integer_Literal (Loc, -1))),
6993                   Unchecked_Convert_To (Typ,
6994                     Make_Integer_Literal (Loc, Uint_0)),
6995                   Relocate_Node (N))));
6996
6997             Set_Analyzed (Next (Next (First (Expressions (N)))));
6998             Analyze_And_Resolve (N, Typ);
6999          end if;
7000       end if;
7001    end Expand_N_Op_Mod;
7002
7003    --------------------------
7004    -- Expand_N_Op_Multiply --
7005    --------------------------
7006
7007    procedure Expand_N_Op_Multiply (N : Node_Id) is
7008       Loc : constant Source_Ptr := Sloc (N);
7009       Lop : constant Node_Id    := Left_Opnd (N);
7010       Rop : constant Node_Id    := Right_Opnd (N);
7011
7012       Lp2 : constant Boolean :=
7013               Nkind (Lop) = N_Op_Expon
7014                 and then Is_Power_Of_2_For_Shift (Lop);
7015
7016       Rp2 : constant Boolean :=
7017               Nkind (Rop) = N_Op_Expon
7018                 and then Is_Power_Of_2_For_Shift (Rop);
7019
7020       Ltyp : constant Entity_Id  := Etype (Lop);
7021       Rtyp : constant Entity_Id  := Etype (Rop);
7022       Typ  : Entity_Id           := Etype (N);
7023
7024    begin
7025       Binary_Op_Validity_Checks (N);
7026
7027       --  Special optimizations for integer types
7028
7029       if Is_Integer_Type (Typ) then
7030
7031          --  N * 0 = 0 for integer types
7032
7033          if Compile_Time_Known_Value (Rop)
7034            and then Expr_Value (Rop) = Uint_0
7035          then
7036             --  Call Remove_Side_Effects to ensure that any side effects in
7037             --  the ignored left operand (in particular function calls to
7038             --  user defined functions) are properly executed.
7039
7040             Remove_Side_Effects (Lop);
7041
7042             Rewrite (N, Make_Integer_Literal (Loc, Uint_0));
7043             Analyze_And_Resolve (N, Typ);
7044             return;
7045          end if;
7046
7047          --  Similar handling for 0 * N = 0
7048
7049          if Compile_Time_Known_Value (Lop)
7050            and then Expr_Value (Lop) = Uint_0
7051          then
7052             Remove_Side_Effects (Rop);
7053             Rewrite (N, Make_Integer_Literal (Loc, Uint_0));
7054             Analyze_And_Resolve (N, Typ);
7055             return;
7056          end if;
7057
7058          --  N * 1 = 1 * N = N for integer types
7059
7060          --  This optimisation is not done if we are going to
7061          --  rewrite the product 1 * 2 ** N to a shift.
7062
7063          if Compile_Time_Known_Value (Rop)
7064            and then Expr_Value (Rop) = Uint_1
7065            and then not Lp2
7066          then
7067             Rewrite (N, Lop);
7068             return;
7069
7070          elsif Compile_Time_Known_Value (Lop)
7071            and then Expr_Value (Lop) = Uint_1
7072            and then not Rp2
7073          then
7074             Rewrite (N, Rop);
7075             return;
7076          end if;
7077       end if;
7078
7079       --  Convert x * 2 ** y to Shift_Left (x, y). Note that the fact that
7080       --  Is_Power_Of_2_For_Shift is set means that we know that our left
7081       --  operand is an integer, as required for this to work.
7082
7083       if Rp2 then
7084          if Lp2 then
7085
7086             --  Convert 2 ** A * 2 ** B into  2 ** (A + B)
7087
7088             Rewrite (N,
7089               Make_Op_Expon (Loc,
7090                 Left_Opnd => Make_Integer_Literal (Loc, 2),
7091                 Right_Opnd =>
7092                   Make_Op_Add (Loc,
7093                     Left_Opnd  => Right_Opnd (Lop),
7094                     Right_Opnd => Right_Opnd (Rop))));
7095             Analyze_And_Resolve (N, Typ);
7096             return;
7097
7098          else
7099             Rewrite (N,
7100               Make_Op_Shift_Left (Loc,
7101                 Left_Opnd  => Lop,
7102                 Right_Opnd =>
7103                   Convert_To (Standard_Natural, Right_Opnd (Rop))));
7104             Analyze_And_Resolve (N, Typ);
7105             return;
7106          end if;
7107
7108       --  Same processing for the operands the other way round
7109
7110       elsif Lp2 then
7111          Rewrite (N,
7112            Make_Op_Shift_Left (Loc,
7113              Left_Opnd  => Rop,
7114              Right_Opnd =>
7115                Convert_To (Standard_Natural, Right_Opnd (Lop))));
7116          Analyze_And_Resolve (N, Typ);
7117          return;
7118       end if;
7119
7120       --  Do required fixup of universal fixed operation
7121
7122       if Typ = Universal_Fixed then
7123          Fixup_Universal_Fixed_Operation (N);
7124          Typ := Etype (N);
7125       end if;
7126
7127       --  Multiplications with fixed-point results
7128
7129       if Is_Fixed_Point_Type (Typ) then
7130
7131          --  No special processing if Treat_Fixed_As_Integer is set, since from
7132          --  a semantic point of view such operations are simply integer
7133          --  operations and will be treated that way.
7134
7135          if not Treat_Fixed_As_Integer (N) then
7136
7137             --  Case of fixed * integer => fixed
7138
7139             if Is_Integer_Type (Rtyp) then
7140                Expand_Multiply_Fixed_By_Integer_Giving_Fixed (N);
7141
7142             --  Case of integer * fixed => fixed
7143
7144             elsif Is_Integer_Type (Ltyp) then
7145                Expand_Multiply_Integer_By_Fixed_Giving_Fixed (N);
7146
7147             --  Case of fixed * fixed => fixed
7148
7149             else
7150                Expand_Multiply_Fixed_By_Fixed_Giving_Fixed (N);
7151             end if;
7152          end if;
7153
7154       --  Other cases of multiplication of fixed-point operands. Again we
7155       --  exclude the cases where Treat_Fixed_As_Integer flag is set.
7156
7157       elsif (Is_Fixed_Point_Type (Ltyp) or else Is_Fixed_Point_Type (Rtyp))
7158         and then not Treat_Fixed_As_Integer (N)
7159       then
7160          if Is_Integer_Type (Typ) then
7161             Expand_Multiply_Fixed_By_Fixed_Giving_Integer (N);
7162          else
7163             pragma Assert (Is_Floating_Point_Type (Typ));
7164             Expand_Multiply_Fixed_By_Fixed_Giving_Float (N);
7165          end if;
7166
7167       --  Mixed-mode operations can appear in a non-static universal context,
7168       --  in which case the integer argument must be converted explicitly.
7169
7170       elsif Typ = Universal_Real
7171         and then Is_Integer_Type (Rtyp)
7172       then
7173          Rewrite (Rop, Convert_To (Universal_Real, Relocate_Node (Rop)));
7174
7175          Analyze_And_Resolve (Rop, Universal_Real);
7176
7177       elsif Typ = Universal_Real
7178         and then Is_Integer_Type (Ltyp)
7179       then
7180          Rewrite (Lop, Convert_To (Universal_Real, Relocate_Node (Lop)));
7181
7182          Analyze_And_Resolve (Lop, Universal_Real);
7183
7184       --  Non-fixed point cases, check software overflow checking required
7185
7186       elsif Is_Signed_Integer_Type (Etype (N)) then
7187          Apply_Arithmetic_Overflow_Check (N);
7188
7189       --  Deal with VAX float case
7190
7191       elsif Vax_Float (Typ) then
7192          Expand_Vax_Arith (N);
7193          return;
7194       end if;
7195    end Expand_N_Op_Multiply;
7196
7197    --------------------
7198    -- Expand_N_Op_Ne --
7199    --------------------
7200
7201    procedure Expand_N_Op_Ne (N : Node_Id) is
7202       Typ : constant Entity_Id := Etype (Left_Opnd (N));
7203
7204    begin
7205       --  Case of elementary type with standard operator
7206
7207       if Is_Elementary_Type (Typ)
7208         and then Sloc (Entity (N)) = Standard_Location
7209       then
7210          Binary_Op_Validity_Checks (N);
7211
7212          --  Boolean types (requiring handling of non-standard case)
7213
7214          if Is_Boolean_Type (Typ) then
7215             Adjust_Condition (Left_Opnd (N));
7216             Adjust_Condition (Right_Opnd (N));
7217             Set_Etype (N, Standard_Boolean);
7218             Adjust_Result_Type (N, Typ);
7219          end if;
7220
7221          Rewrite_Comparison (N);
7222
7223          --  If we still have comparison for Vax_Float, process it
7224
7225          if Vax_Float (Typ) and then Nkind (N) in N_Op_Compare  then
7226             Expand_Vax_Comparison (N);
7227             return;
7228          end if;
7229
7230       --  For all cases other than elementary types, we rewrite node as the
7231       --  negation of an equality operation, and reanalyze. The equality to be
7232       --  used is defined in the same scope and has the same signature. This
7233       --  signature must be set explicitly since in an instance it may not have
7234       --  the same visibility as in the generic unit. This avoids duplicating
7235       --  or factoring the complex code for record/array equality tests etc.
7236
7237       else
7238          declare
7239             Loc : constant Source_Ptr := Sloc (N);
7240             Neg : Node_Id;
7241             Ne  : constant Entity_Id := Entity (N);
7242
7243          begin
7244             Binary_Op_Validity_Checks (N);
7245
7246             Neg :=
7247               Make_Op_Not (Loc,
7248                 Right_Opnd =>
7249                   Make_Op_Eq (Loc,
7250                     Left_Opnd =>  Left_Opnd (N),
7251                     Right_Opnd => Right_Opnd (N)));
7252             Set_Paren_Count (Right_Opnd (Neg), 1);
7253
7254             if Scope (Ne) /= Standard_Standard then
7255                Set_Entity (Right_Opnd (Neg), Corresponding_Equality (Ne));
7256             end if;
7257
7258             --  For navigation purposes, we want to treat the inequality as an
7259             --  implicit reference to the corresponding equality. Preserve the
7260             --  Comes_From_ source flag to generate proper Xref entries.
7261
7262             Preserve_Comes_From_Source (Neg, N);
7263             Preserve_Comes_From_Source (Right_Opnd (Neg), N);
7264             Rewrite (N, Neg);
7265             Analyze_And_Resolve (N, Standard_Boolean);
7266          end;
7267       end if;
7268
7269       Optimize_Length_Comparison (N);
7270    end Expand_N_Op_Ne;
7271
7272    ---------------------
7273    -- Expand_N_Op_Not --
7274    ---------------------
7275
7276    --  If the argument is other than a Boolean array type, there is no special
7277    --  expansion required, except for VMS operations on signed integers.
7278
7279    --  For the packed case, we call the special routine in Exp_Pakd, except
7280    --  that if the component size is greater than one, we use the standard
7281    --  routine generating a gruesome loop (it is so peculiar to have packed
7282    --  arrays with non-standard Boolean representations anyway, so it does not
7283    --  matter that we do not handle this case efficiently).
7284
7285    --  For the unpacked case (and for the special packed case where we have non
7286    --  standard Booleans, as discussed above), we generate and insert into the
7287    --  tree the following function definition:
7288
7289    --     function Nnnn (A : arr) is
7290    --       B : arr;
7291    --     begin
7292    --       for J in a'range loop
7293    --          B (J) := not A (J);
7294    --       end loop;
7295    --       return B;
7296    --     end Nnnn;
7297
7298    --  Here arr is the actual subtype of the parameter (and hence always
7299    --  constrained). Then we replace the not with a call to this function.
7300
7301    procedure Expand_N_Op_Not (N : Node_Id) is
7302       Loc  : constant Source_Ptr := Sloc (N);
7303       Typ  : constant Entity_Id  := Etype (N);
7304       Opnd : Node_Id;
7305       Arr  : Entity_Id;
7306       A    : Entity_Id;
7307       B    : Entity_Id;
7308       J    : Entity_Id;
7309       A_J  : Node_Id;
7310       B_J  : Node_Id;
7311
7312       Func_Name      : Entity_Id;
7313       Loop_Statement : Node_Id;
7314
7315    begin
7316       Unary_Op_Validity_Checks (N);
7317
7318       --  For boolean operand, deal with non-standard booleans
7319
7320       if Is_Boolean_Type (Typ) then
7321          Adjust_Condition (Right_Opnd (N));
7322          Set_Etype (N, Standard_Boolean);
7323          Adjust_Result_Type (N, Typ);
7324          return;
7325       end if;
7326
7327       --  For the VMS "not" on signed integer types, use conversion to and from
7328       --  a predefined modular type.
7329
7330       if Is_VMS_Operator (Entity (N)) then
7331          declare
7332             Rtyp : Entity_Id;
7333             Utyp : Entity_Id;
7334
7335          begin
7336             --  If this is a derived type, retrieve original VMS type so that
7337             --  the proper sized type is used for intermediate values.
7338
7339             if Is_Derived_Type (Typ) then
7340                Rtyp := First_Subtype (Etype (Typ));
7341             else
7342                Rtyp := Typ;
7343             end if;
7344
7345             --  The proper unsigned type must have a size compatible with the
7346             --  operand, to prevent misalignment.
7347
7348             if RM_Size (Rtyp) <= 8 then
7349                Utyp := RTE (RE_Unsigned_8);
7350
7351             elsif RM_Size (Rtyp) <= 16 then
7352                Utyp := RTE (RE_Unsigned_16);
7353
7354             elsif RM_Size (Rtyp) = RM_Size (Standard_Unsigned) then
7355                Utyp := RTE (RE_Unsigned_32);
7356
7357             else
7358                Utyp := RTE (RE_Long_Long_Unsigned);
7359             end if;
7360
7361             Rewrite (N,
7362               Unchecked_Convert_To (Typ,
7363                 Make_Op_Not (Loc,
7364                   Unchecked_Convert_To (Utyp, Right_Opnd (N)))));
7365             Analyze_And_Resolve (N, Typ);
7366             return;
7367          end;
7368       end if;
7369
7370       --  Only array types need any other processing
7371
7372       if not Is_Array_Type (Typ) then
7373          return;
7374       end if;
7375
7376       --  Case of array operand. If bit packed with a component size of 1,
7377       --  handle it in Exp_Pakd if the operand is known to be aligned.
7378
7379       if Is_Bit_Packed_Array (Typ)
7380         and then Component_Size (Typ) = 1
7381         and then not Is_Possibly_Unaligned_Object (Right_Opnd (N))
7382       then
7383          Expand_Packed_Not (N);
7384          return;
7385       end if;
7386
7387       --  Case of array operand which is not bit-packed. If the context is
7388       --  a safe assignment, call in-place operation, If context is a larger
7389       --  boolean expression in the context of a safe assignment, expansion is
7390       --  done by enclosing operation.
7391
7392       Opnd := Relocate_Node (Right_Opnd (N));
7393       Convert_To_Actual_Subtype (Opnd);
7394       Arr := Etype (Opnd);
7395       Ensure_Defined (Arr, N);
7396       Silly_Boolean_Array_Not_Test (N, Arr);
7397
7398       if Nkind (Parent (N)) = N_Assignment_Statement then
7399          if Safe_In_Place_Array_Op (Name (Parent (N)), N, Empty) then
7400             Build_Boolean_Array_Proc_Call (Parent (N), Opnd, Empty);
7401             return;
7402
7403          --  Special case the negation of a binary operation
7404
7405          elsif Nkind_In (Opnd, N_Op_And, N_Op_Or, N_Op_Xor)
7406            and then Safe_In_Place_Array_Op
7407                       (Name (Parent (N)), Left_Opnd (Opnd), Right_Opnd (Opnd))
7408          then
7409             Build_Boolean_Array_Proc_Call (Parent (N), Opnd, Empty);
7410             return;
7411          end if;
7412
7413       elsif Nkind (Parent (N)) in N_Binary_Op
7414         and then Nkind (Parent (Parent (N))) = N_Assignment_Statement
7415       then
7416          declare
7417             Op1 : constant Node_Id := Left_Opnd  (Parent (N));
7418             Op2 : constant Node_Id := Right_Opnd (Parent (N));
7419             Lhs : constant Node_Id := Name (Parent (Parent (N)));
7420
7421          begin
7422             if Safe_In_Place_Array_Op (Lhs, Op1, Op2) then
7423
7424                --  (not A) op (not B) can be reduced to a single call
7425
7426                if N = Op1 and then Nkind (Op2) = N_Op_Not then
7427                   return;
7428
7429                elsif N = Op2 and then Nkind (Op1) = N_Op_Not then
7430                   return;
7431
7432                --  A xor (not B) can also be special-cased
7433
7434                elsif N = Op2 and then Nkind (Parent (N)) = N_Op_Xor then
7435                   return;
7436                end if;
7437             end if;
7438          end;
7439       end if;
7440
7441       A := Make_Defining_Identifier (Loc, Name_uA);
7442       B := Make_Defining_Identifier (Loc, Name_uB);
7443       J := Make_Defining_Identifier (Loc, Name_uJ);
7444
7445       A_J :=
7446         Make_Indexed_Component (Loc,
7447           Prefix      => New_Reference_To (A, Loc),
7448           Expressions => New_List (New_Reference_To (J, Loc)));
7449
7450       B_J :=
7451         Make_Indexed_Component (Loc,
7452           Prefix      => New_Reference_To (B, Loc),
7453           Expressions => New_List (New_Reference_To (J, Loc)));
7454
7455       Loop_Statement :=
7456         Make_Implicit_Loop_Statement (N,
7457           Identifier => Empty,
7458
7459           Iteration_Scheme =>
7460             Make_Iteration_Scheme (Loc,
7461               Loop_Parameter_Specification =>
7462                 Make_Loop_Parameter_Specification (Loc,
7463                   Defining_Identifier         => J,
7464                   Discrete_Subtype_Definition =>
7465                     Make_Attribute_Reference (Loc,
7466                       Prefix         => Make_Identifier (Loc, Chars (A)),
7467                       Attribute_Name => Name_Range))),
7468
7469           Statements => New_List (
7470             Make_Assignment_Statement (Loc,
7471               Name       => B_J,
7472               Expression => Make_Op_Not (Loc, A_J))));
7473
7474       Func_Name := Make_Temporary (Loc, 'N');
7475       Set_Is_Inlined (Func_Name);
7476
7477       Insert_Action (N,
7478         Make_Subprogram_Body (Loc,
7479           Specification =>
7480             Make_Function_Specification (Loc,
7481               Defining_Unit_Name => Func_Name,
7482               Parameter_Specifications => New_List (
7483                 Make_Parameter_Specification (Loc,
7484                   Defining_Identifier => A,
7485                   Parameter_Type      => New_Reference_To (Typ, Loc))),
7486               Result_Definition => New_Reference_To (Typ, Loc)),
7487
7488           Declarations => New_List (
7489             Make_Object_Declaration (Loc,
7490               Defining_Identifier => B,
7491               Object_Definition   => New_Reference_To (Arr, Loc))),
7492
7493           Handled_Statement_Sequence =>
7494             Make_Handled_Sequence_Of_Statements (Loc,
7495               Statements => New_List (
7496                 Loop_Statement,
7497                 Make_Simple_Return_Statement (Loc,
7498                   Expression => Make_Identifier (Loc, Chars (B)))))));
7499
7500       Rewrite (N,
7501         Make_Function_Call (Loc,
7502           Name                   => New_Reference_To (Func_Name, Loc),
7503           Parameter_Associations => New_List (Opnd)));
7504
7505       Analyze_And_Resolve (N, Typ);
7506    end Expand_N_Op_Not;
7507
7508    --------------------
7509    -- Expand_N_Op_Or --
7510    --------------------
7511
7512    procedure Expand_N_Op_Or (N : Node_Id) is
7513       Typ : constant Entity_Id := Etype (N);
7514
7515    begin
7516       Binary_Op_Validity_Checks (N);
7517
7518       if Is_Array_Type (Etype (N)) then
7519          Expand_Boolean_Operator (N);
7520
7521       elsif Is_Boolean_Type (Etype (N)) then
7522          Adjust_Condition (Left_Opnd (N));
7523          Adjust_Condition (Right_Opnd (N));
7524          Set_Etype (N, Standard_Boolean);
7525          Adjust_Result_Type (N, Typ);
7526
7527       elsif Is_Intrinsic_Subprogram (Entity (N)) then
7528          Expand_Intrinsic_Call (N, Entity (N));
7529
7530       end if;
7531    end Expand_N_Op_Or;
7532
7533    ----------------------
7534    -- Expand_N_Op_Plus --
7535    ----------------------
7536
7537    procedure Expand_N_Op_Plus (N : Node_Id) is
7538    begin
7539       Unary_Op_Validity_Checks (N);
7540    end Expand_N_Op_Plus;
7541
7542    ---------------------
7543    -- Expand_N_Op_Rem --
7544    ---------------------
7545
7546    procedure Expand_N_Op_Rem (N : Node_Id) is
7547       Loc : constant Source_Ptr := Sloc (N);
7548       Typ : constant Entity_Id  := Etype (N);
7549
7550       Left  : constant Node_Id := Left_Opnd (N);
7551       Right : constant Node_Id := Right_Opnd (N);
7552
7553       Lo : Uint;
7554       Hi : Uint;
7555       OK : Boolean;
7556
7557       Lneg : Boolean;
7558       Rneg : Boolean;
7559       --  Set if corresponding operand can be negative
7560
7561       pragma Unreferenced (Hi);
7562
7563    begin
7564       Binary_Op_Validity_Checks (N);
7565
7566       if Is_Integer_Type (Etype (N)) then
7567          Apply_Divide_Check (N);
7568       end if;
7569
7570       --  Apply optimization x rem 1 = 0. We don't really need that with gcc,
7571       --  but it is useful with other back ends (e.g. AAMP), and is certainly
7572       --  harmless.
7573
7574       if Is_Integer_Type (Etype (N))
7575         and then Compile_Time_Known_Value (Right)
7576         and then Expr_Value (Right) = Uint_1
7577       then
7578          --  Call Remove_Side_Effects to ensure that any side effects in the
7579          --  ignored left operand (in particular function calls to user defined
7580          --  functions) are properly executed.
7581
7582          Remove_Side_Effects (Left);
7583
7584          Rewrite (N, Make_Integer_Literal (Loc, 0));
7585          Analyze_And_Resolve (N, Typ);
7586          return;
7587       end if;
7588
7589       --  Deal with annoying case of largest negative number remainder minus
7590       --  one. Gigi does not handle this case correctly, because it generates
7591       --  a divide instruction which may trap in this case.
7592
7593       --  In fact the check is quite easy, if the right operand is -1, then
7594       --  the remainder is always 0, and we can just ignore the left operand
7595       --  completely in this case.
7596
7597       Determine_Range (Right, OK, Lo, Hi, Assume_Valid => True);
7598       Lneg := (not OK) or else Lo < 0;
7599
7600       Determine_Range (Left,  OK, Lo, Hi, Assume_Valid => True);
7601       Rneg := (not OK) or else Lo < 0;
7602
7603       --  We won't mess with trying to find out if the left operand can really
7604       --  be the largest negative number (that's a pain in the case of private
7605       --  types and this is really marginal). We will just assume that we need
7606       --  the test if the left operand can be negative at all.
7607
7608       if Lneg and Rneg then
7609          Rewrite (N,
7610            Make_Conditional_Expression (Loc,
7611              Expressions => New_List (
7612                Make_Op_Eq (Loc,
7613                  Left_Opnd  => Duplicate_Subexpr (Right),
7614                  Right_Opnd =>
7615                    Unchecked_Convert_To (Typ, Make_Integer_Literal (Loc, -1))),
7616
7617                Unchecked_Convert_To (Typ,
7618                  Make_Integer_Literal (Loc, Uint_0)),
7619
7620                Relocate_Node (N))));
7621
7622          Set_Analyzed (Next (Next (First (Expressions (N)))));
7623          Analyze_And_Resolve (N, Typ);
7624       end if;
7625    end Expand_N_Op_Rem;
7626
7627    -----------------------------
7628    -- Expand_N_Op_Rotate_Left --
7629    -----------------------------
7630
7631    procedure Expand_N_Op_Rotate_Left (N : Node_Id) is
7632    begin
7633       Binary_Op_Validity_Checks (N);
7634    end Expand_N_Op_Rotate_Left;
7635
7636    ------------------------------
7637    -- Expand_N_Op_Rotate_Right --
7638    ------------------------------
7639
7640    procedure Expand_N_Op_Rotate_Right (N : Node_Id) is
7641    begin
7642       Binary_Op_Validity_Checks (N);
7643    end Expand_N_Op_Rotate_Right;
7644
7645    ----------------------------
7646    -- Expand_N_Op_Shift_Left --
7647    ----------------------------
7648
7649    procedure Expand_N_Op_Shift_Left (N : Node_Id) is
7650    begin
7651       Binary_Op_Validity_Checks (N);
7652    end Expand_N_Op_Shift_Left;
7653
7654    -----------------------------
7655    -- Expand_N_Op_Shift_Right --
7656    -----------------------------
7657
7658    procedure Expand_N_Op_Shift_Right (N : Node_Id) is
7659    begin
7660       Binary_Op_Validity_Checks (N);
7661    end Expand_N_Op_Shift_Right;
7662
7663    ----------------------------------------
7664    -- Expand_N_Op_Shift_Right_Arithmetic --
7665    ----------------------------------------
7666
7667    procedure Expand_N_Op_Shift_Right_Arithmetic (N : Node_Id) is
7668    begin
7669       Binary_Op_Validity_Checks (N);
7670    end Expand_N_Op_Shift_Right_Arithmetic;
7671
7672    --------------------------
7673    -- Expand_N_Op_Subtract --
7674    --------------------------
7675
7676    procedure Expand_N_Op_Subtract (N : Node_Id) is
7677       Typ : constant Entity_Id := Etype (N);
7678
7679    begin
7680       Binary_Op_Validity_Checks (N);
7681
7682       --  N - 0 = N for integer types
7683
7684       if Is_Integer_Type (Typ)
7685         and then Compile_Time_Known_Value (Right_Opnd (N))
7686         and then Expr_Value (Right_Opnd (N)) = 0
7687       then
7688          Rewrite (N, Left_Opnd (N));
7689          return;
7690       end if;
7691
7692       --  Arithmetic overflow checks for signed integer/fixed point types
7693
7694       if Is_Signed_Integer_Type (Typ)
7695            or else
7696          Is_Fixed_Point_Type (Typ)
7697       then
7698          Apply_Arithmetic_Overflow_Check (N);
7699
7700       --  VAX floating-point types case
7701
7702       elsif Vax_Float (Typ) then
7703          Expand_Vax_Arith (N);
7704       end if;
7705    end Expand_N_Op_Subtract;
7706
7707    ---------------------
7708    -- Expand_N_Op_Xor --
7709    ---------------------
7710
7711    procedure Expand_N_Op_Xor (N : Node_Id) is
7712       Typ : constant Entity_Id := Etype (N);
7713
7714    begin
7715       Binary_Op_Validity_Checks (N);
7716
7717       if Is_Array_Type (Etype (N)) then
7718          Expand_Boolean_Operator (N);
7719
7720       elsif Is_Boolean_Type (Etype (N)) then
7721          Adjust_Condition (Left_Opnd (N));
7722          Adjust_Condition (Right_Opnd (N));
7723          Set_Etype (N, Standard_Boolean);
7724          Adjust_Result_Type (N, Typ);
7725
7726       elsif Is_Intrinsic_Subprogram (Entity (N)) then
7727          Expand_Intrinsic_Call (N, Entity (N));
7728
7729       end if;
7730    end Expand_N_Op_Xor;
7731
7732    ----------------------
7733    -- Expand_N_Or_Else --
7734    ----------------------
7735
7736    procedure Expand_N_Or_Else (N : Node_Id)
7737      renames Expand_Short_Circuit_Operator;
7738
7739    -----------------------------------
7740    -- Expand_N_Qualified_Expression --
7741    -----------------------------------
7742
7743    procedure Expand_N_Qualified_Expression (N : Node_Id) is
7744       Operand     : constant Node_Id   := Expression (N);
7745       Target_Type : constant Entity_Id := Entity (Subtype_Mark (N));
7746
7747    begin
7748       --  Do validity check if validity checking operands
7749
7750       if Validity_Checks_On
7751         and then Validity_Check_Operands
7752       then
7753          Ensure_Valid (Operand);
7754       end if;
7755
7756       --  Apply possible constraint check
7757
7758       Apply_Constraint_Check (Operand, Target_Type, No_Sliding => True);
7759
7760       if Do_Range_Check (Operand) then
7761          Set_Do_Range_Check (Operand, False);
7762          Generate_Range_Check (Operand, Target_Type, CE_Range_Check_Failed);
7763       end if;
7764    end Expand_N_Qualified_Expression;
7765
7766    ------------------------------------
7767    -- Expand_N_Quantified_Expression --
7768    ------------------------------------
7769
7770    --  We expand:
7771
7772    --    for all X in range => Cond
7773
7774    --  into:
7775
7776    --        T := True;
7777    --        for X in range loop
7778    --           if not Cond then
7779    --              T := False;
7780    --              exit;
7781    --           end if;
7782    --        end loop;
7783
7784    --  Conversely, an existentially quantified expression:
7785
7786    --    for some X in range => Cond
7787
7788    --  becomes:
7789
7790    --        T := False;
7791    --        for X in range loop
7792    --           if Cond then
7793    --              T := True;
7794    --              exit;
7795    --           end if;
7796    --        end loop;
7797
7798    --  In both cases, the iteration may be over a container in which case it is
7799    --  given by an iterator specification, not a loop parameter specification.
7800
7801    procedure Expand_N_Quantified_Expression (N : Node_Id) is
7802       Loc          : constant Source_Ptr := Sloc (N);
7803       Is_Universal : constant Boolean := All_Present (N);
7804       Actions      : constant List_Id := New_List;
7805       Tnn          : constant Entity_Id := Make_Temporary (Loc, 'T', N);
7806       Cond         : Node_Id;
7807       Decl         : Node_Id;
7808       I_Scheme     : Node_Id;
7809       Test         : Node_Id;
7810
7811    begin
7812       Decl :=
7813         Make_Object_Declaration (Loc,
7814           Defining_Identifier => Tnn,
7815           Object_Definition   => New_Occurrence_Of (Standard_Boolean, Loc),
7816           Expression          =>
7817             New_Occurrence_Of (Boolean_Literals (Is_Universal), Loc));
7818       Append_To (Actions, Decl);
7819
7820       Cond := Relocate_Node (Condition (N));
7821
7822       --  Reset flag analyzed in the condition to force its analysis. Required
7823       --  since the previous analysis was done with expansion disabled (see
7824       --  Resolve_Quantified_Expression) and hence checks were not inserted
7825       --  and record comparisons have not been expanded.
7826
7827       Reset_Analyzed_Flags (Cond);
7828
7829       if Is_Universal then
7830          Cond := Make_Op_Not (Loc, Cond);
7831       end if;
7832
7833       Test :=
7834         Make_Implicit_If_Statement (N,
7835           Condition       => Cond,
7836           Then_Statements => New_List (
7837             Make_Assignment_Statement (Loc,
7838               Name       => New_Occurrence_Of (Tnn, Loc),
7839               Expression =>
7840                 New_Occurrence_Of (Boolean_Literals (not Is_Universal), Loc)),
7841             Make_Exit_Statement (Loc)));
7842
7843       if Present (Loop_Parameter_Specification (N)) then
7844          I_Scheme :=
7845            Make_Iteration_Scheme (Loc,
7846               Loop_Parameter_Specification =>
7847                 Loop_Parameter_Specification (N));
7848       else
7849          I_Scheme :=
7850            Make_Iteration_Scheme (Loc,
7851              Iterator_Specification => Iterator_Specification (N));
7852       end if;
7853
7854       Append_To (Actions,
7855         Make_Loop_Statement (Loc,
7856           Iteration_Scheme => I_Scheme,
7857           Statements       => New_List (Test),
7858           End_Label        => Empty));
7859
7860       Rewrite (N,
7861         Make_Expression_With_Actions (Loc,
7862           Expression => New_Occurrence_Of (Tnn, Loc),
7863           Actions    => Actions));
7864
7865       Analyze_And_Resolve (N, Standard_Boolean);
7866    end Expand_N_Quantified_Expression;
7867
7868    ---------------------------------
7869    -- Expand_N_Selected_Component --
7870    ---------------------------------
7871
7872    --  If the selector is a discriminant of a concurrent object, rewrite the
7873    --  prefix to denote the corresponding record type.
7874
7875    procedure Expand_N_Selected_Component (N : Node_Id) is
7876       Loc   : constant Source_Ptr := Sloc (N);
7877       Par   : constant Node_Id    := Parent (N);
7878       P     : constant Node_Id    := Prefix (N);
7879       Ptyp  : Entity_Id           := Underlying_Type (Etype (P));
7880       Disc  : Entity_Id;
7881       New_N : Node_Id;
7882       Dcon  : Elmt_Id;
7883       Dval  : Node_Id;
7884
7885       function In_Left_Hand_Side (Comp : Node_Id) return Boolean;
7886       --  Gigi needs a temporary for prefixes that depend on a discriminant,
7887       --  unless the context of an assignment can provide size information.
7888       --  Don't we have a general routine that does this???
7889
7890       function Is_Subtype_Declaration return Boolean;
7891       --  The replacement of a discriminant reference by its value is required
7892       --  if this is part of the initialization of an temporary generated by a
7893       --  change of representation. This shows up as the construction of a
7894       --  discriminant constraint for a subtype declared at the same point as
7895       --  the entity in the prefix of the selected component. We recognize this
7896       --  case when the context of the reference is:
7897       --    subtype ST is T(Obj.D);
7898       --  where the entity for Obj comes from source, and ST has the same sloc.
7899
7900       -----------------------
7901       -- In_Left_Hand_Side --
7902       -----------------------
7903
7904       function In_Left_Hand_Side (Comp : Node_Id) return Boolean is
7905       begin
7906          return (Nkind (Parent (Comp)) = N_Assignment_Statement
7907                   and then Comp = Name (Parent (Comp)))
7908            or else (Present (Parent (Comp))
7909                      and then Nkind (Parent (Comp)) in N_Subexpr
7910                      and then In_Left_Hand_Side (Parent (Comp)));
7911       end In_Left_Hand_Side;
7912
7913       -----------------------------
7914       --  Is_Subtype_Declaration --
7915       -----------------------------
7916
7917       function Is_Subtype_Declaration return Boolean is
7918          Par : constant Node_Id := Parent (N);
7919       begin
7920          return
7921            Nkind (Par) = N_Index_Or_Discriminant_Constraint
7922              and then Nkind (Parent (Parent (Par))) = N_Subtype_Declaration
7923              and then Comes_From_Source (Entity (Prefix (N)))
7924              and then Sloc (Par) = Sloc (Entity (Prefix (N)));
7925       end Is_Subtype_Declaration;
7926
7927    --  Start of processing for Expand_N_Selected_Component
7928
7929    begin
7930       --  Insert explicit dereference if required
7931
7932       if Is_Access_Type (Ptyp) then
7933
7934          --  First set prefix type to proper access type, in case it currently
7935          --  has a private (non-access) view of this type.
7936
7937          Set_Etype (P, Ptyp);
7938
7939          Insert_Explicit_Dereference (P);
7940          Analyze_And_Resolve (P, Designated_Type (Ptyp));
7941
7942          if Ekind (Etype (P)) = E_Private_Subtype
7943            and then Is_For_Access_Subtype (Etype (P))
7944          then
7945             Set_Etype (P, Base_Type (Etype (P)));
7946          end if;
7947
7948          Ptyp := Etype (P);
7949       end if;
7950
7951       --  Deal with discriminant check required
7952
7953       if Do_Discriminant_Check (N) then
7954
7955          --  Present the discriminant checking function to the backend, so that
7956          --  it can inline the call to the function.
7957
7958          Add_Inlined_Body
7959            (Discriminant_Checking_Func
7960              (Original_Record_Component (Entity (Selector_Name (N)))));
7961
7962          --  Now reset the flag and generate the call
7963
7964          Set_Do_Discriminant_Check (N, False);
7965          Generate_Discriminant_Check (N);
7966       end if;
7967
7968       --  Ada 2005 (AI-318-02): If the prefix is a call to a build-in-place
7969       --  function, then additional actuals must be passed.
7970
7971       if Ada_Version >= Ada_2005
7972         and then Is_Build_In_Place_Function_Call (P)
7973       then
7974          Make_Build_In_Place_Call_In_Anonymous_Context (P);
7975       end if;
7976
7977       --  Gigi cannot handle unchecked conversions that are the prefix of a
7978       --  selected component with discriminants. This must be checked during
7979       --  expansion, because during analysis the type of the selector is not
7980       --  known at the point the prefix is analyzed. If the conversion is the
7981       --  target of an assignment, then we cannot force the evaluation.
7982
7983       if Nkind (Prefix (N)) = N_Unchecked_Type_Conversion
7984         and then Has_Discriminants (Etype (N))
7985         and then not In_Left_Hand_Side (N)
7986       then
7987          Force_Evaluation (Prefix (N));
7988       end if;
7989
7990       --  Remaining processing applies only if selector is a discriminant
7991
7992       if Ekind (Entity (Selector_Name (N))) = E_Discriminant then
7993
7994          --  If the selector is a discriminant of a constrained record type,
7995          --  we may be able to rewrite the expression with the actual value
7996          --  of the discriminant, a useful optimization in some cases.
7997
7998          if Is_Record_Type (Ptyp)
7999            and then Has_Discriminants (Ptyp)
8000            and then Is_Constrained (Ptyp)
8001          then
8002             --  Do this optimization for discrete types only, and not for
8003             --  access types (access discriminants get us into trouble!)
8004
8005             if not Is_Discrete_Type (Etype (N)) then
8006                null;
8007
8008             --  Don't do this on the left hand of an assignment statement.
8009             --  Normally one would think that references like this would not
8010             --  occur, but they do in generated code, and mean that we really
8011             --  do want to assign the discriminant!
8012
8013             elsif Nkind (Par) = N_Assignment_Statement
8014               and then Name (Par) = N
8015             then
8016                null;
8017
8018             --  Don't do this optimization for the prefix of an attribute or
8019             --  the name of an object renaming declaration since these are
8020             --  contexts where we do not want the value anyway.
8021
8022             elsif (Nkind (Par) = N_Attribute_Reference
8023                      and then Prefix (Par) = N)
8024               or else Is_Renamed_Object (N)
8025             then
8026                null;
8027
8028             --  Don't do this optimization if we are within the code for a
8029             --  discriminant check, since the whole point of such a check may
8030             --  be to verify the condition on which the code below depends!
8031
8032             elsif Is_In_Discriminant_Check (N) then
8033                null;
8034
8035             --  Green light to see if we can do the optimization. There is
8036             --  still one condition that inhibits the optimization below but
8037             --  now is the time to check the particular discriminant.
8038
8039             else
8040                --  Loop through discriminants to find the matching discriminant
8041                --  constraint to see if we can copy it.
8042
8043                Disc := First_Discriminant (Ptyp);
8044                Dcon := First_Elmt (Discriminant_Constraint (Ptyp));
8045                Discr_Loop : while Present (Dcon) loop
8046                   Dval := Node (Dcon);
8047
8048                   --  Check if this is the matching discriminant and if the
8049                   --  discriminant value is simple enough to make sense to
8050                   --  copy. We don't want to copy complex expressions, and
8051                   --  indeed to do so can cause trouble (before we put in
8052                   --  this guard, a discriminant expression containing an
8053                   --  AND THEN was copied, causing problems for coverage
8054                   --  analysis tools).
8055
8056                   --  However, if the reference is part of the initialization
8057                   --  code generated for an object declaration, we must use
8058                   --  the discriminant value from the subtype constraint,
8059                   --  because the selected component may be a reference to the
8060                   --  object being initialized, whose discriminant is not yet
8061                   --  set. This only happens in complex cases involving changes
8062                   --  or representation.
8063
8064                   if Disc = Entity (Selector_Name (N))
8065                     and then (Is_Entity_Name (Dval)
8066                                or else Compile_Time_Known_Value (Dval)
8067                                or else Is_Subtype_Declaration)
8068                   then
8069                      --  Here we have the matching discriminant. Check for
8070                      --  the case of a discriminant of a component that is
8071                      --  constrained by an outer discriminant, which cannot
8072                      --  be optimized away.
8073
8074                      if Denotes_Discriminant
8075                           (Dval, Check_Concurrent => True)
8076                      then
8077                         exit Discr_Loop;
8078
8079                      elsif Nkind (Original_Node (Dval)) = N_Selected_Component
8080                        and then
8081                          Denotes_Discriminant
8082                            (Selector_Name (Original_Node (Dval)), True)
8083                      then
8084                         exit Discr_Loop;
8085
8086                      --  Do not retrieve value if constraint is not static. It
8087                      --  is generally not useful, and the constraint may be a
8088                      --  rewritten outer discriminant in which case it is in
8089                      --  fact incorrect.
8090
8091                      elsif Is_Entity_Name (Dval)
8092                        and then Nkind (Parent (Entity (Dval))) =
8093                                                       N_Object_Declaration
8094                        and then Present (Expression (Parent (Entity (Dval))))
8095                        and then
8096                          not Is_Static_Expression
8097                            (Expression (Parent (Entity (Dval))))
8098                      then
8099                         exit Discr_Loop;
8100
8101                      --  In the context of a case statement, the expression may
8102                      --  have the base type of the discriminant, and we need to
8103                      --  preserve the constraint to avoid spurious errors on
8104                      --  missing cases.
8105
8106                      elsif Nkind (Parent (N)) = N_Case_Statement
8107                        and then Etype (Dval) /= Etype (Disc)
8108                      then
8109                         Rewrite (N,
8110                           Make_Qualified_Expression (Loc,
8111                             Subtype_Mark =>
8112                               New_Occurrence_Of (Etype (Disc), Loc),
8113                             Expression   =>
8114                               New_Copy_Tree (Dval)));
8115                         Analyze_And_Resolve (N, Etype (Disc));
8116
8117                         --  In case that comes out as a static expression,
8118                         --  reset it (a selected component is never static).
8119
8120                         Set_Is_Static_Expression (N, False);
8121                         return;
8122
8123                      --  Otherwise we can just copy the constraint, but the
8124                      --  result is certainly not static! In some cases the
8125                      --  discriminant constraint has been analyzed in the
8126                      --  context of the original subtype indication, but for
8127                      --  itypes the constraint might not have been analyzed
8128                      --  yet, and this must be done now.
8129
8130                      else
8131                         Rewrite (N, New_Copy_Tree (Dval));
8132                         Analyze_And_Resolve (N);
8133                         Set_Is_Static_Expression (N, False);
8134                         return;
8135                      end if;
8136                   end if;
8137
8138                   Next_Elmt (Dcon);
8139                   Next_Discriminant (Disc);
8140                end loop Discr_Loop;
8141
8142                --  Note: the above loop should always find a matching
8143                --  discriminant, but if it does not, we just missed an
8144                --  optimization due to some glitch (perhaps a previous
8145                --  error), so ignore.
8146
8147             end if;
8148          end if;
8149
8150          --  The only remaining processing is in the case of a discriminant of
8151          --  a concurrent object, where we rewrite the prefix to denote the
8152          --  corresponding record type. If the type is derived and has renamed
8153          --  discriminants, use corresponding discriminant, which is the one
8154          --  that appears in the corresponding record.
8155
8156          if not Is_Concurrent_Type (Ptyp) then
8157             return;
8158          end if;
8159
8160          Disc := Entity (Selector_Name (N));
8161
8162          if Is_Derived_Type (Ptyp)
8163            and then Present (Corresponding_Discriminant (Disc))
8164          then
8165             Disc := Corresponding_Discriminant (Disc);
8166          end if;
8167
8168          New_N :=
8169            Make_Selected_Component (Loc,
8170              Prefix =>
8171                Unchecked_Convert_To (Corresponding_Record_Type (Ptyp),
8172                  New_Copy_Tree (P)),
8173              Selector_Name => Make_Identifier (Loc, Chars (Disc)));
8174
8175          Rewrite (N, New_N);
8176          Analyze (N);
8177       end if;
8178    end Expand_N_Selected_Component;
8179
8180    --------------------
8181    -- Expand_N_Slice --
8182    --------------------
8183
8184    procedure Expand_N_Slice (N : Node_Id) is
8185       Loc  : constant Source_Ptr := Sloc (N);
8186       Typ  : constant Entity_Id  := Etype (N);
8187       Pfx  : constant Node_Id    := Prefix (N);
8188       Ptp  : Entity_Id           := Etype (Pfx);
8189
8190       function Is_Procedure_Actual (N : Node_Id) return Boolean;
8191       --  Check whether the argument is an actual for a procedure call, in
8192       --  which case the expansion of a bit-packed slice is deferred until the
8193       --  call itself is expanded. The reason this is required is that we might
8194       --  have an IN OUT or OUT parameter, and the copy out is essential, and
8195       --  that copy out would be missed if we created a temporary here in
8196       --  Expand_N_Slice. Note that we don't bother to test specifically for an
8197       --  IN OUT or OUT mode parameter, since it is a bit tricky to do, and it
8198       --  is harmless to defer expansion in the IN case, since the call
8199       --  processing will still generate the appropriate copy in operation,
8200       --  which will take care of the slice.
8201
8202       procedure Make_Temporary_For_Slice;
8203       --  Create a named variable for the value of the slice, in cases where
8204       --  the back-end cannot handle it properly, e.g. when packed types or
8205       --  unaligned slices are involved.
8206
8207       -------------------------
8208       -- Is_Procedure_Actual --
8209       -------------------------
8210
8211       function Is_Procedure_Actual (N : Node_Id) return Boolean is
8212          Par : Node_Id := Parent (N);
8213
8214       begin
8215          loop
8216             --  If our parent is a procedure call we can return
8217
8218             if Nkind (Par) = N_Procedure_Call_Statement then
8219                return True;
8220
8221             --  If our parent is a type conversion, keep climbing the tree,
8222             --  since a type conversion can be a procedure actual. Also keep
8223             --  climbing if parameter association or a qualified expression,
8224             --  since these are additional cases that do can appear on
8225             --  procedure actuals.
8226
8227             elsif Nkind_In (Par, N_Type_Conversion,
8228                                  N_Parameter_Association,
8229                                  N_Qualified_Expression)
8230             then
8231                Par := Parent (Par);
8232
8233                --  Any other case is not what we are looking for
8234
8235             else
8236                return False;
8237             end if;
8238          end loop;
8239       end Is_Procedure_Actual;
8240
8241       ------------------------------
8242       -- Make_Temporary_For_Slice --
8243       ------------------------------
8244
8245       procedure Make_Temporary_For_Slice is
8246          Decl : Node_Id;
8247          Ent  : constant Entity_Id := Make_Temporary (Loc, 'T', N);
8248
8249       begin
8250          Decl :=
8251            Make_Object_Declaration (Loc,
8252              Defining_Identifier => Ent,
8253              Object_Definition   => New_Occurrence_Of (Typ, Loc));
8254
8255          Set_No_Initialization (Decl);
8256
8257          Insert_Actions (N, New_List (
8258            Decl,
8259            Make_Assignment_Statement (Loc,
8260              Name => New_Occurrence_Of (Ent, Loc),
8261              Expression => Relocate_Node (N))));
8262
8263          Rewrite (N, New_Occurrence_Of (Ent, Loc));
8264          Analyze_And_Resolve (N, Typ);
8265       end Make_Temporary_For_Slice;
8266
8267    --  Start of processing for Expand_N_Slice
8268
8269    begin
8270       --  Special handling for access types
8271
8272       if Is_Access_Type (Ptp) then
8273
8274          Ptp := Designated_Type (Ptp);
8275
8276          Rewrite (Pfx,
8277            Make_Explicit_Dereference (Sloc (N),
8278             Prefix => Relocate_Node (Pfx)));
8279
8280          Analyze_And_Resolve (Pfx, Ptp);
8281       end if;
8282
8283       --  Ada 2005 (AI-318-02): If the prefix is a call to a build-in-place
8284       --  function, then additional actuals must be passed.
8285
8286       if Ada_Version >= Ada_2005
8287         and then Is_Build_In_Place_Function_Call (Pfx)
8288       then
8289          Make_Build_In_Place_Call_In_Anonymous_Context (Pfx);
8290       end if;
8291
8292       --  The remaining case to be handled is packed slices. We can leave
8293       --  packed slices as they are in the following situations:
8294
8295       --    1. Right or left side of an assignment (we can handle this
8296       --       situation correctly in the assignment statement expansion).
8297
8298       --    2. Prefix of indexed component (the slide is optimized away in this
8299       --       case, see the start of Expand_N_Slice.)
8300
8301       --    3. Object renaming declaration, since we want the name of the
8302       --       slice, not the value.
8303
8304       --    4. Argument to procedure call, since copy-in/copy-out handling may
8305       --       be required, and this is handled in the expansion of call
8306       --       itself.
8307
8308       --    5. Prefix of an address attribute (this is an error which is caught
8309       --       elsewhere, and the expansion would interfere with generating the
8310       --       error message).
8311
8312       if not Is_Packed (Typ) then
8313
8314          --  Apply transformation for actuals of a function call, where
8315          --  Expand_Actuals is not used.
8316
8317          if Nkind (Parent (N)) = N_Function_Call
8318            and then Is_Possibly_Unaligned_Slice (N)
8319          then
8320             Make_Temporary_For_Slice;
8321          end if;
8322
8323       elsif Nkind (Parent (N)) = N_Assignment_Statement
8324         or else (Nkind (Parent (Parent (N))) = N_Assignment_Statement
8325                    and then Parent (N) = Name (Parent (Parent (N))))
8326       then
8327          return;
8328
8329       elsif Nkind (Parent (N)) = N_Indexed_Component
8330         or else Is_Renamed_Object (N)
8331         or else Is_Procedure_Actual (N)
8332       then
8333          return;
8334
8335       elsif Nkind (Parent (N)) = N_Attribute_Reference
8336         and then Attribute_Name (Parent (N)) = Name_Address
8337       then
8338          return;
8339
8340       else
8341          Make_Temporary_For_Slice;
8342       end if;
8343    end Expand_N_Slice;
8344
8345    ------------------------------
8346    -- Expand_N_Type_Conversion --
8347    ------------------------------
8348
8349    procedure Expand_N_Type_Conversion (N : Node_Id) is
8350       Loc          : constant Source_Ptr := Sloc (N);
8351       Operand      : constant Node_Id    := Expression (N);
8352       Target_Type  : constant Entity_Id  := Etype (N);
8353       Operand_Type : Entity_Id           := Etype (Operand);
8354
8355       procedure Handle_Changed_Representation;
8356       --  This is called in the case of record and array type conversions to
8357       --  see if there is a change of representation to be handled. Change of
8358       --  representation is actually handled at the assignment statement level,
8359       --  and what this procedure does is rewrite node N conversion as an
8360       --  assignment to temporary. If there is no change of representation,
8361       --  then the conversion node is unchanged.
8362
8363       procedure Raise_Accessibility_Error;
8364       --  Called when we know that an accessibility check will fail. Rewrites
8365       --  node N to an appropriate raise statement and outputs warning msgs.
8366       --  The Etype of the raise node is set to Target_Type.
8367
8368       procedure Real_Range_Check;
8369       --  Handles generation of range check for real target value
8370
8371       function Has_Extra_Accessibility (Id : Entity_Id) return Boolean;
8372       --  True iff Present (Effective_Extra_Accessibility (Id)) successfully
8373       --  evaluates to True.
8374
8375       -----------------------------------
8376       -- Handle_Changed_Representation --
8377       -----------------------------------
8378
8379       procedure Handle_Changed_Representation is
8380          Temp : Entity_Id;
8381          Decl : Node_Id;
8382          Odef : Node_Id;
8383          Disc : Node_Id;
8384          N_Ix : Node_Id;
8385          Cons : List_Id;
8386
8387       begin
8388          --  Nothing else to do if no change of representation
8389
8390          if Same_Representation (Operand_Type, Target_Type) then
8391             return;
8392
8393          --  The real change of representation work is done by the assignment
8394          --  statement processing. So if this type conversion is appearing as
8395          --  the expression of an assignment statement, nothing needs to be
8396          --  done to the conversion.
8397
8398          elsif Nkind (Parent (N)) = N_Assignment_Statement then
8399             return;
8400
8401          --  Otherwise we need to generate a temporary variable, and do the
8402          --  change of representation assignment into that temporary variable.
8403          --  The conversion is then replaced by a reference to this variable.
8404
8405          else
8406             Cons := No_List;
8407
8408             --  If type is unconstrained we have to add a constraint, copied
8409             --  from the actual value of the left hand side.
8410
8411             if not Is_Constrained (Target_Type) then
8412                if Has_Discriminants (Operand_Type) then
8413                   Disc := First_Discriminant (Operand_Type);
8414
8415                   if Disc /= First_Stored_Discriminant (Operand_Type) then
8416                      Disc := First_Stored_Discriminant (Operand_Type);
8417                   end if;
8418
8419                   Cons := New_List;
8420                   while Present (Disc) loop
8421                      Append_To (Cons,
8422                        Make_Selected_Component (Loc,
8423                          Prefix        =>
8424                            Duplicate_Subexpr_Move_Checks (Operand),
8425                          Selector_Name =>
8426                            Make_Identifier (Loc, Chars (Disc))));
8427                      Next_Discriminant (Disc);
8428                   end loop;
8429
8430                elsif Is_Array_Type (Operand_Type) then
8431                   N_Ix := First_Index (Target_Type);
8432                   Cons := New_List;
8433
8434                   for J in 1 .. Number_Dimensions (Operand_Type) loop
8435
8436                      --  We convert the bounds explicitly. We use an unchecked
8437                      --  conversion because bounds checks are done elsewhere.
8438
8439                      Append_To (Cons,
8440                        Make_Range (Loc,
8441                          Low_Bound =>
8442                            Unchecked_Convert_To (Etype (N_Ix),
8443                              Make_Attribute_Reference (Loc,
8444                                Prefix =>
8445                                  Duplicate_Subexpr_No_Checks
8446                                    (Operand, Name_Req => True),
8447                                Attribute_Name => Name_First,
8448                                Expressions    => New_List (
8449                                  Make_Integer_Literal (Loc, J)))),
8450
8451                          High_Bound =>
8452                            Unchecked_Convert_To (Etype (N_Ix),
8453                              Make_Attribute_Reference (Loc,
8454                                Prefix =>
8455                                  Duplicate_Subexpr_No_Checks
8456                                    (Operand, Name_Req => True),
8457                                Attribute_Name => Name_Last,
8458                                Expressions    => New_List (
8459                                  Make_Integer_Literal (Loc, J))))));
8460
8461                      Next_Index (N_Ix);
8462                   end loop;
8463                end if;
8464             end if;
8465
8466             Odef := New_Occurrence_Of (Target_Type, Loc);
8467
8468             if Present (Cons) then
8469                Odef :=
8470                  Make_Subtype_Indication (Loc,
8471                    Subtype_Mark => Odef,
8472                    Constraint =>
8473                      Make_Index_Or_Discriminant_Constraint (Loc,
8474                        Constraints => Cons));
8475             end if;
8476
8477             Temp := Make_Temporary (Loc, 'C');
8478             Decl :=
8479               Make_Object_Declaration (Loc,
8480                 Defining_Identifier => Temp,
8481                 Object_Definition   => Odef);
8482
8483             Set_No_Initialization (Decl, True);
8484
8485             --  Insert required actions. It is essential to suppress checks
8486             --  since we have suppressed default initialization, which means
8487             --  that the variable we create may have no discriminants.
8488
8489             Insert_Actions (N,
8490               New_List (
8491                 Decl,
8492                 Make_Assignment_Statement (Loc,
8493                   Name => New_Occurrence_Of (Temp, Loc),
8494                   Expression => Relocate_Node (N))),
8495                 Suppress => All_Checks);
8496
8497             Rewrite (N, New_Occurrence_Of (Temp, Loc));
8498             return;
8499          end if;
8500       end Handle_Changed_Representation;
8501
8502       -------------------------------
8503       -- Raise_Accessibility_Error --
8504       -------------------------------
8505
8506       procedure Raise_Accessibility_Error is
8507       begin
8508          Rewrite (N,
8509            Make_Raise_Program_Error (Sloc (N),
8510              Reason => PE_Accessibility_Check_Failed));
8511          Set_Etype (N, Target_Type);
8512
8513          Error_Msg_N ("?accessibility check failure", N);
8514          Error_Msg_NE
8515            ("\?& will be raised at run time", N, Standard_Program_Error);
8516       end Raise_Accessibility_Error;
8517
8518       ----------------------
8519       -- Real_Range_Check --
8520       ----------------------
8521
8522       --  Case of conversions to floating-point or fixed-point. If range checks
8523       --  are enabled and the target type has a range constraint, we convert:
8524
8525       --     typ (x)
8526
8527       --       to
8528
8529       --     Tnn : typ'Base := typ'Base (x);
8530       --     [constraint_error when Tnn < typ'First or else Tnn > typ'Last]
8531       --     Tnn
8532
8533       --  This is necessary when there is a conversion of integer to float or
8534       --  to fixed-point to ensure that the correct checks are made. It is not
8535       --  necessary for float to float where it is enough to simply set the
8536       --  Do_Range_Check flag.
8537
8538       procedure Real_Range_Check is
8539          Btyp : constant Entity_Id := Base_Type (Target_Type);
8540          Lo   : constant Node_Id   := Type_Low_Bound  (Target_Type);
8541          Hi   : constant Node_Id   := Type_High_Bound (Target_Type);
8542          Xtyp : constant Entity_Id := Etype (Operand);
8543          Conv : Node_Id;
8544          Tnn  : Entity_Id;
8545
8546       begin
8547          --  Nothing to do if conversion was rewritten
8548
8549          if Nkind (N) /= N_Type_Conversion then
8550             return;
8551          end if;
8552
8553          --  Nothing to do if range checks suppressed, or target has the same
8554          --  range as the base type (or is the base type).
8555
8556          if Range_Checks_Suppressed (Target_Type)
8557            or else (Lo = Type_Low_Bound (Btyp)
8558                       and then
8559                     Hi = Type_High_Bound (Btyp))
8560          then
8561             return;
8562          end if;
8563
8564          --  Nothing to do if expression is an entity on which checks have been
8565          --  suppressed.
8566
8567          if Is_Entity_Name (Operand)
8568            and then Range_Checks_Suppressed (Entity (Operand))
8569          then
8570             return;
8571          end if;
8572
8573          --  Nothing to do if bounds are all static and we can tell that the
8574          --  expression is within the bounds of the target. Note that if the
8575          --  operand is of an unconstrained floating-point type, then we do
8576          --  not trust it to be in range (might be infinite)
8577
8578          declare
8579             S_Lo : constant Node_Id := Type_Low_Bound (Xtyp);
8580             S_Hi : constant Node_Id := Type_High_Bound (Xtyp);
8581
8582          begin
8583             if (not Is_Floating_Point_Type (Xtyp)
8584                  or else Is_Constrained (Xtyp))
8585               and then Compile_Time_Known_Value (S_Lo)
8586               and then Compile_Time_Known_Value (S_Hi)
8587               and then Compile_Time_Known_Value (Hi)
8588               and then Compile_Time_Known_Value (Lo)
8589             then
8590                declare
8591                   D_Lov : constant Ureal := Expr_Value_R (Lo);
8592                   D_Hiv : constant Ureal := Expr_Value_R (Hi);
8593                   S_Lov : Ureal;
8594                   S_Hiv : Ureal;
8595
8596                begin
8597                   if Is_Real_Type (Xtyp) then
8598                      S_Lov := Expr_Value_R (S_Lo);
8599                      S_Hiv := Expr_Value_R (S_Hi);
8600                   else
8601                      S_Lov := UR_From_Uint (Expr_Value (S_Lo));
8602                      S_Hiv := UR_From_Uint (Expr_Value (S_Hi));
8603                   end if;
8604
8605                   if D_Hiv > D_Lov
8606                     and then S_Lov >= D_Lov
8607                     and then S_Hiv <= D_Hiv
8608                   then
8609                      Set_Do_Range_Check (Operand, False);
8610                      return;
8611                   end if;
8612                end;
8613             end if;
8614          end;
8615
8616          --  For float to float conversions, we are done
8617
8618          if Is_Floating_Point_Type (Xtyp)
8619               and then
8620             Is_Floating_Point_Type (Btyp)
8621          then
8622             return;
8623          end if;
8624
8625          --  Otherwise rewrite the conversion as described above
8626
8627          Conv := Relocate_Node (N);
8628          Rewrite (Subtype_Mark (Conv), New_Occurrence_Of (Btyp, Loc));
8629          Set_Etype (Conv, Btyp);
8630
8631          --  Enable overflow except for case of integer to float conversions,
8632          --  where it is never required, since we can never have overflow in
8633          --  this case.
8634
8635          if not Is_Integer_Type (Etype (Operand)) then
8636             Enable_Overflow_Check (Conv);
8637          end if;
8638
8639          Tnn := Make_Temporary (Loc, 'T', Conv);
8640
8641          Insert_Actions (N, New_List (
8642            Make_Object_Declaration (Loc,
8643              Defining_Identifier => Tnn,
8644              Object_Definition   => New_Occurrence_Of (Btyp, Loc),
8645              Constant_Present    => True,
8646              Expression          => Conv),
8647
8648            Make_Raise_Constraint_Error (Loc,
8649              Condition =>
8650               Make_Or_Else (Loc,
8651                 Left_Opnd =>
8652                   Make_Op_Lt (Loc,
8653                     Left_Opnd  => New_Occurrence_Of (Tnn, Loc),
8654                     Right_Opnd =>
8655                       Make_Attribute_Reference (Loc,
8656                         Attribute_Name => Name_First,
8657                         Prefix =>
8658                           New_Occurrence_Of (Target_Type, Loc))),
8659
8660                 Right_Opnd =>
8661                   Make_Op_Gt (Loc,
8662                     Left_Opnd  => New_Occurrence_Of (Tnn, Loc),
8663                     Right_Opnd =>
8664                       Make_Attribute_Reference (Loc,
8665                         Attribute_Name => Name_Last,
8666                         Prefix =>
8667                           New_Occurrence_Of (Target_Type, Loc)))),
8668              Reason => CE_Range_Check_Failed)));
8669
8670          Rewrite (N, New_Occurrence_Of (Tnn, Loc));
8671          Analyze_And_Resolve (N, Btyp);
8672       end Real_Range_Check;
8673
8674       -----------------------------
8675       -- Has_Extra_Accessibility --
8676       -----------------------------
8677
8678       --  Returns true for a formal of an anonymous access type or for
8679       --  an Ada 2012-style stand-alone object of an anonymous access type.
8680
8681       function Has_Extra_Accessibility (Id : Entity_Id) return Boolean is
8682       begin
8683          if Is_Formal (Id) or else Ekind_In (Id, E_Constant, E_Variable) then
8684             return Present (Effective_Extra_Accessibility (Id));
8685          else
8686             return False;
8687          end if;
8688       end Has_Extra_Accessibility;
8689
8690    --  Start of processing for Expand_N_Type_Conversion
8691
8692    begin
8693       --  Nothing at all to do if conversion is to the identical type so remove
8694       --  the conversion completely, it is useless, except that it may carry
8695       --  an Assignment_OK attribute, which must be propagated to the operand.
8696
8697       if Operand_Type = Target_Type then
8698          if Assignment_OK (N) then
8699             Set_Assignment_OK (Operand);
8700          end if;
8701
8702          Rewrite (N, Relocate_Node (Operand));
8703          goto Done;
8704       end if;
8705
8706       --  Nothing to do if this is the second argument of read. This is a
8707       --  "backwards" conversion that will be handled by the specialized code
8708       --  in attribute processing.
8709
8710       if Nkind (Parent (N)) = N_Attribute_Reference
8711         and then Attribute_Name (Parent (N)) = Name_Read
8712         and then Next (First (Expressions (Parent (N)))) = N
8713       then
8714          goto Done;
8715       end if;
8716
8717       --  Check for case of converting to a type that has an invariant
8718       --  associated with it. This required an invariant check. We convert
8719
8720       --    typ (expr)
8721
8722       --  into
8723
8724       --    do invariant_check (typ (expr)) in typ (expr);
8725
8726       --  using Duplicate_Subexpr to avoid multiple side effects
8727
8728       --  Note: the Comes_From_Source check, and then the resetting of this
8729       --  flag prevents what would otherwise be an infinite recursion.
8730
8731       if Has_Invariants (Target_Type)
8732         and then Present (Invariant_Procedure (Target_Type))
8733         and then Comes_From_Source (N)
8734       then
8735          Set_Comes_From_Source (N, False);
8736          Rewrite (N,
8737            Make_Expression_With_Actions (Loc,
8738              Actions    => New_List (
8739                Make_Invariant_Call (Duplicate_Subexpr (N))),
8740              Expression => Duplicate_Subexpr_No_Checks (N)));
8741          Analyze_And_Resolve (N, Target_Type);
8742          goto Done;
8743       end if;
8744
8745       --  Here if we may need to expand conversion
8746
8747       --  If the operand of the type conversion is an arithmetic operation on
8748       --  signed integers, and the based type of the signed integer type in
8749       --  question is smaller than Standard.Integer, we promote both of the
8750       --  operands to type Integer.
8751
8752       --  For example, if we have
8753
8754       --     target-type (opnd1 + opnd2)
8755
8756       --  and opnd1 and opnd2 are of type short integer, then we rewrite
8757       --  this as:
8758
8759       --     target-type (integer(opnd1) + integer(opnd2))
8760
8761       --  We do this because we are always allowed to compute in a larger type
8762       --  if we do the right thing with the result, and in this case we are
8763       --  going to do a conversion which will do an appropriate check to make
8764       --  sure that things are in range of the target type in any case. This
8765       --  avoids some unnecessary intermediate overflows.
8766
8767       --  We might consider a similar transformation in the case where the
8768       --  target is a real type or a 64-bit integer type, and the operand
8769       --  is an arithmetic operation using a 32-bit integer type. However,
8770       --  we do not bother with this case, because it could cause significant
8771       --  inefficiencies on 32-bit machines. On a 64-bit machine it would be
8772       --  much cheaper, but we don't want different behavior on 32-bit and
8773       --  64-bit machines. Note that the exclusion of the 64-bit case also
8774       --  handles the configurable run-time cases where 64-bit arithmetic
8775       --  may simply be unavailable.
8776
8777       --  Note: this circuit is partially redundant with respect to the circuit
8778       --  in Checks.Apply_Arithmetic_Overflow_Check, but we catch more cases in
8779       --  the processing here. Also we still need the Checks circuit, since we
8780       --  have to be sure not to generate junk overflow checks in the first
8781       --  place, since it would be trick to remove them here!
8782
8783       if Integer_Promotion_Possible (N) then
8784
8785          --  All conditions met, go ahead with transformation
8786
8787          declare
8788             Opnd : Node_Id;
8789             L, R : Node_Id;
8790
8791          begin
8792             R :=
8793               Make_Type_Conversion (Loc,
8794                 Subtype_Mark => New_Reference_To (Standard_Integer, Loc),
8795                 Expression   => Relocate_Node (Right_Opnd (Operand)));
8796
8797             Opnd := New_Op_Node (Nkind (Operand), Loc);
8798             Set_Right_Opnd (Opnd, R);
8799
8800             if Nkind (Operand) in N_Binary_Op then
8801                L :=
8802                  Make_Type_Conversion (Loc,
8803                    Subtype_Mark => New_Reference_To (Standard_Integer, Loc),
8804                    Expression   => Relocate_Node (Left_Opnd (Operand)));
8805
8806                Set_Left_Opnd  (Opnd, L);
8807             end if;
8808
8809             Rewrite (N,
8810               Make_Type_Conversion (Loc,
8811                 Subtype_Mark => Relocate_Node (Subtype_Mark (N)),
8812                 Expression   => Opnd));
8813
8814             Analyze_And_Resolve (N, Target_Type);
8815             goto Done;
8816          end;
8817       end if;
8818
8819       --  Do validity check if validity checking operands
8820
8821       if Validity_Checks_On
8822         and then Validity_Check_Operands
8823       then
8824          Ensure_Valid (Operand);
8825       end if;
8826
8827       --  Special case of converting from non-standard boolean type
8828
8829       if Is_Boolean_Type (Operand_Type)
8830         and then (Nonzero_Is_True (Operand_Type))
8831       then
8832          Adjust_Condition (Operand);
8833          Set_Etype (Operand, Standard_Boolean);
8834          Operand_Type := Standard_Boolean;
8835       end if;
8836
8837       --  Case of converting to an access type
8838
8839       if Is_Access_Type (Target_Type) then
8840
8841          --  Apply an accessibility check when the conversion operand is an
8842          --  access parameter (or a renaming thereof), unless conversion was
8843          --  expanded from an Unchecked_ or Unrestricted_Access attribute.
8844          --  Note that other checks may still need to be applied below (such
8845          --  as tagged type checks).
8846
8847          if Is_Entity_Name (Operand)
8848            and then Has_Extra_Accessibility (Entity (Operand))
8849            and then Ekind (Etype (Operand)) = E_Anonymous_Access_Type
8850            and then (Nkind (Original_Node (N)) /= N_Attribute_Reference
8851                       or else Attribute_Name (Original_Node (N)) = Name_Access)
8852          then
8853             Apply_Accessibility_Check
8854               (Operand, Target_Type, Insert_Node => Operand);
8855
8856          --  If the level of the operand type is statically deeper than the
8857          --  level of the target type, then force Program_Error. Note that this
8858          --  can only occur for cases where the attribute is within the body of
8859          --  an instantiation (otherwise the conversion will already have been
8860          --  rejected as illegal). Note: warnings are issued by the analyzer
8861          --  for the instance cases.
8862
8863          elsif In_Instance_Body
8864            and then Type_Access_Level (Operand_Type) >
8865                     Type_Access_Level (Target_Type)
8866          then
8867             Raise_Accessibility_Error;
8868
8869          --  When the operand is a selected access discriminant the check needs
8870          --  to be made against the level of the object denoted by the prefix
8871          --  of the selected name. Force Program_Error for this case as well
8872          --  (this accessibility violation can only happen if within the body
8873          --  of an instantiation).
8874
8875          elsif In_Instance_Body
8876            and then Ekind (Operand_Type) = E_Anonymous_Access_Type
8877            and then Nkind (Operand) = N_Selected_Component
8878            and then Object_Access_Level (Operand) >
8879                       Type_Access_Level (Target_Type)
8880          then
8881             Raise_Accessibility_Error;
8882             goto Done;
8883          end if;
8884       end if;
8885
8886       --  Case of conversions of tagged types and access to tagged types
8887
8888       --  When needed, that is to say when the expression is class-wide, Add
8889       --  runtime a tag check for (strict) downward conversion by using the
8890       --  membership test, generating:
8891
8892       --      [constraint_error when Operand not in Target_Type'Class]
8893
8894       --  or in the access type case
8895
8896       --      [constraint_error
8897       --        when Operand /= null
8898       --          and then Operand.all not in
8899       --            Designated_Type (Target_Type)'Class]
8900
8901       if (Is_Access_Type (Target_Type)
8902            and then Is_Tagged_Type (Designated_Type (Target_Type)))
8903         or else Is_Tagged_Type (Target_Type)
8904       then
8905          --  Do not do any expansion in the access type case if the parent is a
8906          --  renaming, since this is an error situation which will be caught by
8907          --  Sem_Ch8, and the expansion can interfere with this error check.
8908
8909          if Is_Access_Type (Target_Type) and then Is_Renamed_Object (N) then
8910             goto Done;
8911          end if;
8912
8913          --  Otherwise, proceed with processing tagged conversion
8914
8915          Tagged_Conversion : declare
8916             Actual_Op_Typ   : Entity_Id;
8917             Actual_Targ_Typ : Entity_Id;
8918             Make_Conversion : Boolean := False;
8919             Root_Op_Typ     : Entity_Id;
8920
8921             procedure Make_Tag_Check (Targ_Typ : Entity_Id);
8922             --  Create a membership check to test whether Operand is a member
8923             --  of Targ_Typ. If the original Target_Type is an access, include
8924             --  a test for null value. The check is inserted at N.
8925
8926             --------------------
8927             -- Make_Tag_Check --
8928             --------------------
8929
8930             procedure Make_Tag_Check (Targ_Typ : Entity_Id) is
8931                Cond : Node_Id;
8932
8933             begin
8934                --  Generate:
8935                --    [Constraint_Error
8936                --       when Operand /= null
8937                --         and then Operand.all not in Targ_Typ]
8938
8939                if Is_Access_Type (Target_Type) then
8940                   Cond :=
8941                     Make_And_Then (Loc,
8942                       Left_Opnd =>
8943                         Make_Op_Ne (Loc,
8944                           Left_Opnd  => Duplicate_Subexpr_No_Checks (Operand),
8945                           Right_Opnd => Make_Null (Loc)),
8946
8947                       Right_Opnd =>
8948                         Make_Not_In (Loc,
8949                           Left_Opnd  =>
8950                             Make_Explicit_Dereference (Loc,
8951                               Prefix => Duplicate_Subexpr_No_Checks (Operand)),
8952                           Right_Opnd => New_Reference_To (Targ_Typ, Loc)));
8953
8954                --  Generate:
8955                --    [Constraint_Error when Operand not in Targ_Typ]
8956
8957                else
8958                   Cond :=
8959                     Make_Not_In (Loc,
8960                       Left_Opnd  => Duplicate_Subexpr_No_Checks (Operand),
8961                       Right_Opnd => New_Reference_To (Targ_Typ, Loc));
8962                end if;
8963
8964                Insert_Action (N,
8965                  Make_Raise_Constraint_Error (Loc,
8966                    Condition => Cond,
8967                    Reason    => CE_Tag_Check_Failed));
8968             end Make_Tag_Check;
8969
8970          --  Start of processing for Tagged_Conversion
8971
8972          begin
8973             --  Handle entities from the limited view
8974
8975             if Is_Access_Type (Operand_Type) then
8976                Actual_Op_Typ :=
8977                  Available_View (Designated_Type (Operand_Type));
8978             else
8979                Actual_Op_Typ := Operand_Type;
8980             end if;
8981
8982             if Is_Access_Type (Target_Type) then
8983                Actual_Targ_Typ :=
8984                  Available_View (Designated_Type (Target_Type));
8985             else
8986                Actual_Targ_Typ := Target_Type;
8987             end if;
8988
8989             Root_Op_Typ := Root_Type (Actual_Op_Typ);
8990
8991             --  Ada 2005 (AI-251): Handle interface type conversion
8992
8993             if Is_Interface (Actual_Op_Typ) then
8994                Expand_Interface_Conversion (N, Is_Static => False);
8995                goto Done;
8996             end if;
8997
8998             if not Tag_Checks_Suppressed (Actual_Targ_Typ) then
8999
9000                --  Create a runtime tag check for a downward class-wide type
9001                --  conversion.
9002
9003                if Is_Class_Wide_Type (Actual_Op_Typ)
9004                  and then Actual_Op_Typ /= Actual_Targ_Typ
9005                  and then Root_Op_Typ /= Actual_Targ_Typ
9006                  and then Is_Ancestor (Root_Op_Typ, Actual_Targ_Typ,
9007                                        Use_Full_View => True)
9008                then
9009                   Make_Tag_Check (Class_Wide_Type (Actual_Targ_Typ));
9010                   Make_Conversion := True;
9011                end if;
9012
9013                --  AI05-0073: If the result subtype of the function is defined
9014                --  by an access_definition designating a specific tagged type
9015                --  T, a check is made that the result value is null or the tag
9016                --  of the object designated by the result value identifies T.
9017                --  Constraint_Error is raised if this check fails.
9018
9019                if Nkind (Parent (N)) = Sinfo.N_Return_Statement then
9020                   declare
9021                      Func     : Entity_Id;
9022                      Func_Typ : Entity_Id;
9023
9024                   begin
9025                      --  Climb scope stack looking for the enclosing function
9026
9027                      Func := Current_Scope;
9028                      while Present (Func)
9029                        and then Ekind (Func) /= E_Function
9030                      loop
9031                         Func := Scope (Func);
9032                      end loop;
9033
9034                      --  The function's return subtype must be defined using
9035                      --  an access definition.
9036
9037                      if Nkind (Result_Definition (Parent (Func))) =
9038                           N_Access_Definition
9039                      then
9040                         Func_Typ := Directly_Designated_Type (Etype (Func));
9041
9042                         --  The return subtype denotes a specific tagged type,
9043                         --  in other words, a non class-wide type.
9044
9045                         if Is_Tagged_Type (Func_Typ)
9046                           and then not Is_Class_Wide_Type (Func_Typ)
9047                         then
9048                            Make_Tag_Check (Actual_Targ_Typ);
9049                            Make_Conversion := True;
9050                         end if;
9051                      end if;
9052                   end;
9053                end if;
9054
9055                --  We have generated a tag check for either a class-wide type
9056                --  conversion or for AI05-0073.
9057
9058                if Make_Conversion then
9059                   declare
9060                      Conv : Node_Id;
9061                   begin
9062                      Conv :=
9063                        Make_Unchecked_Type_Conversion (Loc,
9064                          Subtype_Mark => New_Occurrence_Of (Target_Type, Loc),
9065                          Expression   => Relocate_Node (Expression (N)));
9066                      Rewrite (N, Conv);
9067                      Analyze_And_Resolve (N, Target_Type);
9068                   end;
9069                end if;
9070             end if;
9071          end Tagged_Conversion;
9072
9073       --  Case of other access type conversions
9074
9075       elsif Is_Access_Type (Target_Type) then
9076          Apply_Constraint_Check (Operand, Target_Type);
9077
9078       --  Case of conversions from a fixed-point type
9079
9080       --  These conversions require special expansion and processing, found in
9081       --  the Exp_Fixd package. We ignore cases where Conversion_OK is set,
9082       --  since from a semantic point of view, these are simple integer
9083       --  conversions, which do not need further processing.
9084
9085       elsif Is_Fixed_Point_Type (Operand_Type)
9086         and then not Conversion_OK (N)
9087       then
9088          --  We should never see universal fixed at this case, since the
9089          --  expansion of the constituent divide or multiply should have
9090          --  eliminated the explicit mention of universal fixed.
9091
9092          pragma Assert (Operand_Type /= Universal_Fixed);
9093
9094          --  Check for special case of the conversion to universal real that
9095          --  occurs as a result of the use of a round attribute. In this case,
9096          --  the real type for the conversion is taken from the target type of
9097          --  the Round attribute and the result must be marked as rounded.
9098
9099          if Target_Type = Universal_Real
9100            and then Nkind (Parent (N)) = N_Attribute_Reference
9101            and then Attribute_Name (Parent (N)) = Name_Round
9102          then
9103             Set_Rounded_Result (N);
9104             Set_Etype (N, Etype (Parent (N)));
9105          end if;
9106
9107          --  Otherwise do correct fixed-conversion, but skip these if the
9108          --  Conversion_OK flag is set, because from a semantic point of view
9109          --  these are simple integer conversions needing no further processing
9110          --  (the backend will simply treat them as integers).
9111
9112          if not Conversion_OK (N) then
9113             if Is_Fixed_Point_Type (Etype (N)) then
9114                Expand_Convert_Fixed_To_Fixed (N);
9115                Real_Range_Check;
9116
9117             elsif Is_Integer_Type (Etype (N)) then
9118                Expand_Convert_Fixed_To_Integer (N);
9119
9120             else
9121                pragma Assert (Is_Floating_Point_Type (Etype (N)));
9122                Expand_Convert_Fixed_To_Float (N);
9123                Real_Range_Check;
9124             end if;
9125          end if;
9126
9127       --  Case of conversions to a fixed-point type
9128
9129       --  These conversions require special expansion and processing, found in
9130       --  the Exp_Fixd package. Again, ignore cases where Conversion_OK is set,
9131       --  since from a semantic point of view, these are simple integer
9132       --  conversions, which do not need further processing.
9133
9134       elsif Is_Fixed_Point_Type (Target_Type)
9135         and then not Conversion_OK (N)
9136       then
9137          if Is_Integer_Type (Operand_Type) then
9138             Expand_Convert_Integer_To_Fixed (N);
9139             Real_Range_Check;
9140          else
9141             pragma Assert (Is_Floating_Point_Type (Operand_Type));
9142             Expand_Convert_Float_To_Fixed (N);
9143             Real_Range_Check;
9144          end if;
9145
9146       --  Case of float-to-integer conversions
9147
9148       --  We also handle float-to-fixed conversions with Conversion_OK set
9149       --  since semantically the fixed-point target is treated as though it
9150       --  were an integer in such cases.
9151
9152       elsif Is_Floating_Point_Type (Operand_Type)
9153         and then
9154           (Is_Integer_Type (Target_Type)
9155             or else
9156           (Is_Fixed_Point_Type (Target_Type) and then Conversion_OK (N)))
9157       then
9158          --  One more check here, gcc is still not able to do conversions of
9159          --  this type with proper overflow checking, and so gigi is doing an
9160          --  approximation of what is required by doing floating-point compares
9161          --  with the end-point. But that can lose precision in some cases, and
9162          --  give a wrong result. Converting the operand to Universal_Real is
9163          --  helpful, but still does not catch all cases with 64-bit integers
9164          --  on targets with only 64-bit floats.
9165
9166          --  The above comment seems obsoleted by Apply_Float_Conversion_Check
9167          --  Can this code be removed ???
9168
9169          if Do_Range_Check (Operand) then
9170             Rewrite (Operand,
9171               Make_Type_Conversion (Loc,
9172                 Subtype_Mark =>
9173                   New_Occurrence_Of (Universal_Real, Loc),
9174                 Expression =>
9175                   Relocate_Node (Operand)));
9176
9177             Set_Etype (Operand, Universal_Real);
9178             Enable_Range_Check (Operand);
9179             Set_Do_Range_Check (Expression (Operand), False);
9180          end if;
9181
9182       --  Case of array conversions
9183
9184       --  Expansion of array conversions, add required length/range checks but
9185       --  only do this if there is no change of representation. For handling of
9186       --  this case, see Handle_Changed_Representation.
9187
9188       elsif Is_Array_Type (Target_Type) then
9189          if Is_Constrained (Target_Type) then
9190             Apply_Length_Check (Operand, Target_Type);
9191          else
9192             Apply_Range_Check (Operand, Target_Type);
9193          end if;
9194
9195          Handle_Changed_Representation;
9196
9197       --  Case of conversions of discriminated types
9198
9199       --  Add required discriminant checks if target is constrained. Again this
9200       --  change is skipped if we have a change of representation.
9201
9202       elsif Has_Discriminants (Target_Type)
9203         and then Is_Constrained (Target_Type)
9204       then
9205          Apply_Discriminant_Check (Operand, Target_Type);
9206          Handle_Changed_Representation;
9207
9208       --  Case of all other record conversions. The only processing required
9209       --  is to check for a change of representation requiring the special
9210       --  assignment processing.
9211
9212       elsif Is_Record_Type (Target_Type) then
9213
9214          --  Ada 2005 (AI-216): Program_Error is raised when converting from
9215          --  a derived Unchecked_Union type to an unconstrained type that is
9216          --  not Unchecked_Union if the operand lacks inferable discriminants.
9217
9218          if Is_Derived_Type (Operand_Type)
9219            and then Is_Unchecked_Union (Base_Type (Operand_Type))
9220            and then not Is_Constrained (Target_Type)
9221            and then not Is_Unchecked_Union (Base_Type (Target_Type))
9222            and then not Has_Inferable_Discriminants (Operand)
9223          then
9224             --  To prevent Gigi from generating illegal code, we generate a
9225             --  Program_Error node, but we give it the target type of the
9226             --  conversion.
9227
9228             declare
9229                PE : constant Node_Id := Make_Raise_Program_Error (Loc,
9230                       Reason => PE_Unchecked_Union_Restriction);
9231
9232             begin
9233                Set_Etype (PE, Target_Type);
9234                Rewrite (N, PE);
9235
9236             end;
9237          else
9238             Handle_Changed_Representation;
9239          end if;
9240
9241       --  Case of conversions of enumeration types
9242
9243       elsif Is_Enumeration_Type (Target_Type) then
9244
9245          --  Special processing is required if there is a change of
9246          --  representation (from enumeration representation clauses).
9247
9248          if not Same_Representation (Target_Type, Operand_Type) then
9249
9250             --  Convert: x(y) to x'val (ytyp'val (y))
9251
9252             Rewrite (N,
9253                Make_Attribute_Reference (Loc,
9254                  Prefix => New_Occurrence_Of (Target_Type, Loc),
9255                  Attribute_Name => Name_Val,
9256                  Expressions => New_List (
9257                    Make_Attribute_Reference (Loc,
9258                      Prefix => New_Occurrence_Of (Operand_Type, Loc),
9259                      Attribute_Name => Name_Pos,
9260                      Expressions => New_List (Operand)))));
9261
9262             Analyze_And_Resolve (N, Target_Type);
9263          end if;
9264
9265       --  Case of conversions to floating-point
9266
9267       elsif Is_Floating_Point_Type (Target_Type) then
9268          Real_Range_Check;
9269       end if;
9270
9271       --  At this stage, either the conversion node has been transformed into
9272       --  some other equivalent expression, or left as a conversion that can be
9273       --  handled by Gigi, in the following cases:
9274
9275       --    Conversions with no change of representation or type
9276
9277       --    Numeric conversions involving integer, floating- and fixed-point
9278       --    values. Fixed-point values are allowed only if Conversion_OK is
9279       --    set, i.e. if the fixed-point values are to be treated as integers.
9280
9281       --  No other conversions should be passed to Gigi
9282
9283       --  Check: are these rules stated in sinfo??? if so, why restate here???
9284
9285       --  The only remaining step is to generate a range check if we still have
9286       --  a type conversion at this stage and Do_Range_Check is set. For now we
9287       --  do this only for conversions of discrete types.
9288
9289       if Nkind (N) = N_Type_Conversion
9290         and then Is_Discrete_Type (Etype (N))
9291       then
9292          declare
9293             Expr : constant Node_Id := Expression (N);
9294             Ftyp : Entity_Id;
9295             Ityp : Entity_Id;
9296
9297          begin
9298             if Do_Range_Check (Expr)
9299               and then Is_Discrete_Type (Etype (Expr))
9300             then
9301                Set_Do_Range_Check (Expr, False);
9302
9303                --  Before we do a range check, we have to deal with treating a
9304                --  fixed-point operand as an integer. The way we do this is
9305                --  simply to do an unchecked conversion to an appropriate
9306                --  integer type large enough to hold the result.
9307
9308                --  This code is not active yet, because we are only dealing
9309                --  with discrete types so far ???
9310
9311                if Nkind (Expr) in N_Has_Treat_Fixed_As_Integer
9312                  and then Treat_Fixed_As_Integer (Expr)
9313                then
9314                   Ftyp := Base_Type (Etype (Expr));
9315
9316                   if Esize (Ftyp) >= Esize (Standard_Integer) then
9317                      Ityp := Standard_Long_Long_Integer;
9318                   else
9319                      Ityp := Standard_Integer;
9320                   end if;
9321
9322                   Rewrite (Expr, Unchecked_Convert_To (Ityp, Expr));
9323                end if;
9324
9325                --  Reset overflow flag, since the range check will include
9326                --  dealing with possible overflow, and generate the check. If
9327                --  Address is either a source type or target type, suppress
9328                --  range check to avoid typing anomalies when it is a visible
9329                --  integer type.
9330
9331                Set_Do_Overflow_Check (N, False);
9332                if not Is_Descendent_Of_Address (Etype (Expr))
9333                  and then not Is_Descendent_Of_Address (Target_Type)
9334                then
9335                   Generate_Range_Check
9336                     (Expr, Target_Type, CE_Range_Check_Failed);
9337                end if;
9338             end if;
9339          end;
9340       end if;
9341
9342       --  Final step, if the result is a type conversion involving Vax_Float
9343       --  types, then it is subject for further special processing.
9344
9345       if Nkind (N) = N_Type_Conversion
9346         and then (Vax_Float (Operand_Type) or else Vax_Float (Target_Type))
9347       then
9348          Expand_Vax_Conversion (N);
9349          goto Done;
9350       end if;
9351
9352       --  Here at end of processing
9353
9354    <<Done>>
9355       --  Apply predicate check if required. Note that we can't just call
9356       --  Apply_Predicate_Check here, because the type looks right after
9357       --  the conversion and it would omit the check. The Comes_From_Source
9358       --  guard is necessary to prevent infinite recursions when we generate
9359       --  internal conversions for the purpose of checking predicates.
9360
9361       if Present (Predicate_Function (Target_Type))
9362         and then Target_Type /= Operand_Type
9363         and then Comes_From_Source (N)
9364       then
9365          declare
9366             New_Expr : constant Node_Id := Duplicate_Subexpr (N);
9367
9368          begin
9369             --  Avoid infinite recursion on the subsequent expansion of
9370             --  of the copy of the original type conversion.
9371
9372             Set_Comes_From_Source (New_Expr, False);
9373             Insert_Action (N, Make_Predicate_Check (Target_Type, New_Expr));
9374          end;
9375       end if;
9376    end Expand_N_Type_Conversion;
9377
9378    -----------------------------------
9379    -- Expand_N_Unchecked_Expression --
9380    -----------------------------------
9381
9382    --  Remove the unchecked expression node from the tree. Its job was simply
9383    --  to make sure that its constituent expression was handled with checks
9384    --  off, and now that that is done, we can remove it from the tree, and
9385    --  indeed must, since Gigi does not expect to see these nodes.
9386
9387    procedure Expand_N_Unchecked_Expression (N : Node_Id) is
9388       Exp : constant Node_Id := Expression (N);
9389    begin
9390       Set_Assignment_OK (Exp, Assignment_OK (N) or else Assignment_OK (Exp));
9391       Rewrite (N, Exp);
9392    end Expand_N_Unchecked_Expression;
9393
9394    ----------------------------------------
9395    -- Expand_N_Unchecked_Type_Conversion --
9396    ----------------------------------------
9397
9398    --  If this cannot be handled by Gigi and we haven't already made a
9399    --  temporary for it, do it now.
9400
9401    procedure Expand_N_Unchecked_Type_Conversion (N : Node_Id) is
9402       Target_Type  : constant Entity_Id := Etype (N);
9403       Operand      : constant Node_Id   := Expression (N);
9404       Operand_Type : constant Entity_Id := Etype (Operand);
9405
9406    begin
9407       --  Nothing at all to do if conversion is to the identical type so remove
9408       --  the conversion completely, it is useless, except that it may carry
9409       --  an Assignment_OK indication which must be propagated to the operand.
9410
9411       if Operand_Type = Target_Type then
9412
9413          --  Code duplicates Expand_N_Unchecked_Expression above, factor???
9414
9415          if Assignment_OK (N) then
9416             Set_Assignment_OK (Operand);
9417          end if;
9418
9419          Rewrite (N, Relocate_Node (Operand));
9420          return;
9421       end if;
9422
9423       --  If we have a conversion of a compile time known value to a target
9424       --  type and the value is in range of the target type, then we can simply
9425       --  replace the construct by an integer literal of the correct type. We
9426       --  only apply this to integer types being converted. Possibly it may
9427       --  apply in other cases, but it is too much trouble to worry about.
9428
9429       --  Note that we do not do this transformation if the Kill_Range_Check
9430       --  flag is set, since then the value may be outside the expected range.
9431       --  This happens in the Normalize_Scalars case.
9432
9433       --  We also skip this if either the target or operand type is biased
9434       --  because in this case, the unchecked conversion is supposed to
9435       --  preserve the bit pattern, not the integer value.
9436
9437       if Is_Integer_Type (Target_Type)
9438         and then not Has_Biased_Representation (Target_Type)
9439         and then Is_Integer_Type (Operand_Type)
9440         and then not Has_Biased_Representation (Operand_Type)
9441         and then Compile_Time_Known_Value (Operand)
9442         and then not Kill_Range_Check (N)
9443       then
9444          declare
9445             Val : constant Uint := Expr_Value (Operand);
9446
9447          begin
9448             if Compile_Time_Known_Value (Type_Low_Bound (Target_Type))
9449                  and then
9450                Compile_Time_Known_Value (Type_High_Bound (Target_Type))
9451                  and then
9452                Val >= Expr_Value (Type_Low_Bound (Target_Type))
9453                  and then
9454                Val <= Expr_Value (Type_High_Bound (Target_Type))
9455             then
9456                Rewrite (N, Make_Integer_Literal (Sloc (N), Val));
9457
9458                --  If Address is the target type, just set the type to avoid a
9459                --  spurious type error on the literal when Address is a visible
9460                --  integer type.
9461
9462                if Is_Descendent_Of_Address (Target_Type) then
9463                   Set_Etype (N, Target_Type);
9464                else
9465                   Analyze_And_Resolve (N, Target_Type);
9466                end if;
9467
9468                return;
9469             end if;
9470          end;
9471       end if;
9472
9473       --  Nothing to do if conversion is safe
9474
9475       if Safe_Unchecked_Type_Conversion (N) then
9476          return;
9477       end if;
9478
9479       --  Otherwise force evaluation unless Assignment_OK flag is set (this
9480       --  flag indicates ??? -- more comments needed here)
9481
9482       if Assignment_OK (N) then
9483          null;
9484       else
9485          Force_Evaluation (N);
9486       end if;
9487    end Expand_N_Unchecked_Type_Conversion;
9488
9489    ----------------------------
9490    -- Expand_Record_Equality --
9491    ----------------------------
9492
9493    --  For non-variant records, Equality is expanded when needed into:
9494
9495    --      and then Lhs.Discr1 = Rhs.Discr1
9496    --      and then ...
9497    --      and then Lhs.Discrn = Rhs.Discrn
9498    --      and then Lhs.Cmp1 = Rhs.Cmp1
9499    --      and then ...
9500    --      and then Lhs.Cmpn = Rhs.Cmpn
9501
9502    --  The expression is folded by the back-end for adjacent fields. This
9503    --  function is called for tagged record in only one occasion: for imple-
9504    --  menting predefined primitive equality (see Predefined_Primitives_Bodies)
9505    --  otherwise the primitive "=" is used directly.
9506
9507    function Expand_Record_Equality
9508      (Nod    : Node_Id;
9509       Typ    : Entity_Id;
9510       Lhs    : Node_Id;
9511       Rhs    : Node_Id;
9512       Bodies : List_Id) return Node_Id
9513    is
9514       Loc : constant Source_Ptr := Sloc (Nod);
9515
9516       Result : Node_Id;
9517       C      : Entity_Id;
9518
9519       First_Time : Boolean := True;
9520
9521       function Suitable_Element (C : Entity_Id) return Entity_Id;
9522       --  Return the first field to compare beginning with C, skipping the
9523       --  inherited components.
9524
9525       ----------------------
9526       -- Suitable_Element --
9527       ----------------------
9528
9529       function Suitable_Element (C : Entity_Id) return Entity_Id is
9530       begin
9531          if No (C) then
9532             return Empty;
9533
9534          elsif Ekind (C) /= E_Discriminant
9535            and then Ekind (C) /= E_Component
9536          then
9537             return Suitable_Element (Next_Entity (C));
9538
9539          elsif Is_Tagged_Type (Typ)
9540            and then C /= Original_Record_Component (C)
9541          then
9542             return Suitable_Element (Next_Entity (C));
9543
9544          elsif Chars (C) = Name_uTag then
9545             return Suitable_Element (Next_Entity (C));
9546
9547          --  The .NET/JVM version of type Root_Controlled contains two fields
9548          --  which should not be considered part of the object. To achieve
9549          --  proper equiality between two controlled objects on .NET/JVM, skip
9550          --  field _parent whenever it is of type Root_Controlled.
9551
9552          elsif Chars (C) = Name_uParent
9553            and then VM_Target /= No_VM
9554            and then Etype (C) = RTE (RE_Root_Controlled)
9555          then
9556             return Suitable_Element (Next_Entity (C));
9557
9558          elsif Is_Interface (Etype (C)) then
9559             return Suitable_Element (Next_Entity (C));
9560
9561          else
9562             return C;
9563          end if;
9564       end Suitable_Element;
9565
9566    --  Start of processing for Expand_Record_Equality
9567
9568    begin
9569       --  Generates the following code: (assuming that Typ has one Discr and
9570       --  component C2 is also a record)
9571
9572       --   True
9573       --     and then Lhs.Discr1 = Rhs.Discr1
9574       --     and then Lhs.C1 = Rhs.C1
9575       --     and then Lhs.C2.C1=Rhs.C2.C1 and then ... Lhs.C2.Cn=Rhs.C2.Cn
9576       --     and then ...
9577       --     and then Lhs.Cmpn = Rhs.Cmpn
9578
9579       Result := New_Reference_To (Standard_True, Loc);
9580       C := Suitable_Element (First_Entity (Typ));
9581       while Present (C) loop
9582          declare
9583             New_Lhs : Node_Id;
9584             New_Rhs : Node_Id;
9585             Check   : Node_Id;
9586
9587          begin
9588             if First_Time then
9589                First_Time := False;
9590                New_Lhs := Lhs;
9591                New_Rhs := Rhs;
9592             else
9593                New_Lhs := New_Copy_Tree (Lhs);
9594                New_Rhs := New_Copy_Tree (Rhs);
9595             end if;
9596
9597             Check :=
9598               Expand_Composite_Equality (Nod, Etype (C),
9599                Lhs =>
9600                  Make_Selected_Component (Loc,
9601                    Prefix => New_Lhs,
9602                    Selector_Name => New_Reference_To (C, Loc)),
9603                Rhs =>
9604                  Make_Selected_Component (Loc,
9605                    Prefix => New_Rhs,
9606                    Selector_Name => New_Reference_To (C, Loc)),
9607                Bodies => Bodies);
9608
9609             --  If some (sub)component is an unchecked_union, the whole
9610             --  operation will raise program error.
9611
9612             if Nkind (Check) = N_Raise_Program_Error then
9613                Result := Check;
9614                Set_Etype (Result, Standard_Boolean);
9615                exit;
9616             else
9617                Result :=
9618                  Make_And_Then (Loc,
9619                    Left_Opnd  => Result,
9620                    Right_Opnd => Check);
9621             end if;
9622          end;
9623
9624          C := Suitable_Element (Next_Entity (C));
9625       end loop;
9626
9627       return Result;
9628    end Expand_Record_Equality;
9629
9630    ---------------------------
9631    -- Expand_Set_Membership --
9632    ---------------------------
9633
9634    procedure Expand_Set_Membership (N : Node_Id) is
9635       Lop : constant Node_Id := Left_Opnd (N);
9636       Alt : Node_Id;
9637       Res : Node_Id;
9638
9639       function Make_Cond (Alt : Node_Id) return Node_Id;
9640       --  If the alternative is a subtype mark, create a simple membership
9641       --  test. Otherwise create an equality test for it.
9642
9643       ---------------
9644       -- Make_Cond --
9645       ---------------
9646
9647       function Make_Cond (Alt : Node_Id) return Node_Id is
9648          Cond : Node_Id;
9649          L    : constant Node_Id := New_Copy (Lop);
9650          R    : constant Node_Id := Relocate_Node (Alt);
9651
9652       begin
9653          if (Is_Entity_Name (Alt) and then Is_Type (Entity (Alt)))
9654            or else Nkind (Alt) = N_Range
9655          then
9656             Cond :=
9657               Make_In (Sloc (Alt),
9658                 Left_Opnd  => L,
9659                 Right_Opnd => R);
9660          else
9661             Cond :=
9662               Make_Op_Eq (Sloc (Alt),
9663                 Left_Opnd  => L,
9664                 Right_Opnd => R);
9665          end if;
9666
9667          return Cond;
9668       end Make_Cond;
9669
9670    --  Start of processing for Expand_Set_Membership
9671
9672    begin
9673       Remove_Side_Effects (Lop);
9674
9675       Alt := Last (Alternatives (N));
9676       Res := Make_Cond (Alt);
9677
9678       Prev (Alt);
9679       while Present (Alt) loop
9680          Res :=
9681            Make_Or_Else (Sloc (Alt),
9682              Left_Opnd  => Make_Cond (Alt),
9683              Right_Opnd => Res);
9684          Prev (Alt);
9685       end loop;
9686
9687       Rewrite (N, Res);
9688       Analyze_And_Resolve (N, Standard_Boolean);
9689    end Expand_Set_Membership;
9690
9691    -----------------------------------
9692    -- Expand_Short_Circuit_Operator --
9693    -----------------------------------
9694
9695    --  Deal with special expansion if actions are present for the right operand
9696    --  and deal with optimizing case of arguments being True or False. We also
9697    --  deal with the special case of non-standard boolean values.
9698
9699    procedure Expand_Short_Circuit_Operator (N : Node_Id) is
9700       Loc     : constant Source_Ptr := Sloc (N);
9701       Typ     : constant Entity_Id  := Etype (N);
9702       Left    : constant Node_Id    := Left_Opnd (N);
9703       Right   : constant Node_Id    := Right_Opnd (N);
9704       LocR    : constant Source_Ptr := Sloc (Right);
9705       Actlist : List_Id;
9706
9707       Shortcut_Value : constant Boolean := Nkind (N) = N_Or_Else;
9708       Shortcut_Ent   : constant Entity_Id := Boolean_Literals (Shortcut_Value);
9709       --  If Left = Shortcut_Value then Right need not be evaluated
9710
9711       function Make_Test_Expr (Opnd : Node_Id) return Node_Id;
9712       --  For Opnd a boolean expression, return a Boolean expression equivalent
9713       --  to Opnd /= Shortcut_Value.
9714
9715       --------------------
9716       -- Make_Test_Expr --
9717       --------------------
9718
9719       function Make_Test_Expr (Opnd : Node_Id) return Node_Id is
9720       begin
9721          if Shortcut_Value then
9722             return Make_Op_Not (Sloc (Opnd), Opnd);
9723          else
9724             return Opnd;
9725          end if;
9726       end Make_Test_Expr;
9727
9728       Op_Var : Entity_Id;
9729       --  Entity for a temporary variable holding the value of the operator,
9730       --  used for expansion in the case where actions are present.
9731
9732    --  Start of processing for Expand_Short_Circuit_Operator
9733
9734    begin
9735       --  Deal with non-standard booleans
9736
9737       if Is_Boolean_Type (Typ) then
9738          Adjust_Condition (Left);
9739          Adjust_Condition (Right);
9740          Set_Etype (N, Standard_Boolean);
9741       end if;
9742
9743       --  Check for cases where left argument is known to be True or False
9744
9745       if Compile_Time_Known_Value (Left) then
9746
9747          --  Mark SCO for left condition as compile time known
9748
9749          if Generate_SCO and then Comes_From_Source (Left) then
9750             Set_SCO_Condition (Left, Expr_Value_E (Left) = Standard_True);
9751          end if;
9752
9753          --  Rewrite True AND THEN Right / False OR ELSE Right to Right.
9754          --  Any actions associated with Right will be executed unconditionally
9755          --  and can thus be inserted into the tree unconditionally.
9756
9757          if Expr_Value_E (Left) /= Shortcut_Ent then
9758             if Present (Actions (N)) then
9759                Insert_Actions (N, Actions (N));
9760             end if;
9761
9762             Rewrite (N, Right);
9763
9764          --  Rewrite False AND THEN Right / True OR ELSE Right to Left.
9765          --  In this case we can forget the actions associated with Right,
9766          --  since they will never be executed.
9767
9768          else
9769             Kill_Dead_Code (Right);
9770             Kill_Dead_Code (Actions (N));
9771             Rewrite (N, New_Occurrence_Of (Shortcut_Ent, Loc));
9772          end if;
9773
9774          Adjust_Result_Type (N, Typ);
9775          return;
9776       end if;
9777
9778       --  If Actions are present for the right operand, we have to do some
9779       --  special processing. We can't just let these actions filter back into
9780       --  code preceding the short circuit (which is what would have happened
9781       --  if we had not trapped them in the short-circuit form), since they
9782       --  must only be executed if the right operand of the short circuit is
9783       --  executed and not otherwise.
9784
9785       --  the temporary variable C.
9786
9787       if Present (Actions (N)) then
9788          Actlist := Actions (N);
9789
9790          --  The old approach is to expand:
9791
9792          --     left AND THEN right
9793
9794          --  into
9795
9796          --     C : Boolean := False;
9797          --     IF left THEN
9798          --        Actions;
9799          --        IF right THEN
9800          --           C := True;
9801          --        END IF;
9802          --     END IF;
9803
9804          --  and finally rewrite the operator into a reference to C. Similarly
9805          --  for left OR ELSE right, with negated values. Note that this
9806          --  rewrite causes some difficulties for coverage analysis because
9807          --  of the introduction of the new variable C, which obscures the
9808          --  structure of the test.
9809
9810          --  We use this "old approach" if use of N_Expression_With_Actions
9811          --  is False (see description in Opt of when this is or is not set).
9812
9813          if not Use_Expression_With_Actions then
9814             Op_Var := Make_Temporary (Loc, 'C', Related_Node => N);
9815
9816             Insert_Action (N,
9817               Make_Object_Declaration (Loc,
9818                 Defining_Identifier =>
9819                   Op_Var,
9820                 Object_Definition   =>
9821                   New_Occurrence_Of (Standard_Boolean, Loc),
9822                 Expression          =>
9823                   New_Occurrence_Of (Shortcut_Ent, Loc)));
9824
9825             Append_To (Actlist,
9826               Make_Implicit_If_Statement (Right,
9827                 Condition       => Make_Test_Expr (Right),
9828                 Then_Statements => New_List (
9829                   Make_Assignment_Statement (LocR,
9830                     Name       => New_Occurrence_Of (Op_Var, LocR),
9831                     Expression =>
9832                       New_Occurrence_Of
9833                         (Boolean_Literals (not Shortcut_Value), LocR)))));
9834
9835             Insert_Action (N,
9836               Make_Implicit_If_Statement (Left,
9837                 Condition       => Make_Test_Expr (Left),
9838                 Then_Statements => Actlist));
9839
9840             Rewrite (N, New_Occurrence_Of (Op_Var, Loc));
9841             Analyze_And_Resolve (N, Standard_Boolean);
9842
9843          --  The new approach, activated for now by the use of debug flag
9844          --  -gnatd.X is to use the new Expression_With_Actions node for the
9845          --  right operand of the short-circuit form. This should solve the
9846          --  traceability problems for coverage analysis.
9847
9848          else
9849             Rewrite (Right,
9850               Make_Expression_With_Actions (LocR,
9851                 Expression => Relocate_Node (Right),
9852                 Actions    => Actlist));
9853             Set_Actions (N, No_List);
9854             Analyze_And_Resolve (Right, Standard_Boolean);
9855          end if;
9856
9857          Adjust_Result_Type (N, Typ);
9858          return;
9859       end if;
9860
9861       --  No actions present, check for cases of right argument True/False
9862
9863       if Compile_Time_Known_Value (Right) then
9864
9865          --  Mark SCO for left condition as compile time known
9866
9867          if Generate_SCO and then Comes_From_Source (Right) then
9868             Set_SCO_Condition (Right, Expr_Value_E (Right) = Standard_True);
9869          end if;
9870
9871          --  Change (Left and then True), (Left or else False) to Left.
9872          --  Note that we know there are no actions associated with the right
9873          --  operand, since we just checked for this case above.
9874
9875          if Expr_Value_E (Right) /= Shortcut_Ent then
9876             Rewrite (N, Left);
9877
9878          --  Change (Left and then False), (Left or else True) to Right,
9879          --  making sure to preserve any side effects associated with the Left
9880          --  operand.
9881
9882          else
9883             Remove_Side_Effects (Left);
9884             Rewrite (N, New_Occurrence_Of (Shortcut_Ent, Loc));
9885          end if;
9886       end if;
9887
9888       Adjust_Result_Type (N, Typ);
9889    end Expand_Short_Circuit_Operator;
9890
9891    -------------------------------------
9892    -- Fixup_Universal_Fixed_Operation --
9893    -------------------------------------
9894
9895    procedure Fixup_Universal_Fixed_Operation (N : Node_Id) is
9896       Conv : constant Node_Id := Parent (N);
9897
9898    begin
9899       --  We must have a type conversion immediately above us
9900
9901       pragma Assert (Nkind (Conv) = N_Type_Conversion);
9902
9903       --  Normally the type conversion gives our target type. The exception
9904       --  occurs in the case of the Round attribute, where the conversion
9905       --  will be to universal real, and our real type comes from the Round
9906       --  attribute (as well as an indication that we must round the result)
9907
9908       if Nkind (Parent (Conv)) = N_Attribute_Reference
9909         and then Attribute_Name (Parent (Conv)) = Name_Round
9910       then
9911          Set_Etype (N, Etype (Parent (Conv)));
9912          Set_Rounded_Result (N);
9913
9914       --  Normal case where type comes from conversion above us
9915
9916       else
9917          Set_Etype (N, Etype (Conv));
9918       end if;
9919    end Fixup_Universal_Fixed_Operation;
9920
9921    ---------------------------------
9922    -- Has_Inferable_Discriminants --
9923    ---------------------------------
9924
9925    function Has_Inferable_Discriminants (N : Node_Id) return Boolean is
9926
9927       function Prefix_Is_Formal_Parameter (N : Node_Id) return Boolean;
9928       --  Determines whether the left-most prefix of a selected component is a
9929       --  formal parameter in a subprogram. Assumes N is a selected component.
9930
9931       --------------------------------
9932       -- Prefix_Is_Formal_Parameter --
9933       --------------------------------
9934
9935       function Prefix_Is_Formal_Parameter (N : Node_Id) return Boolean is
9936          Sel_Comp : Node_Id := N;
9937
9938       begin
9939          --  Move to the left-most prefix by climbing up the tree
9940
9941          while Present (Parent (Sel_Comp))
9942            and then Nkind (Parent (Sel_Comp)) = N_Selected_Component
9943          loop
9944             Sel_Comp := Parent (Sel_Comp);
9945          end loop;
9946
9947          return Ekind (Entity (Prefix (Sel_Comp))) in Formal_Kind;
9948       end Prefix_Is_Formal_Parameter;
9949
9950    --  Start of processing for Has_Inferable_Discriminants
9951
9952    begin
9953       --  For identifiers and indexed components, it is sufficient to have a
9954       --  constrained Unchecked_Union nominal subtype.
9955
9956       if Nkind_In (N, N_Identifier, N_Indexed_Component) then
9957          return Is_Unchecked_Union (Base_Type (Etype (N)))
9958                   and then
9959                 Is_Constrained (Etype (N));
9960
9961       --  For selected components, the subtype of the selector must be a
9962       --  constrained Unchecked_Union. If the component is subject to a
9963       --  per-object constraint, then the enclosing object must have inferable
9964       --  discriminants.
9965
9966       elsif Nkind (N) = N_Selected_Component then
9967          if Has_Per_Object_Constraint (Entity (Selector_Name (N))) then
9968
9969             --  A small hack. If we have a per-object constrained selected
9970             --  component of a formal parameter, return True since we do not
9971             --  know the actual parameter association yet.
9972
9973             if Prefix_Is_Formal_Parameter (N) then
9974                return True;
9975             end if;
9976
9977             --  Otherwise, check the enclosing object and the selector
9978
9979             return Has_Inferable_Discriminants (Prefix (N))
9980                      and then
9981                    Has_Inferable_Discriminants (Selector_Name (N));
9982          end if;
9983
9984          --  The call to Has_Inferable_Discriminants will determine whether
9985          --  the selector has a constrained Unchecked_Union nominal type.
9986
9987          return Has_Inferable_Discriminants (Selector_Name (N));
9988
9989       --  A qualified expression has inferable discriminants if its subtype
9990       --  mark is a constrained Unchecked_Union subtype.
9991
9992       elsif Nkind (N) = N_Qualified_Expression then
9993          return Is_Unchecked_Union (Subtype_Mark (N))
9994                   and then
9995                 Is_Constrained (Subtype_Mark (N));
9996
9997       end if;
9998
9999       return False;
10000    end Has_Inferable_Discriminants;
10001
10002    -------------------------------
10003    -- Insert_Dereference_Action --
10004    -------------------------------
10005
10006    procedure Insert_Dereference_Action (N : Node_Id) is
10007       Loc  : constant Source_Ptr := Sloc (N);
10008       Typ  : constant Entity_Id  := Etype (N);
10009       Pool : constant Entity_Id  := Associated_Storage_Pool (Typ);
10010       Pnod : constant Node_Id    := Parent (N);
10011
10012       function Is_Checked_Storage_Pool (P : Entity_Id) return Boolean;
10013       --  Return true if type of P is derived from Checked_Pool;
10014
10015       -----------------------------
10016       -- Is_Checked_Storage_Pool --
10017       -----------------------------
10018
10019       function Is_Checked_Storage_Pool (P : Entity_Id) return Boolean is
10020          T : Entity_Id;
10021
10022       begin
10023          if No (P) then
10024             return False;
10025          end if;
10026
10027          T := Etype (P);
10028          while T /= Etype (T) loop
10029             if Is_RTE (T, RE_Checked_Pool) then
10030                return True;
10031             else
10032                T := Etype (T);
10033             end if;
10034          end loop;
10035
10036          return False;
10037       end Is_Checked_Storage_Pool;
10038
10039    --  Start of processing for Insert_Dereference_Action
10040
10041    begin
10042       pragma Assert (Nkind (Pnod) = N_Explicit_Dereference);
10043
10044       if not (Is_Checked_Storage_Pool (Pool)
10045               and then Comes_From_Source (Original_Node (Pnod)))
10046       then
10047          return;
10048       end if;
10049
10050       Insert_Action (N,
10051         Make_Procedure_Call_Statement (Loc,
10052           Name => New_Reference_To (
10053             Find_Prim_Op (Etype (Pool), Name_Dereference), Loc),
10054
10055           Parameter_Associations => New_List (
10056
10057             --  Pool
10058
10059              New_Reference_To (Pool, Loc),
10060
10061             --  Storage_Address. We use the attribute Pool_Address, which uses
10062             --  the pointer itself to find the address of the object, and which
10063             --  handles unconstrained arrays properly by computing the address
10064             --  of the template. i.e. the correct address of the corresponding
10065             --  allocation.
10066
10067              Make_Attribute_Reference (Loc,
10068                Prefix         => Duplicate_Subexpr_Move_Checks (N),
10069                Attribute_Name => Name_Pool_Address),
10070
10071             --  Size_In_Storage_Elements
10072
10073              Make_Op_Divide (Loc,
10074                Left_Opnd  =>
10075                 Make_Attribute_Reference (Loc,
10076                   Prefix         =>
10077                     Make_Explicit_Dereference (Loc,
10078                       Duplicate_Subexpr_Move_Checks (N)),
10079                   Attribute_Name => Name_Size),
10080                Right_Opnd =>
10081                  Make_Integer_Literal (Loc, System_Storage_Unit)),
10082
10083             --  Alignment
10084
10085              Make_Attribute_Reference (Loc,
10086                Prefix         =>
10087                  Make_Explicit_Dereference (Loc,
10088                    Duplicate_Subexpr_Move_Checks (N)),
10089                Attribute_Name => Name_Alignment))));
10090
10091    exception
10092       when RE_Not_Available =>
10093          return;
10094    end Insert_Dereference_Action;
10095
10096    --------------------------------
10097    -- Integer_Promotion_Possible --
10098    --------------------------------
10099
10100    function Integer_Promotion_Possible (N : Node_Id) return Boolean is
10101       Operand           : constant Node_Id   := Expression (N);
10102       Operand_Type      : constant Entity_Id := Etype (Operand);
10103       Root_Operand_Type : constant Entity_Id := Root_Type (Operand_Type);
10104
10105    begin
10106       pragma Assert (Nkind (N) = N_Type_Conversion);
10107
10108       return
10109
10110            --  We only do the transformation for source constructs. We assume
10111            --  that the expander knows what it is doing when it generates code.
10112
10113            Comes_From_Source (N)
10114
10115            --  If the operand type is Short_Integer or Short_Short_Integer,
10116            --  then we will promote to Integer, which is available on all
10117            --  targets, and is sufficient to ensure no intermediate overflow.
10118            --  Furthermore it is likely to be as efficient or more efficient
10119            --  than using the smaller type for the computation so we do this
10120            --  unconditionally.
10121
10122            and then
10123              (Root_Operand_Type = Base_Type (Standard_Short_Integer)
10124                or else
10125               Root_Operand_Type = Base_Type (Standard_Short_Short_Integer))
10126
10127            --  Test for interesting operation, which includes addition,
10128            --  division, exponentiation, multiplication, subtraction, absolute
10129            --  value and unary negation. Unary "+" is omitted since it is a
10130            --  no-op and thus can't overflow.
10131
10132            and then Nkind_In (Operand, N_Op_Abs,
10133                                        N_Op_Add,
10134                                        N_Op_Divide,
10135                                        N_Op_Expon,
10136                                        N_Op_Minus,
10137                                        N_Op_Multiply,
10138                                        N_Op_Subtract);
10139    end Integer_Promotion_Possible;
10140
10141    ------------------------------
10142    -- Make_Array_Comparison_Op --
10143    ------------------------------
10144
10145    --  This is a hand-coded expansion of the following generic function:
10146
10147    --  generic
10148    --    type elem is  (<>);
10149    --    type index is (<>);
10150    --    type a is array (index range <>) of elem;
10151
10152    --  function Gnnn (X : a; Y: a) return boolean is
10153    --    J : index := Y'first;
10154
10155    --  begin
10156    --    if X'length = 0 then
10157    --       return false;
10158
10159    --    elsif Y'length = 0 then
10160    --       return true;
10161
10162    --    else
10163    --      for I in X'range loop
10164    --        if X (I) = Y (J) then
10165    --          if J = Y'last then
10166    --            exit;
10167    --          else
10168    --            J := index'succ (J);
10169    --          end if;
10170
10171    --        else
10172    --           return X (I) > Y (J);
10173    --        end if;
10174    --      end loop;
10175
10176    --      return X'length > Y'length;
10177    --    end if;
10178    --  end Gnnn;
10179
10180    --  Note that since we are essentially doing this expansion by hand, we
10181    --  do not need to generate an actual or formal generic part, just the
10182    --  instantiated function itself.
10183
10184    function Make_Array_Comparison_Op
10185      (Typ : Entity_Id;
10186       Nod : Node_Id) return Node_Id
10187    is
10188       Loc : constant Source_Ptr := Sloc (Nod);
10189
10190       X : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uX);
10191       Y : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uY);
10192       I : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uI);
10193       J : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uJ);
10194
10195       Index : constant Entity_Id := Base_Type (Etype (First_Index (Typ)));
10196
10197       Loop_Statement : Node_Id;
10198       Loop_Body      : Node_Id;
10199       If_Stat        : Node_Id;
10200       Inner_If       : Node_Id;
10201       Final_Expr     : Node_Id;
10202       Func_Body      : Node_Id;
10203       Func_Name      : Entity_Id;
10204       Formals        : List_Id;
10205       Length1        : Node_Id;
10206       Length2        : Node_Id;
10207
10208    begin
10209       --  if J = Y'last then
10210       --     exit;
10211       --  else
10212       --     J := index'succ (J);
10213       --  end if;
10214
10215       Inner_If :=
10216         Make_Implicit_If_Statement (Nod,
10217           Condition =>
10218             Make_Op_Eq (Loc,
10219               Left_Opnd => New_Reference_To (J, Loc),
10220               Right_Opnd =>
10221                 Make_Attribute_Reference (Loc,
10222                   Prefix => New_Reference_To (Y, Loc),
10223                   Attribute_Name => Name_Last)),
10224
10225           Then_Statements => New_List (
10226                 Make_Exit_Statement (Loc)),
10227
10228           Else_Statements =>
10229             New_List (
10230               Make_Assignment_Statement (Loc,
10231                 Name => New_Reference_To (J, Loc),
10232                 Expression =>
10233                   Make_Attribute_Reference (Loc,
10234                     Prefix => New_Reference_To (Index, Loc),
10235                     Attribute_Name => Name_Succ,
10236                     Expressions => New_List (New_Reference_To (J, Loc))))));
10237
10238       --  if X (I) = Y (J) then
10239       --     if ... end if;
10240       --  else
10241       --     return X (I) > Y (J);
10242       --  end if;
10243
10244       Loop_Body :=
10245         Make_Implicit_If_Statement (Nod,
10246           Condition =>
10247             Make_Op_Eq (Loc,
10248               Left_Opnd =>
10249                 Make_Indexed_Component (Loc,
10250                   Prefix      => New_Reference_To (X, Loc),
10251                   Expressions => New_List (New_Reference_To (I, Loc))),
10252
10253               Right_Opnd =>
10254                 Make_Indexed_Component (Loc,
10255                   Prefix      => New_Reference_To (Y, Loc),
10256                   Expressions => New_List (New_Reference_To (J, Loc)))),
10257
10258           Then_Statements => New_List (Inner_If),
10259
10260           Else_Statements => New_List (
10261             Make_Simple_Return_Statement (Loc,
10262               Expression =>
10263                 Make_Op_Gt (Loc,
10264                   Left_Opnd =>
10265                     Make_Indexed_Component (Loc,
10266                       Prefix      => New_Reference_To (X, Loc),
10267                       Expressions => New_List (New_Reference_To (I, Loc))),
10268
10269                   Right_Opnd =>
10270                     Make_Indexed_Component (Loc,
10271                       Prefix      => New_Reference_To (Y, Loc),
10272                       Expressions => New_List (
10273                         New_Reference_To (J, Loc)))))));
10274
10275       --  for I in X'range loop
10276       --     if ... end if;
10277       --  end loop;
10278
10279       Loop_Statement :=
10280         Make_Implicit_Loop_Statement (Nod,
10281           Identifier => Empty,
10282
10283           Iteration_Scheme =>
10284             Make_Iteration_Scheme (Loc,
10285               Loop_Parameter_Specification =>
10286                 Make_Loop_Parameter_Specification (Loc,
10287                   Defining_Identifier => I,
10288                   Discrete_Subtype_Definition =>
10289                     Make_Attribute_Reference (Loc,
10290                       Prefix => New_Reference_To (X, Loc),
10291                       Attribute_Name => Name_Range))),
10292
10293           Statements => New_List (Loop_Body));
10294
10295       --    if X'length = 0 then
10296       --       return false;
10297       --    elsif Y'length = 0 then
10298       --       return true;
10299       --    else
10300       --      for ... loop ... end loop;
10301       --      return X'length > Y'length;
10302       --    end if;
10303
10304       Length1 :=
10305         Make_Attribute_Reference (Loc,
10306           Prefix => New_Reference_To (X, Loc),
10307           Attribute_Name => Name_Length);
10308
10309       Length2 :=
10310         Make_Attribute_Reference (Loc,
10311           Prefix => New_Reference_To (Y, Loc),
10312           Attribute_Name => Name_Length);
10313
10314       Final_Expr :=
10315         Make_Op_Gt (Loc,
10316           Left_Opnd  => Length1,
10317           Right_Opnd => Length2);
10318
10319       If_Stat :=
10320         Make_Implicit_If_Statement (Nod,
10321           Condition =>
10322             Make_Op_Eq (Loc,
10323               Left_Opnd =>
10324                 Make_Attribute_Reference (Loc,
10325                   Prefix => New_Reference_To (X, Loc),
10326                   Attribute_Name => Name_Length),
10327               Right_Opnd =>
10328                 Make_Integer_Literal (Loc, 0)),
10329
10330           Then_Statements =>
10331             New_List (
10332               Make_Simple_Return_Statement (Loc,
10333                 Expression => New_Reference_To (Standard_False, Loc))),
10334
10335           Elsif_Parts => New_List (
10336             Make_Elsif_Part (Loc,
10337               Condition =>
10338                 Make_Op_Eq (Loc,
10339                   Left_Opnd =>
10340                     Make_Attribute_Reference (Loc,
10341                       Prefix => New_Reference_To (Y, Loc),
10342                       Attribute_Name => Name_Length),
10343                   Right_Opnd =>
10344                     Make_Integer_Literal (Loc, 0)),
10345
10346               Then_Statements =>
10347                 New_List (
10348                   Make_Simple_Return_Statement (Loc,
10349                      Expression => New_Reference_To (Standard_True, Loc))))),
10350
10351           Else_Statements => New_List (
10352             Loop_Statement,
10353             Make_Simple_Return_Statement (Loc,
10354               Expression => Final_Expr)));
10355
10356       --  (X : a; Y: a)
10357
10358       Formals := New_List (
10359         Make_Parameter_Specification (Loc,
10360           Defining_Identifier => X,
10361           Parameter_Type      => New_Reference_To (Typ, Loc)),
10362
10363         Make_Parameter_Specification (Loc,
10364           Defining_Identifier => Y,
10365           Parameter_Type      => New_Reference_To (Typ, Loc)));
10366
10367       --  function Gnnn (...) return boolean is
10368       --    J : index := Y'first;
10369       --  begin
10370       --    if ... end if;
10371       --  end Gnnn;
10372
10373       Func_Name := Make_Temporary (Loc, 'G');
10374
10375       Func_Body :=
10376         Make_Subprogram_Body (Loc,
10377           Specification =>
10378             Make_Function_Specification (Loc,
10379               Defining_Unit_Name       => Func_Name,
10380               Parameter_Specifications => Formals,
10381               Result_Definition => New_Reference_To (Standard_Boolean, Loc)),
10382
10383           Declarations => New_List (
10384             Make_Object_Declaration (Loc,
10385               Defining_Identifier => J,
10386               Object_Definition   => New_Reference_To (Index, Loc),
10387               Expression =>
10388                 Make_Attribute_Reference (Loc,
10389                   Prefix => New_Reference_To (Y, Loc),
10390                   Attribute_Name => Name_First))),
10391
10392           Handled_Statement_Sequence =>
10393             Make_Handled_Sequence_Of_Statements (Loc,
10394               Statements => New_List (If_Stat)));
10395
10396       return Func_Body;
10397    end Make_Array_Comparison_Op;
10398
10399    ---------------------------
10400    -- Make_Boolean_Array_Op --
10401    ---------------------------
10402
10403    --  For logical operations on boolean arrays, expand in line the following,
10404    --  replacing 'and' with 'or' or 'xor' where needed:
10405
10406    --    function Annn (A : typ; B: typ) return typ is
10407    --       C : typ;
10408    --    begin
10409    --       for J in A'range loop
10410    --          C (J) := A (J) op B (J);
10411    --       end loop;
10412    --       return C;
10413    --    end Annn;
10414
10415    --  Here typ is the boolean array type
10416
10417    function Make_Boolean_Array_Op
10418      (Typ : Entity_Id;
10419       N   : Node_Id) return Node_Id
10420    is
10421       Loc : constant Source_Ptr := Sloc (N);
10422
10423       A : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uA);
10424       B : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uB);
10425       C : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uC);
10426       J : constant Entity_Id := Make_Defining_Identifier (Loc, Name_uJ);
10427
10428       A_J : Node_Id;
10429       B_J : Node_Id;
10430       C_J : Node_Id;
10431       Op  : Node_Id;
10432
10433       Formals        : List_Id;
10434       Func_Name      : Entity_Id;
10435       Func_Body      : Node_Id;
10436       Loop_Statement : Node_Id;
10437
10438    begin
10439       A_J :=
10440         Make_Indexed_Component (Loc,
10441           Prefix      => New_Reference_To (A, Loc),
10442           Expressions => New_List (New_Reference_To (J, Loc)));
10443
10444       B_J :=
10445         Make_Indexed_Component (Loc,
10446           Prefix      => New_Reference_To (B, Loc),
10447           Expressions => New_List (New_Reference_To (J, Loc)));
10448
10449       C_J :=
10450         Make_Indexed_Component (Loc,
10451           Prefix      => New_Reference_To (C, Loc),
10452           Expressions => New_List (New_Reference_To (J, Loc)));
10453
10454       if Nkind (N) = N_Op_And then
10455          Op :=
10456            Make_Op_And (Loc,
10457              Left_Opnd  => A_J,
10458              Right_Opnd => B_J);
10459
10460       elsif Nkind (N) = N_Op_Or then
10461          Op :=
10462            Make_Op_Or (Loc,
10463              Left_Opnd  => A_J,
10464              Right_Opnd => B_J);
10465
10466       else
10467          Op :=
10468            Make_Op_Xor (Loc,
10469              Left_Opnd  => A_J,
10470              Right_Opnd => B_J);
10471       end if;
10472
10473       Loop_Statement :=
10474         Make_Implicit_Loop_Statement (N,
10475           Identifier => Empty,
10476
10477           Iteration_Scheme =>
10478             Make_Iteration_Scheme (Loc,
10479               Loop_Parameter_Specification =>
10480                 Make_Loop_Parameter_Specification (Loc,
10481                   Defining_Identifier => J,
10482                   Discrete_Subtype_Definition =>
10483                     Make_Attribute_Reference (Loc,
10484                       Prefix => New_Reference_To (A, Loc),
10485                       Attribute_Name => Name_Range))),
10486
10487           Statements => New_List (
10488             Make_Assignment_Statement (Loc,
10489               Name       => C_J,
10490               Expression => Op)));
10491
10492       Formals := New_List (
10493         Make_Parameter_Specification (Loc,
10494           Defining_Identifier => A,
10495           Parameter_Type      => New_Reference_To (Typ, Loc)),
10496
10497         Make_Parameter_Specification (Loc,
10498           Defining_Identifier => B,
10499           Parameter_Type      => New_Reference_To (Typ, Loc)));
10500
10501       Func_Name := Make_Temporary (Loc, 'A');
10502       Set_Is_Inlined (Func_Name);
10503
10504       Func_Body :=
10505         Make_Subprogram_Body (Loc,
10506           Specification =>
10507             Make_Function_Specification (Loc,
10508               Defining_Unit_Name       => Func_Name,
10509               Parameter_Specifications => Formals,
10510               Result_Definition        => New_Reference_To (Typ, Loc)),
10511
10512           Declarations => New_List (
10513             Make_Object_Declaration (Loc,
10514               Defining_Identifier => C,
10515               Object_Definition   => New_Reference_To (Typ, Loc))),
10516
10517           Handled_Statement_Sequence =>
10518             Make_Handled_Sequence_Of_Statements (Loc,
10519               Statements => New_List (
10520                 Loop_Statement,
10521                 Make_Simple_Return_Statement (Loc,
10522                   Expression => New_Reference_To (C, Loc)))));
10523
10524       return Func_Body;
10525    end Make_Boolean_Array_Op;
10526
10527    --------------------------------
10528    -- Optimize_Length_Comparison --
10529    --------------------------------
10530
10531    procedure Optimize_Length_Comparison (N : Node_Id) is
10532       Loc    : constant Source_Ptr := Sloc (N);
10533       Typ    : constant Entity_Id  := Etype (N);
10534       Result : Node_Id;
10535
10536       Left  : Node_Id;
10537       Right : Node_Id;
10538       --  First and Last attribute reference nodes, which end up as left and
10539       --  right operands of the optimized result.
10540
10541       Is_Zero : Boolean;
10542       --  True for comparison operand of zero
10543
10544       Comp : Node_Id;
10545       --  Comparison operand, set only if Is_Zero is false
10546
10547       Ent : Entity_Id;
10548       --  Entity whose length is being compared
10549
10550       Index : Node_Id;
10551       --  Integer_Literal node for length attribute expression, or Empty
10552       --  if there is no such expression present.
10553
10554       Ityp  : Entity_Id;
10555       --  Type of array index to which 'Length is applied
10556
10557       Op : Node_Kind := Nkind (N);
10558       --  Kind of comparison operator, gets flipped if operands backwards
10559
10560       function Is_Optimizable (N : Node_Id) return Boolean;
10561       --  Tests N to see if it is an optimizable comparison value (defined as
10562       --  constant zero or one, or something else where the value is known to
10563       --  be positive and in the range of 32-bits, and where the corresponding
10564       --  Length value is also known to be 32-bits. If result is true, sets
10565       --  Is_Zero, Ityp, and Comp accordingly.
10566
10567       function Is_Entity_Length (N : Node_Id) return Boolean;
10568       --  Tests if N is a length attribute applied to a simple entity. If so,
10569       --  returns True, and sets Ent to the entity, and Index to the integer
10570       --  literal provided as an attribute expression, or to Empty if none.
10571       --  Also returns True if the expression is a generated type conversion
10572       --  whose expression is of the desired form. This latter case arises
10573       --  when Apply_Universal_Integer_Attribute_Check installs a conversion
10574       --  to check for being in range, which is not needed in this context.
10575       --  Returns False if neither condition holds.
10576
10577       function Prepare_64 (N : Node_Id) return Node_Id;
10578       --  Given a discrete expression, returns a Long_Long_Integer typed
10579       --  expression representing the underlying value of the expression.
10580       --  This is done with an unchecked conversion to the result type. We
10581       --  use unchecked conversion to handle the enumeration type case.
10582
10583       ----------------------
10584       -- Is_Entity_Length --
10585       ----------------------
10586
10587       function Is_Entity_Length (N : Node_Id) return Boolean is
10588       begin
10589          if Nkind (N) = N_Attribute_Reference
10590            and then Attribute_Name (N) = Name_Length
10591            and then Is_Entity_Name (Prefix (N))
10592          then
10593             Ent := Entity (Prefix (N));
10594
10595             if Present (Expressions (N)) then
10596                Index := First (Expressions (N));
10597             else
10598                Index := Empty;
10599             end if;
10600
10601             return True;
10602
10603          elsif Nkind (N) = N_Type_Conversion
10604            and then not Comes_From_Source (N)
10605          then
10606             return Is_Entity_Length (Expression (N));
10607
10608          else
10609             return False;
10610          end if;
10611       end Is_Entity_Length;
10612
10613       --------------------
10614       -- Is_Optimizable --
10615       --------------------
10616
10617       function Is_Optimizable (N : Node_Id) return Boolean is
10618          Val  : Uint;
10619          OK   : Boolean;
10620          Lo   : Uint;
10621          Hi   : Uint;
10622          Indx : Node_Id;
10623
10624       begin
10625          if Compile_Time_Known_Value (N) then
10626             Val := Expr_Value (N);
10627
10628             if Val = Uint_0 then
10629                Is_Zero := True;
10630                Comp    := Empty;
10631                return True;
10632
10633             elsif Val = Uint_1 then
10634                Is_Zero := False;
10635                Comp    := Empty;
10636                return True;
10637             end if;
10638          end if;
10639
10640          --  Here we have to make sure of being within 32-bits
10641
10642          Determine_Range (N, OK, Lo, Hi, Assume_Valid => True);
10643
10644          if not OK
10645            or else Lo < Uint_1
10646            or else Hi > UI_From_Int (Int'Last)
10647          then
10648             return False;
10649          end if;
10650
10651          --  Comparison value was within range, so now we must check the index
10652          --  value to make sure it is also within 32-bits.
10653
10654          Indx := First_Index (Etype (Ent));
10655
10656          if Present (Index) then
10657             for J in 2 .. UI_To_Int (Intval (Index)) loop
10658                Next_Index (Indx);
10659             end loop;
10660          end if;
10661
10662          Ityp := Etype (Indx);
10663
10664          if Esize (Ityp) > 32 then
10665             return False;
10666          end if;
10667
10668          Is_Zero := False;
10669          Comp := N;
10670          return True;
10671       end Is_Optimizable;
10672
10673       ----------------
10674       -- Prepare_64 --
10675       ----------------
10676
10677       function Prepare_64 (N : Node_Id) return Node_Id is
10678       begin
10679          return Unchecked_Convert_To (Standard_Long_Long_Integer, N);
10680       end Prepare_64;
10681
10682    --  Start of processing for Optimize_Length_Comparison
10683
10684    begin
10685       --  Nothing to do if not a comparison
10686
10687       if Op not in N_Op_Compare then
10688          return;
10689       end if;
10690
10691       --  Nothing to do if special -gnatd.P debug flag set
10692
10693       if Debug_Flag_Dot_PP then
10694          return;
10695       end if;
10696
10697       --  Ent'Length op 0/1
10698
10699       if Is_Entity_Length (Left_Opnd (N))
10700         and then Is_Optimizable (Right_Opnd (N))
10701       then
10702          null;
10703
10704       --  0/1 op Ent'Length
10705
10706       elsif Is_Entity_Length (Right_Opnd (N))
10707         and then Is_Optimizable (Left_Opnd (N))
10708       then
10709          --  Flip comparison to opposite sense
10710
10711          case Op is
10712             when N_Op_Lt => Op := N_Op_Gt;
10713             when N_Op_Le => Op := N_Op_Ge;
10714             when N_Op_Gt => Op := N_Op_Lt;
10715             when N_Op_Ge => Op := N_Op_Le;
10716             when others  => null;
10717          end case;
10718
10719       --  Else optimization not possible
10720
10721       else
10722          return;
10723       end if;
10724
10725       --  Fall through if we will do the optimization
10726
10727       --  Cases to handle:
10728
10729       --    X'Length = 0  => X'First > X'Last
10730       --    X'Length = 1  => X'First = X'Last
10731       --    X'Length = n  => X'First + (n - 1) = X'Last
10732
10733       --    X'Length /= 0 => X'First <= X'Last
10734       --    X'Length /= 1 => X'First /= X'Last
10735       --    X'Length /= n => X'First + (n - 1) /= X'Last
10736
10737       --    X'Length >= 0 => always true, warn
10738       --    X'Length >= 1 => X'First <= X'Last
10739       --    X'Length >= n => X'First + (n - 1) <= X'Last
10740
10741       --    X'Length > 0  => X'First <= X'Last
10742       --    X'Length > 1  => X'First < X'Last
10743       --    X'Length > n  => X'First + (n - 1) < X'Last
10744
10745       --    X'Length <= 0 => X'First > X'Last (warn, could be =)
10746       --    X'Length <= 1 => X'First >= X'Last
10747       --    X'Length <= n => X'First + (n - 1) >= X'Last
10748
10749       --    X'Length < 0  => always false (warn)
10750       --    X'Length < 1  => X'First > X'Last
10751       --    X'Length < n  => X'First + (n - 1) > X'Last
10752
10753       --  Note: for the cases of n (not constant 0,1), we require that the
10754       --  corresponding index type be integer or shorter (i.e. not 64-bit),
10755       --  and the same for the comparison value. Then we do the comparison
10756       --  using 64-bit arithmetic (actually long long integer), so that we
10757       --  cannot have overflow intefering with the result.
10758
10759       --  First deal with warning cases
10760
10761       if Is_Zero then
10762          case Op is
10763
10764             --  X'Length >= 0
10765
10766             when N_Op_Ge =>
10767                Rewrite (N,
10768                  Convert_To (Typ, New_Occurrence_Of (Standard_True, Loc)));
10769                Analyze_And_Resolve (N, Typ);
10770                Warn_On_Known_Condition (N);
10771                return;
10772
10773             --  X'Length < 0
10774
10775             when N_Op_Lt =>
10776                Rewrite (N,
10777                  Convert_To (Typ, New_Occurrence_Of (Standard_False, Loc)));
10778                Analyze_And_Resolve (N, Typ);
10779                Warn_On_Known_Condition (N);
10780                return;
10781
10782             when N_Op_Le =>
10783                if Constant_Condition_Warnings
10784                  and then Comes_From_Source (Original_Node (N))
10785                then
10786                   Error_Msg_N ("could replace by ""'=""?", N);
10787                end if;
10788
10789                Op := N_Op_Eq;
10790
10791             when others =>
10792                null;
10793          end case;
10794       end if;
10795
10796       --  Build the First reference we will use
10797
10798       Left :=
10799         Make_Attribute_Reference (Loc,
10800           Prefix         => New_Occurrence_Of (Ent, Loc),
10801           Attribute_Name => Name_First);
10802
10803       if Present (Index) then
10804          Set_Expressions (Left, New_List (New_Copy (Index)));
10805       end if;
10806
10807       --  If general value case, then do the addition of (n - 1), and
10808       --  also add the needed conversions to type Long_Long_Integer.
10809
10810       if Present (Comp) then
10811          Left :=
10812            Make_Op_Add (Loc,
10813              Left_Opnd  => Prepare_64 (Left),
10814              Right_Opnd =>
10815                Make_Op_Subtract (Loc,
10816                  Left_Opnd  => Prepare_64 (Comp),
10817                  Right_Opnd => Make_Integer_Literal (Loc, 1)));
10818       end if;
10819
10820       --  Build the Last reference we will use
10821
10822       Right :=
10823         Make_Attribute_Reference (Loc,
10824           Prefix         => New_Occurrence_Of (Ent, Loc),
10825           Attribute_Name => Name_Last);
10826
10827       if Present (Index) then
10828          Set_Expressions (Right, New_List (New_Copy (Index)));
10829       end if;
10830
10831       --  If general operand, convert Last reference to Long_Long_Integer
10832
10833       if Present (Comp) then
10834          Right := Prepare_64 (Right);
10835       end if;
10836
10837       --  Check for cases to optimize
10838
10839       --  X'Length = 0  => X'First > X'Last
10840       --  X'Length < 1  => X'First > X'Last
10841       --  X'Length < n  => X'First + (n - 1) > X'Last
10842
10843       if (Is_Zero and then Op = N_Op_Eq)
10844         or else (not Is_Zero and then Op = N_Op_Lt)
10845       then
10846          Result :=
10847            Make_Op_Gt (Loc,
10848              Left_Opnd  => Left,
10849              Right_Opnd => Right);
10850
10851       --  X'Length = 1  => X'First = X'Last
10852       --  X'Length = n  => X'First + (n - 1) = X'Last
10853
10854       elsif not Is_Zero and then Op = N_Op_Eq then
10855          Result :=
10856            Make_Op_Eq (Loc,
10857              Left_Opnd  => Left,
10858              Right_Opnd => Right);
10859
10860       --  X'Length /= 0 => X'First <= X'Last
10861       --  X'Length > 0  => X'First <= X'Last
10862
10863       elsif Is_Zero and (Op = N_Op_Ne or else Op = N_Op_Gt) then
10864          Result :=
10865            Make_Op_Le (Loc,
10866              Left_Opnd  => Left,
10867              Right_Opnd => Right);
10868
10869       --  X'Length /= 1 => X'First /= X'Last
10870       --  X'Length /= n => X'First + (n - 1) /= X'Last
10871
10872       elsif not Is_Zero and then Op = N_Op_Ne then
10873          Result :=
10874            Make_Op_Ne (Loc,
10875              Left_Opnd  => Left,
10876              Right_Opnd => Right);
10877
10878       --  X'Length >= 1 => X'First <= X'Last
10879       --  X'Length >= n => X'First + (n - 1) <= X'Last
10880
10881       elsif not Is_Zero and then Op = N_Op_Ge then
10882          Result :=
10883            Make_Op_Le (Loc,
10884              Left_Opnd  => Left,
10885                        Right_Opnd => Right);
10886
10887       --  X'Length > 1  => X'First < X'Last
10888       --  X'Length > n  => X'First + (n = 1) < X'Last
10889
10890       elsif not Is_Zero and then Op = N_Op_Gt then
10891          Result :=
10892            Make_Op_Lt (Loc,
10893              Left_Opnd  => Left,
10894              Right_Opnd => Right);
10895
10896       --  X'Length <= 1 => X'First >= X'Last
10897       --  X'Length <= n => X'First + (n - 1) >= X'Last
10898
10899       elsif not Is_Zero and then Op = N_Op_Le then
10900          Result :=
10901            Make_Op_Ge (Loc,
10902              Left_Opnd  => Left,
10903              Right_Opnd => Right);
10904
10905       --  Should not happen at this stage
10906
10907       else
10908          raise Program_Error;
10909       end if;
10910
10911       --  Rewrite and finish up
10912
10913       Rewrite (N, Result);
10914       Analyze_And_Resolve (N, Typ);
10915       return;
10916    end Optimize_Length_Comparison;
10917
10918    ------------------------
10919    -- Rewrite_Comparison --
10920    ------------------------
10921
10922    procedure Rewrite_Comparison (N : Node_Id) is
10923       Warning_Generated : Boolean := False;
10924       --  Set to True if first pass with Assume_Valid generates a warning in
10925       --  which case we skip the second pass to avoid warning overloaded.
10926
10927       Result : Node_Id;
10928       --  Set to Standard_True or Standard_False
10929
10930    begin
10931       if Nkind (N) = N_Type_Conversion then
10932          Rewrite_Comparison (Expression (N));
10933          return;
10934
10935       elsif Nkind (N) not in N_Op_Compare then
10936          return;
10937       end if;
10938
10939       --  Now start looking at the comparison in detail. We potentially go
10940       --  through this loop twice. The first time, Assume_Valid is set False
10941       --  in the call to Compile_Time_Compare. If this call results in a
10942       --  clear result of always True or Always False, that's decisive and
10943       --  we are done. Otherwise we repeat the processing with Assume_Valid
10944       --  set to True to generate additional warnings. We can skip that step
10945       --  if Constant_Condition_Warnings is False.
10946
10947       for AV in False .. True loop
10948          declare
10949             Typ : constant Entity_Id := Etype (N);
10950             Op1 : constant Node_Id   := Left_Opnd (N);
10951             Op2 : constant Node_Id   := Right_Opnd (N);
10952
10953             Res : constant Compare_Result :=
10954                     Compile_Time_Compare (Op1, Op2, Assume_Valid => AV);
10955             --  Res indicates if compare outcome can be compile time determined
10956
10957             True_Result  : Boolean;
10958             False_Result : Boolean;
10959
10960          begin
10961             case N_Op_Compare (Nkind (N)) is
10962             when N_Op_Eq =>
10963                True_Result  := Res = EQ;
10964                False_Result := Res = LT or else Res = GT or else Res = NE;
10965
10966             when N_Op_Ge =>
10967                True_Result  := Res in Compare_GE;
10968                False_Result := Res = LT;
10969
10970                if Res = LE
10971                  and then Constant_Condition_Warnings
10972                  and then Comes_From_Source (Original_Node (N))
10973                  and then Nkind (Original_Node (N)) = N_Op_Ge
10974                  and then not In_Instance
10975                  and then Is_Integer_Type (Etype (Left_Opnd (N)))
10976                  and then not Has_Warnings_Off (Etype (Left_Opnd (N)))
10977                then
10978                   Error_Msg_N
10979                     ("can never be greater than, could replace by ""'=""?", N);
10980                   Warning_Generated := True;
10981                end if;
10982
10983             when N_Op_Gt =>
10984                True_Result  := Res = GT;
10985                False_Result := Res in Compare_LE;
10986
10987             when N_Op_Lt =>
10988                True_Result  := Res = LT;
10989                False_Result := Res in Compare_GE;
10990
10991             when N_Op_Le =>
10992                True_Result  := Res in Compare_LE;
10993                False_Result := Res = GT;
10994
10995                if Res = GE
10996                  and then Constant_Condition_Warnings
10997                  and then Comes_From_Source (Original_Node (N))
10998                  and then Nkind (Original_Node (N)) = N_Op_Le
10999                  and then not In_Instance
11000                  and then Is_Integer_Type (Etype (Left_Opnd (N)))
11001                  and then not Has_Warnings_Off (Etype (Left_Opnd (N)))
11002                then
11003                   Error_Msg_N
11004                     ("can never be less than, could replace by ""'=""?", N);
11005                   Warning_Generated := True;
11006                end if;
11007
11008             when N_Op_Ne =>
11009                True_Result  := Res = NE or else Res = GT or else Res = LT;
11010                False_Result := Res = EQ;
11011             end case;
11012
11013             --  If this is the first iteration, then we actually convert the
11014             --  comparison into True or False, if the result is certain.
11015
11016             if AV = False then
11017                if True_Result or False_Result then
11018                   if True_Result then
11019                      Result := Standard_True;
11020                   else
11021                      Result := Standard_False;
11022                   end if;
11023
11024                   Rewrite (N,
11025                     Convert_To (Typ,
11026                       New_Occurrence_Of (Result, Sloc (N))));
11027                   Analyze_And_Resolve (N, Typ);
11028                   Warn_On_Known_Condition (N);
11029                   return;
11030                end if;
11031
11032             --  If this is the second iteration (AV = True), and the original
11033             --  node comes from source and we are not in an instance, then give
11034             --  a warning if we know result would be True or False. Note: we
11035             --  know Constant_Condition_Warnings is set if we get here.
11036
11037             elsif Comes_From_Source (Original_Node (N))
11038               and then not In_Instance
11039             then
11040                if True_Result then
11041                   Error_Msg_N
11042                     ("condition can only be False if invalid values present?",
11043                      N);
11044                elsif False_Result then
11045                   Error_Msg_N
11046                     ("condition can only be True if invalid values present?",
11047                      N);
11048                end if;
11049             end if;
11050          end;
11051
11052          --  Skip second iteration if not warning on constant conditions or
11053          --  if the first iteration already generated a warning of some kind or
11054          --  if we are in any case assuming all values are valid (so that the
11055          --  first iteration took care of the valid case).
11056
11057          exit when not Constant_Condition_Warnings;
11058          exit when Warning_Generated;
11059          exit when Assume_No_Invalid_Values;
11060       end loop;
11061    end Rewrite_Comparison;
11062
11063    ----------------------------
11064    -- Safe_In_Place_Array_Op --
11065    ----------------------------
11066
11067    function Safe_In_Place_Array_Op
11068      (Lhs : Node_Id;
11069       Op1 : Node_Id;
11070       Op2 : Node_Id) return Boolean
11071    is
11072       Target : Entity_Id;
11073
11074       function Is_Safe_Operand (Op : Node_Id) return Boolean;
11075       --  Operand is safe if it cannot overlap part of the target of the
11076       --  operation. If the operand and the target are identical, the operand
11077       --  is safe. The operand can be empty in the case of negation.
11078
11079       function Is_Unaliased (N : Node_Id) return Boolean;
11080       --  Check that N is a stand-alone entity
11081
11082       ------------------
11083       -- Is_Unaliased --
11084       ------------------
11085
11086       function Is_Unaliased (N : Node_Id) return Boolean is
11087       begin
11088          return
11089            Is_Entity_Name (N)
11090              and then No (Address_Clause (Entity (N)))
11091              and then No (Renamed_Object (Entity (N)));
11092       end Is_Unaliased;
11093
11094       ---------------------
11095       -- Is_Safe_Operand --
11096       ---------------------
11097
11098       function Is_Safe_Operand (Op : Node_Id) return Boolean is
11099       begin
11100          if No (Op) then
11101             return True;
11102
11103          elsif Is_Entity_Name (Op) then
11104             return Is_Unaliased (Op);
11105
11106          elsif Nkind_In (Op, N_Indexed_Component, N_Selected_Component) then
11107             return Is_Unaliased (Prefix (Op));
11108
11109          elsif Nkind (Op) = N_Slice then
11110             return
11111               Is_Unaliased (Prefix (Op))
11112                 and then Entity (Prefix (Op)) /= Target;
11113
11114          elsif Nkind (Op) = N_Op_Not then
11115             return Is_Safe_Operand (Right_Opnd (Op));
11116
11117          else
11118             return False;
11119          end if;
11120       end Is_Safe_Operand;
11121
11122    --  Start of processing for Is_Safe_In_Place_Array_Op
11123
11124    begin
11125       --  Skip this processing if the component size is different from system
11126       --  storage unit (since at least for NOT this would cause problems).
11127
11128       if Component_Size (Etype (Lhs)) /= System_Storage_Unit then
11129          return False;
11130
11131       --  Cannot do in place stuff on VM_Target since cannot pass addresses
11132
11133       elsif VM_Target /= No_VM then
11134          return False;
11135
11136       --  Cannot do in place stuff if non-standard Boolean representation
11137
11138       elsif Has_Non_Standard_Rep (Component_Type (Etype (Lhs))) then
11139          return False;
11140
11141       elsif not Is_Unaliased (Lhs) then
11142          return False;
11143
11144       else
11145          Target := Entity (Lhs);
11146          return Is_Safe_Operand (Op1) and then Is_Safe_Operand (Op2);
11147       end if;
11148    end Safe_In_Place_Array_Op;
11149
11150    -----------------------
11151    -- Tagged_Membership --
11152    -----------------------
11153
11154    --  There are two different cases to consider depending on whether the right
11155    --  operand is a class-wide type or not. If not we just compare the actual
11156    --  tag of the left expr to the target type tag:
11157    --
11158    --     Left_Expr.Tag = Right_Type'Tag;
11159    --
11160    --  If it is a class-wide type we use the RT function CW_Membership which is
11161    --  usually implemented by looking in the ancestor tables contained in the
11162    --  dispatch table pointed by Left_Expr.Tag for Typ'Tag
11163
11164    --  Ada 2005 (AI-251): If it is a class-wide interface type we use the RT
11165    --  function IW_Membership which is usually implemented by looking in the
11166    --  table of abstract interface types plus the ancestor table contained in
11167    --  the dispatch table pointed by Left_Expr.Tag for Typ'Tag
11168
11169    procedure Tagged_Membership
11170      (N         : Node_Id;
11171       SCIL_Node : out Node_Id;
11172       Result    : out Node_Id)
11173    is
11174       Left  : constant Node_Id    := Left_Opnd  (N);
11175       Right : constant Node_Id    := Right_Opnd (N);
11176       Loc   : constant Source_Ptr := Sloc (N);
11177
11178       Full_R_Typ : Entity_Id;
11179       Left_Type  : Entity_Id;
11180       New_Node   : Node_Id;
11181       Right_Type : Entity_Id;
11182       Obj_Tag    : Node_Id;
11183
11184    begin
11185       SCIL_Node := Empty;
11186
11187       --  Handle entities from the limited view
11188
11189       Left_Type  := Available_View (Etype (Left));
11190       Right_Type := Available_View (Etype (Right));
11191
11192       --  In the case where the type is an access type, the test is applied
11193       --  using the designated types (needed in Ada 2012 for implicit anonymous
11194       --  access conversions, for AI05-0149).
11195
11196       if Is_Access_Type (Right_Type) then
11197          Left_Type  := Designated_Type (Left_Type);
11198          Right_Type := Designated_Type (Right_Type);
11199       end if;
11200
11201       if Is_Class_Wide_Type (Left_Type) then
11202          Left_Type := Root_Type (Left_Type);
11203       end if;
11204
11205       if Is_Class_Wide_Type (Right_Type) then
11206          Full_R_Typ := Underlying_Type (Root_Type (Right_Type));
11207       else
11208          Full_R_Typ := Underlying_Type (Right_Type);
11209       end if;
11210
11211       Obj_Tag :=
11212         Make_Selected_Component (Loc,
11213           Prefix        => Relocate_Node (Left),
11214           Selector_Name =>
11215             New_Reference_To (First_Tag_Component (Left_Type), Loc));
11216
11217       if Is_Class_Wide_Type (Right_Type) then
11218
11219          --  No need to issue a run-time check if we statically know that the
11220          --  result of this membership test is always true. For example,
11221          --  considering the following declarations:
11222
11223          --    type Iface is interface;
11224          --    type T     is tagged null record;
11225          --    type DT    is new T and Iface with null record;
11226
11227          --    Obj1 : T;
11228          --    Obj2 : DT;
11229
11230          --  These membership tests are always true:
11231
11232          --    Obj1 in T'Class
11233          --    Obj2 in T'Class;
11234          --    Obj2 in Iface'Class;
11235
11236          --  We do not need to handle cases where the membership is illegal.
11237          --  For example:
11238
11239          --    Obj1 in DT'Class;     --  Compile time error
11240          --    Obj1 in Iface'Class;  --  Compile time error
11241
11242          if not Is_Class_Wide_Type (Left_Type)
11243            and then (Is_Ancestor (Etype (Right_Type), Left_Type,
11244                                   Use_Full_View => True)
11245                        or else (Is_Interface (Etype (Right_Type))
11246                                  and then Interface_Present_In_Ancestor
11247                                            (Typ   => Left_Type,
11248                                             Iface => Etype (Right_Type))))
11249          then
11250             Result := New_Reference_To (Standard_True, Loc);
11251             return;
11252          end if;
11253
11254          --  Ada 2005 (AI-251): Class-wide applied to interfaces
11255
11256          if Is_Interface (Etype (Class_Wide_Type (Right_Type)))
11257
11258             --   Support to: "Iface_CW_Typ in Typ'Class"
11259
11260            or else Is_Interface (Left_Type)
11261          then
11262             --  Issue error if IW_Membership operation not available in a
11263             --  configurable run time setting.
11264
11265             if not RTE_Available (RE_IW_Membership) then
11266                Error_Msg_CRT
11267                  ("dynamic membership test on interface types", N);
11268                Result := Empty;
11269                return;
11270             end if;
11271
11272             Result :=
11273               Make_Function_Call (Loc,
11274                  Name => New_Occurrence_Of (RTE (RE_IW_Membership), Loc),
11275                  Parameter_Associations => New_List (
11276                    Make_Attribute_Reference (Loc,
11277                      Prefix => Obj_Tag,
11278                      Attribute_Name => Name_Address),
11279                    New_Reference_To (
11280                      Node (First_Elmt (Access_Disp_Table (Full_R_Typ))),
11281                      Loc)));
11282
11283          --  Ada 95: Normal case
11284
11285          else
11286             Build_CW_Membership (Loc,
11287               Obj_Tag_Node => Obj_Tag,
11288               Typ_Tag_Node =>
11289                  New_Reference_To (
11290                    Node (First_Elmt (Access_Disp_Table (Full_R_Typ))),  Loc),
11291               Related_Nod => N,
11292               New_Node    => New_Node);
11293
11294             --  Generate the SCIL node for this class-wide membership test.
11295             --  Done here because the previous call to Build_CW_Membership
11296             --  relocates Obj_Tag.
11297
11298             if Generate_SCIL then
11299                SCIL_Node := Make_SCIL_Membership_Test (Sloc (N));
11300                Set_SCIL_Entity (SCIL_Node, Etype (Right_Type));
11301                Set_SCIL_Tag_Value (SCIL_Node, Obj_Tag);
11302             end if;
11303
11304             Result := New_Node;
11305          end if;
11306
11307       --  Right_Type is not a class-wide type
11308
11309       else
11310          --  No need to check the tag of the object if Right_Typ is abstract
11311
11312          if Is_Abstract_Type (Right_Type) then
11313             Result := New_Reference_To (Standard_False, Loc);
11314
11315          else
11316             Result :=
11317               Make_Op_Eq (Loc,
11318                 Left_Opnd  => Obj_Tag,
11319                 Right_Opnd =>
11320                   New_Reference_To
11321                     (Node (First_Elmt (Access_Disp_Table (Full_R_Typ))), Loc));
11322          end if;
11323       end if;
11324    end Tagged_Membership;
11325
11326    ------------------------------
11327    -- Unary_Op_Validity_Checks --
11328    ------------------------------
11329
11330    procedure Unary_Op_Validity_Checks (N : Node_Id) is
11331    begin
11332       if Validity_Checks_On and Validity_Check_Operands then
11333          Ensure_Valid (Right_Opnd (N));
11334       end if;
11335    end Unary_Op_Validity_Checks;
11336
11337 end Exp_Ch4;