OSDN Git Service

2012-01-23 Robert Dewar <dewar@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / sem_ch12.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                             S E M _ C H 1 2                              --
6 --                                                                          --
7 --                                 B o d y                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2012, Free Software Foundation, Inc.         --
10 --                                                                          --
11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
12 -- terms of the  GNU General Public License as published  by the Free Soft- --
13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17 -- for  more details.  You should have  received  a copy of the GNU General --
18 -- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
20 --                                                                          --
21 -- GNAT was originally developed  by the GNAT team at  New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
23 --                                                                          --
24 ------------------------------------------------------------------------------
25
26 with Aspects;  use Aspects;
27 with Atree;    use Atree;
28 with Einfo;    use Einfo;
29 with Elists;   use Elists;
30 with Errout;   use Errout;
31 with Expander; use Expander;
32 with Exp_Disp; use Exp_Disp;
33 with Fname;    use Fname;
34 with Fname.UF; use Fname.UF;
35 with Freeze;   use Freeze;
36 with Hostparm;
37 with Itypes;   use Itypes;
38 with Lib;      use Lib;
39 with Lib.Load; use Lib.Load;
40 with Lib.Xref; use Lib.Xref;
41 with Nlists;   use Nlists;
42 with Namet;    use Namet;
43 with Nmake;    use Nmake;
44 with Opt;      use Opt;
45 with Rident;   use Rident;
46 with Restrict; use Restrict;
47 with Rtsfind;  use Rtsfind;
48 with Sem;      use Sem;
49 with Sem_Aux;  use Sem_Aux;
50 with Sem_Cat;  use Sem_Cat;
51 with Sem_Ch3;  use Sem_Ch3;
52 with Sem_Ch6;  use Sem_Ch6;
53 with Sem_Ch7;  use Sem_Ch7;
54 with Sem_Ch8;  use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch13; use Sem_Ch13;
57 with Sem_Dim;  use Sem_Dim;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Elab; use Sem_Elab;
60 with Sem_Elim; use Sem_Elim;
61 with Sem_Eval; use Sem_Eval;
62 with Sem_Res;  use Sem_Res;
63 with Sem_Type; use Sem_Type;
64 with Sem_Util; use Sem_Util;
65 with Sem_Warn; use Sem_Warn;
66 with Stand;    use Stand;
67 with Sinfo;    use Sinfo;
68 with Sinfo.CN; use Sinfo.CN;
69 with Sinput;   use Sinput;
70 with Sinput.L; use Sinput.L;
71 with Snames;   use Snames;
72 with Stringt;  use Stringt;
73 with Uname;    use Uname;
74 with Table;
75 with Tbuild;   use Tbuild;
76 with Uintp;    use Uintp;
77 with Urealp;   use Urealp;
78
79 with GNAT.HTable;
80
81 package body Sem_Ch12 is
82
83    ----------------------------------------------------------
84    -- Implementation of Generic Analysis and Instantiation --
85    ----------------------------------------------------------
86
87    --  GNAT implements generics by macro expansion. No attempt is made to share
88    --  generic instantiations (for now). Analysis of a generic definition does
89    --  not perform any expansion action, but the expander must be called on the
90    --  tree for each instantiation, because the expansion may of course depend
91    --  on the generic actuals. All of this is best achieved as follows:
92    --
93    --  a) Semantic analysis of a generic unit is performed on a copy of the
94    --  tree for the generic unit. All tree modifications that follow analysis
95    --  do not affect the original tree. Links are kept between the original
96    --  tree and the copy, in order to recognize non-local references within
97    --  the generic, and propagate them to each instance (recall that name
98    --  resolution is done on the generic declaration: generics are not really
99    --  macros!). This is summarized in the following diagram:
100
101    --              .-----------.               .----------.
102    --              |  semantic |<--------------|  generic |
103    --              |    copy   |               |    unit  |
104    --              |           |==============>|          |
105    --              |___________|    global     |__________|
106    --                             references     |   |  |
107    --                                            |   |  |
108    --                                          .-----|--|.
109    --                                          |  .-----|---.
110    --                                          |  |  .----------.
111    --                                          |  |  |  generic |
112    --                                          |__|  |          |
113    --                                             |__| instance |
114    --                                                |__________|
115
116    --  b) Each instantiation copies the original tree, and inserts into it a
117    --  series of declarations that describe the mapping between generic formals
118    --  and actuals. For example, a generic In OUT parameter is an object
119    --  renaming of the corresponding actual, etc. Generic IN parameters are
120    --  constant declarations.
121
122    --  c) In order to give the right visibility for these renamings, we use
123    --  a different scheme for package and subprogram instantiations. For
124    --  packages, the list of renamings is inserted into the package
125    --  specification, before the visible declarations of the package. The
126    --  renamings are analyzed before any of the text of the instance, and are
127    --  thus visible at the right place. Furthermore, outside of the instance,
128    --  the generic parameters are visible and denote their corresponding
129    --  actuals.
130
131    --  For subprograms, we create a container package to hold the renamings
132    --  and the subprogram instance itself. Analysis of the package makes the
133    --  renaming declarations visible to the subprogram. After analyzing the
134    --  package, the defining entity for the subprogram is touched-up so that
135    --  it appears declared in the current scope, and not inside the container
136    --  package.
137
138    --  If the instantiation is a compilation unit, the container package is
139    --  given the same name as the subprogram instance. This ensures that
140    --  the elaboration procedure called by the binder, using the compilation
141    --  unit name, calls in fact the elaboration procedure for the package.
142
143    --  Not surprisingly, private types complicate this approach. By saving in
144    --  the original generic object the non-local references, we guarantee that
145    --  the proper entities are referenced at the point of instantiation.
146    --  However, for private types, this by itself does not insure that the
147    --  proper VIEW of the entity is used (the full type may be visible at the
148    --  point of generic definition, but not at instantiation, or vice-versa).
149    --  In  order to reference the proper view, we special-case any reference
150    --  to private types in the generic object, by saving both views, one in
151    --  the generic and one in the semantic copy. At time of instantiation, we
152    --  check whether the two views are consistent, and exchange declarations if
153    --  necessary, in order to restore the correct visibility. Similarly, if
154    --  the instance view is private when the generic view was not, we perform
155    --  the exchange. After completing the instantiation, we restore the
156    --  current visibility. The flag Has_Private_View marks identifiers in the
157    --  the generic unit that require checking.
158
159    --  Visibility within nested generic units requires special handling.
160    --  Consider the following scheme:
161
162    --  type Global is ...         --  outside of generic unit.
163    --  generic ...
164    --  package Outer is
165    --     ...
166    --     type Semi_Global is ... --  global to inner.
167
168    --     generic ...                                         -- 1
169    --     procedure inner (X1 : Global;  X2 : Semi_Global);
170
171    --     procedure in2 is new inner (...);                   -- 4
172    --  end Outer;
173
174    --  package New_Outer is new Outer (...);                  -- 2
175    --  procedure New_Inner is new New_Outer.Inner (...);      -- 3
176
177    --  The semantic analysis of Outer captures all occurrences of Global.
178    --  The semantic analysis of Inner (at 1) captures both occurrences of
179    --  Global and Semi_Global.
180
181    --  At point 2 (instantiation of Outer), we also produce a generic copy
182    --  of Inner, even though Inner is, at that point, not being instantiated.
183    --  (This is just part of the semantic analysis of New_Outer).
184
185    --  Critically, references to Global within Inner must be preserved, while
186    --  references to Semi_Global should not preserved, because they must now
187    --  resolve to an entity within New_Outer. To distinguish between these, we
188    --  use a global variable, Current_Instantiated_Parent, which is set when
189    --  performing a generic copy during instantiation (at 2). This variable is
190    --  used when performing a generic copy that is not an instantiation, but
191    --  that is nested within one, as the occurrence of 1 within 2. The analysis
192    --  of a nested generic only preserves references that are global to the
193    --  enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
194    --  determine whether a reference is external to the given parent.
195
196    --  The instantiation at point 3 requires no special treatment. The method
197    --  works as well for further nestings of generic units, but of course the
198    --  variable Current_Instantiated_Parent must be stacked because nested
199    --  instantiations can occur, e.g. the occurrence of 4 within 2.
200
201    --  The instantiation of package and subprogram bodies is handled in a
202    --  similar manner, except that it is delayed until after semantic
203    --  analysis is complete. In this fashion complex cross-dependencies
204    --  between several package declarations and bodies containing generics
205    --  can be compiled which otherwise would diagnose spurious circularities.
206
207    --  For example, it is possible to compile two packages A and B that
208    --  have the following structure:
209
210    --    package A is                         package B is
211    --       generic ...                          generic ...
212    --       package G_A is                       package G_B is
213
214    --    with B;                              with A;
215    --    package body A is                    package body B is
216    --       package N_B is new G_B (..)          package N_A is new G_A (..)
217
218    --  The table Pending_Instantiations in package Inline is used to keep
219    --  track of body instantiations that are delayed in this manner. Inline
220    --  handles the actual calls to do the body instantiations. This activity
221    --  is part of Inline, since the processing occurs at the same point, and
222    --  for essentially the same reason, as the handling of inlined routines.
223
224    ----------------------------------------------
225    -- Detection of Instantiation Circularities --
226    ----------------------------------------------
227
228    --  If we have a chain of instantiations that is circular, this is static
229    --  error which must be detected at compile time. The detection of these
230    --  circularities is carried out at the point that we insert a generic
231    --  instance spec or body. If there is a circularity, then the analysis of
232    --  the offending spec or body will eventually result in trying to load the
233    --  same unit again, and we detect this problem as we analyze the package
234    --  instantiation for the second time.
235
236    --  At least in some cases after we have detected the circularity, we get
237    --  into trouble if we try to keep going. The following flag is set if a
238    --  circularity is detected, and used to abandon compilation after the
239    --  messages have been posted.
240
241    Circularity_Detected : Boolean := False;
242    --  This should really be reset on encountering a new main unit, but in
243    --  practice we are not using multiple main units so it is not critical.
244
245    -------------------------------------------------
246    -- Formal packages and partial parametrization --
247    -------------------------------------------------
248
249    --  When compiling a generic, a formal package is a local instantiation. If
250    --  declared with a box, its generic formals are visible in the enclosing
251    --  generic. If declared with a partial list of actuals, those actuals that
252    --  are defaulted (covered by an Others clause, or given an explicit box
253    --  initialization) are also visible in the enclosing generic, while those
254    --  that have a corresponding actual are not.
255
256    --  In our source model of instantiation, the same visibility must be
257    --  present in the spec and body of an instance: the names of the formals
258    --  that are defaulted must be made visible within the instance, and made
259    --  invisible (hidden) after the instantiation is complete, so that they
260    --  are not accessible outside of the instance.
261
262    --  In a generic, a formal package is treated like a special instantiation.
263    --  Our Ada 95 compiler handled formals with and without box in different
264    --  ways. With partial parametrization, we use a single model for both.
265    --  We create a package declaration that consists of the specification of
266    --  the generic package, and a set of declarations that map the actuals
267    --  into local renamings, just as we do for bona fide instantiations. For
268    --  defaulted parameters and formals with a box, we copy directly the
269    --  declarations of the formal into this local package. The result is a
270    --  a package whose visible declarations may include generic formals. This
271    --  package is only used for type checking and visibility analysis, and
272    --  never reaches the back-end, so it can freely violate the placement
273    --  rules for generic formal declarations.
274
275    --  The list of declarations (renamings and copies of formals) is built
276    --  by Analyze_Associations, just as for regular instantiations.
277
278    --  At the point of instantiation, conformance checking must be applied only
279    --  to those parameters that were specified in the formal. We perform this
280    --  checking by creating another internal instantiation, this one including
281    --  only the renamings and the formals (the rest of the package spec is not
282    --  relevant to conformance checking). We can then traverse two lists: the
283    --  list of actuals in the instance that corresponds to the formal package,
284    --  and the list of actuals produced for this bogus instantiation. We apply
285    --  the conformance rules to those actuals that are not defaulted (i.e.
286    --  which still appear as generic formals.
287
288    --  When we compile an instance body we must make the right parameters
289    --  visible again. The predicate Is_Generic_Formal indicates which of the
290    --  formals should have its Is_Hidden flag reset.
291
292    -----------------------
293    -- Local subprograms --
294    -----------------------
295
296    procedure Abandon_Instantiation (N : Node_Id);
297    pragma No_Return (Abandon_Instantiation);
298    --  Posts an error message "instantiation abandoned" at the indicated node
299    --  and then raises the exception Instantiation_Error to do it.
300
301    procedure Analyze_Formal_Array_Type
302      (T   : in out Entity_Id;
303       Def : Node_Id);
304    --  A formal array type is treated like an array type declaration, and
305    --  invokes Array_Type_Declaration (sem_ch3) whose first parameter is
306    --  in-out, because in the case of an anonymous type the entity is
307    --  actually created in the procedure.
308
309    --  The following procedures treat other kinds of formal parameters
310
311    procedure Analyze_Formal_Derived_Interface_Type
312      (N   : Node_Id;
313       T   : Entity_Id;
314       Def : Node_Id);
315
316    procedure Analyze_Formal_Derived_Type
317      (N   : Node_Id;
318       T   : Entity_Id;
319       Def : Node_Id);
320
321    procedure Analyze_Formal_Interface_Type
322      (N   : Node_Id;
323       T   : Entity_Id;
324       Def : Node_Id);
325
326    --  The following subprograms create abbreviated declarations for formal
327    --  scalar types. We introduce an anonymous base of the proper class for
328    --  each of them, and define the formals as constrained first subtypes of
329    --  their bases. The bounds are expressions that are non-static in the
330    --  generic.
331
332    procedure Analyze_Formal_Decimal_Fixed_Point_Type
333                                                 (T : Entity_Id; Def : Node_Id);
334    procedure Analyze_Formal_Discrete_Type       (T : Entity_Id; Def : Node_Id);
335    procedure Analyze_Formal_Floating_Type       (T : Entity_Id; Def : Node_Id);
336    procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
337    procedure Analyze_Formal_Modular_Type        (T : Entity_Id; Def : Node_Id);
338    procedure Analyze_Formal_Ordinary_Fixed_Point_Type
339                                                 (T : Entity_Id; Def : Node_Id);
340
341    procedure Analyze_Formal_Private_Type
342      (N   : Node_Id;
343       T   : Entity_Id;
344       Def : Node_Id);
345    --  Creates a new private type, which does not require completion
346
347    procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
348    --  Ada 2012: Creates a new incomplete type whose actual does not freeze
349
350    procedure Analyze_Generic_Formal_Part (N : Node_Id);
351    --  Analyze generic formal part
352
353    procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
354    --  Create a new access type with the given designated type
355
356    function Analyze_Associations
357      (I_Node  : Node_Id;
358       Formals : List_Id;
359       F_Copy  : List_Id) return List_Id;
360    --  At instantiation time, build the list of associations between formals
361    --  and actuals. Each association becomes a renaming declaration for the
362    --  formal entity. F_Copy is the analyzed list of formals in the generic
363    --  copy. It is used to apply legality checks to the actuals. I_Node is the
364    --  instantiation node itself.
365
366    procedure Analyze_Subprogram_Instantiation
367      (N : Node_Id;
368       K : Entity_Kind);
369
370    procedure Build_Instance_Compilation_Unit_Nodes
371      (N        : Node_Id;
372       Act_Body : Node_Id;
373       Act_Decl : Node_Id);
374    --  This procedure is used in the case where the generic instance of a
375    --  subprogram body or package body is a library unit. In this case, the
376    --  original library unit node for the generic instantiation must be
377    --  replaced by the resulting generic body, and a link made to a new
378    --  compilation unit node for the generic declaration. The argument N is
379    --  the original generic instantiation. Act_Body and Act_Decl are the body
380    --  and declaration of the instance (either package body and declaration
381    --  nodes or subprogram body and declaration nodes depending on the case).
382    --  On return, the node N has been rewritten with the actual body.
383
384    procedure Check_Access_Definition (N : Node_Id);
385    --  Subsidiary routine to null exclusion processing. Perform an assertion
386    --  check on Ada version and the presence of an access definition in N.
387
388    procedure Check_Formal_Packages (P_Id : Entity_Id);
389    --  Apply the following to all formal packages in generic associations
390
391    procedure Check_Formal_Package_Instance
392      (Formal_Pack : Entity_Id;
393       Actual_Pack : Entity_Id);
394    --  Verify that the actuals of the actual instance match the actuals of
395    --  the template for a formal package that is not declared with a box.
396
397    procedure Check_Forward_Instantiation (Decl : Node_Id);
398    --  If the generic is a local entity and the corresponding body has not
399    --  been seen yet, flag enclosing packages to indicate that it will be
400    --  elaborated after the generic body. Subprograms declared in the same
401    --  package cannot be inlined by the front-end because front-end inlining
402    --  requires a strict linear order of elaboration.
403
404    function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
405    --  Check if some association between formals and actuals requires to make
406    --  visible primitives of a tagged type, and make those primitives visible.
407    --  Return the list of primitives whose visibility is modified (to restore
408    --  their visibility later through Restore_Hidden_Primitives). If no
409    --  candidate is found then return No_Elist.
410
411    procedure Check_Hidden_Child_Unit
412      (N           : Node_Id;
413       Gen_Unit    : Entity_Id;
414       Act_Decl_Id : Entity_Id);
415    --  If the generic unit is an implicit child instance within a parent
416    --  instance, we need to make an explicit test that it is not hidden by
417    --  a child instance of the same name and parent.
418
419    procedure Check_Generic_Actuals
420      (Instance      : Entity_Id;
421       Is_Formal_Box : Boolean);
422    --  Similar to previous one. Check the actuals in the instantiation,
423    --  whose views can change between the point of instantiation and the point
424    --  of instantiation of the body. In addition, mark the generic renamings
425    --  as generic actuals, so that they are not compatible with other actuals.
426    --  Recurse on an actual that is a formal package whose declaration has
427    --  a box.
428
429    function Contains_Instance_Of
430      (Inner : Entity_Id;
431       Outer : Entity_Id;
432       N     : Node_Id) return Boolean;
433    --  Inner is instantiated within the generic Outer. Check whether Inner
434    --  directly or indirectly contains an instance of Outer or of one of its
435    --  parents, in the case of a subunit. Each generic unit holds a list of
436    --  the entities instantiated within (at any depth). This procedure
437    --  determines whether the set of such lists contains a cycle, i.e. an
438    --  illegal circular instantiation.
439
440    function Denotes_Formal_Package
441      (Pack     : Entity_Id;
442       On_Exit  : Boolean := False;
443       Instance : Entity_Id := Empty) return Boolean;
444    --  Returns True if E is a formal package of an enclosing generic, or
445    --  the actual for such a formal in an enclosing instantiation. If such
446    --  a package is used as a formal in an nested generic, or as an actual
447    --  in a nested instantiation, the visibility of ITS formals should not
448    --  be modified. When called from within Restore_Private_Views, the flag
449    --  On_Exit is true, to indicate that the search for a possible enclosing
450    --  instance should ignore the current one. In that case Instance denotes
451    --  the declaration for which this is an actual. This declaration may be
452    --  an instantiation in the source, or the internal instantiation that
453    --  corresponds to the actual for a formal package.
454
455    function Earlier (N1, N2 : Node_Id) return Boolean;
456    --  Yields True if N1 and N2 appear in the same compilation unit,
457    --  ignoring subunits, and if N1 is to the left of N2 in a left-to-right
458    --  traversal of the tree for the unit. Used to determine the placement
459    --  of freeze nodes for instance bodies that may depend on other instances.
460
461    function Find_Actual_Type
462      (Typ       : Entity_Id;
463       Gen_Type  : Entity_Id) return Entity_Id;
464    --  When validating the actual types of a child instance, check whether
465    --  the formal is a formal type of the parent unit, and retrieve the current
466    --  actual for it. Typ is the entity in the analyzed formal type declaration
467    --  (component or index type of an array type, or designated type of an
468    --  access formal) and Gen_Type is the enclosing analyzed formal array
469    --  or access type. The desired actual may be a formal of a parent, or may
470    --  be declared in a formal package of a parent. In both cases it is a
471    --  generic actual type because it appears within a visible instance.
472    --  Finally, it may be declared in a parent unit without being a formal
473    --  of that unit, in which case it must be retrieved by visibility.
474    --  Ambiguities may still arise if two homonyms are declared in two formal
475    --  packages, and the prefix of the formal type may be needed to resolve
476    --  the ambiguity in the instance ???
477
478    function In_Same_Declarative_Part
479      (F_Node : Node_Id;
480       Inst   : Node_Id) return Boolean;
481    --  True if the instantiation Inst and the given freeze_node F_Node appear
482    --  within the same declarative part, ignoring subunits, but with no inter-
483    --  vening subprograms or concurrent units. Used to find the proper plave
484    --  for the freeze node of an instance, when the generic is declared in a
485    --  previous instance. If predicate is true, the freeze node of the instance
486    --  can be placed after the freeze node of the previous instance, Otherwise
487    --  it has to be placed at the end of the current declarative part.
488
489    function In_Main_Context (E : Entity_Id) return Boolean;
490    --  Check whether an instantiation is in the context of the main unit.
491    --  Used to determine whether its body should be elaborated to allow
492    --  front-end inlining.
493
494    procedure Set_Instance_Env
495      (Gen_Unit : Entity_Id;
496       Act_Unit : Entity_Id);
497    --  Save current instance on saved environment, to be used to determine
498    --  the global status of entities in nested instances. Part of Save_Env.
499    --  called after verifying that the generic unit is legal for the instance,
500    --  The procedure also examines whether the generic unit is a predefined
501    --  unit, in order to set configuration switches accordingly. As a result
502    --  the procedure must be called after analyzing and freezing the actuals.
503
504    procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
505    --  Associate analyzed generic parameter with corresponding
506    --  instance. Used for semantic checks at instantiation time.
507
508    function Has_Been_Exchanged (E : Entity_Id) return Boolean;
509    --  Traverse the Exchanged_Views list to see if a type was private
510    --  and has already been flipped during this phase of instantiation.
511
512    procedure Hide_Current_Scope;
513    --  When instantiating a generic child unit, the parent context must be
514    --  present, but the instance and all entities that may be generated
515    --  must be inserted in the current scope. We leave the current scope
516    --  on the stack, but make its entities invisible to avoid visibility
517    --  problems. This is reversed at the end of the instantiation. This is
518    --  not done for the instantiation of the bodies, which only require the
519    --  instances of the generic parents to be in scope.
520
521    procedure Install_Body
522      (Act_Body : Node_Id;
523       N        : Node_Id;
524       Gen_Body : Node_Id;
525       Gen_Decl : Node_Id);
526    --  If the instantiation happens textually before the body of the generic,
527    --  the instantiation of the body must be analyzed after the generic body,
528    --  and not at the point of instantiation. Such early instantiations can
529    --  happen if the generic and the instance appear in  a package declaration
530    --  because the generic body can only appear in the corresponding package
531    --  body. Early instantiations can also appear if generic, instance and
532    --  body are all in the declarative part of a subprogram or entry. Entities
533    --  of packages that are early instantiations are delayed, and their freeze
534    --  node appears after the generic body.
535
536    procedure Insert_Freeze_Node_For_Instance
537      (N      : Node_Id;
538       F_Node : Node_Id);
539    --  N denotes a package or a subprogram instantiation and F_Node is the
540    --  associated freeze node. Insert the freeze node before the first source
541    --  body which follows immediately after N. If no such body is found, the
542    --  freeze node is inserted at the end of the declarative region which
543    --  contains N.
544
545    procedure Freeze_Subprogram_Body
546      (Inst_Node : Node_Id;
547       Gen_Body  : Node_Id;
548       Pack_Id   : Entity_Id);
549    --  The generic body may appear textually after the instance, including
550    --  in the proper body of a stub, or within a different package instance.
551    --  Given that the instance can only be elaborated after the generic, we
552    --  place freeze_nodes for the instance and/or for packages that may enclose
553    --  the instance and the generic, so that the back-end can establish the
554    --  proper order of elaboration.
555
556    procedure Init_Env;
557    --  Establish environment for subsequent instantiation. Separated from
558    --  Save_Env because data-structures for visibility handling must be
559    --  initialized before call to Check_Generic_Child_Unit.
560
561    procedure Install_Formal_Packages (Par : Entity_Id);
562    --  Install the visible part of any formal of the parent that is a formal
563    --  package. Note that for the case of a formal package with a box, this
564    --  includes the formal part of the formal package (12.7(10/2)).
565
566    procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
567    --  When compiling an instance of a child unit the parent (which is
568    --  itself an instance) is an enclosing scope that must be made
569    --  immediately visible. This procedure is also used to install the non-
570    --  generic parent of a generic child unit when compiling its body, so
571    --  that full views of types in the parent are made visible.
572
573    procedure Remove_Parent (In_Body : Boolean := False);
574    --  Reverse effect after instantiation of child is complete
575
576    procedure Install_Hidden_Primitives
577      (Prims_List : in out Elist_Id;
578       Gen_T      : Entity_Id;
579       Act_T      : Entity_Id);
580    --  Remove suffix 'P' from hidden primitives of Act_T to match the
581    --  visibility of primitives of Gen_T. The list of primitives to which
582    --  the suffix is removed is added to Prims_List to restore them later.
583
584    procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
585    --  Restore suffix 'P' to primitives of Prims_List and leave Prims_List
586    --  set to No_Elist.
587
588    procedure Inline_Instance_Body
589      (N        : Node_Id;
590       Gen_Unit : Entity_Id;
591       Act_Decl : Node_Id);
592    --  If front-end inlining is requested, instantiate the package body,
593    --  and preserve the visibility of its compilation unit, to insure
594    --  that successive instantiations succeed.
595
596    --  The functions Instantiate_XXX perform various legality checks and build
597    --  the declarations for instantiated generic parameters. In all of these
598    --  Formal is the entity in the generic unit, Actual is the entity of
599    --  expression in the generic associations, and Analyzed_Formal is the
600    --  formal in the generic copy, which contains the semantic information to
601    --  be used to validate the actual.
602
603    function Instantiate_Object
604      (Formal          : Node_Id;
605       Actual          : Node_Id;
606       Analyzed_Formal : Node_Id) return List_Id;
607
608    function Instantiate_Type
609      (Formal          : Node_Id;
610       Actual          : Node_Id;
611       Analyzed_Formal : Node_Id;
612       Actual_Decls    : List_Id) return List_Id;
613
614    function Instantiate_Formal_Subprogram
615      (Formal          : Node_Id;
616       Actual          : Node_Id;
617       Analyzed_Formal : Node_Id) return Node_Id;
618
619    function Instantiate_Formal_Package
620      (Formal          : Node_Id;
621       Actual          : Node_Id;
622       Analyzed_Formal : Node_Id) return List_Id;
623    --  If the formal package is declared with a box, special visibility rules
624    --  apply to its formals: they are in the visible part of the package. This
625    --  is true in the declarative region of the formal package, that is to say
626    --  in the enclosing generic or instantiation. For an instantiation, the
627    --  parameters of the formal package are made visible in an explicit step.
628    --  Furthermore, if the actual has a visible USE clause, these formals must
629    --  be made potentially use-visible as well. On exit from the enclosing
630    --  instantiation, the reverse must be done.
631
632    --  For a formal package declared without a box, there are conformance rules
633    --  that apply to the actuals in the generic declaration and the actuals of
634    --  the actual package in the enclosing instantiation. The simplest way to
635    --  apply these rules is to repeat the instantiation of the formal package
636    --  in the context of the enclosing instance, and compare the generic
637    --  associations of this instantiation with those of the actual package.
638    --  This internal instantiation only needs to contain the renamings of the
639    --  formals: the visible and private declarations themselves need not be
640    --  created.
641
642    --  In Ada 2005, the formal package may be only partially parameterized.
643    --  In that case the visibility step must make visible those actuals whose
644    --  corresponding formals were given with a box. A final complication
645    --  involves inherited operations from formal derived types, which must
646    --  be visible if the type is.
647
648    function Is_In_Main_Unit (N : Node_Id) return Boolean;
649    --  Test if given node is in the main unit
650
651    procedure Load_Parent_Of_Generic
652      (N             : Node_Id;
653       Spec          : Node_Id;
654       Body_Optional : Boolean := False);
655    --  If the generic appears in a separate non-generic library unit, load the
656    --  corresponding body to retrieve the body of the generic. N is the node
657    --  for the generic instantiation, Spec is the generic package declaration.
658    --
659    --  Body_Optional is a flag that indicates that the body is being loaded to
660    --  ensure that temporaries are generated consistently when there are other
661    --  instances in the current declarative part that precede the one being
662    --  loaded. In that case a missing body is acceptable.
663
664    procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
665    --  Add the context clause of the unit containing a generic unit to a
666    --  compilation unit that is, or contains, an instantiation.
667
668    function Get_Associated_Node (N : Node_Id) return Node_Id;
669    --  In order to propagate semantic information back from the analyzed copy
670    --  to the original generic, we maintain links between selected nodes in the
671    --  generic and their corresponding copies. At the end of generic analysis,
672    --  the routine Save_Global_References traverses the generic tree, examines
673    --  the semantic information, and preserves the links to those nodes that
674    --  contain global information. At instantiation, the information from the
675    --  associated node is placed on the new copy, so that name resolution is
676    --  not repeated.
677    --
678    --  Three kinds of source nodes have associated nodes:
679    --
680    --    a) those that can reference (denote) entities, that is identifiers,
681    --       character literals, expanded_names, operator symbols, operators,
682    --       and attribute reference nodes. These nodes have an Entity field
683    --       and are the set of nodes that are in N_Has_Entity.
684    --
685    --    b) aggregates (N_Aggregate and N_Extension_Aggregate)
686    --
687    --    c) selected components (N_Selected_Component)
688    --
689    --  For the first class, the associated node preserves the entity if it is
690    --  global. If the generic contains nested instantiations, the associated
691    --  node itself has been recopied, and a chain of them must be followed.
692    --
693    --  For aggregates, the associated node allows retrieval of the type, which
694    --  may otherwise not appear in the generic. The view of this type may be
695    --  different between generic and instantiation, and the full view can be
696    --  installed before the instantiation is analyzed. For aggregates of type
697    --  extensions, the same view exchange may have to be performed for some of
698    --  the ancestor types, if their view is private at the point of
699    --  instantiation.
700    --
701    --  Nodes that are selected components in the parse tree may be rewritten
702    --  as expanded names after resolution, and must be treated as potential
703    --  entity holders, which is why they also have an Associated_Node.
704    --
705    --  Nodes that do not come from source, such as freeze nodes, do not appear
706    --  in the generic tree, and need not have an associated node.
707    --
708    --  The associated node is stored in the Associated_Node field. Note that
709    --  this field overlaps Entity, which is fine, because the whole point is
710    --  that we don't need or want the normal Entity field in this situation.
711
712    procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
713    --  Within the generic part, entities in the formal package are
714    --  visible. To validate subsequent type declarations, indicate
715    --  the correspondence between the entities in the analyzed formal,
716    --  and the entities in  the actual package. There are three packages
717    --  involved in the instantiation of a formal package: the parent
718    --  generic P1 which appears in the generic declaration, the fake
719    --  instantiation P2 which appears in the analyzed generic, and whose
720    --  visible entities may be used in subsequent formals, and the actual
721    --  P3 in the instance. To validate subsequent formals, me indicate
722    --  that the entities in P2 are mapped into those of P3. The mapping of
723    --  entities has to be done recursively for nested packages.
724
725    procedure Move_Freeze_Nodes
726      (Out_Of : Entity_Id;
727       After  : Node_Id;
728       L      : List_Id);
729    --  Freeze nodes can be generated in the analysis of a generic unit, but
730    --  will not be seen by the back-end. It is necessary to move those nodes
731    --  to the enclosing scope if they freeze an outer entity. We place them
732    --  at the end of the enclosing generic package, which is semantically
733    --  neutral.
734
735    procedure Preanalyze_Actuals (N : Node_Id);
736    --  Analyze actuals to perform name resolution. Full resolution is done
737    --  later, when the expected types are known, but names have to be captured
738    --  before installing parents of generics, that are not visible for the
739    --  actuals themselves.
740
741    function True_Parent (N : Node_Id) return Node_Id;
742    --  For a subunit, return parent of corresponding stub, else return
743    --  parent of node.
744
745    procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
746    --  Verify that an attribute that appears as the default for a formal
747    --  subprogram is a function or procedure with the correct profile.
748
749    -------------------------------------------
750    -- Data Structures for Generic Renamings --
751    -------------------------------------------
752
753    --  The map Generic_Renamings associates generic entities with their
754    --  corresponding actuals. Currently used to validate type instances. It
755    --  will eventually be used for all generic parameters to eliminate the
756    --  need for overload resolution in the instance.
757
758    type Assoc_Ptr is new Int;
759
760    Assoc_Null : constant Assoc_Ptr := -1;
761
762    type Assoc is record
763       Gen_Id         : Entity_Id;
764       Act_Id         : Entity_Id;
765       Next_In_HTable : Assoc_Ptr;
766    end record;
767
768    package Generic_Renamings is new Table.Table
769      (Table_Component_Type => Assoc,
770       Table_Index_Type     => Assoc_Ptr,
771       Table_Low_Bound      => 0,
772       Table_Initial        => 10,
773       Table_Increment      => 100,
774       Table_Name           => "Generic_Renamings");
775
776    --  Variable to hold enclosing instantiation. When the environment is
777    --  saved for a subprogram inlining, the corresponding Act_Id is empty.
778
779    Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
780
781    --  Hash table for associations
782
783    HTable_Size : constant := 37;
784    type HTable_Range is range 0 .. HTable_Size - 1;
785
786    procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
787    function  Next_Assoc     (E : Assoc_Ptr) return Assoc_Ptr;
788    function Get_Gen_Id      (E : Assoc_Ptr) return Entity_Id;
789    function Hash            (F : Entity_Id) return HTable_Range;
790
791    package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
792       Header_Num => HTable_Range,
793       Element    => Assoc,
794       Elmt_Ptr   => Assoc_Ptr,
795       Null_Ptr   => Assoc_Null,
796       Set_Next   => Set_Next_Assoc,
797       Next       => Next_Assoc,
798       Key        => Entity_Id,
799       Get_Key    => Get_Gen_Id,
800       Hash       => Hash,
801       Equal      => "=");
802
803    Exchanged_Views : Elist_Id;
804    --  This list holds the private views that have been exchanged during
805    --  instantiation to restore the visibility of the generic declaration.
806    --  (see comments above). After instantiation, the current visibility is
807    --  reestablished by means of a traversal of this list.
808
809    Hidden_Entities : Elist_Id;
810    --  This list holds the entities of the current scope that are removed
811    --  from immediate visibility when instantiating a child unit. Their
812    --  visibility is restored in Remove_Parent.
813
814    --  Because instantiations can be recursive, the following must be saved
815    --  on entry and restored on exit from an instantiation (spec or body).
816    --  This is done by the two procedures Save_Env and Restore_Env. For
817    --  package and subprogram instantiations (but not for the body instances)
818    --  the action of Save_Env is done in two steps: Init_Env is called before
819    --  Check_Generic_Child_Unit, because setting the parent instances requires
820    --  that the visibility data structures be properly initialized. Once the
821    --  generic is unit is validated, Set_Instance_Env completes Save_Env.
822
823    Parent_Unit_Visible : Boolean := False;
824    --  Parent_Unit_Visible is used when the generic is a child unit, and
825    --  indicates whether the ultimate parent of the generic is visible in the
826    --  instantiation environment. It is used to reset the visibility of the
827    --  parent at the end of the instantiation (see Remove_Parent).
828
829    Instance_Parent_Unit : Entity_Id := Empty;
830    --  This records the ultimate parent unit of an instance of a generic
831    --  child unit and is used in conjunction with Parent_Unit_Visible to
832    --  indicate the unit to which the Parent_Unit_Visible flag corresponds.
833
834    type Instance_Env is record
835       Instantiated_Parent  : Assoc;
836       Exchanged_Views      : Elist_Id;
837       Hidden_Entities      : Elist_Id;
838       Current_Sem_Unit     : Unit_Number_Type;
839       Parent_Unit_Visible  : Boolean   := False;
840       Instance_Parent_Unit : Entity_Id := Empty;
841       Switches             : Config_Switches_Type;
842    end record;
843
844    package Instance_Envs is new Table.Table (
845      Table_Component_Type => Instance_Env,
846      Table_Index_Type     => Int,
847      Table_Low_Bound      => 0,
848      Table_Initial        => 32,
849      Table_Increment      => 100,
850      Table_Name           => "Instance_Envs");
851
852    procedure Restore_Private_Views
853      (Pack_Id    : Entity_Id;
854       Is_Package : Boolean := True);
855    --  Restore the private views of external types, and unmark the generic
856    --  renamings of actuals, so that they become compatible subtypes again.
857    --  For subprograms, Pack_Id is the package constructed to hold the
858    --  renamings.
859
860    procedure Switch_View (T : Entity_Id);
861    --  Switch the partial and full views of a type and its private
862    --  dependents (i.e. its subtypes and derived types).
863
864    ------------------------------------
865    -- Structures for Error Reporting --
866    ------------------------------------
867
868    Instantiation_Node : Node_Id;
869    --  Used by subprograms that validate instantiation of formal parameters
870    --  where there might be no actual on which to place the error message.
871    --  Also used to locate the instantiation node for generic subunits.
872
873    Instantiation_Error : exception;
874    --  When there is a semantic error in the generic parameter matching,
875    --  there is no point in continuing the instantiation, because the
876    --  number of cascaded errors is unpredictable. This exception aborts
877    --  the instantiation process altogether.
878
879    S_Adjustment : Sloc_Adjustment;
880    --  Offset created for each node in an instantiation, in order to keep
881    --  track of the source position of the instantiation in each of its nodes.
882    --  A subsequent semantic error or warning on a construct of the instance
883    --  points to both places: the original generic node, and the point of
884    --  instantiation. See Sinput and Sinput.L for additional details.
885
886    ------------------------------------------------------------
887    -- Data structure for keeping track when inside a Generic --
888    ------------------------------------------------------------
889
890    --  The following table is used to save values of the Inside_A_Generic
891    --  flag (see spec of Sem) when they are saved by Start_Generic.
892
893    package Generic_Flags is new Table.Table (
894      Table_Component_Type => Boolean,
895      Table_Index_Type     => Int,
896      Table_Low_Bound      => 0,
897      Table_Initial        => 32,
898      Table_Increment      => 200,
899      Table_Name           => "Generic_Flags");
900
901    ---------------------------
902    -- Abandon_Instantiation --
903    ---------------------------
904
905    procedure Abandon_Instantiation (N : Node_Id) is
906    begin
907       Error_Msg_N ("\instantiation abandoned!", N);
908       raise Instantiation_Error;
909    end Abandon_Instantiation;
910
911    --------------------------
912    -- Analyze_Associations --
913    --------------------------
914
915    function Analyze_Associations
916      (I_Node  : Node_Id;
917       Formals : List_Id;
918       F_Copy  : List_Id) return List_Id
919    is
920       Actuals_To_Freeze : constant Elist_Id  := New_Elmt_List;
921       Assoc             : constant List_Id   := New_List;
922       Default_Actuals   : constant Elist_Id  := New_Elmt_List;
923       Gen_Unit          : constant Entity_Id :=
924                             Defining_Entity (Parent (F_Copy));
925
926       Actuals         : List_Id;
927       Actual          : Node_Id;
928       Analyzed_Formal : Node_Id;
929       First_Named     : Node_Id := Empty;
930       Formal          : Node_Id;
931       Match           : Node_Id;
932       Named           : Node_Id;
933       Saved_Formal    : Node_Id;
934
935       Default_Formals : constant List_Id := New_List;
936       --  If an Others_Choice is present, some of the formals may be defaulted.
937       --  To simplify the treatment of visibility in an instance, we introduce
938       --  individual defaults for each such formal. These defaults are
939       --  appended to the list of associations and replace the Others_Choice.
940
941       Found_Assoc : Node_Id;
942       --  Association for the current formal being match. Empty if there are
943       --  no remaining actuals, or if there is no named association with the
944       --  name of the formal.
945
946       Is_Named_Assoc : Boolean;
947       Num_Matched    : Int := 0;
948       Num_Actuals    : Int := 0;
949
950       Others_Present : Boolean := False;
951       Others_Choice  : Node_Id := Empty;
952       --  In Ada 2005, indicates partial parametrization of a formal
953       --  package. As usual an other association must be last in the list.
954
955       procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
956       --  Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
957       --  cannot have a named association for it. AI05-0025 extends this rule
958       --  to formals of formal packages by AI05-0025, and it also applies to
959       --  box-initialized formals.
960
961       function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
962       --  Determine whether the parameter types and the return type of Subp
963       --  are fully defined at the point of instantiation.
964
965       function Matching_Actual
966         (F   : Entity_Id;
967          A_F : Entity_Id) return Node_Id;
968       --  Find actual that corresponds to a given a formal parameter. If the
969       --  actuals are positional, return the next one, if any. If the actuals
970       --  are named, scan the parameter associations to find the right one.
971       --  A_F is the corresponding entity in the analyzed generic,which is
972       --  placed on the selector name for ASIS use.
973       --
974       --  In Ada 2005, a named association may be given with a box, in which
975       --  case Matching_Actual sets Found_Assoc to the generic association,
976       --  but return Empty for the actual itself. In this case the code below
977       --  creates a corresponding declaration for the formal.
978
979       function Partial_Parametrization return Boolean;
980       --  Ada 2005: if no match is found for a given formal, check if the
981       --  association for it includes a box, or whether the associations
982       --  include an Others clause.
983
984       procedure Process_Default (F : Entity_Id);
985       --  Add a copy of the declaration of generic formal  F to the list of
986       --  associations, and add an explicit box association for F  if there
987       --  is none yet, and the default comes from an Others_Choice.
988
989       function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
990       --  Determine whether Subp renames one of the subprograms defined in the
991       --  generated package Standard.
992
993       procedure Set_Analyzed_Formal;
994       --  Find the node in the generic copy that corresponds to a given formal.
995       --  The semantic information on this node is used to perform legality
996       --  checks on the actuals. Because semantic analysis can introduce some
997       --  anonymous entities or modify the declaration node itself, the
998       --  correspondence between the two lists is not one-one. In addition to
999       --  anonymous types, the presence a formal equality will introduce an
1000       --  implicit declaration for the corresponding inequality.
1001
1002       ----------------------------------------
1003       -- Check_Overloaded_Formal_Subprogram --
1004       ----------------------------------------
1005
1006       procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1007          Temp_Formal : Entity_Id;
1008
1009       begin
1010          Temp_Formal := First (Formals);
1011          while Present (Temp_Formal) loop
1012             if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1013               and then Temp_Formal /= Formal
1014               and then
1015                 Chars (Defining_Unit_Name (Specification (Formal))) =
1016                 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1017             then
1018                if Present (Found_Assoc) then
1019                   Error_Msg_N
1020                     ("named association not allowed for overloaded formal",
1021                      Found_Assoc);
1022
1023                else
1024                   Error_Msg_N
1025                     ("named association not allowed for overloaded formal",
1026                      Others_Choice);
1027                end if;
1028
1029                Abandon_Instantiation (Instantiation_Node);
1030             end if;
1031
1032             Next (Temp_Formal);
1033          end loop;
1034       end Check_Overloaded_Formal_Subprogram;
1035
1036       -------------------------------
1037       -- Has_Fully_Defined_Profile --
1038       -------------------------------
1039
1040       function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1041          function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1042          --  Determine whethet type Typ is fully defined
1043
1044          ---------------------------
1045          -- Is_Fully_Defined_Type --
1046          ---------------------------
1047
1048          function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1049          begin
1050             --  A private type without a full view is not fully defined
1051
1052             if Is_Private_Type (Typ)
1053               and then No (Full_View (Typ))
1054             then
1055                return False;
1056
1057             --  An incomplete type is never fully defined
1058
1059             elsif Is_Incomplete_Type (Typ) then
1060                return False;
1061
1062             --  All other types are fully defined
1063
1064             else
1065                return True;
1066             end if;
1067          end Is_Fully_Defined_Type;
1068
1069          --  Local declarations
1070
1071          Param : Entity_Id;
1072
1073       --  Start of processing for Has_Fully_Defined_Profile
1074
1075       begin
1076          --  Check the parameters
1077
1078          Param := First_Formal (Subp);
1079          while Present (Param) loop
1080             if not Is_Fully_Defined_Type (Etype (Param)) then
1081                return False;
1082             end if;
1083
1084             Next_Formal (Param);
1085          end loop;
1086
1087          --  Check the return type
1088
1089          return Is_Fully_Defined_Type (Etype (Subp));
1090       end Has_Fully_Defined_Profile;
1091
1092       ---------------------
1093       -- Matching_Actual --
1094       ---------------------
1095
1096       function Matching_Actual
1097         (F   : Entity_Id;
1098          A_F : Entity_Id) return Node_Id
1099       is
1100          Prev  : Node_Id;
1101          Act   : Node_Id;
1102
1103       begin
1104          Is_Named_Assoc := False;
1105
1106          --  End of list of purely positional parameters
1107
1108          if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1109             Found_Assoc := Empty;
1110             Act         := Empty;
1111
1112          --  Case of positional parameter corresponding to current formal
1113
1114          elsif No (Selector_Name (Actual)) then
1115             Found_Assoc := Actual;
1116             Act :=  Explicit_Generic_Actual_Parameter (Actual);
1117             Num_Matched := Num_Matched + 1;
1118             Next (Actual);
1119
1120          --  Otherwise scan list of named actuals to find the one with the
1121          --  desired name. All remaining actuals have explicit names.
1122
1123          else
1124             Is_Named_Assoc := True;
1125             Found_Assoc := Empty;
1126             Act         := Empty;
1127             Prev        := Empty;
1128
1129             while Present (Actual) loop
1130                if Chars (Selector_Name (Actual)) = Chars (F) then
1131                   Set_Entity (Selector_Name (Actual), A_F);
1132                   Set_Etype  (Selector_Name (Actual), Etype (A_F));
1133                   Generate_Reference (A_F, Selector_Name (Actual));
1134                   Found_Assoc := Actual;
1135                   Act :=  Explicit_Generic_Actual_Parameter (Actual);
1136                   Num_Matched := Num_Matched + 1;
1137                   exit;
1138                end if;
1139
1140                Prev := Actual;
1141                Next (Actual);
1142             end loop;
1143
1144             --  Reset for subsequent searches. In most cases the named
1145             --  associations are in order. If they are not, we reorder them
1146             --  to avoid scanning twice the same actual. This is not just a
1147             --  question of efficiency: there may be multiple defaults with
1148             --  boxes that have the same name. In a nested instantiation we
1149             --  insert actuals for those defaults, and cannot rely on their
1150             --  names to disambiguate them.
1151
1152             if Actual = First_Named  then
1153                Next (First_Named);
1154
1155             elsif Present (Actual) then
1156                Insert_Before (First_Named, Remove_Next (Prev));
1157             end if;
1158
1159             Actual := First_Named;
1160          end if;
1161
1162          if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1163             Set_Used_As_Generic_Actual (Entity (Act));
1164          end if;
1165
1166          return Act;
1167       end Matching_Actual;
1168
1169       -----------------------------
1170       -- Partial_Parametrization --
1171       -----------------------------
1172
1173       function Partial_Parametrization return Boolean is
1174       begin
1175          return Others_Present
1176           or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1177       end Partial_Parametrization;
1178
1179       ---------------------
1180       -- Process_Default --
1181       ---------------------
1182
1183       procedure Process_Default (F : Entity_Id)  is
1184          Loc     : constant Source_Ptr := Sloc (I_Node);
1185          F_Id    : constant Entity_Id  := Defining_Entity (F);
1186          Decl    : Node_Id;
1187          Default : Node_Id;
1188          Id      : Entity_Id;
1189
1190       begin
1191          --  Append copy of formal declaration to associations, and create new
1192          --  defining identifier for it.
1193
1194          Decl := New_Copy_Tree (F);
1195          Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1196
1197          if Nkind (F) in N_Formal_Subprogram_Declaration then
1198             Set_Defining_Unit_Name (Specification (Decl), Id);
1199
1200          else
1201             Set_Defining_Identifier (Decl, Id);
1202          end if;
1203
1204          Append (Decl, Assoc);
1205
1206          if No (Found_Assoc) then
1207             Default :=
1208                Make_Generic_Association (Loc,
1209                  Selector_Name => New_Occurrence_Of (Id, Loc),
1210                  Explicit_Generic_Actual_Parameter => Empty);
1211             Set_Box_Present (Default);
1212             Append (Default, Default_Formals);
1213          end if;
1214       end Process_Default;
1215
1216       ---------------------------------
1217       -- Renames_Standard_Subprogram --
1218       ---------------------------------
1219
1220       function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1221          Id : Entity_Id;
1222
1223       begin
1224          Id := Alias (Subp);
1225          while Present (Id) loop
1226             if Scope (Id) = Standard_Standard then
1227                return True;
1228             end if;
1229
1230             Id := Alias (Id);
1231          end loop;
1232
1233          return False;
1234       end Renames_Standard_Subprogram;
1235
1236       -------------------------
1237       -- Set_Analyzed_Formal --
1238       -------------------------
1239
1240       procedure Set_Analyzed_Formal is
1241          Kind : Node_Kind;
1242
1243       begin
1244          while Present (Analyzed_Formal) loop
1245             Kind := Nkind (Analyzed_Formal);
1246
1247             case Nkind (Formal) is
1248
1249                when N_Formal_Subprogram_Declaration =>
1250                   exit when Kind in N_Formal_Subprogram_Declaration
1251                     and then
1252                       Chars
1253                         (Defining_Unit_Name (Specification (Formal))) =
1254                       Chars
1255                         (Defining_Unit_Name (Specification (Analyzed_Formal)));
1256
1257                when N_Formal_Package_Declaration =>
1258                   exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1259                                             N_Generic_Package_Declaration,
1260                                             N_Package_Declaration);
1261
1262                when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1263
1264                when others =>
1265
1266                   --  Skip freeze nodes, and nodes inserted to replace
1267                   --  unrecognized pragmas.
1268
1269                   exit when
1270                     Kind not in N_Formal_Subprogram_Declaration
1271                       and then not Nkind_In (Kind, N_Subprogram_Declaration,
1272                                                    N_Freeze_Entity,
1273                                                    N_Null_Statement,
1274                                                    N_Itype_Reference)
1275                       and then Chars (Defining_Identifier (Formal)) =
1276                                Chars (Defining_Identifier (Analyzed_Formal));
1277             end case;
1278
1279             Next (Analyzed_Formal);
1280          end loop;
1281       end Set_Analyzed_Formal;
1282
1283    --  Start of processing for Analyze_Associations
1284
1285    begin
1286       Actuals := Generic_Associations (I_Node);
1287
1288       if Present (Actuals) then
1289
1290          --  Check for an Others choice, indicating a partial parametrization
1291          --  for a formal package.
1292
1293          Actual := First (Actuals);
1294          while Present (Actual) loop
1295             if Nkind (Actual) = N_Others_Choice then
1296                Others_Present := True;
1297                Others_Choice  := Actual;
1298
1299                if Present (Next (Actual)) then
1300                   Error_Msg_N ("others must be last association", Actual);
1301                end if;
1302
1303                --  This subprogram is used both for formal packages and for
1304                --  instantiations. For the latter, associations must all be
1305                --  explicit.
1306
1307                if Nkind (I_Node) /= N_Formal_Package_Declaration
1308                  and then Comes_From_Source (I_Node)
1309                then
1310                   Error_Msg_N
1311                     ("others association not allowed in an instance",
1312                       Actual);
1313                end if;
1314
1315                --  In any case, nothing to do after the others association
1316
1317                exit;
1318
1319             elsif Box_Present (Actual)
1320               and then Comes_From_Source (I_Node)
1321               and then Nkind (I_Node) /= N_Formal_Package_Declaration
1322             then
1323                Error_Msg_N
1324                  ("box association not allowed in an instance", Actual);
1325             end if;
1326
1327             Next (Actual);
1328          end loop;
1329
1330          --  If named associations are present, save first named association
1331          --  (it may of course be Empty) to facilitate subsequent name search.
1332
1333          First_Named := First (Actuals);
1334          while Present (First_Named)
1335            and then Nkind (First_Named) /= N_Others_Choice
1336            and then No (Selector_Name (First_Named))
1337          loop
1338             Num_Actuals := Num_Actuals + 1;
1339             Next (First_Named);
1340          end loop;
1341       end if;
1342
1343       Named := First_Named;
1344       while Present (Named) loop
1345          if Nkind (Named) /= N_Others_Choice
1346            and then No (Selector_Name (Named))
1347          then
1348             Error_Msg_N ("invalid positional actual after named one", Named);
1349             Abandon_Instantiation (Named);
1350          end if;
1351
1352          --  A named association may lack an actual parameter, if it was
1353          --  introduced for a default subprogram that turns out to be local
1354          --  to the outer instantiation.
1355
1356          if Nkind (Named) /= N_Others_Choice
1357            and then Present (Explicit_Generic_Actual_Parameter (Named))
1358          then
1359             Num_Actuals := Num_Actuals + 1;
1360          end if;
1361
1362          Next (Named);
1363       end loop;
1364
1365       if Present (Formals) then
1366          Formal := First_Non_Pragma (Formals);
1367          Analyzed_Formal := First_Non_Pragma (F_Copy);
1368
1369          if Present (Actuals) then
1370             Actual := First (Actuals);
1371
1372          --  All formals should have default values
1373
1374          else
1375             Actual := Empty;
1376          end if;
1377
1378          while Present (Formal) loop
1379             Set_Analyzed_Formal;
1380             Saved_Formal := Next_Non_Pragma (Formal);
1381
1382             case Nkind (Formal) is
1383                when N_Formal_Object_Declaration =>
1384                   Match :=
1385                     Matching_Actual (
1386                       Defining_Identifier (Formal),
1387                       Defining_Identifier (Analyzed_Formal));
1388
1389                   if No (Match) and then Partial_Parametrization then
1390                      Process_Default (Formal);
1391                   else
1392                      Append_List
1393                        (Instantiate_Object (Formal, Match, Analyzed_Formal),
1394                         Assoc);
1395                   end if;
1396
1397                when N_Formal_Type_Declaration =>
1398                   Match :=
1399                     Matching_Actual (
1400                       Defining_Identifier (Formal),
1401                       Defining_Identifier (Analyzed_Formal));
1402
1403                   if No (Match) then
1404                      if Partial_Parametrization then
1405                         Process_Default (Formal);
1406
1407                      else
1408                         Error_Msg_Sloc := Sloc (Gen_Unit);
1409                         Error_Msg_NE
1410                           ("missing actual&",
1411                             Instantiation_Node,
1412                               Defining_Identifier (Formal));
1413                         Error_Msg_NE ("\in instantiation of & declared#",
1414                             Instantiation_Node, Gen_Unit);
1415                         Abandon_Instantiation (Instantiation_Node);
1416                      end if;
1417
1418                   else
1419                      Analyze (Match);
1420                      Append_List
1421                        (Instantiate_Type
1422                           (Formal, Match, Analyzed_Formal, Assoc),
1423                         Assoc);
1424
1425                      --  An instantiation is a freeze point for the actuals,
1426                      --  unless this is a rewritten formal package, or the
1427                      --  formal is an Ada 2012 formal incomplete type.
1428
1429                      if Nkind (I_Node) = N_Formal_Package_Declaration
1430                        or else
1431                          (Ada_Version >= Ada_2012
1432                            and then
1433                              Ekind (Defining_Identifier (Analyzed_Formal)) =
1434                                                             E_Incomplete_Type)
1435                      then
1436                         null;
1437
1438                      else
1439                         Append_Elmt (Entity (Match), Actuals_To_Freeze);
1440                      end if;
1441                   end if;
1442
1443                   --  A remote access-to-class-wide type is not a legal actual
1444                   --  for a generic formal of an access type (E.2.2(17)).
1445
1446                   if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1447                     and then
1448                       Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1449                                             N_Access_To_Object_Definition
1450                   then
1451                      Validate_Remote_Access_To_Class_Wide_Type (Match);
1452                   end if;
1453
1454                when N_Formal_Subprogram_Declaration =>
1455                   Match :=
1456                     Matching_Actual
1457                       (Defining_Unit_Name (Specification (Formal)),
1458                        Defining_Unit_Name (Specification (Analyzed_Formal)));
1459
1460                   --  If the formal subprogram has the same name as another
1461                   --  formal subprogram of the generic, then a named
1462                   --  association is illegal (12.3(9)). Exclude named
1463                   --  associations that are generated for a nested instance.
1464
1465                   if Present (Match)
1466                     and then Is_Named_Assoc
1467                     and then Comes_From_Source (Found_Assoc)
1468                   then
1469                      Check_Overloaded_Formal_Subprogram (Formal);
1470                   end if;
1471
1472                   --  If there is no corresponding actual, this may be case of
1473                   --  partial parametrization, or else the formal has a default
1474                   --  or a box.
1475
1476                   if No (Match) and then Partial_Parametrization then
1477                      Process_Default (Formal);
1478
1479                      if Nkind (I_Node) = N_Formal_Package_Declaration then
1480                         Check_Overloaded_Formal_Subprogram (Formal);
1481                      end if;
1482
1483                   else
1484                      Append_To (Assoc,
1485                        Instantiate_Formal_Subprogram
1486                          (Formal, Match, Analyzed_Formal));
1487
1488                      --  An instantiation is a freeze point for the actuals,
1489                      --  unless this is a rewritten formal package.
1490
1491                      if Nkind (I_Node) /= N_Formal_Package_Declaration
1492                        and then Nkind (Match) = N_Identifier
1493                        and then Is_Subprogram (Entity (Match))
1494
1495                        --  The actual subprogram may rename a routine defined
1496                        --  in Standard. Avoid freezing such renamings because
1497                        --  subprograms coming from Standard cannot be frozen.
1498
1499                        and then
1500                          not Renames_Standard_Subprogram (Entity (Match))
1501
1502                        --  If the actual subprogram comes from a different
1503                        --  unit, it is already frozen, either by a body in
1504                        --  that unit or by the end of the declarative part
1505                        --  of the unit. This check avoids the freezing of
1506                        --  subprograms defined in Standard which are used
1507                        --  as generic actuals.
1508
1509                        and then In_Same_Code_Unit (Entity (Match), I_Node)
1510                        and then Has_Fully_Defined_Profile (Entity (Match))
1511                      then
1512                         --  Mark the subprogram as having a delayed freeze
1513                         --  since this may be an out-of-order action.
1514
1515                         Set_Has_Delayed_Freeze (Entity (Match));
1516                         Append_Elmt (Entity (Match), Actuals_To_Freeze);
1517                      end if;
1518                   end if;
1519
1520                   --  If this is a nested generic, preserve default for later
1521                   --  instantiations.
1522
1523                   if No (Match)
1524                     and then Box_Present (Formal)
1525                   then
1526                      Append_Elmt
1527                        (Defining_Unit_Name (Specification (Last (Assoc))),
1528                         Default_Actuals);
1529                   end if;
1530
1531                when N_Formal_Package_Declaration =>
1532                   Match :=
1533                     Matching_Actual (
1534                       Defining_Identifier (Formal),
1535                       Defining_Identifier (Original_Node (Analyzed_Formal)));
1536
1537                   if No (Match) then
1538                      if Partial_Parametrization then
1539                         Process_Default (Formal);
1540
1541                      else
1542                         Error_Msg_Sloc := Sloc (Gen_Unit);
1543                         Error_Msg_NE
1544                           ("missing actual&",
1545                             Instantiation_Node, Defining_Identifier (Formal));
1546                         Error_Msg_NE ("\in instantiation of & declared#",
1547                             Instantiation_Node, Gen_Unit);
1548
1549                         Abandon_Instantiation (Instantiation_Node);
1550                      end if;
1551
1552                   else
1553                      Analyze (Match);
1554                      Append_List
1555                        (Instantiate_Formal_Package
1556                          (Formal, Match, Analyzed_Formal),
1557                         Assoc);
1558                   end if;
1559
1560                --  For use type and use package appearing in the generic part,
1561                --  we have already copied them, so we can just move them where
1562                --  they belong (we mustn't recopy them since this would mess up
1563                --  the Sloc values).
1564
1565                when N_Use_Package_Clause |
1566                     N_Use_Type_Clause    =>
1567                   if Nkind (Original_Node (I_Node)) =
1568                                      N_Formal_Package_Declaration
1569                   then
1570                      Append (New_Copy_Tree (Formal), Assoc);
1571                   else
1572                      Remove (Formal);
1573                      Append (Formal, Assoc);
1574                   end if;
1575
1576                when others =>
1577                   raise Program_Error;
1578
1579             end case;
1580
1581             Formal := Saved_Formal;
1582             Next_Non_Pragma (Analyzed_Formal);
1583          end loop;
1584
1585          if Num_Actuals > Num_Matched then
1586             Error_Msg_Sloc := Sloc (Gen_Unit);
1587
1588             if Present (Selector_Name (Actual)) then
1589                Error_Msg_NE
1590                  ("unmatched actual&",
1591                     Actual, Selector_Name (Actual));
1592                Error_Msg_NE ("\in instantiation of& declared#",
1593                     Actual, Gen_Unit);
1594             else
1595                Error_Msg_NE
1596                  ("unmatched actual in instantiation of& declared#",
1597                    Actual, Gen_Unit);
1598             end if;
1599          end if;
1600
1601       elsif Present (Actuals) then
1602          Error_Msg_N
1603            ("too many actuals in generic instantiation", Instantiation_Node);
1604       end if;
1605
1606       --  An instantiation freezes all generic actuals. The only exceptions
1607       --  to this are incomplete types and subprograms which are not fully
1608       --  defined at the point of instantiation.
1609
1610       declare
1611          Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1612       begin
1613          while Present (Elmt) loop
1614             Freeze_Before (I_Node, Node (Elmt));
1615             Next_Elmt (Elmt);
1616          end loop;
1617       end;
1618
1619       --  If there are default subprograms, normalize the tree by adding
1620       --  explicit associations for them. This is required if the instance
1621       --  appears within a generic.
1622
1623       declare
1624          Elmt  : Elmt_Id;
1625          Subp  : Entity_Id;
1626          New_D : Node_Id;
1627
1628       begin
1629          Elmt := First_Elmt (Default_Actuals);
1630          while Present (Elmt) loop
1631             if No (Actuals) then
1632                Actuals := New_List;
1633                Set_Generic_Associations (I_Node, Actuals);
1634             end if;
1635
1636             Subp := Node (Elmt);
1637             New_D :=
1638               Make_Generic_Association (Sloc (Subp),
1639                 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1640                   Explicit_Generic_Actual_Parameter =>
1641                     New_Occurrence_Of (Subp, Sloc (Subp)));
1642             Mark_Rewrite_Insertion (New_D);
1643             Append_To (Actuals, New_D);
1644             Next_Elmt (Elmt);
1645          end loop;
1646       end;
1647
1648       --  If this is a formal package, normalize the parameter list by adding
1649       --  explicit box associations for the formals that are covered by an
1650       --  Others_Choice.
1651
1652       if not Is_Empty_List (Default_Formals) then
1653          Append_List (Default_Formals, Formals);
1654       end if;
1655
1656       return Assoc;
1657    end Analyze_Associations;
1658
1659    -------------------------------
1660    -- Analyze_Formal_Array_Type --
1661    -------------------------------
1662
1663    procedure Analyze_Formal_Array_Type
1664      (T   : in out Entity_Id;
1665       Def : Node_Id)
1666    is
1667       DSS : Node_Id;
1668
1669    begin
1670       --  Treated like a non-generic array declaration, with additional
1671       --  semantic checks.
1672
1673       Enter_Name (T);
1674
1675       if Nkind (Def) = N_Constrained_Array_Definition then
1676          DSS := First (Discrete_Subtype_Definitions (Def));
1677          while Present (DSS) loop
1678             if Nkind_In (DSS, N_Subtype_Indication,
1679                               N_Range,
1680                               N_Attribute_Reference)
1681             then
1682                Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1683             end if;
1684
1685             Next (DSS);
1686          end loop;
1687       end if;
1688
1689       Array_Type_Declaration (T, Def);
1690       Set_Is_Generic_Type (Base_Type (T));
1691
1692       if Ekind (Component_Type (T)) = E_Incomplete_Type
1693         and then No (Full_View (Component_Type (T)))
1694       then
1695          Error_Msg_N ("premature usage of incomplete type", Def);
1696
1697       --  Check that range constraint is not allowed on the component type
1698       --  of a generic formal array type (AARM 12.5.3(3))
1699
1700       elsif Is_Internal (Component_Type (T))
1701         and then Present (Subtype_Indication (Component_Definition (Def)))
1702         and then Nkind (Original_Node
1703                          (Subtype_Indication (Component_Definition (Def)))) =
1704                                                          N_Subtype_Indication
1705       then
1706          Error_Msg_N
1707            ("in a formal, a subtype indication can only be "
1708              & "a subtype mark (RM 12.5.3(3))",
1709              Subtype_Indication (Component_Definition (Def)));
1710       end if;
1711
1712    end Analyze_Formal_Array_Type;
1713
1714    ---------------------------------------------
1715    -- Analyze_Formal_Decimal_Fixed_Point_Type --
1716    ---------------------------------------------
1717
1718    --  As for other generic types, we create a valid type representation with
1719    --  legal but arbitrary attributes, whose values are never considered
1720    --  static. For all scalar types we introduce an anonymous base type, with
1721    --  the same attributes. We choose the corresponding integer type to be
1722    --  Standard_Integer.
1723    --  Here and in other similar routines, the Sloc of the generated internal
1724    --  type must be the same as the sloc of the defining identifier of the
1725    --  formal type declaration, to provide proper source navigation.
1726
1727    procedure Analyze_Formal_Decimal_Fixed_Point_Type
1728      (T   : Entity_Id;
1729       Def : Node_Id)
1730    is
1731       Loc : constant Source_Ptr := Sloc (Def);
1732
1733       Base : constant Entity_Id :=
1734                New_Internal_Entity
1735                  (E_Decimal_Fixed_Point_Type,
1736                   Current_Scope,
1737                   Sloc (Defining_Identifier (Parent (Def))), 'G');
1738
1739       Int_Base  : constant Entity_Id := Standard_Integer;
1740       Delta_Val : constant Ureal := Ureal_1;
1741       Digs_Val  : constant Uint  := Uint_6;
1742
1743    begin
1744       Enter_Name (T);
1745
1746       Set_Etype          (Base, Base);
1747       Set_Size_Info      (Base, Int_Base);
1748       Set_RM_Size        (Base, RM_Size (Int_Base));
1749       Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1750       Set_Digits_Value   (Base, Digs_Val);
1751       Set_Delta_Value    (Base, Delta_Val);
1752       Set_Small_Value    (Base, Delta_Val);
1753       Set_Scalar_Range   (Base,
1754         Make_Range (Loc,
1755           Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
1756           High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1757
1758       Set_Is_Generic_Type (Base);
1759       Set_Parent          (Base, Parent (Def));
1760
1761       Set_Ekind          (T, E_Decimal_Fixed_Point_Subtype);
1762       Set_Etype          (T, Base);
1763       Set_Size_Info      (T, Int_Base);
1764       Set_RM_Size        (T, RM_Size (Int_Base));
1765       Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1766       Set_Digits_Value   (T, Digs_Val);
1767       Set_Delta_Value    (T, Delta_Val);
1768       Set_Small_Value    (T, Delta_Val);
1769       Set_Scalar_Range   (T, Scalar_Range (Base));
1770       Set_Is_Constrained (T);
1771
1772       Check_Restriction (No_Fixed_Point, Def);
1773    end Analyze_Formal_Decimal_Fixed_Point_Type;
1774
1775    -------------------------------------------
1776    -- Analyze_Formal_Derived_Interface_Type --
1777    -------------------------------------------
1778
1779    procedure Analyze_Formal_Derived_Interface_Type
1780      (N   : Node_Id;
1781       T   : Entity_Id;
1782       Def : Node_Id)
1783    is
1784       Loc   : constant Source_Ptr := Sloc (Def);
1785
1786    begin
1787       --  Rewrite as a type declaration of a derived type. This ensures that
1788       --  the interface list and primitive operations are properly captured.
1789
1790       Rewrite (N,
1791         Make_Full_Type_Declaration (Loc,
1792           Defining_Identifier => T,
1793           Type_Definition     => Def));
1794       Analyze (N);
1795       Set_Is_Generic_Type (T);
1796    end Analyze_Formal_Derived_Interface_Type;
1797
1798    ---------------------------------
1799    -- Analyze_Formal_Derived_Type --
1800    ---------------------------------
1801
1802    procedure Analyze_Formal_Derived_Type
1803      (N   : Node_Id;
1804       T   : Entity_Id;
1805       Def : Node_Id)
1806    is
1807       Loc      : constant Source_Ptr := Sloc (Def);
1808       Unk_Disc : constant Boolean    := Unknown_Discriminants_Present (N);
1809       New_N    : Node_Id;
1810
1811    begin
1812       Set_Is_Generic_Type (T);
1813
1814       if Private_Present (Def) then
1815          New_N :=
1816            Make_Private_Extension_Declaration (Loc,
1817              Defining_Identifier           => T,
1818              Discriminant_Specifications   => Discriminant_Specifications (N),
1819              Unknown_Discriminants_Present => Unk_Disc,
1820              Subtype_Indication            => Subtype_Mark (Def),
1821              Interface_List                => Interface_List (Def));
1822
1823          Set_Abstract_Present     (New_N, Abstract_Present     (Def));
1824          Set_Limited_Present      (New_N, Limited_Present      (Def));
1825          Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1826
1827       else
1828          New_N :=
1829            Make_Full_Type_Declaration (Loc,
1830              Defining_Identifier => T,
1831              Discriminant_Specifications =>
1832                Discriminant_Specifications (Parent (T)),
1833              Type_Definition =>
1834                Make_Derived_Type_Definition (Loc,
1835                  Subtype_Indication => Subtype_Mark (Def)));
1836
1837          Set_Abstract_Present
1838            (Type_Definition (New_N), Abstract_Present (Def));
1839          Set_Limited_Present
1840            (Type_Definition (New_N), Limited_Present  (Def));
1841       end if;
1842
1843       Rewrite (N, New_N);
1844       Analyze (N);
1845
1846       if Unk_Disc then
1847          if not Is_Composite_Type (T) then
1848             Error_Msg_N
1849               ("unknown discriminants not allowed for elementary types", N);
1850          else
1851             Set_Has_Unknown_Discriminants (T);
1852             Set_Is_Constrained (T, False);
1853          end if;
1854       end if;
1855
1856       --  If the parent type has a known size, so does the formal, which makes
1857       --  legal representation clauses that involve the formal.
1858
1859       Set_Size_Known_At_Compile_Time
1860         (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1861    end Analyze_Formal_Derived_Type;
1862
1863    ----------------------------------
1864    -- Analyze_Formal_Discrete_Type --
1865    ----------------------------------
1866
1867    --  The operations defined for a discrete types are those of an enumeration
1868    --  type. The size is set to an arbitrary value, for use in analyzing the
1869    --  generic unit.
1870
1871    procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1872       Loc : constant Source_Ptr := Sloc (Def);
1873       Lo  : Node_Id;
1874       Hi  : Node_Id;
1875
1876       Base : constant Entity_Id :=
1877                New_Internal_Entity
1878                  (E_Floating_Point_Type, Current_Scope,
1879                   Sloc (Defining_Identifier (Parent (Def))), 'G');
1880
1881    begin
1882       Enter_Name          (T);
1883       Set_Ekind           (T, E_Enumeration_Subtype);
1884       Set_Etype           (T, Base);
1885       Init_Size           (T, 8);
1886       Init_Alignment      (T);
1887       Set_Is_Generic_Type (T);
1888       Set_Is_Constrained  (T);
1889
1890       --  For semantic analysis, the bounds of the type must be set to some
1891       --  non-static value. The simplest is to create attribute nodes for those
1892       --  bounds, that refer to the type itself. These bounds are never
1893       --  analyzed but serve as place-holders.
1894
1895       Lo :=
1896         Make_Attribute_Reference (Loc,
1897           Attribute_Name => Name_First,
1898           Prefix         => New_Reference_To (T, Loc));
1899       Set_Etype (Lo, T);
1900
1901       Hi :=
1902         Make_Attribute_Reference (Loc,
1903           Attribute_Name => Name_Last,
1904           Prefix         => New_Reference_To (T, Loc));
1905       Set_Etype (Hi, T);
1906
1907       Set_Scalar_Range (T,
1908         Make_Range (Loc,
1909           Low_Bound  => Lo,
1910           High_Bound => Hi));
1911
1912       Set_Ekind           (Base, E_Enumeration_Type);
1913       Set_Etype           (Base, Base);
1914       Init_Size           (Base, 8);
1915       Init_Alignment      (Base);
1916       Set_Is_Generic_Type (Base);
1917       Set_Scalar_Range    (Base, Scalar_Range (T));
1918       Set_Parent          (Base, Parent (Def));
1919    end Analyze_Formal_Discrete_Type;
1920
1921    ----------------------------------
1922    -- Analyze_Formal_Floating_Type --
1923    ---------------------------------
1924
1925    procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1926       Base : constant Entity_Id :=
1927                New_Internal_Entity
1928                  (E_Floating_Point_Type, Current_Scope,
1929                   Sloc (Defining_Identifier (Parent (Def))), 'G');
1930
1931    begin
1932       --  The various semantic attributes are taken from the predefined type
1933       --  Float, just so that all of them are initialized. Their values are
1934       --  never used because no constant folding or expansion takes place in
1935       --  the generic itself.
1936
1937       Enter_Name (T);
1938       Set_Ekind          (T, E_Floating_Point_Subtype);
1939       Set_Etype          (T, Base);
1940       Set_Size_Info      (T,              (Standard_Float));
1941       Set_RM_Size        (T, RM_Size      (Standard_Float));
1942       Set_Digits_Value   (T, Digits_Value (Standard_Float));
1943       Set_Scalar_Range   (T, Scalar_Range (Standard_Float));
1944       Set_Is_Constrained (T);
1945
1946       Set_Is_Generic_Type (Base);
1947       Set_Etype           (Base, Base);
1948       Set_Size_Info       (Base,              (Standard_Float));
1949       Set_RM_Size         (Base, RM_Size      (Standard_Float));
1950       Set_Digits_Value    (Base, Digits_Value (Standard_Float));
1951       Set_Scalar_Range    (Base, Scalar_Range (Standard_Float));
1952       Set_Parent          (Base, Parent (Def));
1953
1954       Check_Restriction (No_Floating_Point, Def);
1955    end Analyze_Formal_Floating_Type;
1956
1957    -----------------------------------
1958    -- Analyze_Formal_Interface_Type;--
1959    -----------------------------------
1960
1961    procedure Analyze_Formal_Interface_Type
1962       (N   : Node_Id;
1963        T   : Entity_Id;
1964        Def : Node_Id)
1965    is
1966       Loc   : constant Source_Ptr := Sloc (N);
1967       New_N : Node_Id;
1968
1969    begin
1970       New_N :=
1971         Make_Full_Type_Declaration (Loc,
1972           Defining_Identifier => T,
1973           Type_Definition => Def);
1974
1975       Rewrite (N, New_N);
1976       Analyze (N);
1977       Set_Is_Generic_Type (T);
1978    end Analyze_Formal_Interface_Type;
1979
1980    ---------------------------------
1981    -- Analyze_Formal_Modular_Type --
1982    ---------------------------------
1983
1984    procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
1985    begin
1986       --  Apart from their entity kind, generic modular types are treated like
1987       --  signed integer types, and have the same attributes.
1988
1989       Analyze_Formal_Signed_Integer_Type (T, Def);
1990       Set_Ekind (T, E_Modular_Integer_Subtype);
1991       Set_Ekind (Etype (T), E_Modular_Integer_Type);
1992
1993    end Analyze_Formal_Modular_Type;
1994
1995    ---------------------------------------
1996    -- Analyze_Formal_Object_Declaration --
1997    ---------------------------------------
1998
1999    procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2000       E  : constant Node_Id := Default_Expression (N);
2001       Id : constant Node_Id := Defining_Identifier (N);
2002       K  : Entity_Kind;
2003       T  : Node_Id;
2004
2005    begin
2006       Enter_Name (Id);
2007
2008       --  Determine the mode of the formal object
2009
2010       if Out_Present (N) then
2011          K := E_Generic_In_Out_Parameter;
2012
2013          if not In_Present (N) then
2014             Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2015          end if;
2016
2017       else
2018          K := E_Generic_In_Parameter;
2019       end if;
2020
2021       if Present (Subtype_Mark (N)) then
2022          Find_Type (Subtype_Mark (N));
2023          T := Entity (Subtype_Mark (N));
2024
2025          --  Verify that there is no redundant null exclusion
2026
2027          if Null_Exclusion_Present (N) then
2028             if not Is_Access_Type (T) then
2029                Error_Msg_N
2030                  ("null exclusion can only apply to an access type", N);
2031
2032             elsif Can_Never_Be_Null (T) then
2033                Error_Msg_NE
2034                  ("`NOT NULL` not allowed (& already excludes null)",
2035                     N, T);
2036             end if;
2037          end if;
2038
2039       --  Ada 2005 (AI-423): Formal object with an access definition
2040
2041       else
2042          Check_Access_Definition (N);
2043          T := Access_Definition
2044                 (Related_Nod => N,
2045                  N           => Access_Definition (N));
2046       end if;
2047
2048       if Ekind (T) = E_Incomplete_Type then
2049          declare
2050             Error_Node : Node_Id;
2051
2052          begin
2053             if Present (Subtype_Mark (N)) then
2054                Error_Node := Subtype_Mark (N);
2055             else
2056                Check_Access_Definition (N);
2057                Error_Node := Access_Definition (N);
2058             end if;
2059
2060             Error_Msg_N ("premature usage of incomplete type", Error_Node);
2061          end;
2062       end if;
2063
2064       if K = E_Generic_In_Parameter then
2065
2066          --  Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2067
2068          if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2069             Error_Msg_N
2070               ("generic formal of mode IN must not be of limited type", N);
2071             Explain_Limited_Type (T, N);
2072          end if;
2073
2074          if Is_Abstract_Type (T) then
2075             Error_Msg_N
2076               ("generic formal of mode IN must not be of abstract type", N);
2077          end if;
2078
2079          if Present (E) then
2080             Preanalyze_Spec_Expression (E, T);
2081
2082             if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2083                Error_Msg_N
2084                  ("initialization not allowed for limited types", E);
2085                Explain_Limited_Type (T, E);
2086             end if;
2087          end if;
2088
2089          Set_Ekind (Id, K);
2090          Set_Etype (Id, T);
2091
2092       --  Case of generic IN OUT parameter
2093
2094       else
2095          --  If the formal has an unconstrained type, construct its actual
2096          --  subtype, as is done for subprogram formals. In this fashion, all
2097          --  its uses can refer to specific bounds.
2098
2099          Set_Ekind (Id, K);
2100          Set_Etype (Id, T);
2101
2102          if (Is_Array_Type (T)
2103               and then not Is_Constrained (T))
2104            or else
2105             (Ekind (T) = E_Record_Type
2106               and then Has_Discriminants (T))
2107          then
2108             declare
2109                Non_Freezing_Ref : constant Node_Id :=
2110                                     New_Reference_To (Id, Sloc (Id));
2111                Decl : Node_Id;
2112
2113             begin
2114                --  Make sure the actual subtype doesn't generate bogus freezing
2115
2116                Set_Must_Not_Freeze (Non_Freezing_Ref);
2117                Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2118                Insert_Before_And_Analyze (N, Decl);
2119                Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2120             end;
2121          else
2122             Set_Actual_Subtype (Id, T);
2123          end if;
2124
2125          if Present (E) then
2126             Error_Msg_N
2127               ("initialization not allowed for `IN OUT` formals", N);
2128          end if;
2129       end if;
2130
2131       if Has_Aspects (N) then
2132          Analyze_Aspect_Specifications (N, Id);
2133       end if;
2134    end Analyze_Formal_Object_Declaration;
2135
2136    ----------------------------------------------
2137    -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2138    ----------------------------------------------
2139
2140    procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2141      (T   : Entity_Id;
2142       Def : Node_Id)
2143    is
2144       Loc  : constant Source_Ptr := Sloc (Def);
2145       Base : constant Entity_Id :=
2146                New_Internal_Entity
2147                  (E_Ordinary_Fixed_Point_Type, Current_Scope,
2148                   Sloc (Defining_Identifier (Parent (Def))), 'G');
2149
2150    begin
2151       --  The semantic attributes are set for completeness only, their values
2152       --  will never be used, since all properties of the type are non-static.
2153
2154       Enter_Name (T);
2155       Set_Ekind            (T, E_Ordinary_Fixed_Point_Subtype);
2156       Set_Etype            (T, Base);
2157       Set_Size_Info        (T, Standard_Integer);
2158       Set_RM_Size          (T, RM_Size (Standard_Integer));
2159       Set_Small_Value      (T, Ureal_1);
2160       Set_Delta_Value      (T, Ureal_1);
2161       Set_Scalar_Range     (T,
2162         Make_Range (Loc,
2163           Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
2164           High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2165       Set_Is_Constrained   (T);
2166
2167       Set_Is_Generic_Type (Base);
2168       Set_Etype           (Base, Base);
2169       Set_Size_Info       (Base, Standard_Integer);
2170       Set_RM_Size         (Base, RM_Size (Standard_Integer));
2171       Set_Small_Value     (Base, Ureal_1);
2172       Set_Delta_Value     (Base, Ureal_1);
2173       Set_Scalar_Range    (Base, Scalar_Range (T));
2174       Set_Parent          (Base, Parent (Def));
2175
2176       Check_Restriction (No_Fixed_Point, Def);
2177    end Analyze_Formal_Ordinary_Fixed_Point_Type;
2178
2179    ----------------------------------------
2180    -- Analyze_Formal_Package_Declaration --
2181    ----------------------------------------
2182
2183    procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2184       Loc              : constant Source_Ptr := Sloc (N);
2185       Pack_Id          : constant Entity_Id  := Defining_Identifier (N);
2186       Formal           : Entity_Id;
2187       Gen_Id           : constant Node_Id    := Name (N);
2188       Gen_Decl         : Node_Id;
2189       Gen_Unit         : Entity_Id;
2190       New_N            : Node_Id;
2191       Parent_Installed : Boolean := False;
2192       Renaming         : Node_Id;
2193       Parent_Instance  : Entity_Id;
2194       Renaming_In_Par  : Entity_Id;
2195       Associations     : Boolean := True;
2196
2197       Vis_Prims_List : Elist_Id := No_Elist;
2198       --  List of primitives made temporarily visible in the instantiation
2199       --  to match the visibility of the formal type
2200
2201       function Build_Local_Package return Node_Id;
2202       --  The formal package is rewritten so that its parameters are replaced
2203       --  with corresponding declarations. For parameters with bona fide
2204       --  associations these declarations are created by Analyze_Associations
2205       --  as for a regular instantiation. For boxed parameters, we preserve
2206       --  the formal declarations and analyze them, in order to introduce
2207       --  entities of the right kind in the environment of the formal.
2208
2209       -------------------------
2210       -- Build_Local_Package --
2211       -------------------------
2212
2213       function Build_Local_Package return Node_Id is
2214          Decls     : List_Id;
2215          Pack_Decl : Node_Id;
2216
2217       begin
2218          --  Within the formal, the name of the generic package is a renaming
2219          --  of the formal (as for a regular instantiation).
2220
2221          Pack_Decl :=
2222            Make_Package_Declaration (Loc,
2223              Specification =>
2224                Copy_Generic_Node
2225                  (Specification (Original_Node (Gen_Decl)),
2226                     Empty, Instantiating => True));
2227
2228          Renaming := Make_Package_Renaming_Declaration (Loc,
2229              Defining_Unit_Name =>
2230                Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2231              Name => New_Occurrence_Of (Formal, Loc));
2232
2233          if Nkind (Gen_Id) = N_Identifier
2234            and then Chars (Gen_Id) = Chars (Pack_Id)
2235          then
2236             Error_Msg_NE
2237               ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2238          end if;
2239
2240          --  If the formal is declared with a box, or with an others choice,
2241          --  create corresponding declarations for all entities in the formal
2242          --  part, so that names with the proper types are available in the
2243          --  specification of the formal package.
2244
2245          --  On the other hand, if there are no associations, then all the
2246          --  formals must have defaults, and this will be checked by the
2247          --  call to Analyze_Associations.
2248
2249          if Box_Present (N)
2250            or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2251          then
2252             declare
2253                Formal_Decl : Node_Id;
2254
2255             begin
2256                --  TBA : for a formal package, need to recurse ???
2257
2258                Decls := New_List;
2259                Formal_Decl :=
2260                  First
2261                    (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2262                while Present (Formal_Decl) loop
2263                   Append_To
2264                     (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2265                   Next (Formal_Decl);
2266                end loop;
2267             end;
2268
2269          --  If generic associations are present, use Analyze_Associations to
2270          --  create the proper renaming declarations.
2271
2272          else
2273             declare
2274                Act_Tree : constant Node_Id :=
2275                             Copy_Generic_Node
2276                               (Original_Node (Gen_Decl), Empty,
2277                                Instantiating => True);
2278
2279             begin
2280                Generic_Renamings.Set_Last (0);
2281                Generic_Renamings_HTable.Reset;
2282                Instantiation_Node := N;
2283
2284                Decls :=
2285                  Analyze_Associations
2286                    (I_Node  => Original_Node (N),
2287                     Formals => Generic_Formal_Declarations (Act_Tree),
2288                     F_Copy  => Generic_Formal_Declarations (Gen_Decl));
2289
2290                Vis_Prims_List := Check_Hidden_Primitives (Decls);
2291             end;
2292          end if;
2293
2294          Append (Renaming, To => Decls);
2295
2296          --  Add generated declarations ahead of local declarations in
2297          --  the package.
2298
2299          if No (Visible_Declarations (Specification (Pack_Decl))) then
2300             Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2301          else
2302             Insert_List_Before
2303               (First (Visible_Declarations (Specification (Pack_Decl))),
2304                  Decls);
2305          end if;
2306
2307          return Pack_Decl;
2308       end Build_Local_Package;
2309
2310    --  Start of processing for Analyze_Formal_Package_Declaration
2311
2312    begin
2313       Text_IO_Kludge (Gen_Id);
2314
2315       Init_Env;
2316       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2317       Gen_Unit := Entity (Gen_Id);
2318
2319       --  Check for a formal package that is a package renaming
2320
2321       if Present (Renamed_Object (Gen_Unit)) then
2322
2323          --  Indicate that unit is used, before replacing it with renamed
2324          --  entity for use below.
2325
2326          if In_Extended_Main_Source_Unit (N) then
2327             Set_Is_Instantiated (Gen_Unit);
2328             Generate_Reference  (Gen_Unit, N);
2329          end if;
2330
2331          Gen_Unit := Renamed_Object (Gen_Unit);
2332       end if;
2333
2334       if Ekind (Gen_Unit) /= E_Generic_Package then
2335          Error_Msg_N ("expect generic package name", Gen_Id);
2336          Restore_Env;
2337          goto Leave;
2338
2339       elsif  Gen_Unit = Current_Scope then
2340          Error_Msg_N
2341            ("generic package cannot be used as a formal package of itself",
2342              Gen_Id);
2343          Restore_Env;
2344          goto Leave;
2345
2346       elsif In_Open_Scopes (Gen_Unit) then
2347          if Is_Compilation_Unit (Gen_Unit)
2348            and then Is_Child_Unit (Current_Scope)
2349          then
2350             --  Special-case the error when the formal is a parent, and
2351             --  continue analysis to minimize cascaded errors.
2352
2353             Error_Msg_N
2354               ("generic parent cannot be used as formal package "
2355                 & "of a child unit",
2356                 Gen_Id);
2357
2358          else
2359             Error_Msg_N
2360               ("generic package cannot be used as a formal package "
2361                 & "within itself",
2362                 Gen_Id);
2363             Restore_Env;
2364             goto Leave;
2365          end if;
2366       end if;
2367
2368       --  Check that name of formal package does not hide name of generic,
2369       --  or its leading prefix. This check must be done separately because
2370       --  the name of the generic has already been analyzed.
2371
2372       declare
2373          Gen_Name : Entity_Id;
2374
2375       begin
2376          Gen_Name := Gen_Id;
2377          while Nkind (Gen_Name) = N_Expanded_Name loop
2378             Gen_Name := Prefix (Gen_Name);
2379          end loop;
2380
2381          if Chars (Gen_Name) = Chars (Pack_Id) then
2382             Error_Msg_NE
2383              ("& is hidden within declaration of formal package",
2384                Gen_Id, Gen_Name);
2385          end if;
2386       end;
2387
2388       if Box_Present (N)
2389         or else No (Generic_Associations (N))
2390         or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2391       then
2392          Associations := False;
2393       end if;
2394
2395       --  If there are no generic associations, the generic parameters appear
2396       --  as local entities and are instantiated like them. We copy the generic
2397       --  package declaration as if it were an instantiation, and analyze it
2398       --  like a regular package, except that we treat the formals as
2399       --  additional visible components.
2400
2401       Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2402
2403       if In_Extended_Main_Source_Unit (N) then
2404          Set_Is_Instantiated (Gen_Unit);
2405          Generate_Reference  (Gen_Unit, N);
2406       end if;
2407
2408       Formal := New_Copy (Pack_Id);
2409       Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2410
2411       begin
2412          --  Make local generic without formals. The formals will be replaced
2413          --  with internal declarations.
2414
2415          New_N := Build_Local_Package;
2416
2417          --  If there are errors in the parameter list, Analyze_Associations
2418          --  raises Instantiation_Error. Patch the declaration to prevent
2419          --  further exception propagation.
2420
2421       exception
2422          when Instantiation_Error =>
2423
2424             Enter_Name (Formal);
2425             Set_Ekind  (Formal, E_Variable);
2426             Set_Etype  (Formal, Any_Type);
2427             Restore_Hidden_Primitives (Vis_Prims_List);
2428
2429             if Parent_Installed then
2430                Remove_Parent;
2431             end if;
2432
2433             goto Leave;
2434       end;
2435
2436       Rewrite (N, New_N);
2437       Set_Defining_Unit_Name (Specification (New_N), Formal);
2438       Set_Generic_Parent (Specification (N), Gen_Unit);
2439       Set_Instance_Env (Gen_Unit, Formal);
2440       Set_Is_Generic_Instance (Formal);
2441
2442       Enter_Name (Formal);
2443       Set_Ekind  (Formal, E_Package);
2444       Set_Etype  (Formal, Standard_Void_Type);
2445       Set_Inner_Instances (Formal, New_Elmt_List);
2446       Push_Scope  (Formal);
2447
2448       if Is_Child_Unit (Gen_Unit)
2449         and then Parent_Installed
2450       then
2451          --  Similarly, we have to make the name of the formal visible in the
2452          --  parent instance, to resolve properly fully qualified names that
2453          --  may appear in the generic unit. The parent instance has been
2454          --  placed on the scope stack ahead of the current scope.
2455
2456          Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2457
2458          Renaming_In_Par :=
2459            Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2460          Set_Ekind (Renaming_In_Par, E_Package);
2461          Set_Etype (Renaming_In_Par, Standard_Void_Type);
2462          Set_Scope (Renaming_In_Par, Parent_Instance);
2463          Set_Parent (Renaming_In_Par, Parent (Formal));
2464          Set_Renamed_Object (Renaming_In_Par, Formal);
2465          Append_Entity (Renaming_In_Par, Parent_Instance);
2466       end if;
2467
2468       Analyze (Specification (N));
2469
2470       --  The formals for which associations are provided are not visible
2471       --  outside of the formal package. The others are still declared by a
2472       --  formal parameter declaration.
2473
2474       --  If there are no associations, the only local entity to hide is the
2475       --  generated package renaming itself.
2476
2477       declare
2478          E : Entity_Id;
2479
2480       begin
2481          E := First_Entity (Formal);
2482          while Present (E) loop
2483             if Associations
2484               and then not Is_Generic_Formal (E)
2485             then
2486                Set_Is_Hidden (E);
2487             end if;
2488
2489             if Ekind (E) = E_Package
2490               and then Renamed_Entity (E) = Formal
2491             then
2492                Set_Is_Hidden (E);
2493                exit;
2494             end if;
2495
2496             Next_Entity (E);
2497          end loop;
2498       end;
2499
2500       End_Package_Scope (Formal);
2501       Restore_Hidden_Primitives (Vis_Prims_List);
2502
2503       if Parent_Installed then
2504          Remove_Parent;
2505       end if;
2506
2507       Restore_Env;
2508
2509       --  Inside the generic unit, the formal package is a regular package, but
2510       --  no body is needed for it. Note that after instantiation, the defining
2511       --  unit name we need is in the new tree and not in the original (see
2512       --  Package_Instantiation). A generic formal package is an instance, and
2513       --  can be used as an actual for an inner instance.
2514
2515       Set_Has_Completion (Formal, True);
2516
2517       --  Add semantic information to the original defining identifier.
2518       --  for ASIS use.
2519
2520       Set_Ekind (Pack_Id, E_Package);
2521       Set_Etype (Pack_Id, Standard_Void_Type);
2522       Set_Scope (Pack_Id, Scope (Formal));
2523       Set_Has_Completion (Pack_Id, True);
2524
2525    <<Leave>>
2526       if Has_Aspects (N) then
2527          Analyze_Aspect_Specifications (N, Pack_Id);
2528       end if;
2529    end Analyze_Formal_Package_Declaration;
2530
2531    ---------------------------------
2532    -- Analyze_Formal_Private_Type --
2533    ---------------------------------
2534
2535    procedure Analyze_Formal_Private_Type
2536      (N   : Node_Id;
2537       T   : Entity_Id;
2538       Def : Node_Id)
2539    is
2540    begin
2541       New_Private_Type (N, T, Def);
2542
2543       --  Set the size to an arbitrary but legal value
2544
2545       Set_Size_Info (T, Standard_Integer);
2546       Set_RM_Size   (T, RM_Size (Standard_Integer));
2547    end Analyze_Formal_Private_Type;
2548
2549    ------------------------------------
2550    -- Analyze_Formal_Incomplete_Type --
2551    ------------------------------------
2552
2553    procedure Analyze_Formal_Incomplete_Type
2554      (T   : Entity_Id;
2555       Def : Node_Id)
2556    is
2557    begin
2558       Enter_Name (T);
2559       Set_Ekind (T, E_Incomplete_Type);
2560       Set_Etype (T, T);
2561       Set_Private_Dependents (T, New_Elmt_List);
2562
2563       if Tagged_Present (Def) then
2564          Set_Is_Tagged_Type (T);
2565          Make_Class_Wide_Type (T);
2566          Set_Direct_Primitive_Operations (T, New_Elmt_List);
2567       end if;
2568    end Analyze_Formal_Incomplete_Type;
2569
2570    ----------------------------------------
2571    -- Analyze_Formal_Signed_Integer_Type --
2572    ----------------------------------------
2573
2574    procedure Analyze_Formal_Signed_Integer_Type
2575      (T   : Entity_Id;
2576       Def : Node_Id)
2577    is
2578       Base : constant Entity_Id :=
2579                New_Internal_Entity
2580                  (E_Signed_Integer_Type,
2581                   Current_Scope,
2582                   Sloc (Defining_Identifier (Parent (Def))), 'G');
2583
2584    begin
2585       Enter_Name (T);
2586
2587       Set_Ekind          (T, E_Signed_Integer_Subtype);
2588       Set_Etype          (T, Base);
2589       Set_Size_Info      (T, Standard_Integer);
2590       Set_RM_Size        (T, RM_Size (Standard_Integer));
2591       Set_Scalar_Range   (T, Scalar_Range (Standard_Integer));
2592       Set_Is_Constrained (T);
2593
2594       Set_Is_Generic_Type (Base);
2595       Set_Size_Info       (Base, Standard_Integer);
2596       Set_RM_Size         (Base, RM_Size (Standard_Integer));
2597       Set_Etype           (Base, Base);
2598       Set_Scalar_Range    (Base, Scalar_Range (Standard_Integer));
2599       Set_Parent          (Base, Parent (Def));
2600    end Analyze_Formal_Signed_Integer_Type;
2601
2602    -------------------------------------------
2603    -- Analyze_Formal_Subprogram_Declaration --
2604    -------------------------------------------
2605
2606    procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2607       Spec : constant Node_Id   := Specification (N);
2608       Def  : constant Node_Id   := Default_Name (N);
2609       Nam  : constant Entity_Id := Defining_Unit_Name (Spec);
2610       Subp : Entity_Id;
2611
2612    begin
2613       if Nam = Error then
2614          return;
2615       end if;
2616
2617       if Nkind (Nam) = N_Defining_Program_Unit_Name then
2618          Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2619          goto Leave;
2620       end if;
2621
2622       Analyze_Subprogram_Declaration (N);
2623       Set_Is_Formal_Subprogram (Nam);
2624       Set_Has_Completion (Nam);
2625
2626       if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2627          Set_Is_Abstract_Subprogram (Nam);
2628          Set_Is_Dispatching_Operation (Nam);
2629
2630          declare
2631             Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2632          begin
2633             if No (Ctrl_Type) then
2634                Error_Msg_N
2635                  ("abstract formal subprogram must have a controlling type",
2636                   N);
2637             else
2638                Check_Controlling_Formals (Ctrl_Type, Nam);
2639             end if;
2640          end;
2641       end if;
2642
2643       --  Default name is resolved at the point of instantiation
2644
2645       if Box_Present (N) then
2646          null;
2647
2648       --  Else default is bound at the point of generic declaration
2649
2650       elsif Present (Def) then
2651          if Nkind (Def) = N_Operator_Symbol then
2652             Find_Direct_Name (Def);
2653
2654          elsif Nkind (Def) /= N_Attribute_Reference then
2655             Analyze (Def);
2656
2657          else
2658             --  For an attribute reference, analyze the prefix and verify
2659             --  that it has the proper profile for the subprogram.
2660
2661             Analyze (Prefix (Def));
2662             Valid_Default_Attribute (Nam, Def);
2663             goto Leave;
2664          end if;
2665
2666          --  Default name may be overloaded, in which case the interpretation
2667          --  with the correct profile must be  selected, as for a renaming.
2668          --  If the definition is an indexed component, it must denote a
2669          --  member of an entry family. If it is a selected component, it
2670          --  can be a protected operation.
2671
2672          if Etype (Def) = Any_Type then
2673             goto Leave;
2674
2675          elsif Nkind (Def) = N_Selected_Component then
2676             if not Is_Overloadable (Entity (Selector_Name (Def))) then
2677                Error_Msg_N ("expect valid subprogram name as default", Def);
2678             end if;
2679
2680          elsif Nkind (Def) = N_Indexed_Component then
2681             if Is_Entity_Name (Prefix (Def)) then
2682                if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2683                   Error_Msg_N ("expect valid subprogram name as default", Def);
2684                end if;
2685
2686             elsif Nkind (Prefix (Def)) = N_Selected_Component then
2687                if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2688                                                           E_Entry_Family
2689                then
2690                   Error_Msg_N ("expect valid subprogram name as default", Def);
2691                end if;
2692
2693             else
2694                Error_Msg_N ("expect valid subprogram name as default", Def);
2695                goto Leave;
2696             end if;
2697
2698          elsif Nkind (Def) = N_Character_Literal then
2699
2700             --  Needs some type checks: subprogram should be parameterless???
2701
2702             Resolve (Def, (Etype (Nam)));
2703
2704          elsif not Is_Entity_Name (Def)
2705            or else not Is_Overloadable (Entity (Def))
2706          then
2707             Error_Msg_N ("expect valid subprogram name as default", Def);
2708             goto Leave;
2709
2710          elsif not Is_Overloaded (Def) then
2711             Subp := Entity (Def);
2712
2713             if Subp = Nam then
2714                Error_Msg_N ("premature usage of formal subprogram", Def);
2715
2716             elsif not Entity_Matches_Spec (Subp, Nam) then
2717                Error_Msg_N ("no visible entity matches specification", Def);
2718             end if;
2719
2720          --  More than one interpretation, so disambiguate as for a renaming
2721
2722          else
2723             declare
2724                I   : Interp_Index;
2725                I1  : Interp_Index := 0;
2726                It  : Interp;
2727                It1 : Interp;
2728
2729             begin
2730                Subp := Any_Id;
2731                Get_First_Interp (Def, I, It);
2732                while Present (It.Nam) loop
2733                   if Entity_Matches_Spec (It.Nam, Nam) then
2734                      if Subp /= Any_Id then
2735                         It1 := Disambiguate (Def, I1, I, Etype (Subp));
2736
2737                         if It1 = No_Interp then
2738                            Error_Msg_N ("ambiguous default subprogram", Def);
2739                         else
2740                            Subp := It1.Nam;
2741                         end if;
2742
2743                         exit;
2744
2745                      else
2746                         I1  := I;
2747                         Subp := It.Nam;
2748                      end if;
2749                   end if;
2750
2751                   Get_Next_Interp (I, It);
2752                end loop;
2753             end;
2754
2755             if Subp /= Any_Id then
2756
2757                --  Subprogram found, generate reference to it
2758
2759                Set_Entity (Def, Subp);
2760                Generate_Reference (Subp, Def);
2761
2762                if Subp = Nam then
2763                   Error_Msg_N ("premature usage of formal subprogram", Def);
2764
2765                elsif Ekind (Subp) /= E_Operator then
2766                   Check_Mode_Conformant (Subp, Nam);
2767                end if;
2768
2769             else
2770                Error_Msg_N ("no visible subprogram matches specification", N);
2771             end if;
2772          end if;
2773       end if;
2774
2775    <<Leave>>
2776       if Has_Aspects (N) then
2777          Analyze_Aspect_Specifications (N, Nam);
2778       end if;
2779
2780    end Analyze_Formal_Subprogram_Declaration;
2781
2782    -------------------------------------
2783    -- Analyze_Formal_Type_Declaration --
2784    -------------------------------------
2785
2786    procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2787       Def : constant Node_Id := Formal_Type_Definition (N);
2788       T   : Entity_Id;
2789
2790    begin
2791       T := Defining_Identifier (N);
2792
2793       if Present (Discriminant_Specifications (N))
2794         and then Nkind (Def) /= N_Formal_Private_Type_Definition
2795       then
2796          Error_Msg_N
2797            ("discriminants not allowed for this formal type", T);
2798       end if;
2799
2800       --  Enter the new name, and branch to specific routine
2801
2802       case Nkind (Def) is
2803          when N_Formal_Private_Type_Definition         =>
2804             Analyze_Formal_Private_Type (N, T, Def);
2805
2806          when N_Formal_Derived_Type_Definition         =>
2807             Analyze_Formal_Derived_Type (N, T, Def);
2808
2809          when N_Formal_Incomplete_Type_Definition         =>
2810             Analyze_Formal_Incomplete_Type (T, Def);
2811
2812          when N_Formal_Discrete_Type_Definition        =>
2813             Analyze_Formal_Discrete_Type (T, Def);
2814
2815          when N_Formal_Signed_Integer_Type_Definition  =>
2816             Analyze_Formal_Signed_Integer_Type (T, Def);
2817
2818          when N_Formal_Modular_Type_Definition         =>
2819             Analyze_Formal_Modular_Type (T, Def);
2820
2821          when N_Formal_Floating_Point_Definition       =>
2822             Analyze_Formal_Floating_Type (T, Def);
2823
2824          when N_Formal_Ordinary_Fixed_Point_Definition =>
2825             Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2826
2827          when N_Formal_Decimal_Fixed_Point_Definition  =>
2828             Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2829
2830          when N_Array_Type_Definition =>
2831             Analyze_Formal_Array_Type (T, Def);
2832
2833          when N_Access_To_Object_Definition            |
2834               N_Access_Function_Definition             |
2835               N_Access_Procedure_Definition            =>
2836             Analyze_Generic_Access_Type (T, Def);
2837
2838          --  Ada 2005: a interface declaration is encoded as an abstract
2839          --  record declaration or a abstract type derivation.
2840
2841          when N_Record_Definition                      =>
2842             Analyze_Formal_Interface_Type (N, T, Def);
2843
2844          when N_Derived_Type_Definition                =>
2845             Analyze_Formal_Derived_Interface_Type (N, T, Def);
2846
2847          when N_Error                                  =>
2848             null;
2849
2850          when others                                   =>
2851             raise Program_Error;
2852
2853       end case;
2854
2855       Set_Is_Generic_Type (T);
2856
2857       if Has_Aspects (N) then
2858          Analyze_Aspect_Specifications (N, T);
2859       end if;
2860    end Analyze_Formal_Type_Declaration;
2861
2862    ------------------------------------
2863    -- Analyze_Function_Instantiation --
2864    ------------------------------------
2865
2866    procedure Analyze_Function_Instantiation (N : Node_Id) is
2867    begin
2868       Analyze_Subprogram_Instantiation (N, E_Function);
2869    end Analyze_Function_Instantiation;
2870
2871    ---------------------------------
2872    -- Analyze_Generic_Access_Type --
2873    ---------------------------------
2874
2875    procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2876    begin
2877       Enter_Name (T);
2878
2879       if Nkind (Def) = N_Access_To_Object_Definition then
2880          Access_Type_Declaration (T, Def);
2881
2882          if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2883            and then No (Full_View (Designated_Type (T)))
2884            and then not Is_Generic_Type (Designated_Type (T))
2885          then
2886             Error_Msg_N ("premature usage of incomplete type", Def);
2887
2888          elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2889             Error_Msg_N
2890               ("only a subtype mark is allowed in a formal", Def);
2891          end if;
2892
2893       else
2894          Access_Subprogram_Declaration (T, Def);
2895       end if;
2896    end Analyze_Generic_Access_Type;
2897
2898    ---------------------------------
2899    -- Analyze_Generic_Formal_Part --
2900    ---------------------------------
2901
2902    procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2903       Gen_Parm_Decl : Node_Id;
2904
2905    begin
2906       --  The generic formals are processed in the scope of the generic unit,
2907       --  where they are immediately visible. The scope is installed by the
2908       --  caller.
2909
2910       Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2911
2912       while Present (Gen_Parm_Decl) loop
2913          Analyze (Gen_Parm_Decl);
2914          Next (Gen_Parm_Decl);
2915       end loop;
2916
2917       Generate_Reference_To_Generic_Formals (Current_Scope);
2918    end Analyze_Generic_Formal_Part;
2919
2920    ------------------------------------------
2921    -- Analyze_Generic_Package_Declaration  --
2922    ------------------------------------------
2923
2924    procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2925       Loc         : constant Source_Ptr := Sloc (N);
2926       Id          : Entity_Id;
2927       New_N       : Node_Id;
2928       Save_Parent : Node_Id;
2929       Renaming    : Node_Id;
2930       Decls       : constant List_Id :=
2931                       Visible_Declarations (Specification (N));
2932       Decl        : Node_Id;
2933
2934    begin
2935       Check_SPARK_Restriction ("generic is not allowed", N);
2936
2937       --  We introduce a renaming of the enclosing package, to have a usable
2938       --  entity as the prefix of an expanded name for a local entity of the
2939       --  form Par.P.Q, where P is the generic package. This is because a local
2940       --  entity named P may hide it, so that the usual visibility rules in
2941       --  the instance will not resolve properly.
2942
2943       Renaming :=
2944         Make_Package_Renaming_Declaration (Loc,
2945           Defining_Unit_Name =>
2946             Make_Defining_Identifier (Loc,
2947              Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2948           Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2949
2950       if Present (Decls) then
2951          Decl := First (Decls);
2952          while Present (Decl)
2953            and then Nkind (Decl) = N_Pragma
2954          loop
2955             Next (Decl);
2956          end loop;
2957
2958          if Present (Decl) then
2959             Insert_Before (Decl, Renaming);
2960          else
2961             Append (Renaming, Visible_Declarations (Specification (N)));
2962          end if;
2963
2964       else
2965          Set_Visible_Declarations (Specification (N), New_List (Renaming));
2966       end if;
2967
2968       --  Create copy of generic unit, and save for instantiation. If the unit
2969       --  is a child unit, do not copy the specifications for the parent, which
2970       --  are not part of the generic tree.
2971
2972       Save_Parent := Parent_Spec (N);
2973       Set_Parent_Spec (N, Empty);
2974
2975       New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2976       Set_Parent_Spec (New_N, Save_Parent);
2977       Rewrite (N, New_N);
2978       Id := Defining_Entity (N);
2979       Generate_Definition (Id);
2980
2981       --  Expansion is not applied to generic units
2982
2983       Start_Generic;
2984
2985       Enter_Name (Id);
2986       Set_Ekind (Id, E_Generic_Package);
2987       Set_Etype (Id, Standard_Void_Type);
2988       Push_Scope (Id);
2989       Enter_Generic_Scope (Id);
2990       Set_Inner_Instances (Id, New_Elmt_List);
2991
2992       Set_Categorization_From_Pragmas (N);
2993       Set_Is_Pure (Id, Is_Pure (Current_Scope));
2994
2995       --  Link the declaration of the generic homonym in the generic copy to
2996       --  the package it renames, so that it is always resolved properly.
2997
2998       Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
2999       Set_Entity (Associated_Node (Name (Renaming)), Id);
3000
3001       --  For a library unit, we have reconstructed the entity for the unit,
3002       --  and must reset it in the library tables.
3003
3004       if Nkind (Parent (N)) = N_Compilation_Unit then
3005          Set_Cunit_Entity (Current_Sem_Unit, Id);
3006       end if;
3007
3008       Analyze_Generic_Formal_Part (N);
3009
3010       --  After processing the generic formals, analysis proceeds as for a
3011       --  non-generic package.
3012
3013       Analyze (Specification (N));
3014
3015       Validate_Categorization_Dependency (N, Id);
3016
3017       End_Generic;
3018
3019       End_Package_Scope (Id);
3020       Exit_Generic_Scope (Id);
3021
3022       if Nkind (Parent (N)) /= N_Compilation_Unit then
3023          Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3024          Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3025          Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3026
3027       else
3028          Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3029          Validate_RT_RAT_Component (N);
3030
3031          --  If this is a spec without a body, check that generic parameters
3032          --  are referenced.
3033
3034          if not Body_Required (Parent (N)) then
3035             Check_References (Id);
3036          end if;
3037       end if;
3038
3039       if Has_Aspects (N) then
3040          Analyze_Aspect_Specifications (N, Id);
3041       end if;
3042    end Analyze_Generic_Package_Declaration;
3043
3044    --------------------------------------------
3045    -- Analyze_Generic_Subprogram_Declaration --
3046    --------------------------------------------
3047
3048    procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3049       Spec        : Node_Id;
3050       Id          : Entity_Id;
3051       Formals     : List_Id;
3052       New_N       : Node_Id;
3053       Result_Type : Entity_Id;
3054       Save_Parent : Node_Id;
3055       Typ         : Entity_Id;
3056
3057    begin
3058       Check_SPARK_Restriction ("generic is not allowed", N);
3059
3060       --  Create copy of generic unit, and save for instantiation. If the unit
3061       --  is a child unit, do not copy the specifications for the parent, which
3062       --  are not part of the generic tree.
3063
3064       Save_Parent := Parent_Spec (N);
3065       Set_Parent_Spec (N, Empty);
3066
3067       New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3068       Set_Parent_Spec (New_N, Save_Parent);
3069       Rewrite (N, New_N);
3070
3071       --  The aspect specifications are not attached to the tree, and must
3072       --  be copied and attached to the generic copy explicitly.
3073
3074       if Present (Aspect_Specifications (New_N)) then
3075          declare
3076             Aspects : constant List_Id := Aspect_Specifications (N);
3077          begin
3078             Set_Has_Aspects (N, False);
3079             Move_Aspects (New_N, N);
3080             Set_Has_Aspects (Original_Node (N), False);
3081             Set_Aspect_Specifications (Original_Node (N), Aspects);
3082          end;
3083       end if;
3084
3085       Spec := Specification (N);
3086       Id := Defining_Entity (Spec);
3087       Generate_Definition (Id);
3088       Set_Contract (Id, Make_Contract (Sloc (Id)));
3089
3090       if Nkind (Id) = N_Defining_Operator_Symbol then
3091          Error_Msg_N
3092            ("operator symbol not allowed for generic subprogram", Id);
3093       end if;
3094
3095       Start_Generic;
3096
3097       Enter_Name (Id);
3098
3099       Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3100       Push_Scope (Id);
3101       Enter_Generic_Scope (Id);
3102       Set_Inner_Instances (Id, New_Elmt_List);
3103       Set_Is_Pure (Id, Is_Pure (Current_Scope));
3104
3105       Analyze_Generic_Formal_Part (N);
3106
3107       Formals := Parameter_Specifications (Spec);
3108
3109       if Present (Formals) then
3110          Process_Formals (Formals, Spec);
3111       end if;
3112
3113       if Nkind (Spec) = N_Function_Specification then
3114          Set_Ekind (Id, E_Generic_Function);
3115
3116          if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3117             Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3118             Set_Etype (Id, Result_Type);
3119
3120             --  Check restriction imposed by AI05-073: a generic function
3121             --  cannot return an abstract type or an access to such.
3122
3123             --  This is a binding interpretation should it apply to earlier
3124             --  versions of Ada as well as Ada 2012???
3125
3126             if Is_Abstract_Type (Designated_Type (Result_Type))
3127               and then Ada_Version >= Ada_2012
3128             then
3129                Error_Msg_N ("generic function cannot have an access result"
3130                  & " that designates an abstract type", Spec);
3131             end if;
3132
3133          else
3134             Find_Type (Result_Definition (Spec));
3135             Typ := Entity (Result_Definition (Spec));
3136
3137             if Is_Abstract_Type (Typ)
3138               and then Ada_Version >= Ada_2012
3139             then
3140                Error_Msg_N
3141                  ("generic function cannot have abstract result type", Spec);
3142             end if;
3143
3144             --  If a null exclusion is imposed on the result type, then create
3145             --  a null-excluding itype (an access subtype) and use it as the
3146             --  function's Etype.
3147
3148             if Is_Access_Type (Typ)
3149               and then Null_Exclusion_Present (Spec)
3150             then
3151                Set_Etype  (Id,
3152                  Create_Null_Excluding_Itype
3153                    (T           => Typ,
3154                     Related_Nod => Spec,
3155                     Scope_Id    => Defining_Unit_Name (Spec)));
3156             else
3157                Set_Etype (Id, Typ);
3158             end if;
3159          end if;
3160
3161       else
3162          Set_Ekind (Id, E_Generic_Procedure);
3163          Set_Etype (Id, Standard_Void_Type);
3164       end if;
3165
3166       --  For a library unit, we have reconstructed the entity for the unit,
3167       --  and must reset it in the library tables. We also make sure that
3168       --  Body_Required is set properly in the original compilation unit node.
3169
3170       if Nkind (Parent (N)) = N_Compilation_Unit then
3171          Set_Cunit_Entity (Current_Sem_Unit, Id);
3172          Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3173       end if;
3174
3175       Set_Categorization_From_Pragmas (N);
3176       Validate_Categorization_Dependency (N, Id);
3177
3178       Save_Global_References (Original_Node (N));
3179
3180       --  To capture global references, analyze the expressions of aspects,
3181       --  and propagate information to original tree. Note that in this case
3182       --  analysis of attributes is not delayed until the freeze point.
3183
3184       --  It seems very hard to recreate the proper visibility of the generic
3185       --  subprogram at a later point because the analysis of an aspect may
3186       --  create pragmas after the generic copies have been made ???
3187
3188       if Has_Aspects (N) then
3189          declare
3190             Aspect : Node_Id;
3191
3192          begin
3193             Aspect := First (Aspect_Specifications (N));
3194             while Present (Aspect) loop
3195                if Get_Aspect_Id (Chars (Identifier (Aspect)))
3196                   /= Aspect_Warnings
3197                then
3198                   Analyze (Expression (Aspect));
3199                end if;
3200                Next (Aspect);
3201             end loop;
3202
3203             Aspect := First (Aspect_Specifications (Original_Node (N)));
3204             while Present (Aspect) loop
3205                Save_Global_References (Expression (Aspect));
3206                Next (Aspect);
3207             end loop;
3208          end;
3209       end if;
3210
3211       End_Generic;
3212       End_Scope;
3213       Exit_Generic_Scope (Id);
3214       Generate_Reference_To_Formals (Id);
3215
3216       List_Inherited_Pre_Post_Aspects (Id);
3217    end Analyze_Generic_Subprogram_Declaration;
3218
3219    -----------------------------------
3220    -- Analyze_Package_Instantiation --
3221    -----------------------------------
3222
3223    procedure Analyze_Package_Instantiation (N : Node_Id) is
3224       Loc    : constant Source_Ptr := Sloc (N);
3225       Gen_Id : constant Node_Id    := Name (N);
3226
3227       Act_Decl      : Node_Id;
3228       Act_Decl_Name : Node_Id;
3229       Act_Decl_Id   : Entity_Id;
3230       Act_Spec      : Node_Id;
3231       Act_Tree      : Node_Id;
3232
3233       Gen_Decl : Node_Id;
3234       Gen_Unit : Entity_Id;
3235
3236       Is_Actual_Pack : constant Boolean :=
3237                          Is_Internal (Defining_Entity (N));
3238
3239       Env_Installed    : Boolean := False;
3240       Parent_Installed : Boolean := False;
3241       Renaming_List    : List_Id;
3242       Unit_Renaming    : Node_Id;
3243       Needs_Body       : Boolean;
3244       Inline_Now       : Boolean := False;
3245
3246       Save_Style_Check : constant Boolean := Style_Check;
3247       --  Save style check mode for restore on exit
3248
3249       procedure Delay_Descriptors (E : Entity_Id);
3250       --  Delay generation of subprogram descriptors for given entity
3251
3252       function Might_Inline_Subp return Boolean;
3253       --  If inlining is active and the generic contains inlined subprograms,
3254       --  we instantiate the body. This may cause superfluous instantiations,
3255       --  but it is simpler than detecting the need for the body at the point
3256       --  of inlining, when the context of the instance is not available.
3257
3258       -----------------------
3259       -- Delay_Descriptors --
3260       -----------------------
3261
3262       procedure Delay_Descriptors (E : Entity_Id) is
3263       begin
3264          if not Delay_Subprogram_Descriptors (E) then
3265             Set_Delay_Subprogram_Descriptors (E);
3266             Pending_Descriptor.Append (E);
3267          end if;
3268       end Delay_Descriptors;
3269
3270       -----------------------
3271       -- Might_Inline_Subp --
3272       -----------------------
3273
3274       function Might_Inline_Subp return Boolean is
3275          E : Entity_Id;
3276
3277       begin
3278          if not Inline_Processing_Required then
3279             return False;
3280
3281          else
3282             E := First_Entity (Gen_Unit);
3283             while Present (E) loop
3284                if Is_Subprogram (E)
3285                  and then Is_Inlined (E)
3286                then
3287                   return True;
3288                end if;
3289
3290                Next_Entity (E);
3291             end loop;
3292          end if;
3293
3294          return False;
3295       end Might_Inline_Subp;
3296
3297       --  Local declarations
3298
3299       Vis_Prims_List : Elist_Id := No_Elist;
3300       --  List of primitives made temporarily visible in the instantiation
3301       --  to match the visibility of the formal type
3302
3303    --  Start of processing for Analyze_Package_Instantiation
3304
3305    begin
3306       Check_SPARK_Restriction ("generic is not allowed", N);
3307
3308       --  Very first thing: apply the special kludge for Text_IO processing
3309       --  in case we are instantiating one of the children of [Wide_]Text_IO.
3310
3311       Text_IO_Kludge (Name (N));
3312
3313       --  Make node global for error reporting
3314
3315       Instantiation_Node := N;
3316
3317       --  Turn off style checking in instances. If the check is enabled on the
3318       --  generic unit, a warning in an instance would just be noise. If not
3319       --  enabled on the generic, then a warning in an instance is just wrong.
3320
3321       Style_Check := False;
3322
3323       --  Case of instantiation of a generic package
3324
3325       if Nkind (N) = N_Package_Instantiation then
3326          Act_Decl_Id := New_Copy (Defining_Entity (N));
3327          Set_Comes_From_Source (Act_Decl_Id, True);
3328
3329          if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3330             Act_Decl_Name :=
3331               Make_Defining_Program_Unit_Name (Loc,
3332                 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3333                 Defining_Identifier => Act_Decl_Id);
3334          else
3335             Act_Decl_Name :=  Act_Decl_Id;
3336          end if;
3337
3338       --  Case of instantiation of a formal package
3339
3340       else
3341          Act_Decl_Id   := Defining_Identifier (N);
3342          Act_Decl_Name := Act_Decl_Id;
3343       end if;
3344
3345       Generate_Definition (Act_Decl_Id);
3346       Preanalyze_Actuals (N);
3347
3348       Init_Env;
3349       Env_Installed := True;
3350
3351       --  Reset renaming map for formal types. The mapping is established
3352       --  when analyzing the generic associations, but some mappings are
3353       --  inherited from formal packages of parent units, and these are
3354       --  constructed when the parents are installed.
3355
3356       Generic_Renamings.Set_Last (0);
3357       Generic_Renamings_HTable.Reset;
3358
3359       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3360       Gen_Unit := Entity (Gen_Id);
3361
3362       --  Verify that it is the name of a generic package
3363
3364       --  A visibility glitch: if the instance is a child unit and the generic
3365       --  is the generic unit of a parent instance (i.e. both the parent and
3366       --  the child units are instances of the same package) the name now
3367       --  denotes the renaming within the parent, not the intended generic
3368       --  unit. See if there is a homonym that is the desired generic. The
3369       --  renaming declaration must be visible inside the instance of the
3370       --  child, but not when analyzing the name in the instantiation itself.
3371
3372       if Ekind (Gen_Unit) = E_Package
3373         and then Present (Renamed_Entity (Gen_Unit))
3374         and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3375         and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3376         and then Present (Homonym (Gen_Unit))
3377       then
3378          Gen_Unit := Homonym (Gen_Unit);
3379       end if;
3380
3381       if Etype (Gen_Unit) = Any_Type then
3382          Restore_Env;
3383          goto Leave;
3384
3385       elsif Ekind (Gen_Unit) /= E_Generic_Package then
3386
3387          --  Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3388
3389          if From_With_Type (Gen_Unit) then
3390             Error_Msg_N
3391               ("cannot instantiate a limited withed package", Gen_Id);
3392          else
3393             Error_Msg_N
3394               ("expect name of generic package in instantiation", Gen_Id);
3395          end if;
3396
3397          Restore_Env;
3398          goto Leave;
3399       end if;
3400
3401       if In_Extended_Main_Source_Unit (N) then
3402          Set_Is_Instantiated (Gen_Unit);
3403          Generate_Reference  (Gen_Unit, N);
3404
3405          if Present (Renamed_Object (Gen_Unit)) then
3406             Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3407             Generate_Reference  (Renamed_Object (Gen_Unit), N);
3408          end if;
3409       end if;
3410
3411       if Nkind (Gen_Id) = N_Identifier
3412         and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3413       then
3414          Error_Msg_NE
3415            ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3416
3417       elsif Nkind (Gen_Id) = N_Expanded_Name
3418         and then Is_Child_Unit (Gen_Unit)
3419         and then Nkind (Prefix (Gen_Id)) = N_Identifier
3420         and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3421       then
3422          Error_Msg_N
3423            ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3424       end if;
3425
3426       Set_Entity (Gen_Id, Gen_Unit);
3427
3428       --  If generic is a renaming, get original generic unit
3429
3430       if Present (Renamed_Object (Gen_Unit))
3431         and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3432       then
3433          Gen_Unit := Renamed_Object (Gen_Unit);
3434       end if;
3435
3436       --  Verify that there are no circular instantiations
3437
3438       if In_Open_Scopes (Gen_Unit) then
3439          Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3440          Restore_Env;
3441          goto Leave;
3442
3443       elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3444          Error_Msg_Node_2 := Current_Scope;
3445          Error_Msg_NE
3446            ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3447          Circularity_Detected := True;
3448          Restore_Env;
3449          goto Leave;
3450
3451       else
3452          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3453
3454          --  Initialize renamings map, for error checking, and the list that
3455          --  holds private entities whose views have changed between generic
3456          --  definition and instantiation. If this is the instance created to
3457          --  validate an actual package, the instantiation environment is that
3458          --  of the enclosing instance.
3459
3460          Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3461
3462          --  Copy original generic tree, to produce text for instantiation
3463
3464          Act_Tree :=
3465            Copy_Generic_Node
3466              (Original_Node (Gen_Decl), Empty, Instantiating => True);
3467
3468          Act_Spec := Specification (Act_Tree);
3469
3470          --  If this is the instance created to validate an actual package,
3471          --  only the formals matter, do not examine the package spec itself.
3472
3473          if Is_Actual_Pack then
3474             Set_Visible_Declarations (Act_Spec, New_List);
3475             Set_Private_Declarations (Act_Spec, New_List);
3476          end if;
3477
3478          Renaming_List :=
3479            Analyze_Associations
3480              (I_Node  => N,
3481               Formals => Generic_Formal_Declarations (Act_Tree),
3482               F_Copy  => Generic_Formal_Declarations (Gen_Decl));
3483
3484          Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3485
3486          Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3487          Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3488          Set_Is_Generic_Instance (Act_Decl_Id);
3489
3490          Set_Generic_Parent (Act_Spec, Gen_Unit);
3491
3492          --  References to the generic in its own declaration or its body are
3493          --  references to the instance. Add a renaming declaration for the
3494          --  generic unit itself. This declaration, as well as the renaming
3495          --  declarations for the generic formals, must remain private to the
3496          --  unit: the formals, because this is the language semantics, and
3497          --  the unit because its use is an artifact of the implementation.
3498
3499          Unit_Renaming :=
3500            Make_Package_Renaming_Declaration (Loc,
3501              Defining_Unit_Name =>
3502                Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3503              Name => New_Reference_To (Act_Decl_Id, Loc));
3504
3505          Append (Unit_Renaming, Renaming_List);
3506
3507          --  The renaming declarations are the first local declarations of
3508          --  the new unit.
3509
3510          if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3511             Insert_List_Before
3512               (First (Visible_Declarations (Act_Spec)), Renaming_List);
3513          else
3514             Set_Visible_Declarations (Act_Spec, Renaming_List);
3515          end if;
3516
3517          Act_Decl :=
3518            Make_Package_Declaration (Loc,
3519              Specification => Act_Spec);
3520
3521          --  Save the instantiation node, for subsequent instantiation of the
3522          --  body, if there is one and we are generating code for the current
3523          --  unit. Mark the unit as having a body, to avoid a premature error
3524          --  message.
3525
3526          --  We instantiate the body if we are generating code, if we are
3527          --  generating cross-reference information, or if we are building
3528          --  trees for ASIS use.
3529
3530          declare
3531             Enclosing_Body_Present : Boolean := False;
3532             --  If the generic unit is not a compilation unit, then a body may
3533             --  be present in its parent even if none is required. We create a
3534             --  tentative pending instantiation for the body, which will be
3535             --  discarded if none is actually present.
3536
3537             Scop : Entity_Id;
3538
3539          begin
3540             if Scope (Gen_Unit) /= Standard_Standard
3541               and then not Is_Child_Unit (Gen_Unit)
3542             then
3543                Scop := Scope (Gen_Unit);
3544
3545                while Present (Scop)
3546                  and then Scop /= Standard_Standard
3547                loop
3548                   if Unit_Requires_Body (Scop) then
3549                      Enclosing_Body_Present := True;
3550                      exit;
3551
3552                   elsif In_Open_Scopes (Scop)
3553                     and then In_Package_Body (Scop)
3554                   then
3555                      Enclosing_Body_Present := True;
3556                      exit;
3557                   end if;
3558
3559                   exit when Is_Compilation_Unit (Scop);
3560                   Scop := Scope (Scop);
3561                end loop;
3562             end if;
3563
3564             --  If front-end inlining is enabled, and this is a unit for which
3565             --  code will be generated, we instantiate the body at once.
3566
3567             --  This is done if the instance is not the main unit, and if the
3568             --  generic is not a child unit of another generic, to avoid scope
3569             --  problems and the reinstallation of parent instances.
3570
3571             if Expander_Active
3572               and then (not Is_Child_Unit (Gen_Unit)
3573                          or else not Is_Generic_Unit (Scope (Gen_Unit)))
3574               and then Might_Inline_Subp
3575               and then not Is_Actual_Pack
3576             then
3577                if Front_End_Inlining
3578                  and then (Is_In_Main_Unit (N)
3579                             or else In_Main_Context (Current_Scope))
3580                  and then Nkind (Parent (N)) /= N_Compilation_Unit
3581                then
3582                   Inline_Now := True;
3583
3584                --  In configurable_run_time mode we force the inlining of
3585                --  predefined subprograms marked Inline_Always, to minimize
3586                --  the use of the run-time library.
3587
3588                elsif Is_Predefined_File_Name
3589                        (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3590                  and then Configurable_Run_Time_Mode
3591                  and then Nkind (Parent (N)) /= N_Compilation_Unit
3592                then
3593                   Inline_Now := True;
3594                end if;
3595
3596                --  If the current scope is itself an instance within a child
3597                --  unit, there will be duplications in the scope stack, and the
3598                --  unstacking mechanism in Inline_Instance_Body will fail.
3599                --  This loses some rare cases of optimization, and might be
3600                --  improved some day, if we can find a proper abstraction for
3601                --  "the complete compilation context" that can be saved and
3602                --  restored. ???
3603
3604                if Is_Generic_Instance (Current_Scope) then
3605                   declare
3606                      Curr_Unit : constant Entity_Id :=
3607                                    Cunit_Entity (Current_Sem_Unit);
3608                   begin
3609                      if Curr_Unit /= Current_Scope
3610                        and then Is_Child_Unit (Curr_Unit)
3611                      then
3612                         Inline_Now := False;
3613                      end if;
3614                   end;
3615                end if;
3616             end if;
3617
3618             Needs_Body :=
3619               (Unit_Requires_Body (Gen_Unit)
3620                   or else Enclosing_Body_Present
3621                   or else Present (Corresponding_Body (Gen_Decl)))
3622                 and then (Is_In_Main_Unit (N)
3623                            or else Might_Inline_Subp)
3624                 and then not Is_Actual_Pack
3625                 and then not Inline_Now
3626                 and then not Alfa_Mode
3627                 and then (Operating_Mode = Generate_Code
3628                            or else (Operating_Mode = Check_Semantics
3629                                      and then ASIS_Mode));
3630
3631             --  If front_end_inlining is enabled, do not instantiate body if
3632             --  within a generic context.
3633
3634             if (Front_End_Inlining
3635                  and then not Expander_Active)
3636               or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3637             then
3638                Needs_Body := False;
3639             end if;
3640
3641             --  If the current context is generic, and the package being
3642             --  instantiated is declared within a formal package, there is no
3643             --  body to instantiate until the enclosing generic is instantiated
3644             --  and there is an actual for the formal package. If the formal
3645             --  package has parameters, we build a regular package instance for
3646             --  it, that precedes the original formal package declaration.
3647
3648             if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3649                declare
3650                   Decl : constant Node_Id :=
3651                            Original_Node
3652                              (Unit_Declaration_Node (Scope (Gen_Unit)));
3653                begin
3654                   if Nkind (Decl) = N_Formal_Package_Declaration
3655                     or else (Nkind (Decl) = N_Package_Declaration
3656                               and then Is_List_Member (Decl)
3657                               and then Present (Next (Decl))
3658                               and then
3659                                 Nkind (Next (Decl)) =
3660                                                 N_Formal_Package_Declaration)
3661                   then
3662                      Needs_Body := False;
3663                   end if;
3664                end;
3665             end if;
3666          end;
3667
3668          --  Note that we generate the instance body even when generating
3669          --  calling stubs for an RCI unit: it may be required e.g. if it
3670          --  provides stream attributes for some type used in the profile of a
3671          --  remote subprogram. If the instantiation is within the visible part
3672          --  of the RCI, then calling stubs for any relevant subprogram will
3673          --  be inserted immediately after the subprogram declaration, and
3674          --  will take precedence over the subsequent (original) body. (The
3675          --  stub and original body will be complete homographs, but this is
3676          --  permitted in an instance).
3677
3678          --  Could we do better and remove the original subprogram body in that
3679          --  case???
3680
3681          if Needs_Body then
3682
3683             --  Here is a defence against a ludicrous number of instantiations
3684             --  caused by a circular set of instantiation attempts.
3685
3686             if Pending_Instantiations.Last >
3687                  Hostparm.Max_Instantiations
3688             then
3689                Error_Msg_N ("too many instantiations", N);
3690                raise Unrecoverable_Error;
3691             end if;
3692
3693             --  Indicate that the enclosing scopes contain an instantiation,
3694             --  and that cleanup actions should be delayed until after the
3695             --  instance body is expanded.
3696
3697             Check_Forward_Instantiation (Gen_Decl);
3698             if Nkind (N) = N_Package_Instantiation then
3699                declare
3700                   Enclosing_Master : Entity_Id;
3701
3702                begin
3703                   --  Loop to search enclosing masters
3704
3705                   Enclosing_Master := Current_Scope;
3706                   Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3707                      if Ekind (Enclosing_Master) = E_Package then
3708                         if Is_Compilation_Unit (Enclosing_Master) then
3709                            if In_Package_Body (Enclosing_Master) then
3710                               Delay_Descriptors
3711                                 (Body_Entity (Enclosing_Master));
3712                            else
3713                               Delay_Descriptors
3714                                 (Enclosing_Master);
3715                            end if;
3716
3717                            exit Scope_Loop;
3718
3719                         else
3720                            Enclosing_Master := Scope (Enclosing_Master);
3721                         end if;
3722
3723                      elsif Is_Generic_Unit (Enclosing_Master)
3724                        or else Ekind (Enclosing_Master) = E_Void
3725                      then
3726                         --  Cleanup actions will eventually be performed on the
3727                         --  enclosing subprogram or package instance, if any.
3728                         --  Enclosing scope is void in the formal part of a
3729                         --  generic subprogram.
3730
3731                         exit Scope_Loop;
3732
3733                      else
3734                         if Ekind (Enclosing_Master) = E_Entry
3735                           and then
3736                             Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3737                         then
3738                            if not Expander_Active then
3739                               exit Scope_Loop;
3740                            else
3741                               Enclosing_Master :=
3742                                 Protected_Body_Subprogram (Enclosing_Master);
3743                            end if;
3744                         end if;
3745
3746                         Set_Delay_Cleanups (Enclosing_Master);
3747
3748                         while Ekind (Enclosing_Master) = E_Block loop
3749                            Enclosing_Master := Scope (Enclosing_Master);
3750                         end loop;
3751
3752                         if Is_Subprogram (Enclosing_Master) then
3753                            Delay_Descriptors (Enclosing_Master);
3754
3755                         elsif Is_Task_Type (Enclosing_Master) then
3756                            declare
3757                               TBP : constant Node_Id :=
3758                                       Get_Task_Body_Procedure
3759                                         (Enclosing_Master);
3760                            begin
3761                               if Present (TBP) then
3762                                  Delay_Descriptors  (TBP);
3763                                  Set_Delay_Cleanups (TBP);
3764                               end if;
3765                            end;
3766                         end if;
3767
3768                         exit Scope_Loop;
3769                      end if;
3770                   end loop Scope_Loop;
3771                end;
3772
3773                --  Make entry in table
3774
3775                Pending_Instantiations.Append
3776                  ((Inst_Node                => N,
3777                    Act_Decl                 => Act_Decl,
3778                    Expander_Status          => Expander_Active,
3779                    Current_Sem_Unit         => Current_Sem_Unit,
3780                    Scope_Suppress           => Scope_Suppress,
3781                    Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3782                    Version                  => Ada_Version));
3783             end if;
3784          end if;
3785
3786          Set_Categorization_From_Pragmas (Act_Decl);
3787
3788          if Parent_Installed then
3789             Hide_Current_Scope;
3790          end if;
3791
3792          Set_Instance_Spec (N, Act_Decl);
3793
3794          --  If not a compilation unit, insert the package declaration before
3795          --  the original instantiation node.
3796
3797          if Nkind (Parent (N)) /= N_Compilation_Unit then
3798             Mark_Rewrite_Insertion (Act_Decl);
3799             Insert_Before (N, Act_Decl);
3800             Analyze (Act_Decl);
3801
3802          --  For an instantiation that is a compilation unit, place declaration
3803          --  on current node so context is complete for analysis (including
3804          --  nested instantiations). If this is the main unit, the declaration
3805          --  eventually replaces the instantiation node. If the instance body
3806          --  is created later, it replaces the instance node, and the
3807          --  declaration is attached to it (see
3808          --  Build_Instance_Compilation_Unit_Nodes).
3809
3810          else
3811             if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3812
3813                --  The entity for the current unit is the newly created one,
3814                --  and all semantic information is attached to it.
3815
3816                Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3817
3818                --  If this is the main unit, replace the main entity as well
3819
3820                if Current_Sem_Unit = Main_Unit then
3821                   Main_Unit_Entity := Act_Decl_Id;
3822                end if;
3823             end if;
3824
3825             Set_Unit (Parent (N), Act_Decl);
3826             Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3827             Set_Package_Instantiation (Act_Decl_Id, N);
3828             Analyze (Act_Decl);
3829             Set_Unit (Parent (N), N);
3830             Set_Body_Required (Parent (N), False);
3831
3832             --  We never need elaboration checks on instantiations, since by
3833             --  definition, the body instantiation is elaborated at the same
3834             --  time as the spec instantiation.
3835
3836             Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3837             Set_Kill_Elaboration_Checks       (Act_Decl_Id);
3838          end if;
3839
3840          Check_Elab_Instantiation (N);
3841
3842          if ABE_Is_Certain (N) and then Needs_Body then
3843             Pending_Instantiations.Decrement_Last;
3844          end if;
3845
3846          Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3847
3848          Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3849            First_Private_Entity (Act_Decl_Id));
3850
3851          --  If the instantiation will receive a body, the unit will be
3852          --  transformed into a package body, and receive its own elaboration
3853          --  entity. Otherwise, the nature of the unit is now a package
3854          --  declaration.
3855
3856          if Nkind (Parent (N)) = N_Compilation_Unit
3857            and then not Needs_Body
3858          then
3859             Rewrite (N, Act_Decl);
3860          end if;
3861
3862          if Present (Corresponding_Body (Gen_Decl))
3863            or else Unit_Requires_Body (Gen_Unit)
3864          then
3865             Set_Has_Completion (Act_Decl_Id);
3866          end if;
3867
3868          Check_Formal_Packages (Act_Decl_Id);
3869
3870          Restore_Hidden_Primitives (Vis_Prims_List);
3871          Restore_Private_Views (Act_Decl_Id);
3872
3873          Inherit_Context (Gen_Decl, N);
3874
3875          if Parent_Installed then
3876             Remove_Parent;
3877          end if;
3878
3879          Restore_Env;
3880          Env_Installed := False;
3881       end if;
3882
3883       Validate_Categorization_Dependency (N, Act_Decl_Id);
3884
3885       --  There used to be a check here to prevent instantiations in local
3886       --  contexts if the No_Local_Allocators restriction was active. This
3887       --  check was removed by a binding interpretation in AI-95-00130/07,
3888       --  but we retain the code for documentation purposes.
3889
3890       --  if Ekind (Act_Decl_Id) /= E_Void
3891       --    and then not Is_Library_Level_Entity (Act_Decl_Id)
3892       --  then
3893       --     Check_Restriction (No_Local_Allocators, N);
3894       --  end if;
3895
3896       if Inline_Now then
3897          Inline_Instance_Body (N, Gen_Unit, Act_Decl);
3898       end if;
3899
3900       --  The following is a tree patch for ASIS: ASIS needs separate nodes to
3901       --  be used as defining identifiers for a formal package and for the
3902       --  corresponding expanded package.
3903
3904       if Nkind (N) = N_Formal_Package_Declaration then
3905          Act_Decl_Id := New_Copy (Defining_Entity (N));
3906          Set_Comes_From_Source (Act_Decl_Id, True);
3907          Set_Is_Generic_Instance (Act_Decl_Id, False);
3908          Set_Defining_Identifier (N, Act_Decl_Id);
3909       end if;
3910
3911       Style_Check := Save_Style_Check;
3912
3913       --  Check that if N is an instantiation of System.Dim_Float_IO or
3914       --  System.Dim_Integer_IO, the formal type has a dimension system.
3915
3916       if Nkind (N) = N_Package_Instantiation
3917         and then Is_Dim_IO_Package_Instantiation (N)
3918       then
3919          declare
3920             Assoc : constant Node_Id := First (Generic_Associations (N));
3921          begin
3922             if not Has_Dimension_System
3923                      (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
3924             then
3925                Error_Msg_N ("type with a dimension system expected", Assoc);
3926             end if;
3927          end;
3928       end if;
3929
3930    <<Leave>>
3931       if Has_Aspects (N) then
3932          Analyze_Aspect_Specifications (N, Act_Decl_Id);
3933       end if;
3934
3935    exception
3936       when Instantiation_Error =>
3937          if Parent_Installed then
3938             Remove_Parent;
3939          end if;
3940
3941          if Env_Installed then
3942             Restore_Env;
3943          end if;
3944
3945          Style_Check := Save_Style_Check;
3946    end Analyze_Package_Instantiation;
3947
3948    --------------------------
3949    -- Inline_Instance_Body --
3950    --------------------------
3951
3952    procedure Inline_Instance_Body
3953      (N        : Node_Id;
3954       Gen_Unit : Entity_Id;
3955       Act_Decl : Node_Id)
3956    is
3957       Vis          : Boolean;
3958       Gen_Comp     : constant Entity_Id :=
3959                       Cunit_Entity (Get_Source_Unit (Gen_Unit));
3960       Curr_Comp    : constant Node_Id := Cunit (Current_Sem_Unit);
3961       Curr_Scope   : Entity_Id := Empty;
3962       Curr_Unit    : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
3963       Removed      : Boolean := False;
3964       Num_Scopes   : Int := 0;
3965
3966       Scope_Stack_Depth : constant Int :=
3967                             Scope_Stack.Last - Scope_Stack.First + 1;
3968
3969       Use_Clauses  : array (1 .. Scope_Stack_Depth) of Node_Id;
3970       Instances    : array (1 .. Scope_Stack_Depth) of Entity_Id;
3971       Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
3972       Num_Inner    : Int := 0;
3973       N_Instances  : Int := 0;
3974       S            : Entity_Id;
3975
3976    begin
3977       --  Case of generic unit defined in another unit. We must remove the
3978       --  complete context of the current unit to install that of the generic.
3979
3980       if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
3981
3982          --  Add some comments for the following two loops ???
3983
3984          S := Current_Scope;
3985          while Present (S) and then S /= Standard_Standard loop
3986             loop
3987                Num_Scopes := Num_Scopes + 1;
3988
3989                Use_Clauses (Num_Scopes) :=
3990                  (Scope_Stack.Table
3991                     (Scope_Stack.Last - Num_Scopes + 1).
3992                        First_Use_Clause);
3993                End_Use_Clauses (Use_Clauses (Num_Scopes));
3994
3995                exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
3996                  or else Scope_Stack.Table
3997                            (Scope_Stack.Last - Num_Scopes).Entity
3998                              = Scope (S);
3999             end loop;
4000
4001             exit when Is_Generic_Instance (S)
4002               and then (In_Package_Body (S)
4003                           or else Ekind (S) = E_Procedure
4004                           or else Ekind (S) = E_Function);
4005             S := Scope (S);
4006          end loop;
4007
4008          Vis := Is_Immediately_Visible (Gen_Comp);
4009
4010          --  Find and save all enclosing instances
4011
4012          S := Current_Scope;
4013
4014          while Present (S)
4015            and then S /= Standard_Standard
4016          loop
4017             if Is_Generic_Instance (S) then
4018                N_Instances := N_Instances + 1;
4019                Instances (N_Instances) := S;
4020
4021                exit when In_Package_Body (S);
4022             end if;
4023
4024             S := Scope (S);
4025          end loop;
4026
4027          --  Remove context of current compilation unit, unless we are within a
4028          --  nested package instantiation, in which case the context has been
4029          --  removed previously.
4030
4031          --  If current scope is the body of a child unit, remove context of
4032          --  spec as well. If an enclosing scope is an instance body, the
4033          --  context has already been removed, but the entities in the body
4034          --  must be made invisible as well.
4035
4036          S := Current_Scope;
4037
4038          while Present (S)
4039            and then S /= Standard_Standard
4040          loop
4041             if Is_Generic_Instance (S)
4042               and then (In_Package_Body (S)
4043                           or else Ekind (S) = E_Procedure
4044                             or else Ekind (S) = E_Function)
4045             then
4046                --  We still have to remove the entities of the enclosing
4047                --  instance from direct visibility.
4048
4049                declare
4050                   E : Entity_Id;
4051                begin
4052                   E := First_Entity (S);
4053                   while Present (E) loop
4054                      Set_Is_Immediately_Visible (E, False);
4055                      Next_Entity (E);
4056                   end loop;
4057                end;
4058
4059                exit;
4060             end if;
4061
4062             if S = Curr_Unit
4063               or else (Ekind (Curr_Unit) = E_Package_Body
4064                         and then S = Spec_Entity (Curr_Unit))
4065               or else (Ekind (Curr_Unit) = E_Subprogram_Body
4066                         and then S =
4067                           Corresponding_Spec
4068                             (Unit_Declaration_Node (Curr_Unit)))
4069             then
4070                Removed := True;
4071
4072                --  Remove entities in current scopes from visibility, so that
4073                --  instance body is compiled in a clean environment.
4074
4075                Save_Scope_Stack (Handle_Use => False);
4076
4077                if Is_Child_Unit (S) then
4078
4079                   --  Remove child unit from stack, as well as inner scopes.
4080                   --  Removing the context of a child unit removes parent units
4081                   --  as well.
4082
4083                   while Current_Scope /= S loop
4084                      Num_Inner := Num_Inner + 1;
4085                      Inner_Scopes (Num_Inner) := Current_Scope;
4086                      Pop_Scope;
4087                   end loop;
4088
4089                   Pop_Scope;
4090                   Remove_Context (Curr_Comp);
4091                   Curr_Scope := S;
4092
4093                else
4094                   Remove_Context (Curr_Comp);
4095                end if;
4096
4097                if Ekind (Curr_Unit) = E_Package_Body then
4098                   Remove_Context (Library_Unit (Curr_Comp));
4099                end if;
4100             end if;
4101
4102             S := Scope (S);
4103          end loop;
4104          pragma Assert (Num_Inner < Num_Scopes);
4105
4106          Push_Scope (Standard_Standard);
4107          Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4108          Instantiate_Package_Body
4109            (Body_Info =>
4110              ((Inst_Node                => N,
4111                Act_Decl                 => Act_Decl,
4112                Expander_Status          => Expander_Active,
4113                Current_Sem_Unit         => Current_Sem_Unit,
4114                Scope_Suppress           => Scope_Suppress,
4115                Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4116                Version                  => Ada_Version)),
4117             Inlined_Body => True);
4118
4119          Pop_Scope;
4120
4121          --  Restore context
4122
4123          Set_Is_Immediately_Visible (Gen_Comp, Vis);
4124
4125          --  Reset Generic_Instance flag so that use clauses can be installed
4126          --  in the proper order. (See Use_One_Package for effect of enclosing
4127          --  instances on processing of use clauses).
4128
4129          for J in 1 .. N_Instances loop
4130             Set_Is_Generic_Instance (Instances (J), False);
4131          end loop;
4132
4133          if Removed then
4134             Install_Context (Curr_Comp);
4135
4136             if Present (Curr_Scope)
4137               and then Is_Child_Unit (Curr_Scope)
4138             then
4139                Push_Scope (Curr_Scope);
4140                Set_Is_Immediately_Visible (Curr_Scope);
4141
4142                --  Finally, restore inner scopes as well
4143
4144                for J in reverse 1 .. Num_Inner loop
4145                   Push_Scope (Inner_Scopes (J));
4146                end loop;
4147             end if;
4148
4149             Restore_Scope_Stack (Handle_Use => False);
4150
4151             if Present (Curr_Scope)
4152               and then
4153                 (In_Private_Part (Curr_Scope)
4154                   or else In_Package_Body (Curr_Scope))
4155             then
4156                --  Install private declaration of ancestor units, which are
4157                --  currently available. Restore_Scope_Stack and Install_Context
4158                --  only install the visible part of parents.
4159
4160                declare
4161                   Par : Entity_Id;
4162                begin
4163                   Par := Scope (Curr_Scope);
4164                   while (Present (Par))
4165                     and then Par /= Standard_Standard
4166                   loop
4167                      Install_Private_Declarations (Par);
4168                      Par := Scope (Par);
4169                   end loop;
4170                end;
4171             end if;
4172          end if;
4173
4174          --  Restore use clauses. For a child unit, use clauses in the parents
4175          --  are restored when installing the context, so only those in inner
4176          --  scopes (and those local to the child unit itself) need to be
4177          --  installed explicitly.
4178
4179          if Is_Child_Unit (Curr_Unit)
4180            and then Removed
4181          then
4182             for J in reverse 1 .. Num_Inner + 1 loop
4183                Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4184                  Use_Clauses (J);
4185                Install_Use_Clauses (Use_Clauses (J));
4186             end  loop;
4187
4188          else
4189             for J in reverse 1 .. Num_Scopes loop
4190                Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4191                  Use_Clauses (J);
4192                Install_Use_Clauses (Use_Clauses (J));
4193             end  loop;
4194          end if;
4195
4196          --  Restore status of instances. If one of them is a body, make
4197          --  its local entities visible again.
4198
4199          declare
4200             E    : Entity_Id;
4201             Inst : Entity_Id;
4202
4203          begin
4204             for J in 1 .. N_Instances loop
4205                Inst := Instances (J);
4206                Set_Is_Generic_Instance (Inst, True);
4207
4208                if In_Package_Body (Inst)
4209                  or else Ekind (S) = E_Procedure
4210                  or else Ekind (S) = E_Function
4211                then
4212                   E := First_Entity (Instances (J));
4213                   while Present (E) loop
4214                      Set_Is_Immediately_Visible (E);
4215                      Next_Entity (E);
4216                   end loop;
4217                end if;
4218             end loop;
4219          end;
4220
4221       --  If generic unit is in current unit, current context is correct
4222
4223       else
4224          Instantiate_Package_Body
4225            (Body_Info =>
4226              ((Inst_Node                => N,
4227                Act_Decl                 => Act_Decl,
4228                Expander_Status          => Expander_Active,
4229                Current_Sem_Unit         => Current_Sem_Unit,
4230                Scope_Suppress           => Scope_Suppress,
4231                Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4232                Version                  => Ada_Version)),
4233             Inlined_Body => True);
4234       end if;
4235    end Inline_Instance_Body;
4236
4237    -------------------------------------
4238    -- Analyze_Procedure_Instantiation --
4239    -------------------------------------
4240
4241    procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4242    begin
4243       Analyze_Subprogram_Instantiation (N, E_Procedure);
4244    end Analyze_Procedure_Instantiation;
4245
4246    -----------------------------------
4247    -- Need_Subprogram_Instance_Body --
4248    -----------------------------------
4249
4250    function Need_Subprogram_Instance_Body
4251      (N    : Node_Id;
4252       Subp : Entity_Id) return Boolean
4253    is
4254    begin
4255       if (Is_In_Main_Unit (N)
4256            or else Is_Inlined (Subp)
4257            or else Is_Inlined (Alias (Subp)))
4258         and then (Operating_Mode = Generate_Code
4259                    or else (Operating_Mode = Check_Semantics
4260                              and then ASIS_Mode))
4261         and then (Full_Expander_Active or else ASIS_Mode)
4262         and then not ABE_Is_Certain (N)
4263         and then not Is_Eliminated (Subp)
4264       then
4265          Pending_Instantiations.Append
4266            ((Inst_Node                => N,
4267              Act_Decl                 => Unit_Declaration_Node (Subp),
4268              Expander_Status          => Expander_Active,
4269              Current_Sem_Unit         => Current_Sem_Unit,
4270              Scope_Suppress           => Scope_Suppress,
4271              Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4272              Version                  => Ada_Version));
4273          return True;
4274
4275       else
4276          return False;
4277       end if;
4278    end Need_Subprogram_Instance_Body;
4279
4280    --------------------------------------
4281    -- Analyze_Subprogram_Instantiation --
4282    --------------------------------------
4283
4284    procedure Analyze_Subprogram_Instantiation
4285      (N : Node_Id;
4286       K : Entity_Kind)
4287    is
4288       Loc    : constant Source_Ptr := Sloc (N);
4289       Gen_Id : constant Node_Id    := Name (N);
4290
4291       Anon_Id : constant Entity_Id :=
4292                   Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4293                     Chars => New_External_Name
4294                                (Chars (Defining_Entity (N)), 'R'));
4295
4296       Act_Decl_Id : Entity_Id;
4297       Act_Decl    : Node_Id;
4298       Act_Spec    : Node_Id;
4299       Act_Tree    : Node_Id;
4300
4301       Env_Installed    : Boolean := False;
4302       Gen_Unit         : Entity_Id;
4303       Gen_Decl         : Node_Id;
4304       Pack_Id          : Entity_Id;
4305       Parent_Installed : Boolean := False;
4306       Renaming_List    : List_Id;
4307
4308       Save_Style_Check : constant Boolean := Style_Check;
4309       --  Save style check mode for restore on exit
4310
4311       procedure Analyze_Instance_And_Renamings;
4312       --  The instance must be analyzed in a context that includes the mappings
4313       --  of generic parameters into actuals. We create a package declaration
4314       --  for this purpose, and a subprogram with an internal name within the
4315       --  package. The subprogram instance is simply an alias for the internal
4316       --  subprogram, declared in the current scope.
4317
4318       ------------------------------------
4319       -- Analyze_Instance_And_Renamings --
4320       ------------------------------------
4321
4322       procedure Analyze_Instance_And_Renamings is
4323          Def_Ent   : constant Entity_Id := Defining_Entity (N);
4324          Pack_Decl : Node_Id;
4325
4326       begin
4327          if Nkind (Parent (N)) = N_Compilation_Unit then
4328
4329             --  For the case of a compilation unit, the container package has
4330             --  the same name as the instantiation, to insure that the binder
4331             --  calls the elaboration procedure with the right name. Copy the
4332             --  entity of the instance, which may have compilation level flags
4333             --  (e.g. Is_Child_Unit) set.
4334
4335             Pack_Id := New_Copy (Def_Ent);
4336
4337          else
4338             --  Otherwise we use the name of the instantiation concatenated
4339             --  with its source position to ensure uniqueness if there are
4340             --  several instantiations with the same name.
4341
4342             Pack_Id :=
4343               Make_Defining_Identifier (Loc,
4344                 Chars => New_External_Name
4345                            (Related_Id   => Chars (Def_Ent),
4346                             Suffix       => "GP",
4347                             Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4348          end if;
4349
4350          Pack_Decl := Make_Package_Declaration (Loc,
4351            Specification => Make_Package_Specification (Loc,
4352              Defining_Unit_Name   => Pack_Id,
4353              Visible_Declarations => Renaming_List,
4354              End_Label            => Empty));
4355
4356          Set_Instance_Spec (N, Pack_Decl);
4357          Set_Is_Generic_Instance (Pack_Id);
4358          Set_Debug_Info_Needed (Pack_Id);
4359
4360          --  Case of not a compilation unit
4361
4362          if Nkind (Parent (N)) /= N_Compilation_Unit then
4363             Mark_Rewrite_Insertion (Pack_Decl);
4364             Insert_Before (N, Pack_Decl);
4365             Set_Has_Completion (Pack_Id);
4366
4367          --  Case of an instantiation that is a compilation unit
4368
4369          --  Place declaration on current node so context is complete for
4370          --  analysis (including nested instantiations), and for use in a
4371          --  context_clause (see Analyze_With_Clause).
4372
4373          else
4374             Set_Unit (Parent (N), Pack_Decl);
4375             Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4376          end if;
4377
4378          Analyze (Pack_Decl);
4379          Check_Formal_Packages (Pack_Id);
4380          Set_Is_Generic_Instance (Pack_Id, False);
4381
4382          --  Why do we clear Is_Generic_Instance??? We set it 20 lines
4383          --  above???
4384
4385          --  Body of the enclosing package is supplied when instantiating the
4386          --  subprogram body, after semantic analysis is completed.
4387
4388          if Nkind (Parent (N)) = N_Compilation_Unit then
4389
4390             --  Remove package itself from visibility, so it does not
4391             --  conflict with subprogram.
4392
4393             Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4394
4395             --  Set name and scope of internal subprogram so that the proper
4396             --  external name will be generated. The proper scope is the scope
4397             --  of the wrapper package. We need to generate debugging info for
4398             --  the internal subprogram, so set flag accordingly.
4399
4400             Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4401             Set_Scope (Anon_Id, Scope (Pack_Id));
4402
4403             --  Mark wrapper package as referenced, to avoid spurious warnings
4404             --  if the instantiation appears in various with_ clauses of
4405             --  subunits of the main unit.
4406
4407             Set_Referenced (Pack_Id);
4408          end if;
4409
4410          Set_Is_Generic_Instance (Anon_Id);
4411          Set_Debug_Info_Needed   (Anon_Id);
4412          Act_Decl_Id := New_Copy (Anon_Id);
4413
4414          Set_Parent            (Act_Decl_Id, Parent (Anon_Id));
4415          Set_Chars             (Act_Decl_Id, Chars (Defining_Entity (N)));
4416          Set_Sloc              (Act_Decl_Id, Sloc (Defining_Entity (N)));
4417          Set_Comes_From_Source (Act_Decl_Id, True);
4418
4419          --  The signature may involve types that are not frozen yet, but the
4420          --  subprogram will be frozen at the point the wrapper package is
4421          --  frozen, so it does not need its own freeze node. In fact, if one
4422          --  is created, it might conflict with the freezing actions from the
4423          --  wrapper package.
4424
4425          Set_Has_Delayed_Freeze (Anon_Id, False);
4426
4427          --  If the instance is a child unit, mark the Id accordingly. Mark
4428          --  the anonymous entity as well, which is the real subprogram and
4429          --  which is used when the instance appears in a context clause.
4430          --  Similarly, propagate the Is_Eliminated flag to handle properly
4431          --  nested eliminated subprograms.
4432
4433          Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4434          Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4435          New_Overloaded_Entity (Act_Decl_Id);
4436          Check_Eliminated  (Act_Decl_Id);
4437          Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4438
4439          --  In compilation unit case, kill elaboration checks on the
4440          --  instantiation, since they are never needed -- the body is
4441          --  instantiated at the same point as the spec.
4442
4443          if Nkind (Parent (N)) = N_Compilation_Unit then
4444             Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4445             Set_Kill_Elaboration_Checks       (Act_Decl_Id);
4446             Set_Is_Compilation_Unit (Anon_Id);
4447
4448             Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4449          end if;
4450
4451          --  The instance is not a freezing point for the new subprogram
4452
4453          Set_Is_Frozen (Act_Decl_Id, False);
4454
4455          if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4456             Valid_Operator_Definition (Act_Decl_Id);
4457          end if;
4458
4459          Set_Alias  (Act_Decl_Id, Anon_Id);
4460          Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4461          Set_Has_Completion (Act_Decl_Id);
4462          Set_Related_Instance (Pack_Id, Act_Decl_Id);
4463
4464          if Nkind (Parent (N)) = N_Compilation_Unit then
4465             Set_Body_Required (Parent (N), False);
4466          end if;
4467       end Analyze_Instance_And_Renamings;
4468
4469       --  Local variables
4470
4471       Vis_Prims_List : Elist_Id := No_Elist;
4472       --  List of primitives made temporarily visible in the instantiation
4473       --  to match the visibility of the formal type
4474
4475    --  Start of processing for Analyze_Subprogram_Instantiation
4476
4477    begin
4478       Check_SPARK_Restriction ("generic is not allowed", N);
4479
4480       --  Very first thing: apply the special kludge for Text_IO processing
4481       --  in case we are instantiating one of the children of [Wide_]Text_IO.
4482       --  Of course such an instantiation is bogus (these are packages, not
4483       --  subprograms), but we get a better error message if we do this.
4484
4485       Text_IO_Kludge (Gen_Id);
4486
4487       --  Make node global for error reporting
4488
4489       Instantiation_Node := N;
4490
4491       --  Turn off style checking in instances. If the check is enabled on the
4492       --  generic unit, a warning in an instance would just be noise. If not
4493       --  enabled on the generic, then a warning in an instance is just wrong.
4494
4495       Style_Check := False;
4496
4497       Preanalyze_Actuals (N);
4498
4499       Init_Env;
4500       Env_Installed := True;
4501       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4502       Gen_Unit := Entity (Gen_Id);
4503
4504       Generate_Reference (Gen_Unit, Gen_Id);
4505
4506       if Nkind (Gen_Id) = N_Identifier
4507         and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4508       then
4509          Error_Msg_NE
4510            ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4511       end if;
4512
4513       if Etype (Gen_Unit) = Any_Type then
4514          Restore_Env;
4515          return;
4516       end if;
4517
4518       --  Verify that it is a generic subprogram of the right kind, and that
4519       --  it does not lead to a circular instantiation.
4520
4521       if not Ekind_In (Gen_Unit, E_Generic_Procedure, E_Generic_Function) then
4522          Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
4523
4524       elsif In_Open_Scopes (Gen_Unit) then
4525          Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4526
4527       elsif K = E_Procedure
4528         and then Ekind (Gen_Unit) /= E_Generic_Procedure
4529       then
4530          if Ekind (Gen_Unit) = E_Generic_Function then
4531             Error_Msg_N
4532               ("cannot instantiate generic function as procedure", Gen_Id);
4533          else
4534             Error_Msg_N
4535               ("expect name of generic procedure in instantiation", Gen_Id);
4536          end if;
4537
4538       elsif K = E_Function
4539         and then Ekind (Gen_Unit) /= E_Generic_Function
4540       then
4541          if Ekind (Gen_Unit) = E_Generic_Procedure then
4542             Error_Msg_N
4543               ("cannot instantiate generic procedure as function", Gen_Id);
4544          else
4545             Error_Msg_N
4546               ("expect name of generic function in instantiation", Gen_Id);
4547          end if;
4548
4549       else
4550          Set_Entity (Gen_Id, Gen_Unit);
4551          Set_Is_Instantiated (Gen_Unit);
4552
4553          if In_Extended_Main_Source_Unit (N) then
4554             Generate_Reference (Gen_Unit, N);
4555          end if;
4556
4557          --  If renaming, get original unit
4558
4559          if Present (Renamed_Object (Gen_Unit))
4560            and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4561                        or else
4562                      Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4563          then
4564             Gen_Unit := Renamed_Object (Gen_Unit);
4565             Set_Is_Instantiated (Gen_Unit);
4566             Generate_Reference  (Gen_Unit, N);
4567          end if;
4568
4569          if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4570             Error_Msg_Node_2 := Current_Scope;
4571             Error_Msg_NE
4572               ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4573             Circularity_Detected := True;
4574             Restore_Hidden_Primitives (Vis_Prims_List);
4575             goto Leave;
4576          end if;
4577
4578          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4579
4580          --  Initialize renamings map, for error checking
4581
4582          Generic_Renamings.Set_Last (0);
4583          Generic_Renamings_HTable.Reset;
4584
4585          Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4586
4587          --  Copy original generic tree, to produce text for instantiation
4588
4589          Act_Tree :=
4590            Copy_Generic_Node
4591              (Original_Node (Gen_Decl), Empty, Instantiating => True);
4592
4593          --  Inherit overriding indicator from instance node
4594
4595          Act_Spec := Specification (Act_Tree);
4596          Set_Must_Override     (Act_Spec, Must_Override (N));
4597          Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4598
4599          Renaming_List :=
4600            Analyze_Associations
4601              (I_Node  => N,
4602               Formals => Generic_Formal_Declarations (Act_Tree),
4603               F_Copy  => Generic_Formal_Declarations (Gen_Decl));
4604
4605          Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4606
4607          --  The subprogram itself cannot contain a nested instance, so the
4608          --  current parent is left empty.
4609
4610          Set_Instance_Env (Gen_Unit, Empty);
4611
4612          --  Build the subprogram declaration, which does not appear in the
4613          --  generic template, and give it a sloc consistent with that of the
4614          --  template.
4615
4616          Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4617          Set_Generic_Parent (Act_Spec, Gen_Unit);
4618          Act_Decl :=
4619            Make_Subprogram_Declaration (Sloc (Act_Spec),
4620              Specification => Act_Spec);
4621
4622          --  The aspects have been copied previously, but they have to be
4623          --  linked explicitly to the new subprogram declaration. Explicit
4624          --  pre/postconditions on the instance are analyzed below, in a
4625          --  separate step.
4626
4627          Move_Aspects (Act_Tree, Act_Decl);
4628          Set_Categorization_From_Pragmas (Act_Decl);
4629
4630          if Parent_Installed then
4631             Hide_Current_Scope;
4632          end if;
4633
4634          Append (Act_Decl, Renaming_List);
4635          Analyze_Instance_And_Renamings;
4636
4637          --  If the generic is marked Import (Intrinsic), then so is the
4638          --  instance. This indicates that there is no body to instantiate. If
4639          --  generic is marked inline, so it the instance, and the anonymous
4640          --  subprogram it renames. If inlined, or else if inlining is enabled
4641          --  for the compilation, we generate the instance body even if it is
4642          --  not within the main unit.
4643
4644          if Is_Intrinsic_Subprogram (Gen_Unit) then
4645             Set_Is_Intrinsic_Subprogram (Anon_Id);
4646             Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4647
4648             if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4649                Validate_Unchecked_Conversion (N, Act_Decl_Id);
4650             end if;
4651          end if;
4652
4653          --  Inherit convention from generic unit. Intrinsic convention, as for
4654          --  an instance of unchecked conversion, is not inherited because an
4655          --  explicit Ada instance has been created.
4656
4657          if Has_Convention_Pragma (Gen_Unit)
4658            and then Convention (Gen_Unit) /= Convention_Intrinsic
4659          then
4660             Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4661             Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4662          end if;
4663
4664          Generate_Definition (Act_Decl_Id);
4665          Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id))); -- ??? needed?
4666          Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4667
4668          --  Inherit all inlining-related flags which apply to the generic in
4669          --  the subprogram and its declaration.
4670
4671          Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4672          Set_Is_Inlined (Anon_Id,     Is_Inlined (Gen_Unit));
4673
4674          Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4675          Set_Has_Pragma_Inline (Anon_Id,     Has_Pragma_Inline (Gen_Unit));
4676
4677          Set_Has_Pragma_Inline_Always
4678            (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4679          Set_Has_Pragma_Inline_Always
4680            (Anon_Id,     Has_Pragma_Inline_Always (Gen_Unit));
4681
4682          if not Is_Intrinsic_Subprogram (Gen_Unit) then
4683             Check_Elab_Instantiation (N);
4684          end if;
4685
4686          if Is_Dispatching_Operation (Act_Decl_Id)
4687            and then Ada_Version >= Ada_2005
4688          then
4689             declare
4690                Formal : Entity_Id;
4691
4692             begin
4693                Formal := First_Formal (Act_Decl_Id);
4694                while Present (Formal) loop
4695                   if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4696                     and then Is_Controlling_Formal (Formal)
4697                     and then not Can_Never_Be_Null (Formal)
4698                   then
4699                      Error_Msg_NE ("access parameter& is controlling,",
4700                        N, Formal);
4701                      Error_Msg_NE
4702                        ("\corresponding parameter of & must be"
4703                        & " explicitly null-excluding", N, Gen_Id);
4704                   end if;
4705
4706                   Next_Formal (Formal);
4707                end loop;
4708             end;
4709          end if;
4710
4711          Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4712
4713          Validate_Categorization_Dependency (N, Act_Decl_Id);
4714
4715          if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4716             Inherit_Context (Gen_Decl, N);
4717
4718             Restore_Private_Views (Pack_Id, False);
4719
4720             --  If the context requires a full instantiation, mark node for
4721             --  subsequent construction of the body.
4722
4723             if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4724
4725                Check_Forward_Instantiation (Gen_Decl);
4726
4727                --  The wrapper package is always delayed, because it does not
4728                --  constitute a freeze point, but to insure that the freeze
4729                --  node is placed properly, it is created directly when
4730                --  instantiating the body (otherwise the freeze node might
4731                --  appear to early for nested instantiations).
4732
4733             elsif Nkind (Parent (N)) = N_Compilation_Unit then
4734
4735                --  For ASIS purposes, indicate that the wrapper package has
4736                --  replaced the instantiation node.
4737
4738                Rewrite (N, Unit (Parent (N)));
4739                Set_Unit (Parent (N), N);
4740             end if;
4741
4742          elsif Nkind (Parent (N)) = N_Compilation_Unit then
4743
4744                --  Replace instance node for library-level instantiations of
4745                --  intrinsic subprograms, for ASIS use.
4746
4747                Rewrite (N, Unit (Parent (N)));
4748                Set_Unit (Parent (N), N);
4749          end if;
4750
4751          if Parent_Installed then
4752             Remove_Parent;
4753          end if;
4754
4755          Restore_Hidden_Primitives (Vis_Prims_List);
4756          Restore_Env;
4757          Env_Installed := False;
4758          Generic_Renamings.Set_Last (0);
4759          Generic_Renamings_HTable.Reset;
4760       end if;
4761
4762       Style_Check := Save_Style_Check;
4763
4764    <<Leave>>
4765       if Has_Aspects (N) then
4766          Analyze_Aspect_Specifications (N, Act_Decl_Id);
4767       end if;
4768
4769    exception
4770       when Instantiation_Error =>
4771          if Parent_Installed then
4772             Remove_Parent;
4773          end if;
4774
4775          if Env_Installed then
4776             Restore_Env;
4777          end if;
4778
4779          Style_Check := Save_Style_Check;
4780    end Analyze_Subprogram_Instantiation;
4781
4782    -------------------------
4783    -- Get_Associated_Node --
4784    -------------------------
4785
4786    function Get_Associated_Node (N : Node_Id) return Node_Id is
4787       Assoc : Node_Id;
4788
4789    begin
4790       Assoc := Associated_Node (N);
4791
4792       if Nkind (Assoc) /= Nkind (N) then
4793          return Assoc;
4794
4795       elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4796          return Assoc;
4797
4798       else
4799          --  If the node is part of an inner generic, it may itself have been
4800          --  remapped into a further generic copy. Associated_Node is otherwise
4801          --  used for the entity of the node, and will be of a different node
4802          --  kind, or else N has been rewritten as a literal or function call.
4803
4804          while Present (Associated_Node (Assoc))
4805            and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4806          loop
4807             Assoc := Associated_Node (Assoc);
4808          end loop;
4809
4810          --  Follow and additional link in case the final node was rewritten.
4811          --  This can only happen with nested generic units.
4812
4813          if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4814            and then Present (Associated_Node (Assoc))
4815            and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4816                                                         N_Explicit_Dereference,
4817                                                         N_Integer_Literal,
4818                                                         N_Real_Literal,
4819                                                         N_String_Literal))
4820          then
4821             Assoc := Associated_Node (Assoc);
4822          end if;
4823
4824          return Assoc;
4825       end if;
4826    end Get_Associated_Node;
4827
4828    -------------------------------------------
4829    -- Build_Instance_Compilation_Unit_Nodes --
4830    -------------------------------------------
4831
4832    procedure Build_Instance_Compilation_Unit_Nodes
4833      (N        : Node_Id;
4834       Act_Body : Node_Id;
4835       Act_Decl : Node_Id)
4836    is
4837       Decl_Cunit : Node_Id;
4838       Body_Cunit : Node_Id;
4839       Citem      : Node_Id;
4840       New_Main   : constant Entity_Id := Defining_Entity (Act_Decl);
4841       Old_Main   : constant Entity_Id := Cunit_Entity (Main_Unit);
4842
4843    begin
4844       --  A new compilation unit node is built for the instance declaration
4845
4846       Decl_Cunit :=
4847         Make_Compilation_Unit (Sloc (N),
4848           Context_Items  => Empty_List,
4849           Unit           => Act_Decl,
4850           Aux_Decls_Node =>
4851             Make_Compilation_Unit_Aux (Sloc (N)));
4852
4853       Set_Parent_Spec   (Act_Decl, Parent_Spec (N));
4854
4855       --  The new compilation unit is linked to its body, but both share the
4856       --  same file, so we do not set Body_Required on the new unit so as not
4857       --  to create a spurious dependency on a non-existent body in the ali.
4858       --  This simplifies CodePeer unit traversal.
4859
4860       --  We use the original instantiation compilation unit as the resulting
4861       --  compilation unit of the instance, since this is the main unit.
4862
4863       Rewrite (N, Act_Body);
4864       Body_Cunit := Parent (N);
4865
4866       --  The two compilation unit nodes are linked by the Library_Unit field
4867
4868       Set_Library_Unit  (Decl_Cunit, Body_Cunit);
4869       Set_Library_Unit  (Body_Cunit, Decl_Cunit);
4870
4871       --  Preserve the private nature of the package if needed
4872
4873       Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
4874
4875       --  If the instance is not the main unit, its context, categorization
4876       --  and elaboration entity are not relevant to the compilation.
4877
4878       if Body_Cunit /= Cunit (Main_Unit) then
4879          Make_Instance_Unit (Body_Cunit, In_Main => False);
4880          return;
4881       end if;
4882
4883       --  The context clause items on the instantiation, which are now attached
4884       --  to the body compilation unit (since the body overwrote the original
4885       --  instantiation node), semantically belong on the spec, so copy them
4886       --  there. It's harmless to leave them on the body as well. In fact one
4887       --  could argue that they belong in both places.
4888
4889       Citem := First (Context_Items (Body_Cunit));
4890       while Present (Citem) loop
4891          Append (New_Copy (Citem), Context_Items (Decl_Cunit));
4892          Next (Citem);
4893       end loop;
4894
4895       --  Propagate categorization flags on packages, so that they appear in
4896       --  the ali file for the spec of the unit.
4897
4898       if Ekind (New_Main) = E_Package then
4899          Set_Is_Pure           (Old_Main, Is_Pure (New_Main));
4900          Set_Is_Preelaborated  (Old_Main, Is_Preelaborated (New_Main));
4901          Set_Is_Remote_Types   (Old_Main, Is_Remote_Types (New_Main));
4902          Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
4903          Set_Is_Remote_Call_Interface
4904            (Old_Main, Is_Remote_Call_Interface (New_Main));
4905       end if;
4906
4907       --  Make entry in Units table, so that binder can generate call to
4908       --  elaboration procedure for body, if any.
4909
4910       Make_Instance_Unit (Body_Cunit, In_Main => True);
4911       Main_Unit_Entity := New_Main;
4912       Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
4913
4914       --  Build elaboration entity, since the instance may certainly generate
4915       --  elaboration code requiring a flag for protection.
4916
4917       Build_Elaboration_Entity (Decl_Cunit, New_Main);
4918    end Build_Instance_Compilation_Unit_Nodes;
4919
4920    -----------------------------
4921    -- Check_Access_Definition --
4922    -----------------------------
4923
4924    procedure Check_Access_Definition (N : Node_Id) is
4925    begin
4926       pragma Assert
4927         (Ada_Version >= Ada_2005
4928            and then Present (Access_Definition (N)));
4929       null;
4930    end Check_Access_Definition;
4931
4932    -----------------------------------
4933    -- Check_Formal_Package_Instance --
4934    -----------------------------------
4935
4936    --  If the formal has specific parameters, they must match those of the
4937    --  actual. Both of them are instances, and the renaming declarations for
4938    --  their formal parameters appear in the same order in both. The analyzed
4939    --  formal has been analyzed in the context of the current instance.
4940
4941    procedure Check_Formal_Package_Instance
4942      (Formal_Pack : Entity_Id;
4943       Actual_Pack : Entity_Id)
4944    is
4945       E1 : Entity_Id := First_Entity (Actual_Pack);
4946       E2 : Entity_Id := First_Entity (Formal_Pack);
4947
4948       Expr1 : Node_Id;
4949       Expr2 : Node_Id;
4950
4951       procedure Check_Mismatch (B : Boolean);
4952       --  Common error routine for mismatch between the parameters of the
4953       --  actual instance and those of the formal package.
4954
4955       function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
4956       --  The formal may come from a nested formal package, and the actual may
4957       --  have been constant-folded. To determine whether the two denote the
4958       --  same entity we may have to traverse several definitions to recover
4959       --  the ultimate entity that they refer to.
4960
4961       function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
4962       --  Similarly, if the formal comes from a nested formal package, the
4963       --  actual may designate the formal through multiple renamings, which
4964       --  have to be followed to determine the original variable in question.
4965
4966       --------------------
4967       -- Check_Mismatch --
4968       --------------------
4969
4970       procedure Check_Mismatch (B : Boolean) is
4971          Kind : constant Node_Kind := Nkind (Parent (E2));
4972
4973       begin
4974          if Kind = N_Formal_Type_Declaration then
4975             return;
4976
4977          elsif Nkind_In (Kind, N_Formal_Object_Declaration,
4978                                N_Formal_Package_Declaration)
4979            or else Kind in N_Formal_Subprogram_Declaration
4980          then
4981             null;
4982
4983          elsif B then
4984             Error_Msg_NE
4985               ("actual for & in actual instance does not match formal",
4986                Parent (Actual_Pack), E1);
4987          end if;
4988       end Check_Mismatch;
4989
4990       --------------------------------
4991       -- Same_Instantiated_Constant --
4992       --------------------------------
4993
4994       function Same_Instantiated_Constant
4995         (E1, E2 : Entity_Id) return Boolean
4996       is
4997          Ent : Entity_Id;
4998
4999       begin
5000          Ent := E2;
5001          while Present (Ent) loop
5002             if E1 = Ent then
5003                return True;
5004
5005             elsif Ekind (Ent) /= E_Constant then
5006                return False;
5007
5008             elsif Is_Entity_Name (Constant_Value (Ent)) then
5009                if  Entity (Constant_Value (Ent)) = E1 then
5010                   return True;
5011                else
5012                   Ent := Entity (Constant_Value (Ent));
5013                end if;
5014
5015             --  The actual may be a constant that has been folded. Recover
5016             --  original name.
5017
5018             elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5019                   Ent := Entity (Original_Node (Constant_Value (Ent)));
5020             else
5021                return False;
5022             end if;
5023          end loop;
5024
5025          return False;
5026       end Same_Instantiated_Constant;
5027
5028       --------------------------------
5029       -- Same_Instantiated_Variable --
5030       --------------------------------
5031
5032       function Same_Instantiated_Variable
5033         (E1, E2 : Entity_Id) return Boolean
5034       is
5035          function Original_Entity (E : Entity_Id) return Entity_Id;
5036          --  Follow chain of renamings to the ultimate ancestor
5037
5038          ---------------------
5039          -- Original_Entity --
5040          ---------------------
5041
5042          function Original_Entity (E : Entity_Id) return Entity_Id is
5043             Orig : Entity_Id;
5044
5045          begin
5046             Orig := E;
5047             while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5048               and then Present (Renamed_Object (Orig))
5049               and then Is_Entity_Name (Renamed_Object (Orig))
5050             loop
5051                Orig := Entity (Renamed_Object (Orig));
5052             end loop;
5053
5054             return Orig;
5055          end Original_Entity;
5056
5057       --  Start of processing for Same_Instantiated_Variable
5058
5059       begin
5060          return Ekind (E1) = Ekind (E2)
5061            and then Original_Entity (E1) = Original_Entity (E2);
5062       end Same_Instantiated_Variable;
5063
5064    --  Start of processing for Check_Formal_Package_Instance
5065
5066    begin
5067       while Present (E1)
5068         and then Present (E2)
5069       loop
5070          exit when Ekind (E1) = E_Package
5071            and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5072
5073          --  If the formal is the renaming of the formal package, this
5074          --  is the end of its formal part, which may occur before the
5075          --  end of the formal part in the actual in the presence of
5076          --  defaulted parameters in the formal package.
5077
5078          exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5079            and then Renamed_Entity (E2) = Scope (E2);
5080
5081          --  The analysis of the actual may generate additional internal
5082          --  entities. If the formal is defaulted, there is no corresponding
5083          --  analysis and the internal entities must be skipped, until we
5084          --  find corresponding entities again.
5085
5086          if Comes_From_Source (E2)
5087            and then not Comes_From_Source (E1)
5088            and then Chars (E1) /= Chars (E2)
5089          then
5090             while Present (E1)
5091               and then  Chars (E1) /= Chars (E2)
5092             loop
5093                Next_Entity (E1);
5094             end loop;
5095          end if;
5096
5097          if No (E1) then
5098             return;
5099
5100          --  If the formal entity comes from a formal declaration, it was
5101          --  defaulted in the formal package, and no check is needed on it.
5102
5103          elsif Nkind (Parent (E2)) =  N_Formal_Object_Declaration then
5104             goto Next_E;
5105
5106          elsif Is_Type (E1) then
5107
5108             --  Subtypes must statically match. E1, E2 are the local entities
5109             --  that are subtypes of the actuals. Itypes generated for other
5110             --  parameters need not be checked, the check will be performed
5111             --  on the parameters themselves.
5112
5113             --  If E2 is a formal type declaration, it is a defaulted parameter
5114             --  and needs no checking.
5115
5116             if not Is_Itype (E1)
5117               and then not Is_Itype (E2)
5118             then
5119                Check_Mismatch
5120                  (not Is_Type (E2)
5121                    or else Etype (E1) /= Etype (E2)
5122                    or else not Subtypes_Statically_Match (E1, E2));
5123             end if;
5124
5125          elsif Ekind (E1) = E_Constant then
5126
5127             --  IN parameters must denote the same static value, or the same
5128             --  constant, or the literal null.
5129
5130             Expr1 := Expression (Parent (E1));
5131
5132             if Ekind (E2) /= E_Constant then
5133                Check_Mismatch (True);
5134                goto Next_E;
5135             else
5136                Expr2 := Expression (Parent (E2));
5137             end if;
5138
5139             if Is_Static_Expression (Expr1) then
5140
5141                if not Is_Static_Expression (Expr2) then
5142                   Check_Mismatch (True);
5143
5144                elsif Is_Discrete_Type (Etype (E1)) then
5145                   declare
5146                      V1 : constant Uint := Expr_Value (Expr1);
5147                      V2 : constant Uint := Expr_Value (Expr2);
5148                   begin
5149                      Check_Mismatch (V1 /= V2);
5150                   end;
5151
5152                elsif Is_Real_Type (Etype (E1)) then
5153                   declare
5154                      V1 : constant Ureal := Expr_Value_R (Expr1);
5155                      V2 : constant Ureal := Expr_Value_R (Expr2);
5156                   begin
5157                      Check_Mismatch (V1 /= V2);
5158                   end;
5159
5160                elsif Is_String_Type (Etype (E1))
5161                  and then Nkind (Expr1) = N_String_Literal
5162                then
5163                   if Nkind (Expr2) /= N_String_Literal then
5164                      Check_Mismatch (True);
5165                   else
5166                      Check_Mismatch
5167                        (not String_Equal (Strval (Expr1), Strval (Expr2)));
5168                   end if;
5169                end if;
5170
5171             elsif Is_Entity_Name (Expr1) then
5172                if Is_Entity_Name (Expr2) then
5173                   if Entity (Expr1) = Entity (Expr2) then
5174                      null;
5175                   else
5176                      Check_Mismatch
5177                        (not Same_Instantiated_Constant
5178                          (Entity (Expr1), Entity (Expr2)));
5179                   end if;
5180                else
5181                   Check_Mismatch (True);
5182                end if;
5183
5184             elsif Is_Entity_Name (Original_Node (Expr1))
5185               and then Is_Entity_Name (Expr2)
5186             and then
5187               Same_Instantiated_Constant
5188                 (Entity (Original_Node (Expr1)), Entity (Expr2))
5189             then
5190                null;
5191
5192             elsif Nkind (Expr1) = N_Null then
5193                Check_Mismatch (Nkind (Expr1) /= N_Null);
5194
5195             else
5196                Check_Mismatch (True);
5197             end if;
5198
5199          elsif Ekind (E1) = E_Variable then
5200             Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5201
5202          elsif Ekind (E1) = E_Package then
5203             Check_Mismatch
5204               (Ekind (E1) /= Ekind (E2)
5205                 or else Renamed_Object (E1) /= Renamed_Object (E2));
5206
5207          elsif Is_Overloadable (E1) then
5208
5209             --  Verify that the actual subprograms match. Note that actuals
5210             --  that are attributes are rewritten as subprograms. If the
5211             --  subprogram in the formal package is defaulted, no check is
5212             --  needed. Note that this can only happen in Ada 2005 when the
5213             --  formal package can be partially parameterized.
5214
5215             if Nkind (Unit_Declaration_Node (E1)) =
5216                                            N_Subprogram_Renaming_Declaration
5217               and then From_Default (Unit_Declaration_Node (E1))
5218             then
5219                null;
5220
5221             --  If the formal package has an "others"  box association that
5222             --  covers this formal, there is no need for a check either.
5223
5224             elsif Nkind (Unit_Declaration_Node (E2)) in
5225                     N_Formal_Subprogram_Declaration
5226               and then Box_Present (Unit_Declaration_Node (E2))
5227             then
5228                null;
5229
5230             --  No check needed if subprogram is a defaulted null procedure
5231
5232             elsif No (Alias (E2))
5233               and then Ekind (E2) = E_Procedure
5234               and then
5235                 Null_Present (Specification (Unit_Declaration_Node (E2)))
5236             then
5237                null;
5238
5239             --  Otherwise the actual in the formal and the actual in the
5240             --  instantiation of the formal must match, up to renamings.
5241
5242             else
5243                Check_Mismatch
5244                  (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5245             end if;
5246
5247          else
5248             raise Program_Error;
5249          end if;
5250
5251          <<Next_E>>
5252             Next_Entity (E1);
5253             Next_Entity (E2);
5254       end loop;
5255    end Check_Formal_Package_Instance;
5256
5257    ---------------------------
5258    -- Check_Formal_Packages --
5259    ---------------------------
5260
5261    procedure Check_Formal_Packages (P_Id : Entity_Id) is
5262       E        : Entity_Id;
5263       Formal_P : Entity_Id;
5264
5265    begin
5266       --  Iterate through the declarations in the instance, looking for package
5267       --  renaming declarations that denote instances of formal packages. Stop
5268       --  when we find the renaming of the current package itself. The
5269       --  declaration for a formal package without a box is followed by an
5270       --  internal entity that repeats the instantiation.
5271
5272       E := First_Entity (P_Id);
5273       while Present (E) loop
5274          if Ekind (E) = E_Package then
5275             if Renamed_Object (E) = P_Id then
5276                exit;
5277
5278             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5279                null;
5280
5281             elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5282                Formal_P := Next_Entity (E);
5283                Check_Formal_Package_Instance (Formal_P, E);
5284
5285                --  After checking, remove the internal validating package. It
5286                --  is only needed for semantic checks, and as it may contain
5287                --  generic formal declarations it should not reach gigi.
5288
5289                Remove (Unit_Declaration_Node (Formal_P));
5290             end if;
5291          end if;
5292
5293          Next_Entity (E);
5294       end loop;
5295    end Check_Formal_Packages;
5296
5297    ---------------------------------
5298    -- Check_Forward_Instantiation --
5299    ---------------------------------
5300
5301    procedure Check_Forward_Instantiation (Decl : Node_Id) is
5302       S        : Entity_Id;
5303       Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5304
5305    begin
5306       --  The instantiation appears before the generic body if we are in the
5307       --  scope of the unit containing the generic, either in its spec or in
5308       --  the package body, and before the generic body.
5309
5310       if Ekind (Gen_Comp) = E_Package_Body then
5311          Gen_Comp := Spec_Entity (Gen_Comp);
5312       end if;
5313
5314       if In_Open_Scopes (Gen_Comp)
5315         and then No (Corresponding_Body (Decl))
5316       then
5317          S := Current_Scope;
5318
5319          while Present (S)
5320            and then not Is_Compilation_Unit (S)
5321            and then not Is_Child_Unit (S)
5322          loop
5323             if Ekind (S) = E_Package then
5324                Set_Has_Forward_Instantiation (S);
5325             end if;
5326
5327             S := Scope (S);
5328          end loop;
5329       end if;
5330    end Check_Forward_Instantiation;
5331
5332    ---------------------------
5333    -- Check_Generic_Actuals --
5334    ---------------------------
5335
5336    --  The visibility of the actuals may be different between the point of
5337    --  generic instantiation and the instantiation of the body.
5338
5339    procedure Check_Generic_Actuals
5340      (Instance      : Entity_Id;
5341       Is_Formal_Box : Boolean)
5342    is
5343       E      : Entity_Id;
5344       Astype : Entity_Id;
5345
5346       function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5347       --  For a formal that is an array type, the component type is often a
5348       --  previous formal in the same unit. The privacy status of the component
5349       --  type will have been examined earlier in the traversal of the
5350       --  corresponding actuals, and this status should not be modified for the
5351       --  array type itself.
5352       --
5353       --  To detect this case we have to rescan the list of formals, which
5354       --  is usually short enough to ignore the resulting inefficiency.
5355
5356       -----------------------------
5357       -- Denotes_Previous_Actual --
5358       -----------------------------
5359
5360       function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5361          Prev : Entity_Id;
5362
5363       begin
5364          Prev := First_Entity (Instance);
5365          while Present (Prev) loop
5366             if Is_Type (Prev)
5367               and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5368               and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5369               and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5370             then
5371                return True;
5372
5373             elsif Prev = E then
5374                return False;
5375
5376             else
5377                Next_Entity (Prev);
5378             end if;
5379          end loop;
5380
5381          return False;
5382       end Denotes_Previous_Actual;
5383
5384    --  Start of processing for Check_Generic_Actuals
5385
5386    begin
5387       E := First_Entity (Instance);
5388       while Present (E) loop
5389          if Is_Type (E)
5390            and then Nkind (Parent (E)) = N_Subtype_Declaration
5391            and then Scope (Etype (E)) /= Instance
5392            and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5393          then
5394             if Is_Array_Type (E)
5395               and then Denotes_Previous_Actual (Component_Type (E))
5396             then
5397                null;
5398             else
5399                Check_Private_View (Subtype_Indication (Parent (E)));
5400             end if;
5401
5402             Set_Is_Generic_Actual_Type (E, True);
5403             Set_Is_Hidden (E, False);
5404             Set_Is_Potentially_Use_Visible (E,
5405               In_Use (Instance));
5406
5407             --  We constructed the generic actual type as a subtype of the
5408             --  supplied type. This means that it normally would not inherit
5409             --  subtype specific attributes of the actual, which is wrong for
5410             --  the generic case.
5411
5412             Astype := Ancestor_Subtype (E);
5413
5414             if No (Astype) then
5415
5416                --  This can happen when E is an itype that is the full view of
5417                --  a private type completed, e.g. with a constrained array. In
5418                --  that case, use the first subtype, which will carry size
5419                --  information. The base type itself is unconstrained and will
5420                --  not carry it.
5421
5422                Astype := First_Subtype (E);
5423             end if;
5424
5425             Set_Size_Info      (E,                (Astype));
5426             Set_RM_Size        (E, RM_Size        (Astype));
5427             Set_First_Rep_Item (E, First_Rep_Item (Astype));
5428
5429             if Is_Discrete_Or_Fixed_Point_Type (E) then
5430                Set_RM_Size (E, RM_Size (Astype));
5431
5432             --  In  nested instances, the base type of an access actual
5433             --  may itself be private, and need to be exchanged.
5434
5435             elsif Is_Access_Type (E)
5436               and then Is_Private_Type (Etype (E))
5437             then
5438                Check_Private_View
5439                  (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5440             end if;
5441
5442          elsif Ekind (E) = E_Package then
5443
5444             --  If this is the renaming for the current instance, we're done.
5445             --  Otherwise it is a formal package. If the corresponding formal
5446             --  was declared with a box, the (instantiations of the) generic
5447             --  formal part are also visible. Otherwise, ignore the entity
5448             --  created to validate the actuals.
5449
5450             if Renamed_Object (E) = Instance then
5451                exit;
5452
5453             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5454                null;
5455
5456             --  The visibility of a formal of an enclosing generic is already
5457             --  correct.
5458
5459             elsif Denotes_Formal_Package (E) then
5460                null;
5461
5462             elsif Present (Associated_Formal_Package (E))
5463               and then not Is_Generic_Formal (E)
5464             then
5465                if Box_Present (Parent (Associated_Formal_Package (E))) then
5466                   Check_Generic_Actuals (Renamed_Object (E), True);
5467
5468                else
5469                   Check_Generic_Actuals (Renamed_Object (E), False);
5470                end if;
5471
5472                Set_Is_Hidden (E, False);
5473             end if;
5474
5475          --  If this is a subprogram instance (in a wrapper package) the
5476          --  actual is fully visible.
5477
5478          elsif Is_Wrapper_Package (Instance) then
5479             Set_Is_Hidden (E, False);
5480
5481          --  If the formal package is declared with a box, or if the formal
5482          --  parameter is defaulted, it is visible in the body.
5483
5484          elsif Is_Formal_Box
5485            or else Is_Visible_Formal (E)
5486          then
5487             Set_Is_Hidden (E, False);
5488          end if;
5489
5490          if Ekind (E) = E_Constant then
5491
5492             --  If the type of the actual is a private type declared in the
5493             --  enclosing scope of the generic unit, the body of the generic
5494             --  sees the full view of the type (because it has to appear in
5495             --  the corresponding package body). If the type is private now,
5496             --  exchange views to restore the proper visiblity in the instance.
5497
5498             declare
5499                Typ : constant Entity_Id := Base_Type (Etype (E));
5500                --  The type of the actual
5501
5502                Gen_Id : Entity_Id;
5503                --  The generic unit
5504
5505                Parent_Scope : Entity_Id;
5506                --  The enclosing scope of the generic unit
5507
5508             begin
5509                if Is_Wrapper_Package (Instance) then
5510                   Gen_Id :=
5511                      Generic_Parent
5512                        (Specification
5513                          (Unit_Declaration_Node
5514                            (Related_Instance (Instance))));
5515                else
5516                   Gen_Id :=
5517                     Generic_Parent
5518                       (Specification (Unit_Declaration_Node (Instance)));
5519                end if;
5520
5521                Parent_Scope := Scope (Gen_Id);
5522
5523                --  The exchange is only needed if the generic is defined
5524                --  within a package which is not a common ancestor of the
5525                --  scope of the instance, and is not already in scope.
5526
5527                if Is_Private_Type (Typ)
5528                  and then Scope (Typ) = Parent_Scope
5529                  and then Scope (Instance) /= Parent_Scope
5530                  and then Ekind (Parent_Scope) = E_Package
5531                  and then not Is_Child_Unit (Gen_Id)
5532                then
5533                   Switch_View (Typ);
5534
5535                   --  If the type of the entity is a subtype, it may also
5536                   --  have to be made visible, together with the base type
5537                   --  of its full view, after exchange.
5538
5539                   if Is_Private_Type (Etype (E)) then
5540                      Switch_View (Etype (E));
5541                      Switch_View (Base_Type (Etype (E)));
5542                   end if;
5543                end if;
5544             end;
5545          end if;
5546
5547          Next_Entity (E);
5548       end loop;
5549    end Check_Generic_Actuals;
5550
5551    ------------------------------
5552    -- Check_Generic_Child_Unit --
5553    ------------------------------
5554
5555    procedure Check_Generic_Child_Unit
5556      (Gen_Id           : Node_Id;
5557       Parent_Installed : in out Boolean)
5558    is
5559       Loc      : constant Source_Ptr := Sloc (Gen_Id);
5560       Gen_Par  : Entity_Id := Empty;
5561       E        : Entity_Id;
5562       Inst_Par : Entity_Id;
5563       S        : Node_Id;
5564
5565       function Find_Generic_Child
5566         (Scop : Entity_Id;
5567          Id   : Node_Id) return Entity_Id;
5568       --  Search generic parent for possible child unit with the given name
5569
5570       function In_Enclosing_Instance return Boolean;
5571       --  Within an instance of the parent, the child unit may be denoted
5572       --  by a simple name, or an abbreviated expanded name. Examine enclosing
5573       --  scopes to locate a possible parent instantiation.
5574
5575       ------------------------
5576       -- Find_Generic_Child --
5577       ------------------------
5578
5579       function Find_Generic_Child
5580         (Scop : Entity_Id;
5581          Id   : Node_Id) return Entity_Id
5582       is
5583          E : Entity_Id;
5584
5585       begin
5586          --  If entity of name is already set, instance has already been
5587          --  resolved, e.g. in an enclosing instantiation.
5588
5589          if Present (Entity (Id)) then
5590             if Scope (Entity (Id)) = Scop then
5591                return Entity (Id);
5592             else
5593                return Empty;
5594             end if;
5595
5596          else
5597             E := First_Entity (Scop);
5598             while Present (E) loop
5599                if Chars (E) = Chars (Id)
5600                  and then Is_Child_Unit (E)
5601                then
5602                   if Is_Child_Unit (E)
5603                     and then not Is_Visible_Child_Unit (E)
5604                   then
5605                      Error_Msg_NE
5606                        ("generic child unit& is not visible", Gen_Id, E);
5607                   end if;
5608
5609                   Set_Entity (Id, E);
5610                   return E;
5611                end if;
5612
5613                Next_Entity (E);
5614             end loop;
5615
5616             return Empty;
5617          end if;
5618       end Find_Generic_Child;
5619
5620       ---------------------------
5621       -- In_Enclosing_Instance --
5622       ---------------------------
5623
5624       function In_Enclosing_Instance return Boolean is
5625          Enclosing_Instance : Node_Id;
5626          Instance_Decl      : Node_Id;
5627
5628       begin
5629          --  We do not inline any call that contains instantiations, except
5630          --  for instantiations of Unchecked_Conversion, so if we are within
5631          --  an inlined body the current instance does not require parents.
5632
5633          if In_Inlined_Body then
5634             pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5635             return False;
5636          end if;
5637
5638          --  Loop to check enclosing scopes
5639
5640          Enclosing_Instance := Current_Scope;
5641          while Present (Enclosing_Instance) loop
5642             Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5643
5644             if Ekind (Enclosing_Instance) = E_Package
5645               and then Is_Generic_Instance (Enclosing_Instance)
5646               and then Present
5647                 (Generic_Parent (Specification (Instance_Decl)))
5648             then
5649                --  Check whether the generic we are looking for is a child of
5650                --  this instance.
5651
5652                E := Find_Generic_Child
5653                       (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5654                exit when Present (E);
5655
5656             else
5657                E := Empty;
5658             end if;
5659
5660             Enclosing_Instance := Scope (Enclosing_Instance);
5661          end loop;
5662
5663          if No (E) then
5664
5665             --  Not a child unit
5666
5667             Analyze (Gen_Id);
5668             return False;
5669
5670          else
5671             Rewrite (Gen_Id,
5672               Make_Expanded_Name (Loc,
5673                 Chars         => Chars (E),
5674                 Prefix        => New_Occurrence_Of (Enclosing_Instance, Loc),
5675                 Selector_Name => New_Occurrence_Of (E, Loc)));
5676
5677             Set_Entity (Gen_Id, E);
5678             Set_Etype  (Gen_Id, Etype (E));
5679             Parent_Installed := False;      -- Already in scope.
5680             return True;
5681          end if;
5682       end In_Enclosing_Instance;
5683
5684    --  Start of processing for Check_Generic_Child_Unit
5685
5686    begin
5687       --  If the name of the generic is given by a selected component, it may
5688       --  be the name of a generic child unit, and the prefix is the name of an
5689       --  instance of the parent, in which case the child unit must be visible.
5690       --  If this instance is not in scope, it must be placed there and removed
5691       --  after instantiation, because what is being instantiated is not the
5692       --  original child, but the corresponding child present in the instance
5693       --  of the parent.
5694
5695       --  If the child is instantiated within the parent, it can be given by
5696       --  a simple name. In this case the instance is already in scope, but
5697       --  the child generic must be recovered from the generic parent as well.
5698
5699       if Nkind (Gen_Id) = N_Selected_Component then
5700          S := Selector_Name (Gen_Id);
5701          Analyze (Prefix (Gen_Id));
5702          Inst_Par := Entity (Prefix (Gen_Id));
5703
5704          if Ekind (Inst_Par) = E_Package
5705            and then Present (Renamed_Object (Inst_Par))
5706          then
5707             Inst_Par := Renamed_Object (Inst_Par);
5708          end if;
5709
5710          if Ekind (Inst_Par) = E_Package then
5711             if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5712                Gen_Par := Generic_Parent (Parent (Inst_Par));
5713
5714             elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5715               and then
5716                 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5717             then
5718                Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5719             end if;
5720
5721          elsif Ekind (Inst_Par) = E_Generic_Package
5722            and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5723          then
5724             --  A formal package may be a real child package, and not the
5725             --  implicit instance within a parent. In this case the child is
5726             --  not visible and has to be retrieved explicitly as well.
5727
5728             Gen_Par := Inst_Par;
5729          end if;
5730
5731          if Present (Gen_Par) then
5732
5733             --  The prefix denotes an instantiation. The entity itself may be a
5734             --  nested generic, or a child unit.
5735
5736             E := Find_Generic_Child (Gen_Par, S);
5737
5738             if Present (E) then
5739                Change_Selected_Component_To_Expanded_Name (Gen_Id);
5740                Set_Entity (Gen_Id, E);
5741                Set_Etype (Gen_Id, Etype (E));
5742                Set_Entity (S, E);
5743                Set_Etype (S, Etype (E));
5744
5745                --  Indicate that this is a reference to the parent
5746
5747                if In_Extended_Main_Source_Unit (Gen_Id) then
5748                   Set_Is_Instantiated (Inst_Par);
5749                end if;
5750
5751                --  A common mistake is to replicate the naming scheme of a
5752                --  hierarchy by instantiating a generic child directly, rather
5753                --  than the implicit child in a parent instance:
5754
5755                --  generic .. package Gpar is ..
5756                --  generic .. package Gpar.Child is ..
5757                --  package Par is new Gpar ();
5758
5759                --  with Gpar.Child;
5760                --  package Par.Child is new Gpar.Child ();
5761                --                           rather than Par.Child
5762
5763                --  In this case the instantiation is within Par, which is an
5764                --  instance, but Gpar does not denote Par because we are not IN
5765                --  the instance of Gpar, so this is illegal. The test below
5766                --  recognizes this particular case.
5767
5768                if Is_Child_Unit (E)
5769                  and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5770                  and then (not In_Instance
5771                              or else Nkind (Parent (Parent (Gen_Id))) =
5772                                                          N_Compilation_Unit)
5773                then
5774                   Error_Msg_N
5775                     ("prefix of generic child unit must be instance of parent",
5776                       Gen_Id);
5777                end if;
5778
5779                if not In_Open_Scopes (Inst_Par)
5780                  and then Nkind (Parent (Gen_Id)) not in
5781                                            N_Generic_Renaming_Declaration
5782                then
5783                   Install_Parent (Inst_Par);
5784                   Parent_Installed := True;
5785
5786                elsif In_Open_Scopes (Inst_Par) then
5787
5788                   --  If the parent is already installed, install the actuals
5789                   --  for its formal packages. This is necessary when the
5790                   --  child instance is a child of the parent instance:
5791                   --  in this case, the parent is placed on the scope stack
5792                   --  but the formal packages are not made visible.
5793
5794                   Install_Formal_Packages (Inst_Par);
5795                end if;
5796
5797             else
5798                --  If the generic parent does not contain an entity that
5799                --  corresponds to the selector, the instance doesn't either.
5800                --  Analyzing the node will yield the appropriate error message.
5801                --  If the entity is not a child unit, then it is an inner
5802                --  generic in the parent.
5803
5804                Analyze (Gen_Id);
5805             end if;
5806
5807          else
5808             Analyze (Gen_Id);
5809
5810             if Is_Child_Unit (Entity (Gen_Id))
5811               and then
5812                 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5813               and then not In_Open_Scopes (Inst_Par)
5814             then
5815                Install_Parent (Inst_Par);
5816                Parent_Installed := True;
5817
5818             --  The generic unit may be the renaming of the implicit child
5819             --  present in an instance. In that case the parent instance is
5820             --  obtained from the name of the renamed entity.
5821
5822             elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5823               and then Present (Renamed_Entity (Entity (Gen_Id)))
5824               and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5825             then
5826                declare
5827                   Renamed_Package : constant Node_Id :=
5828                                       Name (Parent (Entity (Gen_Id)));
5829                begin
5830                   if Nkind (Renamed_Package) = N_Expanded_Name then
5831                      Inst_Par := Entity (Prefix (Renamed_Package));
5832                      Install_Parent (Inst_Par);
5833                      Parent_Installed := True;
5834                   end if;
5835                end;
5836             end if;
5837          end if;
5838
5839       elsif Nkind (Gen_Id) = N_Expanded_Name then
5840
5841          --  Entity already present, analyze prefix, whose meaning may be
5842          --  an instance in the current context. If it is an instance of
5843          --  a relative within another, the proper parent may still have
5844          --  to be installed, if they are not of the same generation.
5845
5846          Analyze (Prefix (Gen_Id));
5847
5848          --  In the unlikely case that a local declaration hides the name
5849          --  of the parent package, locate it on the homonym chain. If the
5850          --  context is an instance of the parent, the renaming entity is
5851          --  flagged as such.
5852
5853          Inst_Par := Entity (Prefix (Gen_Id));
5854          while Present (Inst_Par)
5855            and then not Is_Package_Or_Generic_Package (Inst_Par)
5856          loop
5857             Inst_Par := Homonym (Inst_Par);
5858          end loop;
5859
5860          pragma Assert (Present (Inst_Par));
5861          Set_Entity (Prefix (Gen_Id), Inst_Par);
5862
5863          if In_Enclosing_Instance then
5864             null;
5865
5866          elsif Present (Entity (Gen_Id))
5867            and then Is_Child_Unit (Entity (Gen_Id))
5868            and then not In_Open_Scopes (Inst_Par)
5869          then
5870             Install_Parent (Inst_Par);
5871             Parent_Installed := True;
5872          end if;
5873
5874       elsif In_Enclosing_Instance then
5875
5876          --  The child unit is found in some enclosing scope
5877
5878          null;
5879
5880       else
5881          Analyze (Gen_Id);
5882
5883          --  If this is the renaming of the implicit child in a parent
5884          --  instance, recover the parent name and install it.
5885
5886          if Is_Entity_Name (Gen_Id) then
5887             E := Entity (Gen_Id);
5888
5889             if Is_Generic_Unit (E)
5890               and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
5891               and then Is_Child_Unit (Renamed_Object (E))
5892               and then Is_Generic_Unit (Scope (Renamed_Object (E)))
5893               and then Nkind (Name (Parent (E))) = N_Expanded_Name
5894             then
5895                Rewrite (Gen_Id,
5896                  New_Copy_Tree (Name (Parent (E))));
5897                Inst_Par := Entity (Prefix (Gen_Id));
5898
5899                if not In_Open_Scopes (Inst_Par) then
5900                   Install_Parent (Inst_Par);
5901                   Parent_Installed := True;
5902                end if;
5903
5904             --  If it is a child unit of a non-generic parent, it may be
5905             --  use-visible and given by a direct name. Install parent as
5906             --  for other cases.
5907
5908             elsif Is_Generic_Unit (E)
5909               and then Is_Child_Unit (E)
5910               and then
5911                 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5912               and then not Is_Generic_Unit (Scope (E))
5913             then
5914                if not In_Open_Scopes (Scope (E)) then
5915                   Install_Parent (Scope (E));
5916                   Parent_Installed := True;
5917                end if;
5918             end if;
5919          end if;
5920       end if;
5921    end Check_Generic_Child_Unit;
5922
5923    -----------------------------
5924    -- Check_Hidden_Child_Unit --
5925    -----------------------------
5926
5927    procedure Check_Hidden_Child_Unit
5928      (N           : Node_Id;
5929       Gen_Unit    : Entity_Id;
5930       Act_Decl_Id : Entity_Id)
5931    is
5932       Gen_Id : constant Node_Id := Name (N);
5933
5934    begin
5935       if Is_Child_Unit (Gen_Unit)
5936         and then Is_Child_Unit (Act_Decl_Id)
5937         and then Nkind (Gen_Id) = N_Expanded_Name
5938         and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
5939         and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
5940       then
5941          Error_Msg_Node_2 := Scope (Act_Decl_Id);
5942          Error_Msg_NE
5943            ("generic unit & is implicitly declared in &",
5944              Defining_Unit_Name (N), Gen_Unit);
5945          Error_Msg_N ("\instance must have different name",
5946            Defining_Unit_Name (N));
5947       end if;
5948    end Check_Hidden_Child_Unit;
5949
5950    ------------------------
5951    -- Check_Private_View --
5952    ------------------------
5953
5954    procedure Check_Private_View (N : Node_Id) is
5955       T : constant Entity_Id := Etype (N);
5956       BT : Entity_Id;
5957
5958    begin
5959       --  Exchange views if the type was not private in the generic but is
5960       --  private at the point of instantiation. Do not exchange views if
5961       --  the scope of the type is in scope. This can happen if both generic
5962       --  and instance are sibling units, or if type is defined in a parent.
5963       --  In this case the visibility of the type will be correct for all
5964       --  semantic checks.
5965
5966       if Present (T) then
5967          BT := Base_Type (T);
5968
5969          if Is_Private_Type (T)
5970            and then not Has_Private_View (N)
5971            and then Present (Full_View (T))
5972            and then not In_Open_Scopes (Scope (T))
5973          then
5974             --  In the generic, the full type was visible. Save the private
5975             --  entity, for subsequent exchange.
5976
5977             Switch_View (T);
5978
5979          elsif Has_Private_View (N)
5980            and then not Is_Private_Type (T)
5981            and then not Has_Been_Exchanged (T)
5982            and then Etype (Get_Associated_Node (N)) /= T
5983          then
5984             --  Only the private declaration was visible in the generic. If
5985             --  the type appears in a subtype declaration, the subtype in the
5986             --  instance must have a view compatible with that of its parent,
5987             --  which must be exchanged (see corresponding code in Restore_
5988             --  Private_Views). Otherwise, if the type is defined in a parent
5989             --  unit, leave full visibility within instance, which is safe.
5990
5991             if In_Open_Scopes (Scope (Base_Type (T)))
5992               and then not Is_Private_Type (Base_Type (T))
5993               and then Comes_From_Source (Base_Type (T))
5994             then
5995                null;
5996
5997             elsif Nkind (Parent (N)) = N_Subtype_Declaration
5998               or else not In_Private_Part (Scope (Base_Type (T)))
5999             then
6000                Prepend_Elmt (T, Exchanged_Views);
6001                Exchange_Declarations (Etype (Get_Associated_Node (N)));
6002             end if;
6003
6004          --  For composite types with inconsistent representation exchange
6005          --  component types accordingly.
6006
6007          elsif Is_Access_Type (T)
6008            and then Is_Private_Type (Designated_Type (T))
6009            and then not Has_Private_View (N)
6010            and then Present (Full_View (Designated_Type (T)))
6011          then
6012             Switch_View (Designated_Type (T));
6013
6014          elsif Is_Array_Type (T) then
6015             if Is_Private_Type (Component_Type (T))
6016               and then not Has_Private_View (N)
6017               and then Present (Full_View (Component_Type (T)))
6018             then
6019                Switch_View (Component_Type (T));
6020             end if;
6021
6022             --  The normal exchange mechanism relies on the setting of a
6023             --  flag on the reference in the generic. However, an additional
6024             --  mechanism is needed for types that are not explicitly mentioned
6025             --  in the generic, but may be needed in expanded code in the
6026             --  instance. This includes component types of arrays and
6027             --  designated types of access types. This processing must also
6028             --  include the index types of arrays which we take care of here.
6029
6030             declare
6031                Indx : Node_Id;
6032                Typ  : Entity_Id;
6033
6034             begin
6035                Indx := First_Index (T);
6036                Typ  := Base_Type (Etype (Indx));
6037                while Present (Indx) loop
6038                   if Is_Private_Type (Typ)
6039                     and then Present (Full_View (Typ))
6040                   then
6041                      Switch_View (Typ);
6042                   end if;
6043
6044                   Next_Index (Indx);
6045                end loop;
6046             end;
6047
6048          elsif Is_Private_Type (T)
6049            and then Present (Full_View (T))
6050            and then Is_Array_Type (Full_View (T))
6051            and then Is_Private_Type (Component_Type (Full_View (T)))
6052          then
6053             Switch_View (T);
6054
6055          --  Finally, a non-private subtype may have a private base type, which
6056          --  must be exchanged for consistency. This can happen when a package
6057          --  body is instantiated, when the scope stack is empty but in fact
6058          --  the subtype and the base type are declared in an enclosing scope.
6059
6060          --  Note that in this case we introduce an inconsistency in the view
6061          --  set, because we switch the base type BT, but there could be some
6062          --  private dependent subtypes of BT which remain unswitched. Such
6063          --  subtypes might need to be switched at a later point (see specific
6064          --  provision for that case in Switch_View).
6065
6066          elsif not Is_Private_Type (T)
6067            and then not Has_Private_View (N)
6068            and then Is_Private_Type (BT)
6069            and then Present (Full_View (BT))
6070            and then not Is_Generic_Type (BT)
6071            and then not In_Open_Scopes (BT)
6072          then
6073             Prepend_Elmt (Full_View (BT), Exchanged_Views);
6074             Exchange_Declarations (BT);
6075          end if;
6076       end if;
6077    end Check_Private_View;
6078
6079    -----------------------------
6080    -- Check_Hidden_Primitives --
6081    -----------------------------
6082
6083    function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6084       Actual : Node_Id;
6085       Gen_T  : Entity_Id;
6086       Result : Elist_Id := No_Elist;
6087
6088    begin
6089       if No (Assoc_List) then
6090          return No_Elist;
6091       end if;
6092
6093       --  Traverse the list of associations between formals and actuals
6094       --  searching for renamings of tagged types
6095
6096       Actual := First (Assoc_List);
6097       while Present (Actual) loop
6098          if Nkind (Actual) = N_Subtype_Declaration then
6099             Gen_T := Generic_Parent_Type (Actual);
6100
6101             if Present (Gen_T)
6102               and then Is_Tagged_Type (Gen_T)
6103             then
6104                --  Traverse the list of primitives of the actual types
6105                --  searching for hidden primitives that are visible in the
6106                --  corresponding generic formal; leave them visible and
6107                --  append them to Result to restore their decoration later.
6108
6109                Install_Hidden_Primitives
6110                  (Prims_List => Result,
6111                   Gen_T      => Gen_T,
6112                   Act_T      => Entity (Subtype_Indication (Actual)));
6113             end if;
6114          end if;
6115
6116          Next (Actual);
6117       end loop;
6118
6119       return Result;
6120    end Check_Hidden_Primitives;
6121
6122    --------------------------
6123    -- Contains_Instance_Of --
6124    --------------------------
6125
6126    function Contains_Instance_Of
6127      (Inner : Entity_Id;
6128       Outer : Entity_Id;
6129       N     : Node_Id) return Boolean
6130    is
6131       Elmt : Elmt_Id;
6132       Scop : Entity_Id;
6133
6134    begin
6135       Scop := Outer;
6136
6137       --  Verify that there are no circular instantiations. We check whether
6138       --  the unit contains an instance of the current scope or some enclosing
6139       --  scope (in case one of the instances appears in a subunit). Longer
6140       --  circularities involving subunits might seem too pathological to
6141       --  consider, but they were not too pathological for the authors of
6142       --  DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6143       --  enclosing generic scopes as containing an instance.
6144
6145       loop
6146          --  Within a generic subprogram body, the scope is not generic, to
6147          --  allow for recursive subprograms. Use the declaration to determine
6148          --  whether this is a generic unit.
6149
6150          if Ekind (Scop) = E_Generic_Package
6151            or else (Is_Subprogram (Scop)
6152                       and then Nkind (Unit_Declaration_Node (Scop)) =
6153                                         N_Generic_Subprogram_Declaration)
6154          then
6155             Elmt := First_Elmt (Inner_Instances (Inner));
6156
6157             while Present (Elmt) loop
6158                if Node (Elmt) = Scop then
6159                   Error_Msg_Node_2 := Inner;
6160                   Error_Msg_NE
6161                     ("circular Instantiation: & instantiated within &!",
6162                        N, Scop);
6163                   return True;
6164
6165                elsif Node (Elmt) = Inner then
6166                   return True;
6167
6168                elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6169                   Error_Msg_Node_2 := Inner;
6170                   Error_Msg_NE
6171                     ("circular Instantiation: & instantiated within &!",
6172                       N, Node (Elmt));
6173                   return True;
6174                end if;
6175
6176                Next_Elmt (Elmt);
6177             end loop;
6178
6179             --  Indicate that Inner is being instantiated within Scop
6180
6181             Append_Elmt (Inner, Inner_Instances (Scop));
6182          end if;
6183
6184          if Scop = Standard_Standard then
6185             exit;
6186          else
6187             Scop := Scope (Scop);
6188          end if;
6189       end loop;
6190
6191       return False;
6192    end Contains_Instance_Of;
6193
6194    -----------------------
6195    -- Copy_Generic_Node --
6196    -----------------------
6197
6198    function Copy_Generic_Node
6199      (N             : Node_Id;
6200       Parent_Id     : Node_Id;
6201       Instantiating : Boolean) return Node_Id
6202    is
6203       Ent   : Entity_Id;
6204       New_N : Node_Id;
6205
6206       function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6207       --  Check the given value of one of the Fields referenced by the
6208       --  current node to determine whether to copy it recursively. The
6209       --  field may hold a Node_Id, a List_Id, or an Elist_Id, or a plain
6210       --  value (Sloc, Uint, Char) in which case it need not be copied.
6211
6212       procedure Copy_Descendants;
6213       --  Common utility for various nodes
6214
6215       function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6216       --  Make copy of element list
6217
6218       function Copy_Generic_List
6219         (L         : List_Id;
6220          Parent_Id : Node_Id) return List_Id;
6221       --  Apply Copy_Node recursively to the members of a node list
6222
6223       function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6224       --  True if an identifier is part of the defining program unit name
6225       --  of a child unit. The entity of such an identifier must be kept
6226       --  (for ASIS use) even though as the name of an enclosing generic
6227       --   it would otherwise not be preserved in the generic tree.
6228
6229       ----------------------
6230       -- Copy_Descendants --
6231       ----------------------
6232
6233       procedure Copy_Descendants is
6234
6235          use Atree.Unchecked_Access;
6236          --  This code section is part of the implementation of an untyped
6237          --  tree traversal, so it needs direct access to node fields.
6238
6239       begin
6240          Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6241          Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6242          Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6243          Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6244          Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6245       end Copy_Descendants;
6246
6247       -----------------------------
6248       -- Copy_Generic_Descendant --
6249       -----------------------------
6250
6251       function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6252       begin
6253          if D = Union_Id (Empty) then
6254             return D;
6255
6256          elsif D in Node_Range then
6257             return Union_Id
6258               (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6259
6260          elsif D in List_Range then
6261             return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6262
6263          elsif D in Elist_Range then
6264             return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6265
6266          --  Nothing else is copyable (e.g. Uint values), return as is
6267
6268          else
6269             return D;
6270          end if;
6271       end Copy_Generic_Descendant;
6272
6273       ------------------------
6274       -- Copy_Generic_Elist --
6275       ------------------------
6276
6277       function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6278          M : Elmt_Id;
6279          L : Elist_Id;
6280
6281       begin
6282          if Present (E) then
6283             L := New_Elmt_List;
6284             M := First_Elmt (E);
6285             while Present (M) loop
6286                Append_Elmt
6287                  (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6288                Next_Elmt (M);
6289             end loop;
6290
6291             return L;
6292
6293          else
6294             return No_Elist;
6295          end if;
6296       end Copy_Generic_Elist;
6297
6298       -----------------------
6299       -- Copy_Generic_List --
6300       -----------------------
6301
6302       function Copy_Generic_List
6303         (L         : List_Id;
6304          Parent_Id : Node_Id) return List_Id
6305       is
6306          N     : Node_Id;
6307          New_L : List_Id;
6308
6309       begin
6310          if Present (L) then
6311             New_L := New_List;
6312             Set_Parent (New_L, Parent_Id);
6313
6314             N := First (L);
6315             while Present (N) loop
6316                Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6317                Next (N);
6318             end loop;
6319
6320             return New_L;
6321
6322          else
6323             return No_List;
6324          end if;
6325       end Copy_Generic_List;
6326
6327       ---------------------------
6328       -- In_Defining_Unit_Name --
6329       ---------------------------
6330
6331       function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6332       begin
6333          return Present (Parent (Nam))
6334            and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6335                       or else
6336                         (Nkind (Parent (Nam)) = N_Expanded_Name
6337                           and then In_Defining_Unit_Name (Parent (Nam))));
6338       end In_Defining_Unit_Name;
6339
6340    --  Start of processing for Copy_Generic_Node
6341
6342    begin
6343       if N = Empty then
6344          return N;
6345       end if;
6346
6347       New_N := New_Copy (N);
6348
6349       --  Copy aspects if present
6350
6351       if Has_Aspects (N) then
6352          Set_Has_Aspects (New_N, False);
6353          Set_Aspect_Specifications
6354            (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6355       end if;
6356
6357       if Instantiating then
6358          Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6359       end if;
6360
6361       if not Is_List_Member (N) then
6362          Set_Parent (New_N, Parent_Id);
6363       end if;
6364
6365       --  If defining identifier, then all fields have been copied already
6366
6367       if Nkind (New_N) in N_Entity then
6368          null;
6369
6370       --  Special casing for identifiers and other entity names and operators
6371
6372       elsif Nkind_In (New_N, N_Identifier,
6373                              N_Character_Literal,
6374                              N_Expanded_Name,
6375                              N_Operator_Symbol)
6376         or else Nkind (New_N) in N_Op
6377       then
6378          if not Instantiating then
6379
6380             --  Link both nodes in order to assign subsequently the entity of
6381             --  the copy to the original node, in case this is a global
6382             --  reference.
6383
6384             Set_Associated_Node (N, New_N);
6385
6386             --  If we are within an instantiation, this is a nested generic
6387             --  that has already been analyzed at the point of definition. We
6388             --  must preserve references that were global to the enclosing
6389             --  parent at that point. Other occurrences, whether global or
6390             --  local to the current generic, must be resolved anew, so we
6391             --  reset the entity in the generic copy. A global reference has a
6392             --  smaller depth than the parent, or else the same depth in case
6393             --  both are distinct compilation units.
6394             --  A child unit is implicitly declared within the enclosing parent
6395             --  but is in fact global to it, and must be preserved.
6396
6397             --  It is also possible for Current_Instantiated_Parent to be
6398             --  defined, and for this not to be a nested generic, namely if the
6399             --  unit is loaded through Rtsfind. In that case, the entity of
6400             --  New_N is only a link to the associated node, and not a defining
6401             --  occurrence.
6402
6403             --  The entities for parent units in the defining_program_unit of a
6404             --  generic child unit are established when the context of the unit
6405             --  is first analyzed, before the generic copy is made. They are
6406             --  preserved in the copy for use in ASIS queries.
6407
6408             Ent := Entity (New_N);
6409
6410             if No (Current_Instantiated_Parent.Gen_Id) then
6411                if No (Ent)
6412                  or else Nkind (Ent) /= N_Defining_Identifier
6413                  or else not In_Defining_Unit_Name (N)
6414                then
6415                   Set_Associated_Node (New_N, Empty);
6416                end if;
6417
6418             elsif No (Ent)
6419               or else
6420                 not Nkind_In (Ent, N_Defining_Identifier,
6421                                    N_Defining_Character_Literal,
6422                                    N_Defining_Operator_Symbol)
6423               or else No (Scope (Ent))
6424               or else
6425                 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6426                   and then not Is_Child_Unit (Ent))
6427               or else
6428                 (Scope_Depth (Scope (Ent)) >
6429                              Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6430                   and then
6431                     Get_Source_Unit (Ent) =
6432                     Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6433             then
6434                Set_Associated_Node (New_N, Empty);
6435             end if;
6436
6437          --  Case of instantiating identifier or some other name or operator
6438
6439          else
6440             --  If the associated node is still defined, the entity in it is
6441             --  global, and must be copied to the instance. If this copy is
6442             --  being made for a body to inline, it is applied to an
6443             --  instantiated tree, and the entity is already present and must
6444             --  be also preserved.
6445
6446             declare
6447                Assoc : constant Node_Id := Get_Associated_Node (N);
6448
6449             begin
6450                if Present (Assoc) then
6451                   if Nkind (Assoc) = Nkind (N) then
6452                      Set_Entity (New_N, Entity (Assoc));
6453                      Check_Private_View (N);
6454
6455                   elsif Nkind (Assoc) = N_Function_Call then
6456                      Set_Entity (New_N, Entity (Name (Assoc)));
6457
6458                   elsif Nkind_In (Assoc, N_Defining_Identifier,
6459                                          N_Defining_Character_Literal,
6460                                          N_Defining_Operator_Symbol)
6461                     and then Expander_Active
6462                   then
6463                      --  Inlining case: we are copying a tree that contains
6464                      --  global entities, which are preserved in the copy to be
6465                      --  used for subsequent inlining.
6466
6467                      null;
6468
6469                   else
6470                      Set_Entity (New_N, Empty);
6471                   end if;
6472                end if;
6473             end;
6474          end if;
6475
6476          --  For expanded name, we must copy the Prefix and Selector_Name
6477
6478          if Nkind (N) = N_Expanded_Name then
6479             Set_Prefix
6480               (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6481
6482             Set_Selector_Name (New_N,
6483               Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6484
6485          --  For operators, we must copy the right operand
6486
6487          elsif Nkind (N) in N_Op then
6488             Set_Right_Opnd (New_N,
6489               Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6490
6491             --  And for binary operators, the left operand as well
6492
6493             if Nkind (N) in N_Binary_Op then
6494                Set_Left_Opnd (New_N,
6495                  Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6496             end if;
6497          end if;
6498
6499       --  Special casing for stubs
6500
6501       elsif Nkind (N) in N_Body_Stub then
6502
6503          --  In any case, we must copy the specification or defining
6504          --  identifier as appropriate.
6505
6506          if Nkind (N) = N_Subprogram_Body_Stub then
6507             Set_Specification (New_N,
6508               Copy_Generic_Node (Specification (N), New_N, Instantiating));
6509
6510          else
6511             Set_Defining_Identifier (New_N,
6512               Copy_Generic_Node
6513                 (Defining_Identifier (N), New_N, Instantiating));
6514          end if;
6515
6516          --  If we are not instantiating, then this is where we load and
6517          --  analyze subunits, i.e. at the point where the stub occurs. A
6518          --  more permissive system might defer this analysis to the point
6519          --  of instantiation, but this seems to complicated for now.
6520
6521          if not Instantiating then
6522             declare
6523                Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6524                Subunit      : Node_Id;
6525                Unum         : Unit_Number_Type;
6526                New_Body     : Node_Id;
6527
6528             begin
6529                --  Make sure that, if it is a subunit of the main unit that is
6530                --  preprocessed and if -gnateG is specified, the preprocessed
6531                --  file will be written.
6532
6533                Lib.Analysing_Subunit_Of_Main :=
6534                  Lib.In_Extended_Main_Source_Unit (N);
6535                Unum :=
6536                  Load_Unit
6537                    (Load_Name  => Subunit_Name,
6538                     Required   => False,
6539                     Subunit    => True,
6540                     Error_Node => N);
6541                Lib.Analysing_Subunit_Of_Main := False;
6542
6543                --  If the proper body is not found, a warning message will be
6544                --  emitted when analyzing the stub, or later at the point
6545                --  of instantiation. Here we just leave the stub as is.
6546
6547                if Unum = No_Unit then
6548                   Subunits_Missing := True;
6549                   goto Subunit_Not_Found;
6550                end if;
6551
6552                Subunit := Cunit (Unum);
6553
6554                if Nkind (Unit (Subunit)) /= N_Subunit then
6555                   Error_Msg_N
6556                     ("found child unit instead of expected SEPARATE subunit",
6557                      Subunit);
6558                   Error_Msg_Sloc := Sloc (N);
6559                   Error_Msg_N ("\to complete stub #", Subunit);
6560                   goto Subunit_Not_Found;
6561                end if;
6562
6563                --  We must create a generic copy of the subunit, in order to
6564                --  perform semantic analysis on it, and we must replace the
6565                --  stub in the original generic unit with the subunit, in order
6566                --  to preserve non-local references within.
6567
6568                --  Only the proper body needs to be copied. Library_Unit and
6569                --  context clause are simply inherited by the generic copy.
6570                --  Note that the copy (which may be recursive if there are
6571                --  nested subunits) must be done first, before attaching it to
6572                --  the enclosing generic.
6573
6574                New_Body :=
6575                  Copy_Generic_Node
6576                    (Proper_Body (Unit (Subunit)),
6577                     Empty, Instantiating => False);
6578
6579                --  Now place the original proper body in the original generic
6580                --  unit. This is a body, not a compilation unit.
6581
6582                Rewrite (N, Proper_Body (Unit (Subunit)));
6583                Set_Is_Compilation_Unit (Defining_Entity (N), False);
6584                Set_Was_Originally_Stub (N);
6585
6586                --  Finally replace the body of the subunit with its copy, and
6587                --  make this new subunit into the library unit of the generic
6588                --  copy, which does not have stubs any longer.
6589
6590                Set_Proper_Body (Unit (Subunit), New_Body);
6591                Set_Library_Unit (New_N, Subunit);
6592                Inherit_Context (Unit (Subunit), N);
6593             end;
6594
6595          --  If we are instantiating, this must be an error case, since
6596          --  otherwise we would have replaced the stub node by the proper body
6597          --  that corresponds. So just ignore it in the copy (i.e. we have
6598          --  copied it, and that is good enough).
6599
6600          else
6601             null;
6602          end if;
6603
6604          <<Subunit_Not_Found>> null;
6605
6606       --  If the node is a compilation unit, it is the subunit of a stub, which
6607       --  has been loaded already (see code below). In this case, the library
6608       --  unit field of N points to the parent unit (which is a compilation
6609       --  unit) and need not (and cannot!) be copied.
6610
6611       --  When the proper body of the stub is analyzed, the library_unit link
6612       --  is used to establish the proper context (see sem_ch10).
6613
6614       --  The other fields of a compilation unit are copied as usual
6615
6616       elsif Nkind (N) = N_Compilation_Unit then
6617
6618          --  This code can only be executed when not instantiating, because in
6619          --  the copy made for an instantiation, the compilation unit node has
6620          --  disappeared at the point that a stub is replaced by its proper
6621          --  body.
6622
6623          pragma Assert (not Instantiating);
6624
6625          Set_Context_Items (New_N,
6626            Copy_Generic_List (Context_Items (N), New_N));
6627
6628          Set_Unit (New_N,
6629            Copy_Generic_Node (Unit (N), New_N, False));
6630
6631          Set_First_Inlined_Subprogram (New_N,
6632            Copy_Generic_Node
6633              (First_Inlined_Subprogram (N), New_N, False));
6634
6635          Set_Aux_Decls_Node (New_N,
6636            Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6637
6638       --  For an assignment node, the assignment is known to be semantically
6639       --  legal if we are instantiating the template. This avoids incorrect
6640       --  diagnostics in generated code.
6641
6642       elsif Nkind (N) = N_Assignment_Statement then
6643
6644          --  Copy name and expression fields in usual manner
6645
6646          Set_Name (New_N,
6647            Copy_Generic_Node (Name (N), New_N, Instantiating));
6648
6649          Set_Expression (New_N,
6650            Copy_Generic_Node (Expression (N), New_N, Instantiating));
6651
6652          if Instantiating then
6653             Set_Assignment_OK (Name (New_N), True);
6654          end if;
6655
6656       elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6657          if not Instantiating then
6658             Set_Associated_Node (N, New_N);
6659
6660          else
6661             if Present (Get_Associated_Node (N))
6662               and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6663             then
6664                --  In the generic the aggregate has some composite type. If at
6665                --  the point of instantiation the type has a private view,
6666                --  install the full view (and that of its ancestors, if any).
6667
6668                declare
6669                   T   : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6670                   Rt  : Entity_Id;
6671
6672                begin
6673                   if Present (T)
6674                     and then Is_Private_Type (T)
6675                   then
6676                      Switch_View (T);
6677                   end if;
6678
6679                   if Present (T)
6680                     and then Is_Tagged_Type (T)
6681                     and then Is_Derived_Type (T)
6682                   then
6683                      Rt := Root_Type (T);
6684
6685                      loop
6686                         T := Etype (T);
6687
6688                         if Is_Private_Type (T) then
6689                            Switch_View (T);
6690                         end if;
6691
6692                         exit when T = Rt;
6693                      end loop;
6694                   end if;
6695                end;
6696             end if;
6697          end if;
6698
6699          --  Do not copy the associated node, which points to the generic copy
6700          --  of the aggregate.
6701
6702          declare
6703             use Atree.Unchecked_Access;
6704             --  This code section is part of the implementation of an untyped
6705             --  tree traversal, so it needs direct access to node fields.
6706
6707          begin
6708             Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6709             Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6710             Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6711             Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6712          end;
6713
6714       --  Allocators do not have an identifier denoting the access type, so we
6715       --  must locate it through the expression to check whether the views are
6716       --  consistent.
6717
6718       elsif Nkind (N) = N_Allocator
6719         and then Nkind (Expression (N)) = N_Qualified_Expression
6720         and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6721         and then Instantiating
6722       then
6723          declare
6724             T     : constant Node_Id :=
6725                       Get_Associated_Node (Subtype_Mark (Expression (N)));
6726             Acc_T : Entity_Id;
6727
6728          begin
6729             if Present (T) then
6730
6731                --  Retrieve the allocator node in the generic copy
6732
6733                Acc_T := Etype (Parent (Parent (T)));
6734                if Present (Acc_T)
6735                  and then Is_Private_Type (Acc_T)
6736                then
6737                   Switch_View (Acc_T);
6738                end if;
6739             end if;
6740
6741             Copy_Descendants;
6742          end;
6743
6744       --  For a proper body, we must catch the case of a proper body that
6745       --  replaces a stub. This represents the point at which a separate
6746       --  compilation unit, and hence template file, may be referenced, so we
6747       --  must make a new source instantiation entry for the template of the
6748       --  subunit, and ensure that all nodes in the subunit are adjusted using
6749       --  this new source instantiation entry.
6750
6751       elsif Nkind (N) in N_Proper_Body then
6752          declare
6753             Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6754
6755          begin
6756             if Instantiating and then Was_Originally_Stub (N) then
6757                Create_Instantiation_Source
6758                  (Instantiation_Node,
6759                   Defining_Entity (N),
6760                   False,
6761                   S_Adjustment);
6762             end if;
6763
6764             --  Now copy the fields of the proper body, using the new
6765             --  adjustment factor if one was needed as per test above.
6766
6767             Copy_Descendants;
6768
6769             --  Restore the original adjustment factor in case changed
6770
6771             S_Adjustment := Save_Adjustment;
6772          end;
6773
6774       --  Don't copy Ident or Comment pragmas, since the comment belongs to the
6775       --  generic unit, not to the instantiating unit.
6776
6777       elsif Nkind (N) = N_Pragma and then Instantiating then
6778          declare
6779             Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6780          begin
6781             if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6782                New_N := Make_Null_Statement (Sloc (N));
6783
6784             else
6785                Copy_Descendants;
6786             end if;
6787          end;
6788
6789       elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6790
6791          --  No descendant fields need traversing
6792
6793          null;
6794
6795       elsif Nkind (N) = N_String_Literal
6796         and then Present (Etype (N))
6797         and then Instantiating
6798       then
6799          --  If the string is declared in an outer scope, the string_literal
6800          --  subtype created for it may have the wrong scope. We force the
6801          --  reanalysis of the constant to generate a new itype in the proper
6802          --  context.
6803
6804          Set_Etype (New_N, Empty);
6805          Set_Analyzed (New_N, False);
6806
6807       --  For the remaining nodes, copy their descendants recursively
6808
6809       else
6810          Copy_Descendants;
6811
6812          if Instantiating and then Nkind (N) = N_Subprogram_Body then
6813             Set_Generic_Parent (Specification (New_N), N);
6814
6815             --  Should preserve Corresponding_Spec??? (12.3(14))
6816          end if;
6817       end if;
6818
6819       return New_N;
6820    end Copy_Generic_Node;
6821
6822    ----------------------------
6823    -- Denotes_Formal_Package --
6824    ----------------------------
6825
6826    function Denotes_Formal_Package
6827      (Pack     : Entity_Id;
6828       On_Exit  : Boolean := False;
6829       Instance : Entity_Id := Empty) return Boolean
6830    is
6831       Par  : Entity_Id;
6832       Scop : constant Entity_Id := Scope (Pack);
6833       E    : Entity_Id;
6834
6835       function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6836       --  The package in question may be an actual for a previous formal
6837       --  package P of the current instance, so examine its actuals as well.
6838       --  This must be recursive over other formal packages.
6839
6840       ----------------------------------
6841       -- Is_Actual_Of_Previous_Formal --
6842       ----------------------------------
6843
6844       function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
6845          E1 : Entity_Id;
6846
6847       begin
6848          E1 := First_Entity (P);
6849          while Present (E1) and then  E1 /= Instance loop
6850             if Ekind (E1) = E_Package
6851               and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
6852             then
6853                if Renamed_Object (E1) = Pack then
6854                   return True;
6855
6856                elsif E1 = P or else  Renamed_Object (E1) = P then
6857                   return False;
6858
6859                elsif Is_Actual_Of_Previous_Formal (E1) then
6860                   return True;
6861                end if;
6862             end if;
6863
6864             Next_Entity (E1);
6865          end loop;
6866
6867          return False;
6868       end Is_Actual_Of_Previous_Formal;
6869
6870    --  Start of processing for Denotes_Formal_Package
6871
6872    begin
6873       if On_Exit then
6874          Par :=
6875            Instance_Envs.Table
6876              (Instance_Envs.Last).Instantiated_Parent.Act_Id;
6877       else
6878          Par := Current_Instantiated_Parent.Act_Id;
6879       end if;
6880
6881       if Ekind (Scop) = E_Generic_Package
6882         or else Nkind (Unit_Declaration_Node (Scop)) =
6883                                          N_Generic_Subprogram_Declaration
6884       then
6885          return True;
6886
6887       elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
6888         N_Formal_Package_Declaration
6889       then
6890          return True;
6891
6892       elsif No (Par) then
6893          return False;
6894
6895       else
6896          --  Check whether this package is associated with a formal package of
6897          --  the enclosing instantiation. Iterate over the list of renamings.
6898
6899          E := First_Entity (Par);
6900          while Present (E) loop
6901             if Ekind (E) /= E_Package
6902               or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
6903             then
6904                null;
6905
6906             elsif Renamed_Object (E) = Par then
6907                return False;
6908
6909             elsif Renamed_Object (E) = Pack then
6910                return True;
6911
6912             elsif Is_Actual_Of_Previous_Formal (E) then
6913                return True;
6914
6915             end if;
6916
6917             Next_Entity (E);
6918          end loop;
6919
6920          return False;
6921       end if;
6922    end Denotes_Formal_Package;
6923
6924    -----------------
6925    -- End_Generic --
6926    -----------------
6927
6928    procedure End_Generic is
6929    begin
6930       --  ??? More things could be factored out in this routine. Should
6931       --  probably be done at a later stage.
6932
6933       Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
6934       Generic_Flags.Decrement_Last;
6935
6936       Expander_Mode_Restore;
6937    end End_Generic;
6938
6939    -------------
6940    -- Earlier --
6941    -------------
6942
6943    function Earlier (N1, N2 : Node_Id) return Boolean is
6944       procedure Find_Depth (P : in out Node_Id; D : in out Integer);
6945       --  Find distance from given node to enclosing compilation unit
6946
6947       ----------------
6948       -- Find_Depth --
6949       ----------------
6950
6951       procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
6952       begin
6953          while Present (P)
6954            and then Nkind (P) /= N_Compilation_Unit
6955          loop
6956             P := True_Parent (P);
6957             D := D + 1;
6958          end loop;
6959       end Find_Depth;
6960
6961       --  Local declarations
6962
6963       D1 : Integer := 0;
6964       D2 : Integer := 0;
6965       P1 : Node_Id := N1;
6966       P2 : Node_Id := N2;
6967
6968    --  Start of processing for Earlier
6969
6970    begin
6971       Find_Depth (P1, D1);
6972       Find_Depth (P2, D2);
6973
6974       if P1 /= P2 then
6975          return False;
6976       else
6977          P1 := N1;
6978          P2 := N2;
6979       end if;
6980
6981       while D1 > D2 loop
6982          P1 := True_Parent (P1);
6983          D1 := D1 - 1;
6984       end loop;
6985
6986       while D2 > D1 loop
6987          P2 := True_Parent (P2);
6988          D2 := D2 - 1;
6989       end loop;
6990
6991       --  At this point P1 and P2 are at the same distance from the root.
6992       --  We examine their parents until we find a common declarative list.
6993       --  If we reach the root, N1 and N2 do not descend from the same
6994       --  declarative list (e.g. one is nested in the declarative part and
6995       --  the other is in a block in the statement part) and the earlier
6996       --  one is already frozen.
6997
6998       while not Is_List_Member (P1)
6999         or else not Is_List_Member (P2)
7000         or else List_Containing (P1) /= List_Containing (P2)
7001       loop
7002          P1 := True_Parent (P1);
7003          P2 := True_Parent (P2);
7004
7005          if Nkind (Parent (P1)) = N_Subunit then
7006             P1 := Corresponding_Stub (Parent (P1));
7007          end if;
7008
7009          if Nkind (Parent (P2)) = N_Subunit then
7010             P2 := Corresponding_Stub (Parent (P2));
7011          end if;
7012
7013          if P1 = P2 then
7014             return False;
7015          end if;
7016       end loop;
7017
7018       --  Expanded code usually shares the source location of the original
7019       --  construct it was generated for. This however may not necessarely
7020       --  reflect the true location of the code within the tree.
7021
7022       --  Before comparing the slocs of the two nodes, make sure that we are
7023       --  working with correct source locations. Assume that P1 is to the left
7024       --  of P2. If either one does not come from source, traverse the common
7025       --  list heading towards the other node and locate the first source
7026       --  statement.
7027
7028       --             P1                     P2
7029       --     ----+===+===+--------------+===+===+----
7030       --          expanded code          expanded code
7031
7032       if not Comes_From_Source (P1) then
7033          while Present (P1) loop
7034
7035             --  Neither P2 nor a source statement were located during the
7036             --  search. If we reach the end of the list, then P1 does not
7037             --  occur earlier than P2.
7038
7039             --                     ---->
7040             --   start --- P2 ----- P1 --- end
7041
7042             if No (Next (P1)) then
7043                return False;
7044
7045             --  We encounter P2 while going to the right of the list. This
7046             --  means that P1 does indeed appear earlier.
7047
7048             --             ---->
7049             --    start --- P1 ===== P2 --- end
7050             --                 expanded code in between
7051
7052             elsif P1 = P2 then
7053                return True;
7054
7055             --  No need to look any further since we have located a source
7056             --  statement.
7057
7058             elsif Comes_From_Source (P1) then
7059                exit;
7060             end if;
7061
7062             --  Keep going right
7063
7064             Next (P1);
7065          end loop;
7066       end if;
7067
7068       if not Comes_From_Source (P2) then
7069          while Present (P2) loop
7070
7071             --  Neither P1 nor a source statement were located during the
7072             --  search. If we reach the start of the list, then P1 does not
7073             --  occur earlier than P2.
7074
7075             --            <----
7076             --    start --- P2 --- P1 --- end
7077
7078             if No (Prev (P2)) then
7079                return False;
7080
7081             --  We encounter P1 while going to the left of the list. This
7082             --  means that P1 does indeed appear earlier.
7083
7084             --                     <----
7085             --    start --- P1 ===== P2 --- end
7086             --                 expanded code in between
7087
7088             elsif P2 = P1 then
7089                return True;
7090
7091             --  No need to look any further since we have located a source
7092             --  statement.
7093
7094             elsif Comes_From_Source (P2) then
7095                exit;
7096             end if;
7097
7098             --  Keep going left
7099
7100             Prev (P2);
7101          end loop;
7102       end if;
7103
7104       --  At this point either both nodes came from source or we approximated
7105       --  their source locations through neighbouring source statements.
7106
7107       if Top_Level_Location (Sloc (P1)) < Top_Level_Location (Sloc (P2)) then
7108          return True;
7109       else
7110          return False;
7111       end if;
7112    end Earlier;
7113
7114    ----------------------
7115    -- Find_Actual_Type --
7116    ----------------------
7117
7118    function Find_Actual_Type
7119      (Typ      : Entity_Id;
7120       Gen_Type : Entity_Id) return Entity_Id
7121    is
7122       Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7123       T         : Entity_Id;
7124
7125    begin
7126       --  Special processing only applies to child units
7127
7128       if not Is_Child_Unit (Gen_Scope) then
7129          return Get_Instance_Of (Typ);
7130
7131       --  If designated or component type is itself a formal of the child unit,
7132       --  its instance is available.
7133
7134       elsif Scope (Typ) = Gen_Scope then
7135          return Get_Instance_Of (Typ);
7136
7137       --  If the array or access type is not declared in the parent unit,
7138       --  no special processing needed.
7139
7140       elsif not Is_Generic_Type (Typ)
7141         and then Scope (Gen_Scope) /= Scope (Typ)
7142       then
7143          return Get_Instance_Of (Typ);
7144
7145       --  Otherwise, retrieve designated or component type by visibility
7146
7147       else
7148          T := Current_Entity (Typ);
7149          while Present (T) loop
7150             if In_Open_Scopes (Scope (T)) then
7151                return T;
7152
7153             elsif Is_Generic_Actual_Type (T) then
7154                return T;
7155             end if;
7156
7157             T := Homonym (T);
7158          end loop;
7159
7160          return Typ;
7161       end if;
7162    end Find_Actual_Type;
7163
7164    ----------------------------
7165    -- Freeze_Subprogram_Body --
7166    ----------------------------
7167
7168    procedure Freeze_Subprogram_Body
7169      (Inst_Node : Node_Id;
7170       Gen_Body  : Node_Id;
7171       Pack_Id   : Entity_Id)
7172   is
7173       Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7174       Par      : constant Entity_Id := Scope (Gen_Unit);
7175       E_G_Id   : Entity_Id;
7176       Enc_G    : Entity_Id;
7177       Enc_I    : Node_Id;
7178       F_Node   : Node_Id;
7179
7180       function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7181       --  Find innermost package body that encloses the given node, and which
7182       --  is not a compilation unit. Freeze nodes for the instance, or for its
7183       --  enclosing body, may be inserted after the enclosing_body of the
7184       --  generic unit. Used to determine proper placement of freeze node for
7185       --  both package and subprogram instances.
7186
7187       function Package_Freeze_Node (B : Node_Id) return Node_Id;
7188       --  Find entity for given package body, and locate or create a freeze
7189       --  node for it.
7190
7191       ----------------------------
7192       -- Enclosing_Package_Body --
7193       ----------------------------
7194
7195       function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7196          P : Node_Id;
7197
7198       begin
7199          P := Parent (N);
7200          while Present (P)
7201            and then Nkind (Parent (P)) /= N_Compilation_Unit
7202          loop
7203             if Nkind (P) = N_Package_Body then
7204                if Nkind (Parent (P)) = N_Subunit then
7205                   return Corresponding_Stub (Parent (P));
7206                else
7207                   return P;
7208                end if;
7209             end if;
7210
7211             P := True_Parent (P);
7212          end loop;
7213
7214          return Empty;
7215       end Enclosing_Package_Body;
7216
7217       -------------------------
7218       -- Package_Freeze_Node --
7219       -------------------------
7220
7221       function Package_Freeze_Node (B : Node_Id) return Node_Id is
7222          Id : Entity_Id;
7223
7224       begin
7225          if Nkind (B) = N_Package_Body then
7226             Id := Corresponding_Spec (B);
7227          else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7228             Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7229          end if;
7230
7231          Ensure_Freeze_Node (Id);
7232          return Freeze_Node (Id);
7233       end Package_Freeze_Node;
7234
7235    --  Start of processing of Freeze_Subprogram_Body
7236
7237    begin
7238       --  If the instance and the generic body appear within the same unit, and
7239       --  the instance precedes the generic, the freeze node for the instance
7240       --  must appear after that of the generic. If the generic is nested
7241       --  within another instance I2, then current instance must be frozen
7242       --  after I2. In both cases, the freeze nodes are those of enclosing
7243       --  packages. Otherwise, the freeze node is placed at the end of the
7244       --  current declarative part.
7245
7246       Enc_G  := Enclosing_Package_Body (Gen_Body);
7247       Enc_I  := Enclosing_Package_Body (Inst_Node);
7248       Ensure_Freeze_Node (Pack_Id);
7249       F_Node := Freeze_Node (Pack_Id);
7250
7251       if Is_Generic_Instance (Par)
7252         and then Present (Freeze_Node (Par))
7253         and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7254       then
7255          --  The parent was a premature instantiation. Insert freeze node at
7256          --  the end the current declarative part.
7257
7258          if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7259             Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7260
7261          --  Handle the following case:
7262          --
7263          --    package Parent_Inst is new ...
7264          --    Parent_Inst []
7265          --
7266          --    procedure P ...  --  this body freezes Parent_Inst
7267          --
7268          --    package Inst is new ...
7269          --
7270          --  In this particular scenario, the freeze node for Inst must be
7271          --  inserted in the same manner as that of Parent_Inst - before the
7272          --  next source body or at the end of the declarative list (body not
7273          --  available). If body P did not exist and Parent_Inst was frozen
7274          --  after Inst, either by a body following Inst or at the end of the
7275          --  declarative region, the freeze node for Inst must be inserted
7276          --  after that of Parent_Inst. This relation is established by
7277          --  comparing the Slocs of Parent_Inst freeze node and Inst.
7278
7279          elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7280                List_Containing (Inst_Node)
7281            and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7282          then
7283             Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7284
7285          else
7286             Insert_After (Freeze_Node (Par), F_Node);
7287          end if;
7288
7289       --  The body enclosing the instance should be frozen after the body that
7290       --  includes the generic, because the body of the instance may make
7291       --  references to entities therein. If the two are not in the same
7292       --  declarative part, or if the one enclosing the instance is frozen
7293       --  already, freeze the instance at the end of the current declarative
7294       --  part.
7295
7296       elsif Is_Generic_Instance (Par)
7297         and then Present (Freeze_Node (Par))
7298         and then Present (Enc_I)
7299       then
7300          if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7301            or else
7302              (Nkind (Enc_I) = N_Package_Body
7303                and then
7304                  In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7305          then
7306             --  The enclosing package may contain several instances. Rather
7307             --  than computing the earliest point at which to insert its freeze
7308             --  node, we place it at the end of the declarative part of the
7309             --  parent of the generic.
7310
7311             Insert_Freeze_Node_For_Instance
7312               (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7313          end if;
7314
7315          Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7316
7317       elsif Present (Enc_G)
7318         and then Present (Enc_I)
7319         and then Enc_G /= Enc_I
7320         and then Earlier (Inst_Node, Gen_Body)
7321       then
7322          if Nkind (Enc_G) = N_Package_Body then
7323             E_G_Id := Corresponding_Spec (Enc_G);
7324          else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7325             E_G_Id :=
7326               Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7327          end if;
7328
7329          --  Freeze package that encloses instance, and place node after
7330          --  package that encloses generic. If enclosing package is already
7331          --  frozen we have to assume it is at the proper place. This may be a
7332          --  potential ABE that requires dynamic checking. Do not add a freeze
7333          --  node if the package that encloses the generic is inside the body
7334          --  that encloses the instance, because the freeze node would be in
7335          --  the wrong scope. Additional contortions needed if the bodies are
7336          --  within a subunit.
7337
7338          declare
7339             Enclosing_Body : Node_Id;
7340
7341          begin
7342             if Nkind (Enc_I) = N_Package_Body_Stub then
7343                Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7344             else
7345                Enclosing_Body := Enc_I;
7346             end if;
7347
7348             if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7349                Insert_Freeze_Node_For_Instance
7350                  (Enc_G, Package_Freeze_Node (Enc_I));
7351             end if;
7352          end;
7353
7354          --  Freeze enclosing subunit before instance
7355
7356          Ensure_Freeze_Node (E_G_Id);
7357
7358          if not Is_List_Member (Freeze_Node (E_G_Id)) then
7359             Insert_After (Enc_G, Freeze_Node (E_G_Id));
7360          end if;
7361
7362          Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7363
7364       else
7365          --  If none of the above, insert freeze node at the end of the current
7366          --  declarative part.
7367
7368          Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7369       end if;
7370    end Freeze_Subprogram_Body;
7371
7372    ----------------
7373    -- Get_Gen_Id --
7374    ----------------
7375
7376    function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7377    begin
7378       return Generic_Renamings.Table (E).Gen_Id;
7379    end Get_Gen_Id;
7380
7381    ---------------------
7382    -- Get_Instance_Of --
7383    ---------------------
7384
7385    function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7386       Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7387
7388    begin
7389       if Res /= Assoc_Null then
7390          return Generic_Renamings.Table (Res).Act_Id;
7391       else
7392          --  On exit, entity is not instantiated: not a generic parameter, or
7393          --  else parameter of an inner generic unit.
7394
7395          return A;
7396       end if;
7397    end Get_Instance_Of;
7398
7399    ------------------------------------
7400    -- Get_Package_Instantiation_Node --
7401    ------------------------------------
7402
7403    function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7404       Decl : Node_Id := Unit_Declaration_Node (A);
7405       Inst : Node_Id;
7406
7407    begin
7408       --  If the Package_Instantiation attribute has been set on the package
7409       --  entity, then use it directly when it (or its Original_Node) refers
7410       --  to an N_Package_Instantiation node. In principle it should be
7411       --  possible to have this field set in all cases, which should be
7412       --  investigated, and would allow this function to be significantly
7413       --  simplified. ???
7414
7415       Inst := Package_Instantiation (A);
7416
7417       if Present (Inst) then
7418          if Nkind (Inst) = N_Package_Instantiation then
7419             return Inst;
7420
7421          elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7422             return Original_Node (Inst);
7423          end if;
7424       end if;
7425
7426       --  If the instantiation is a compilation unit that does not need body
7427       --  then the instantiation node has been rewritten as a package
7428       --  declaration for the instance, and we return the original node.
7429
7430       --  If it is a compilation unit and the instance node has not been
7431       --  rewritten, then it is still the unit of the compilation. Finally, if
7432       --  a body is present, this is a parent of the main unit whose body has
7433       --  been compiled for inlining purposes, and the instantiation node has
7434       --  been rewritten with the instance body.
7435
7436       --  Otherwise the instantiation node appears after the declaration. If
7437       --  the entity is a formal package, the declaration may have been
7438       --  rewritten as a generic declaration (in the case of a formal with box)
7439       --  or left as a formal package declaration if it has actuals, and is
7440       --  found with a forward search.
7441
7442       if Nkind (Parent (Decl)) = N_Compilation_Unit then
7443          if Nkind (Decl) = N_Package_Declaration
7444            and then Present (Corresponding_Body (Decl))
7445          then
7446             Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7447          end if;
7448
7449          if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7450             return Original_Node (Decl);
7451          else
7452             return Unit (Parent (Decl));
7453          end if;
7454
7455       elsif Nkind (Decl) = N_Package_Declaration
7456         and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7457       then
7458          return Original_Node (Decl);
7459
7460       else
7461          Inst := Next (Decl);
7462          while not Nkind_In (Inst, N_Package_Instantiation,
7463                                    N_Formal_Package_Declaration)
7464          loop
7465             Next (Inst);
7466          end loop;
7467
7468          return Inst;
7469       end if;
7470    end Get_Package_Instantiation_Node;
7471
7472    ------------------------
7473    -- Has_Been_Exchanged --
7474    ------------------------
7475
7476    function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7477       Next : Elmt_Id;
7478
7479    begin
7480       Next := First_Elmt (Exchanged_Views);
7481       while Present (Next) loop
7482          if Full_View (Node (Next)) = E then
7483             return True;
7484          end if;
7485
7486          Next_Elmt (Next);
7487       end loop;
7488
7489       return False;
7490    end Has_Been_Exchanged;
7491
7492    ----------
7493    -- Hash --
7494    ----------
7495
7496    function Hash (F : Entity_Id) return HTable_Range is
7497    begin
7498       return HTable_Range (F mod HTable_Size);
7499    end Hash;
7500
7501    ------------------------
7502    -- Hide_Current_Scope --
7503    ------------------------
7504
7505    procedure Hide_Current_Scope is
7506       C : constant Entity_Id := Current_Scope;
7507       E : Entity_Id;
7508
7509    begin
7510       Set_Is_Hidden_Open_Scope (C);
7511
7512       E := First_Entity (C);
7513       while Present (E) loop
7514          if Is_Immediately_Visible (E) then
7515             Set_Is_Immediately_Visible (E, False);
7516             Append_Elmt (E, Hidden_Entities);
7517          end if;
7518
7519          Next_Entity (E);
7520       end loop;
7521
7522       --  Make the scope name invisible as well. This is necessary, but might
7523       --  conflict with calls to Rtsfind later on, in case the scope is a
7524       --  predefined one. There is no clean solution to this problem, so for
7525       --  now we depend on the user not redefining Standard itself in one of
7526       --  the parent units.
7527
7528       if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7529          Set_Is_Immediately_Visible (C, False);
7530          Append_Elmt (C, Hidden_Entities);
7531       end if;
7532
7533    end Hide_Current_Scope;
7534
7535    --------------
7536    -- Init_Env --
7537    --------------
7538
7539    procedure Init_Env is
7540       Saved : Instance_Env;
7541
7542    begin
7543       Saved.Instantiated_Parent  := Current_Instantiated_Parent;
7544       Saved.Exchanged_Views      := Exchanged_Views;
7545       Saved.Hidden_Entities      := Hidden_Entities;
7546       Saved.Current_Sem_Unit     := Current_Sem_Unit;
7547       Saved.Parent_Unit_Visible  := Parent_Unit_Visible;
7548       Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7549
7550       --  Save configuration switches. These may be reset if the unit is a
7551       --  predefined unit, and the current mode is not Ada 2005.
7552
7553       Save_Opt_Config_Switches (Saved.Switches);
7554
7555       Instance_Envs.Append (Saved);
7556
7557       Exchanged_Views := New_Elmt_List;
7558       Hidden_Entities := New_Elmt_List;
7559
7560       --  Make dummy entry for Instantiated parent. If generic unit is legal,
7561       --  this is set properly in Set_Instance_Env.
7562
7563       Current_Instantiated_Parent :=
7564         (Current_Scope, Current_Scope, Assoc_Null);
7565    end Init_Env;
7566
7567    ------------------------------
7568    -- In_Same_Declarative_Part --
7569    ------------------------------
7570
7571    function In_Same_Declarative_Part
7572      (F_Node : Node_Id;
7573       Inst   : Node_Id) return Boolean
7574    is
7575       Decls : constant Node_Id := Parent (F_Node);
7576       Nod   : Node_Id := Parent (Inst);
7577
7578    begin
7579       while Present (Nod) loop
7580          if Nod = Decls then
7581             return True;
7582
7583          elsif Nkind_In (Nod, N_Subprogram_Body,
7584                               N_Package_Body,
7585                               N_Package_Declaration,
7586                               N_Task_Body,
7587                               N_Protected_Body,
7588                               N_Block_Statement)
7589          then
7590             return False;
7591
7592          elsif Nkind (Nod) = N_Subunit then
7593             Nod := Corresponding_Stub (Nod);
7594
7595          elsif Nkind (Nod) = N_Compilation_Unit then
7596             return False;
7597
7598          else
7599             Nod := Parent (Nod);
7600          end if;
7601       end loop;
7602
7603       return False;
7604    end In_Same_Declarative_Part;
7605
7606    ---------------------
7607    -- In_Main_Context --
7608    ---------------------
7609
7610    function In_Main_Context (E : Entity_Id) return Boolean is
7611       Context : List_Id;
7612       Clause  : Node_Id;
7613       Nam     : Node_Id;
7614
7615    begin
7616       if not Is_Compilation_Unit (E)
7617         or else Ekind (E) /= E_Package
7618         or else In_Private_Part (E)
7619       then
7620          return False;
7621       end if;
7622
7623       Context := Context_Items (Cunit (Main_Unit));
7624
7625       Clause  := First (Context);
7626       while Present (Clause) loop
7627          if Nkind (Clause) = N_With_Clause then
7628             Nam := Name (Clause);
7629
7630             --  If the current scope is part of the context of the main unit,
7631             --  analysis of the corresponding with_clause is not complete, and
7632             --  the entity is not set. We use the Chars field directly, which
7633             --  might produce false positives in rare cases, but guarantees
7634             --  that we produce all the instance bodies we will need.
7635
7636             if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7637                  or else (Nkind (Nam) = N_Selected_Component
7638                            and then Chars (Selector_Name (Nam)) = Chars (E))
7639             then
7640                return True;
7641             end if;
7642          end if;
7643
7644          Next (Clause);
7645       end loop;
7646
7647       return False;
7648    end In_Main_Context;
7649
7650    ---------------------
7651    -- Inherit_Context --
7652    ---------------------
7653
7654    procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7655       Current_Context : List_Id;
7656       Current_Unit    : Node_Id;
7657       Item            : Node_Id;
7658       New_I           : Node_Id;
7659
7660    begin
7661       if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7662
7663          --  The inherited context is attached to the enclosing compilation
7664          --  unit. This is either the main unit, or the declaration for the
7665          --  main unit (in case the instantiation appears within the package
7666          --  declaration and the main unit is its body).
7667
7668          Current_Unit := Parent (Inst);
7669          while Present (Current_Unit)
7670            and then Nkind (Current_Unit) /= N_Compilation_Unit
7671          loop
7672             Current_Unit := Parent (Current_Unit);
7673          end loop;
7674
7675          Current_Context := Context_Items (Current_Unit);
7676
7677          Item := First (Context_Items (Parent (Gen_Decl)));
7678          while Present (Item) loop
7679             if Nkind (Item) = N_With_Clause then
7680
7681                --  Take care to prevent direct cyclic with's, which can happen
7682                --  if the generic body with's the current unit. Such a case
7683                --  would result in binder errors (or run-time errors if the
7684                --  -gnatE switch is in effect), but we want to prevent it here,
7685                --  because Sem.Walk_Library_Items doesn't like cycles. Note
7686                --  that we don't bother to detect indirect cycles.
7687
7688                if Library_Unit (Item) /= Current_Unit then
7689                   New_I := New_Copy (Item);
7690                   Set_Implicit_With (New_I, True);
7691                   Append (New_I, Current_Context);
7692                end if;
7693             end if;
7694
7695             Next (Item);
7696          end loop;
7697       end if;
7698    end Inherit_Context;
7699
7700    ----------------
7701    -- Initialize --
7702    ----------------
7703
7704    procedure Initialize is
7705    begin
7706       Generic_Renamings.Init;
7707       Instance_Envs.Init;
7708       Generic_Flags.Init;
7709       Generic_Renamings_HTable.Reset;
7710       Circularity_Detected := False;
7711       Exchanged_Views      := No_Elist;
7712       Hidden_Entities      := No_Elist;
7713    end Initialize;
7714
7715    -------------------------------------
7716    -- Insert_Freeze_Node_For_Instance --
7717    -------------------------------------
7718
7719    procedure Insert_Freeze_Node_For_Instance
7720      (N      : Node_Id;
7721       F_Node : Node_Id)
7722    is
7723       Inst  : constant Entity_Id := Entity (F_Node);
7724       Decl  : Node_Id;
7725       Decls : List_Id;
7726       Par_N : Node_Id;
7727
7728       function Enclosing_Body (N : Node_Id) return Node_Id;
7729       --  Find enclosing package or subprogram body, if any. Freeze node
7730       --  may be placed at end of current declarative list if previous
7731       --  instance and current one have different enclosing bodies.
7732
7733       function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7734       --  Find the local instance, if any, that declares the generic that is
7735       --  being instantiated. If present, the freeze node for this instance
7736       --  must follow the freeze node for the previous instance.
7737
7738       --------------------
7739       -- Enclosing_Body --
7740       --------------------
7741
7742       function Enclosing_Body (N : Node_Id) return Node_Id is
7743          P : Node_Id;
7744
7745       begin
7746          P := Parent (N);
7747          while Present (P)
7748            and then Nkind (Parent (P)) /= N_Compilation_Unit
7749          loop
7750             if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7751                if Nkind (Parent (P)) = N_Subunit then
7752                   return Corresponding_Stub (Parent (P));
7753                else
7754                   return P;
7755                end if;
7756             end if;
7757
7758             P := True_Parent (P);
7759          end loop;
7760
7761          return Empty;
7762       end Enclosing_Body;
7763
7764       -----------------------
7765       -- Previous_Instance --
7766       -----------------------
7767
7768       function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7769          S : Entity_Id;
7770
7771       begin
7772          S := Scope (Gen);
7773          while Present (S)
7774            and then S /= Standard_Standard
7775          loop
7776             if Is_Generic_Instance (S)
7777               and then In_Same_Source_Unit (S, N)
7778             then
7779                return S;
7780             end if;
7781
7782             S := Scope (S);
7783          end loop;
7784
7785          return Empty;
7786       end Previous_Instance;
7787
7788    --  Start of processing for Insert_Freeze_Node_For_Instance
7789
7790    begin
7791       if not Is_List_Member (F_Node) then
7792          Decls := List_Containing (N);
7793          Par_N := Parent (Decls);
7794          Decl  := N;
7795
7796          --  If this is a package instance, check whether the generic is
7797          --  declared in a previous instance and the current instance is
7798          --  not within the previous one.
7799
7800          if Present (Generic_Parent (Parent (Inst)))
7801            and then Is_In_Main_Unit (N)
7802          then
7803             declare
7804                Enclosing_N : constant Node_Id := Enclosing_Body (N);
7805                Par_I       : constant Entity_Id :=
7806                                Previous_Instance
7807                                  (Generic_Parent (Parent (Inst)));
7808                Scop        : Entity_Id;
7809
7810             begin
7811                if Present (Par_I)
7812                  and then Earlier (N, Freeze_Node (Par_I))
7813                then
7814                   Scop := Scope (Inst);
7815
7816                   --  If the current instance is within the one that contains
7817                   --  the generic, the freeze node for the current one must
7818                   --  appear in the current declarative part. Ditto, if the
7819                   --  current instance is within another package instance or
7820                   --  within a body that does not enclose the current instance.
7821                   --  In these three cases the freeze node of the previous
7822                   --  instance is not relevant.
7823
7824                   while Present (Scop)
7825                     and then Scop /= Standard_Standard
7826                   loop
7827                      exit when Scop = Par_I
7828                        or else
7829                          (Is_Generic_Instance (Scop)
7830                            and then Scope_Depth (Scop) > Scope_Depth (Par_I));
7831                      Scop := Scope (Scop);
7832                   end loop;
7833
7834                   --  Previous instance encloses current instance
7835
7836                   if Scop = Par_I then
7837                      null;
7838
7839                   --  If the next node is a source  body we must freeze in
7840                   --  the current scope as well.
7841
7842                   elsif Present (Next (N))
7843                     and then Nkind_In (Next (N),
7844                       N_Subprogram_Body, N_Package_Body)
7845                     and then Comes_From_Source (Next (N))
7846                   then
7847                      null;
7848
7849                   --  Current instance is within an unrelated instance
7850
7851                   elsif Is_Generic_Instance (Scop) then
7852                      null;
7853
7854                   --  Current instance is within an unrelated body
7855
7856                   elsif Present (Enclosing_N)
7857                      and then Enclosing_N /= Enclosing_Body (Par_I)
7858                   then
7859                      null;
7860
7861                   else
7862                      Insert_After (Freeze_Node (Par_I), F_Node);
7863                      return;
7864                   end if;
7865                end if;
7866             end;
7867          end if;
7868
7869          --  When the instantiation occurs in a package declaration, append the
7870          --  freeze node to the private declarations (if any).
7871
7872          if Nkind (Par_N) = N_Package_Specification
7873            and then Decls = Visible_Declarations (Par_N)
7874            and then Present (Private_Declarations (Par_N))
7875            and then not Is_Empty_List (Private_Declarations (Par_N))
7876          then
7877             Decls := Private_Declarations (Par_N);
7878             Decl  := First (Decls);
7879          end if;
7880
7881          --  Determine the proper freeze point of a package instantiation. We
7882          --  adhere to the general rule of a package or subprogram body causing
7883          --  freezing of anything before it in the same declarative region. In
7884          --  this case, the proper freeze point of a package instantiation is
7885          --  before the first source body which follows, or before a stub. This
7886          --  ensures that entities coming from the instance are already frozen
7887          --  and usable in source bodies.
7888
7889          if Nkind (Par_N) /= N_Package_Declaration
7890            and then Ekind (Inst) = E_Package
7891            and then Is_Generic_Instance (Inst)
7892            and then
7893              not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
7894          then
7895             while Present (Decl) loop
7896                if (Nkind (Decl) in N_Unit_Body
7897                      or else
7898                    Nkind (Decl) in N_Body_Stub)
7899                  and then Comes_From_Source (Decl)
7900                then
7901                   Insert_Before (Decl, F_Node);
7902                   return;
7903                end if;
7904
7905                Next (Decl);
7906             end loop;
7907          end if;
7908
7909          --  In a package declaration, or if no previous body, insert at end
7910          --  of list.
7911
7912          Set_Sloc (F_Node, Sloc (Last (Decls)));
7913          Insert_After (Last (Decls), F_Node);
7914       end if;
7915    end Insert_Freeze_Node_For_Instance;
7916
7917    ------------------
7918    -- Install_Body --
7919    ------------------
7920
7921    procedure Install_Body
7922      (Act_Body : Node_Id;
7923       N        : Node_Id;
7924       Gen_Body : Node_Id;
7925       Gen_Decl : Node_Id)
7926    is
7927       Act_Id    : constant Entity_Id := Corresponding_Spec (Act_Body);
7928       Act_Unit  : constant Node_Id   := Unit (Cunit (Get_Source_Unit (N)));
7929       Gen_Id    : constant Entity_Id := Corresponding_Spec (Gen_Body);
7930       Par       : constant Entity_Id := Scope (Gen_Id);
7931       Gen_Unit  : constant Node_Id   :=
7932                     Unit (Cunit (Get_Source_Unit (Gen_Decl)));
7933       Orig_Body : Node_Id := Gen_Body;
7934       F_Node    : Node_Id;
7935       Body_Unit : Node_Id;
7936
7937       Must_Delay : Boolean;
7938
7939       function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
7940       --  Find subprogram (if any) that encloses instance and/or generic body
7941
7942       function True_Sloc (N : Node_Id) return Source_Ptr;
7943       --  If the instance is nested inside a generic unit, the Sloc of the
7944       --  instance indicates the place of the original definition, not the
7945       --  point of the current enclosing instance. Pending a better usage of
7946       --  Slocs to indicate instantiation places, we determine the place of
7947       --  origin of a node by finding the maximum sloc of any ancestor node.
7948       --  Why is this not equivalent to Top_Level_Location ???
7949
7950       --------------------
7951       -- Enclosing_Subp --
7952       --------------------
7953
7954       function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
7955          Scop : Entity_Id;
7956
7957       begin
7958          Scop := Scope (Id);
7959          while Scop /= Standard_Standard
7960            and then not Is_Overloadable (Scop)
7961          loop
7962             Scop := Scope (Scop);
7963          end loop;
7964
7965          return Scop;
7966       end Enclosing_Subp;
7967
7968       ---------------
7969       -- True_Sloc --
7970       ---------------
7971
7972       function True_Sloc (N : Node_Id) return Source_Ptr is
7973          Res : Source_Ptr;
7974          N1  : Node_Id;
7975
7976       begin
7977          Res := Sloc (N);
7978          N1 := N;
7979          while Present (N1) and then N1 /= Act_Unit loop
7980             if Sloc (N1) > Res then
7981                Res := Sloc (N1);
7982             end if;
7983
7984             N1 := Parent (N1);
7985          end loop;
7986
7987          return Res;
7988       end True_Sloc;
7989
7990    --  Start of processing for Install_Body
7991
7992    begin
7993       --  If the body is a subunit, the freeze point is the corresponding stub
7994       --  in the current compilation, not the subunit itself.
7995
7996       if Nkind (Parent (Gen_Body)) = N_Subunit then
7997          Orig_Body := Corresponding_Stub (Parent (Gen_Body));
7998       else
7999          Orig_Body := Gen_Body;
8000       end if;
8001
8002       Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8003
8004       --  If the instantiation and the generic definition appear in the same
8005       --  package declaration, this is an early instantiation. If they appear
8006       --  in the same declarative part, it is an early instantiation only if
8007       --  the generic body appears textually later, and the generic body is
8008       --  also in the main unit.
8009
8010       --  If instance is nested within a subprogram, and the generic body is
8011       --  not, the instance is delayed because the enclosing body is. If
8012       --  instance and body are within the same scope, or the same sub-
8013       --  program body, indicate explicitly that the instance is delayed.
8014
8015       Must_Delay :=
8016         (Gen_Unit = Act_Unit
8017           and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8018                                         N_Generic_Package_Declaration)
8019                       or else (Gen_Unit = Body_Unit
8020                                 and then True_Sloc (N) < Sloc (Orig_Body)))
8021           and then Is_In_Main_Unit (Gen_Unit)
8022           and then (Scope (Act_Id) = Scope (Gen_Id)
8023                       or else
8024                     Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
8025
8026       --  If this is an early instantiation, the freeze node is placed after
8027       --  the generic body. Otherwise, if the generic appears in an instance,
8028       --  we cannot freeze the current instance until the outer one is frozen.
8029       --  This is only relevant if the current instance is nested within some
8030       --  inner scope not itself within the outer instance. If this scope is
8031       --  a package body in the same declarative part as the outer instance,
8032       --  then that body needs to be frozen after the outer instance. Finally,
8033       --  if no delay is needed, we place the freeze node at the end of the
8034       --  current declarative part.
8035
8036       if Expander_Active then
8037          Ensure_Freeze_Node (Act_Id);
8038          F_Node := Freeze_Node (Act_Id);
8039
8040          if Must_Delay then
8041             Insert_After (Orig_Body, F_Node);
8042
8043          elsif Is_Generic_Instance (Par)
8044            and then Present (Freeze_Node (Par))
8045            and then Scope (Act_Id) /= Par
8046          then
8047             --  Freeze instance of inner generic after instance of enclosing
8048             --  generic.
8049
8050             if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8051
8052                --  Handle the following case:
8053
8054                --    package Parent_Inst is new ...
8055                --    Parent_Inst []
8056
8057                --    procedure P ...  --  this body freezes Parent_Inst
8058
8059                --    package Inst is new ...
8060
8061                --  In this particular scenario, the freeze node for Inst must
8062                --  be inserted in the same manner as that of Parent_Inst -
8063                --  before the next source body or at the end of the declarative
8064                --  list (body not available). If body P did not exist and
8065                --  Parent_Inst was frozen after Inst, either by a body
8066                --  following Inst or at the end of the declarative region, the
8067                --  freeze node for Inst must be inserted after that of
8068                --  Parent_Inst. This relation is established by comparing the
8069                --  Slocs of Parent_Inst freeze node and Inst.
8070
8071                if List_Containing (Get_Package_Instantiation_Node (Par)) =
8072                   List_Containing (N)
8073                  and then Sloc (Freeze_Node (Par)) < Sloc (N)
8074                then
8075                   Insert_Freeze_Node_For_Instance (N, F_Node);
8076                else
8077                   Insert_After (Freeze_Node (Par), F_Node);
8078                end if;
8079
8080             --  Freeze package enclosing instance of inner generic after
8081             --  instance of enclosing generic.
8082
8083             elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8084               and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8085             then
8086                declare
8087                   Enclosing :  Entity_Id;
8088
8089                begin
8090                   Enclosing := Corresponding_Spec (Parent (N));
8091
8092                   if No (Enclosing) then
8093                      Enclosing := Defining_Entity (Parent (N));
8094                   end if;
8095
8096                   Insert_Freeze_Node_For_Instance (N, F_Node);
8097                   Ensure_Freeze_Node (Enclosing);
8098
8099                   if not Is_List_Member (Freeze_Node (Enclosing)) then
8100
8101                      --  The enclosing context is a subunit, insert the freeze
8102                      --  node after the stub.
8103
8104                      if Nkind (Parent (Parent (N))) = N_Subunit then
8105                         Insert_Freeze_Node_For_Instance
8106                           (Corresponding_Stub (Parent (Parent (N))),
8107                            Freeze_Node (Enclosing));
8108
8109                      --  The enclosing context is a package with a stub body
8110                      --  which has already been replaced by the real body.
8111                      --  Insert the freeze node after the actual body.
8112
8113                      elsif Ekind (Enclosing) = E_Package
8114                        and then Present (Body_Entity (Enclosing))
8115                        and then Was_Originally_Stub
8116                                   (Parent (Body_Entity (Enclosing)))
8117                      then
8118                         Insert_Freeze_Node_For_Instance
8119                           (Parent (Body_Entity (Enclosing)),
8120                            Freeze_Node (Enclosing));
8121
8122                      --  The parent instance has been frozen before the body of
8123                      --  the enclosing package, insert the freeze node after
8124                      --  the body.
8125
8126                      elsif List_Containing (Freeze_Node (Par)) =
8127                            List_Containing (Parent (N))
8128                        and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8129                      then
8130                         Insert_Freeze_Node_For_Instance
8131                           (Parent (N), Freeze_Node (Enclosing));
8132
8133                      else
8134                         Insert_After
8135                           (Freeze_Node (Par), Freeze_Node (Enclosing));
8136                      end if;
8137                   end if;
8138                end;
8139
8140             else
8141                Insert_Freeze_Node_For_Instance (N, F_Node);
8142             end if;
8143
8144          else
8145             Insert_Freeze_Node_For_Instance (N, F_Node);
8146          end if;
8147       end if;
8148
8149       Set_Is_Frozen (Act_Id);
8150       Insert_Before (N, Act_Body);
8151       Mark_Rewrite_Insertion (Act_Body);
8152    end Install_Body;
8153
8154    -----------------------------
8155    -- Install_Formal_Packages --
8156    -----------------------------
8157
8158    procedure Install_Formal_Packages (Par : Entity_Id) is
8159       E     : Entity_Id;
8160       Gen   : Entity_Id;
8161       Gen_E : Entity_Id := Empty;
8162
8163    begin
8164       E := First_Entity (Par);
8165
8166       --  If we are installing an instance parent, locate the formal packages
8167       --  of its generic parent.
8168
8169       if Is_Generic_Instance (Par) then
8170          Gen   := Generic_Parent (Specification (Unit_Declaration_Node (Par)));
8171          Gen_E := First_Entity (Gen);
8172       end if;
8173
8174       while Present (E) loop
8175          if Ekind (E) = E_Package
8176            and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8177          then
8178             --  If this is the renaming for the parent instance, done
8179
8180             if Renamed_Object (E) = Par then
8181                exit;
8182
8183             --  The visibility of a formal of an enclosing generic is already
8184             --  correct.
8185
8186             elsif Denotes_Formal_Package (E) then
8187                null;
8188
8189             elsif Present (Associated_Formal_Package (E)) then
8190                Check_Generic_Actuals (Renamed_Object (E), True);
8191                Set_Is_Hidden (E, False);
8192
8193                --  Find formal package in generic unit that corresponds to
8194                --  (instance of) formal package in instance.
8195
8196                while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8197                   Next_Entity (Gen_E);
8198                end loop;
8199
8200                if Present (Gen_E) then
8201                   Map_Formal_Package_Entities (Gen_E, E);
8202                end if;
8203             end if;
8204          end if;
8205
8206          Next_Entity (E);
8207          if Present (Gen_E) then
8208             Next_Entity (Gen_E);
8209          end if;
8210       end loop;
8211    end Install_Formal_Packages;
8212
8213    --------------------
8214    -- Install_Parent --
8215    --------------------
8216
8217    procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8218       Ancestors : constant Elist_Id  := New_Elmt_List;
8219       S         : constant Entity_Id := Current_Scope;
8220       Inst_Par  : Entity_Id;
8221       First_Par : Entity_Id;
8222       Inst_Node : Node_Id;
8223       Gen_Par   : Entity_Id;
8224       First_Gen : Entity_Id;
8225       Elmt      : Elmt_Id;
8226
8227       procedure Install_Noninstance_Specs (Par : Entity_Id);
8228       --  Install the scopes of noninstance parent units ending with Par
8229
8230       procedure Install_Spec (Par : Entity_Id);
8231       --  The child unit is within the declarative part of the parent, so
8232       --  the declarations within the parent are immediately visible.
8233
8234       -------------------------------
8235       -- Install_Noninstance_Specs --
8236       -------------------------------
8237
8238       procedure Install_Noninstance_Specs (Par : Entity_Id) is
8239       begin
8240          if Present (Par)
8241            and then Par /= Standard_Standard
8242            and then not In_Open_Scopes (Par)
8243          then
8244             Install_Noninstance_Specs (Scope (Par));
8245             Install_Spec (Par);
8246          end if;
8247       end Install_Noninstance_Specs;
8248
8249       ------------------
8250       -- Install_Spec --
8251       ------------------
8252
8253       procedure Install_Spec (Par : Entity_Id) is
8254          Spec : constant Node_Id :=
8255                   Specification (Unit_Declaration_Node (Par));
8256
8257       begin
8258          --  If this parent of the child instance is a top-level unit,
8259          --  then record the unit and its visibility for later resetting
8260          --  in Remove_Parent. We exclude units that are generic instances,
8261          --  as we only want to record this information for the ultimate
8262          --  top-level noninstance parent (is that always correct???).
8263
8264          if Scope (Par) = Standard_Standard
8265            and then not Is_Generic_Instance (Par)
8266          then
8267             Parent_Unit_Visible := Is_Immediately_Visible (Par);
8268             Instance_Parent_Unit := Par;
8269          end if;
8270
8271          --  Open the parent scope and make it and its declarations visible.
8272          --  If this point is not within a body, then only the visible
8273          --  declarations should be made visible, and installation of the
8274          --  private declarations is deferred until the appropriate point
8275          --  within analysis of the spec being instantiated (see the handling
8276          --  of parent visibility in Analyze_Package_Specification). This is
8277          --  relaxed in the case where the parent unit is Ada.Tags, to avoid
8278          --  private view problems that occur when compiling instantiations of
8279          --  a generic child of that package (Generic_Dispatching_Constructor).
8280          --  If the instance freezes a tagged type, inlinings of operations
8281          --  from Ada.Tags may need the full view of type Tag. If inlining took
8282          --  proper account of establishing visibility of inlined subprograms'
8283          --  parents then it should be possible to remove this
8284          --  special check. ???
8285
8286          Push_Scope (Par);
8287          Set_Is_Immediately_Visible   (Par);
8288          Install_Visible_Declarations (Par);
8289          Set_Use (Visible_Declarations (Spec));
8290
8291          if In_Body or else Is_RTU (Par, Ada_Tags) then
8292             Install_Private_Declarations (Par);
8293             Set_Use (Private_Declarations (Spec));
8294          end if;
8295       end Install_Spec;
8296
8297    --  Start of processing for Install_Parent
8298
8299    begin
8300       --  We need to install the parent instance to compile the instantiation
8301       --  of the child, but the child instance must appear in the current
8302       --  scope. Given that we cannot place the parent above the current scope
8303       --  in the scope stack, we duplicate the current scope and unstack both
8304       --  after the instantiation is complete.
8305
8306       --  If the parent is itself the instantiation of a child unit, we must
8307       --  also stack the instantiation of its parent, and so on. Each such
8308       --  ancestor is the prefix of the name in a prior instantiation.
8309
8310       --  If this is a nested instance, the parent unit itself resolves to
8311       --  a renaming of the parent instance, whose declaration we need.
8312
8313       --  Finally, the parent may be a generic (not an instance) when the
8314       --  child unit appears as a formal package.
8315
8316       Inst_Par := P;
8317
8318       if Present (Renamed_Entity (Inst_Par)) then
8319          Inst_Par := Renamed_Entity (Inst_Par);
8320       end if;
8321
8322       First_Par := Inst_Par;
8323
8324       Gen_Par :=
8325         Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
8326
8327       First_Gen := Gen_Par;
8328
8329       while Present (Gen_Par)
8330         and then Is_Child_Unit (Gen_Par)
8331       loop
8332          --  Load grandparent instance as well
8333
8334          Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8335
8336          if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8337             Inst_Par := Entity (Prefix (Name (Inst_Node)));
8338
8339             if Present (Renamed_Entity (Inst_Par)) then
8340                Inst_Par := Renamed_Entity (Inst_Par);
8341             end if;
8342
8343             Gen_Par :=
8344               Generic_Parent
8345                 (Specification (Unit_Declaration_Node (Inst_Par)));
8346
8347             if Present (Gen_Par) then
8348                Prepend_Elmt (Inst_Par, Ancestors);
8349
8350             else
8351                --  Parent is not the name of an instantiation
8352
8353                Install_Noninstance_Specs (Inst_Par);
8354                exit;
8355             end if;
8356
8357          else
8358             --  Previous error
8359
8360             exit;
8361          end if;
8362       end loop;
8363
8364       if Present (First_Gen) then
8365          Append_Elmt (First_Par, Ancestors);
8366       else
8367          Install_Noninstance_Specs (First_Par);
8368       end if;
8369
8370       if not Is_Empty_Elmt_List (Ancestors) then
8371          Elmt := First_Elmt (Ancestors);
8372          while Present (Elmt) loop
8373             Install_Spec (Node (Elmt));
8374             Install_Formal_Packages (Node (Elmt));
8375             Next_Elmt (Elmt);
8376          end loop;
8377       end if;
8378
8379       if not In_Body then
8380          Push_Scope (S);
8381       end if;
8382    end Install_Parent;
8383
8384    -------------------------------
8385    -- Install_Hidden_Primitives --
8386    -------------------------------
8387
8388    procedure Install_Hidden_Primitives
8389      (Prims_List : in out Elist_Id;
8390       Gen_T      : Entity_Id;
8391       Act_T      : Entity_Id)
8392    is
8393       Elmt        : Elmt_Id;
8394       List        : Elist_Id := No_Elist;
8395       Prim_G_Elmt : Elmt_Id;
8396       Prim_A_Elmt : Elmt_Id;
8397       Prim_G      : Node_Id;
8398       Prim_A      : Node_Id;
8399
8400    begin
8401       --  No action needed in case of serious errors because we cannot trust
8402       --  in the order of primitives
8403
8404       if Serious_Errors_Detected > 0 then
8405          return;
8406
8407       --  No action possible if we don't have available the list of primitive
8408       --  operations
8409
8410       elsif No (Gen_T)
8411         or else not Is_Record_Type (Gen_T)
8412         or else not Is_Tagged_Type (Gen_T)
8413         or else not Is_Record_Type (Act_T)
8414         or else not Is_Tagged_Type (Act_T)
8415       then
8416          return;
8417
8418       --  There is no need to handle interface types since their primitives
8419       --  cannot be hidden
8420
8421       elsif Is_Interface (Gen_T) then
8422          return;
8423       end if;
8424
8425       Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8426
8427       if not Is_Class_Wide_Type (Act_T) then
8428          Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8429       else
8430          Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8431       end if;
8432
8433       loop
8434          --  Skip predefined primitives in the generic formal
8435
8436          while Present (Prim_G_Elmt)
8437            and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8438          loop
8439             Next_Elmt (Prim_G_Elmt);
8440          end loop;
8441
8442          --  Skip predefined primitives in the generic actual
8443
8444          while Present (Prim_A_Elmt)
8445            and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8446          loop
8447             Next_Elmt (Prim_A_Elmt);
8448          end loop;
8449
8450          exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8451
8452          Prim_G := Node (Prim_G_Elmt);
8453          Prim_A := Node (Prim_A_Elmt);
8454
8455          --  There is no need to handle interface primitives because their
8456          --  primitives are not hidden
8457
8458          exit when Present (Interface_Alias (Prim_G));
8459
8460          --  Here we install one hidden primitive
8461
8462          if Chars (Prim_G) /= Chars (Prim_A)
8463            and then Has_Suffix (Prim_A, 'P')
8464            and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8465          then
8466             Set_Chars (Prim_A, Chars (Prim_G));
8467
8468             if List = No_Elist then
8469                List := New_Elmt_List;
8470             end if;
8471
8472             Append_Elmt (Prim_A, List);
8473          end if;
8474
8475          Next_Elmt (Prim_A_Elmt);
8476          Next_Elmt (Prim_G_Elmt);
8477       end loop;
8478
8479       --  Append the elements to the list of temporarily visible primitives
8480       --  avoiding duplicates.
8481
8482       if Present (List) then
8483          if No (Prims_List) then
8484             Prims_List := New_Elmt_List;
8485          end if;
8486
8487          Elmt := First_Elmt (List);
8488          while Present (Elmt) loop
8489             Append_Unique_Elmt (Node (Elmt), Prims_List);
8490             Next_Elmt (Elmt);
8491          end loop;
8492       end if;
8493    end Install_Hidden_Primitives;
8494
8495    -------------------------------
8496    -- Restore_Hidden_Primitives --
8497    -------------------------------
8498
8499    procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8500       Prim_Elmt : Elmt_Id;
8501       Prim      : Node_Id;
8502
8503    begin
8504       if Prims_List /= No_Elist then
8505          Prim_Elmt := First_Elmt (Prims_List);
8506          while Present (Prim_Elmt) loop
8507             Prim := Node (Prim_Elmt);
8508             Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8509             Next_Elmt (Prim_Elmt);
8510          end loop;
8511
8512          Prims_List := No_Elist;
8513       end if;
8514    end Restore_Hidden_Primitives;
8515
8516    --------------------------------
8517    -- Instantiate_Formal_Package --
8518    --------------------------------
8519
8520    function Instantiate_Formal_Package
8521      (Formal          : Node_Id;
8522       Actual          : Node_Id;
8523       Analyzed_Formal : Node_Id) return List_Id
8524    is
8525       Loc         : constant Source_Ptr := Sloc (Actual);
8526       Actual_Pack : Entity_Id;
8527       Formal_Pack : Entity_Id;
8528       Gen_Parent  : Entity_Id;
8529       Decls       : List_Id;
8530       Nod         : Node_Id;
8531       Parent_Spec : Node_Id;
8532
8533       procedure Find_Matching_Actual
8534        (F    : Node_Id;
8535         Act  : in out Entity_Id);
8536       --  We need to associate each formal entity in the formal package
8537       --  with the corresponding entity in the actual package. The actual
8538       --  package has been analyzed and possibly expanded, and as a result
8539       --  there is no one-to-one correspondence between the two lists (for
8540       --  example, the actual may include subtypes, itypes, and inherited
8541       --  primitive operations, interspersed among the renaming declarations
8542       --  for the actuals) . We retrieve the corresponding actual by name
8543       --  because each actual has the same name as the formal, and they do
8544       --  appear in the same order.
8545
8546       function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8547       --  Retrieve entity of defining entity of  generic formal parameter.
8548       --  Only the declarations of formals need to be considered when
8549       --  linking them to actuals, but the declarative list may include
8550       --  internal entities generated during analysis, and those are ignored.
8551
8552       procedure Match_Formal_Entity
8553         (Formal_Node : Node_Id;
8554          Formal_Ent  : Entity_Id;
8555          Actual_Ent  : Entity_Id);
8556       --  Associates the formal entity with the actual. In the case
8557       --  where Formal_Ent is a formal package, this procedure iterates
8558       --  through all of its formals and enters associations between the
8559       --  actuals occurring in the formal package's corresponding actual
8560       --  package (given by Actual_Ent) and the formal package's formal
8561       --  parameters. This procedure recurses if any of the parameters is
8562       --  itself a package.
8563
8564       function Is_Instance_Of
8565         (Act_Spec : Entity_Id;
8566          Gen_Anc  : Entity_Id) return Boolean;
8567       --  The actual can be an instantiation of a generic within another
8568       --  instance, in which case there is no direct link from it to the
8569       --  original generic ancestor. In that case, we recognize that the
8570       --  ultimate ancestor is the same by examining names and scopes.
8571
8572       procedure Process_Nested_Formal (Formal : Entity_Id);
8573       --  If the current formal is declared with a box, its own formals are
8574       --  visible in the instance, as they were in the generic, and their
8575       --  Hidden flag must be reset. If some of these formals are themselves
8576       --  packages declared with a box, the processing must be recursive.
8577
8578       --------------------------
8579       -- Find_Matching_Actual --
8580       --------------------------
8581
8582       procedure Find_Matching_Actual
8583         (F   : Node_Id;
8584          Act : in out Entity_Id)
8585      is
8586          Formal_Ent : Entity_Id;
8587
8588       begin
8589          case Nkind (Original_Node (F)) is
8590             when N_Formal_Object_Declaration |
8591                  N_Formal_Type_Declaration   =>
8592                Formal_Ent := Defining_Identifier (F);
8593
8594                while Chars (Act) /= Chars (Formal_Ent) loop
8595                   Next_Entity (Act);
8596                end loop;
8597
8598             when N_Formal_Subprogram_Declaration |
8599                  N_Formal_Package_Declaration    |
8600                  N_Package_Declaration           |
8601                  N_Generic_Package_Declaration   =>
8602                Formal_Ent := Defining_Entity (F);
8603
8604                while Chars (Act) /= Chars (Formal_Ent) loop
8605                   Next_Entity (Act);
8606                end loop;
8607
8608             when others =>
8609                raise Program_Error;
8610          end case;
8611       end Find_Matching_Actual;
8612
8613       -------------------------
8614       -- Match_Formal_Entity --
8615       -------------------------
8616
8617       procedure Match_Formal_Entity
8618         (Formal_Node : Node_Id;
8619          Formal_Ent  : Entity_Id;
8620          Actual_Ent  : Entity_Id)
8621       is
8622          Act_Pkg   : Entity_Id;
8623
8624       begin
8625          Set_Instance_Of (Formal_Ent, Actual_Ent);
8626
8627          if Ekind (Actual_Ent) = E_Package then
8628
8629             --  Record associations for each parameter
8630
8631             Act_Pkg := Actual_Ent;
8632
8633             declare
8634                A_Ent  : Entity_Id := First_Entity (Act_Pkg);
8635                F_Ent  : Entity_Id;
8636                F_Node : Node_Id;
8637
8638                Gen_Decl : Node_Id;
8639                Formals  : List_Id;
8640                Actual   : Entity_Id;
8641
8642             begin
8643                --  Retrieve the actual given in the formal package declaration
8644
8645                Actual := Entity (Name (Original_Node (Formal_Node)));
8646
8647                --  The actual in the formal package declaration  may be a
8648                --  renamed generic package, in which case we want to retrieve
8649                --  the original generic in order to traverse its formal part.
8650
8651                if Present (Renamed_Entity (Actual)) then
8652                   Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8653                else
8654                   Gen_Decl := Unit_Declaration_Node (Actual);
8655                end if;
8656
8657                Formals := Generic_Formal_Declarations (Gen_Decl);
8658
8659                if Present (Formals) then
8660                   F_Node := First_Non_Pragma (Formals);
8661                else
8662                   F_Node := Empty;
8663                end if;
8664
8665                while Present (A_Ent)
8666                  and then Present (F_Node)
8667                  and then A_Ent /= First_Private_Entity (Act_Pkg)
8668                loop
8669                   F_Ent := Get_Formal_Entity (F_Node);
8670
8671                   if Present (F_Ent) then
8672
8673                      --  This is a formal of the original package. Record
8674                      --  association and recurse.
8675
8676                      Find_Matching_Actual (F_Node, A_Ent);
8677                      Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8678                      Next_Entity (A_Ent);
8679                   end if;
8680
8681                   Next_Non_Pragma (F_Node);
8682                end loop;
8683             end;
8684          end if;
8685       end Match_Formal_Entity;
8686
8687       -----------------------
8688       -- Get_Formal_Entity --
8689       -----------------------
8690
8691       function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8692          Kind : constant Node_Kind := Nkind (Original_Node (N));
8693       begin
8694          case Kind is
8695             when N_Formal_Object_Declaration     =>
8696                return Defining_Identifier (N);
8697
8698             when N_Formal_Type_Declaration       =>
8699                return Defining_Identifier (N);
8700
8701             when N_Formal_Subprogram_Declaration =>
8702                return Defining_Unit_Name (Specification (N));
8703
8704             when N_Formal_Package_Declaration    =>
8705                return Defining_Identifier (Original_Node (N));
8706
8707             when N_Generic_Package_Declaration   =>
8708                return Defining_Identifier (Original_Node (N));
8709
8710             --  All other declarations are introduced by semantic analysis and
8711             --  have no match in the actual.
8712
8713             when others =>
8714                return Empty;
8715          end case;
8716       end Get_Formal_Entity;
8717
8718       --------------------
8719       -- Is_Instance_Of --
8720       --------------------
8721
8722       function Is_Instance_Of
8723         (Act_Spec : Entity_Id;
8724          Gen_Anc  : Entity_Id) return Boolean
8725       is
8726          Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8727
8728       begin
8729          if No (Gen_Par) then
8730             return False;
8731
8732          --  Simplest case: the generic parent of the actual is the formal
8733
8734          elsif Gen_Par = Gen_Anc then
8735             return True;
8736
8737          elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8738             return False;
8739
8740          --  The actual may be obtained through several instantiations. Its
8741          --  scope must itself be an instance of a generic declared in the
8742          --  same scope as the formal. Any other case is detected above.
8743
8744          elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8745             return False;
8746
8747          else
8748             return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8749          end if;
8750       end Is_Instance_Of;
8751
8752       ---------------------------
8753       -- Process_Nested_Formal --
8754       ---------------------------
8755
8756       procedure Process_Nested_Formal (Formal : Entity_Id) is
8757          Ent : Entity_Id;
8758
8759       begin
8760          if Present (Associated_Formal_Package (Formal))
8761            and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8762          then
8763             Ent := First_Entity (Formal);
8764             while Present (Ent) loop
8765                Set_Is_Hidden (Ent, False);
8766                Set_Is_Visible_Formal (Ent);
8767                Set_Is_Potentially_Use_Visible
8768                  (Ent, Is_Potentially_Use_Visible (Formal));
8769
8770                if Ekind (Ent) = E_Package then
8771                   exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8772                   Process_Nested_Formal (Ent);
8773                end if;
8774
8775                Next_Entity (Ent);
8776             end loop;
8777          end if;
8778       end Process_Nested_Formal;
8779
8780    --  Start of processing for Instantiate_Formal_Package
8781
8782    begin
8783       Analyze (Actual);
8784
8785       if not Is_Entity_Name (Actual)
8786         or else  Ekind (Entity (Actual)) /= E_Package
8787       then
8788          Error_Msg_N
8789            ("expect package instance to instantiate formal", Actual);
8790          Abandon_Instantiation (Actual);
8791          raise Program_Error;
8792
8793       else
8794          Actual_Pack := Entity (Actual);
8795          Set_Is_Instantiated (Actual_Pack);
8796
8797          --  The actual may be a renamed package, or an outer generic formal
8798          --  package whose instantiation is converted into a renaming.
8799
8800          if Present (Renamed_Object (Actual_Pack)) then
8801             Actual_Pack := Renamed_Object (Actual_Pack);
8802          end if;
8803
8804          if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
8805             Gen_Parent  := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
8806             Formal_Pack := Defining_Identifier (Analyzed_Formal);
8807          else
8808             Gen_Parent :=
8809               Generic_Parent (Specification (Analyzed_Formal));
8810             Formal_Pack :=
8811               Defining_Unit_Name (Specification (Analyzed_Formal));
8812          end if;
8813
8814          if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
8815             Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
8816          else
8817             Parent_Spec := Parent (Actual_Pack);
8818          end if;
8819
8820          if Gen_Parent = Any_Id then
8821             Error_Msg_N
8822               ("previous error in declaration of formal package", Actual);
8823             Abandon_Instantiation (Actual);
8824
8825          elsif
8826            Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
8827          then
8828             null;
8829
8830          else
8831             Error_Msg_NE
8832               ("actual parameter must be instance of&", Actual, Gen_Parent);
8833             Abandon_Instantiation (Actual);
8834          end if;
8835
8836          Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
8837          Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
8838
8839          Nod :=
8840            Make_Package_Renaming_Declaration (Loc,
8841              Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
8842              Name               => New_Reference_To (Actual_Pack, Loc));
8843
8844          Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
8845            Defining_Identifier (Formal));
8846          Decls := New_List (Nod);
8847
8848          --  If the formal F has a box, then the generic declarations are
8849          --  visible in the generic G. In an instance of G, the corresponding
8850          --  entities in the actual for F (which are the actuals for the
8851          --  instantiation of the generic that F denotes) must also be made
8852          --  visible for analysis of the current instance. On exit from the
8853          --  current instance, those entities are made private again. If the
8854          --  actual is currently in use, these entities are also use-visible.
8855
8856          --  The loop through the actual entities also steps through the formal
8857          --  entities and enters associations from formals to actuals into the
8858          --  renaming map. This is necessary to properly handle checking of
8859          --  actual parameter associations for later formals that depend on
8860          --  actuals declared in the formal package.
8861
8862          --  In Ada 2005, partial parametrization requires that we make visible
8863          --  the actuals corresponding to formals that were defaulted in the
8864          --  formal package. There formals are identified because they remain
8865          --  formal generics within the formal package, rather than being
8866          --  renamings of the actuals supplied.
8867
8868          declare
8869             Gen_Decl : constant Node_Id :=
8870                          Unit_Declaration_Node (Gen_Parent);
8871             Formals  : constant List_Id :=
8872                          Generic_Formal_Declarations (Gen_Decl);
8873
8874             Actual_Ent       : Entity_Id;
8875             Actual_Of_Formal : Node_Id;
8876             Formal_Node      : Node_Id;
8877             Formal_Ent       : Entity_Id;
8878
8879          begin
8880             if Present (Formals) then
8881                Formal_Node := First_Non_Pragma (Formals);
8882             else
8883                Formal_Node := Empty;
8884             end if;
8885
8886             Actual_Ent := First_Entity (Actual_Pack);
8887             Actual_Of_Formal :=
8888                First (Visible_Declarations (Specification (Analyzed_Formal)));
8889             while Present (Actual_Ent)
8890               and then Actual_Ent /= First_Private_Entity (Actual_Pack)
8891             loop
8892                if Present (Formal_Node) then
8893                   Formal_Ent := Get_Formal_Entity (Formal_Node);
8894
8895                   if Present (Formal_Ent) then
8896                      Find_Matching_Actual (Formal_Node, Actual_Ent);
8897                      Match_Formal_Entity
8898                        (Formal_Node, Formal_Ent, Actual_Ent);
8899
8900                      --  We iterate at the same time over the actuals of the
8901                      --  local package created for the formal, to determine
8902                      --  which one of the formals of the original generic were
8903                      --  defaulted in the formal. The corresponding actual
8904                      --  entities are visible in the enclosing instance.
8905
8906                      if Box_Present (Formal)
8907                        or else
8908                          (Present (Actual_Of_Formal)
8909                            and then
8910                              Is_Generic_Formal
8911                                (Get_Formal_Entity (Actual_Of_Formal)))
8912                      then
8913                         Set_Is_Hidden (Actual_Ent, False);
8914                         Set_Is_Visible_Formal (Actual_Ent);
8915                         Set_Is_Potentially_Use_Visible
8916                           (Actual_Ent, In_Use (Actual_Pack));
8917
8918                         if Ekind (Actual_Ent) = E_Package then
8919                            Process_Nested_Formal (Actual_Ent);
8920                         end if;
8921
8922                      else
8923                         Set_Is_Hidden (Actual_Ent);
8924                         Set_Is_Potentially_Use_Visible (Actual_Ent, False);
8925                      end if;
8926                   end if;
8927
8928                   Next_Non_Pragma (Formal_Node);
8929                   Next (Actual_Of_Formal);
8930
8931                else
8932                   --  No further formals to match, but the generic part may
8933                   --  contain inherited operation that are not hidden in the
8934                   --  enclosing instance.
8935
8936                   Next_Entity (Actual_Ent);
8937                end if;
8938             end loop;
8939
8940             --  Inherited subprograms generated by formal derived types are
8941             --  also visible if the types are.
8942
8943             Actual_Ent := First_Entity (Actual_Pack);
8944             while Present (Actual_Ent)
8945               and then Actual_Ent /= First_Private_Entity (Actual_Pack)
8946             loop
8947                if Is_Overloadable (Actual_Ent)
8948                  and then
8949                    Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
8950                  and then
8951                    not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
8952                then
8953                   Set_Is_Hidden (Actual_Ent, False);
8954                   Set_Is_Potentially_Use_Visible
8955                     (Actual_Ent, In_Use (Actual_Pack));
8956                end if;
8957
8958                Next_Entity (Actual_Ent);
8959             end loop;
8960          end;
8961
8962          --  If the formal is not declared with a box, reanalyze it as an
8963          --  abbreviated instantiation, to verify the matching rules of 12.7.
8964          --  The actual checks are performed after the generic associations
8965          --  have been analyzed, to guarantee the same visibility for this
8966          --  instantiation and for the actuals.
8967
8968          --  In Ada 2005, the generic associations for the formal can include
8969          --  defaulted parameters. These are ignored during check. This
8970          --  internal instantiation is removed from the tree after conformance
8971          --  checking, because it contains formal declarations for those
8972          --  defaulted parameters, and those should not reach the back-end.
8973
8974          if not Box_Present (Formal) then
8975             declare
8976                I_Pack : constant Entity_Id :=
8977                           Make_Temporary (Sloc (Actual), 'P');
8978
8979             begin
8980                Set_Is_Internal (I_Pack);
8981
8982                Append_To (Decls,
8983                  Make_Package_Instantiation (Sloc (Actual),
8984                    Defining_Unit_Name => I_Pack,
8985                    Name =>
8986                      New_Occurrence_Of
8987                        (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
8988                    Generic_Associations =>
8989                      Generic_Associations (Formal)));
8990             end;
8991          end if;
8992
8993          return Decls;
8994       end if;
8995    end Instantiate_Formal_Package;
8996
8997    -----------------------------------
8998    -- Instantiate_Formal_Subprogram --
8999    -----------------------------------
9000
9001    function Instantiate_Formal_Subprogram
9002      (Formal          : Node_Id;
9003       Actual          : Node_Id;
9004       Analyzed_Formal : Node_Id) return Node_Id
9005    is
9006       Loc        : Source_Ptr;
9007       Formal_Sub : constant Entity_Id :=
9008                      Defining_Unit_Name (Specification (Formal));
9009       Analyzed_S : constant Entity_Id :=
9010                      Defining_Unit_Name (Specification (Analyzed_Formal));
9011       Decl_Node  : Node_Id;
9012       Nam        : Node_Id;
9013       New_Spec   : Node_Id;
9014
9015       function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9016       --  If the generic is a child unit, the parent has been installed on the
9017       --  scope stack, but a default subprogram cannot resolve to something on
9018       --  the parent because that parent is not really part of the visible
9019       --  context (it is there to resolve explicit local entities). If the
9020       --  default has resolved in this way, we remove the entity from
9021       --  immediate visibility and analyze the node again to emit an error
9022       --  message or find another visible candidate.
9023
9024       procedure Valid_Actual_Subprogram (Act : Node_Id);
9025       --  Perform legality check and raise exception on failure
9026
9027       -----------------------
9028       -- From_Parent_Scope --
9029       -----------------------
9030
9031       function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9032          Gen_Scope : Node_Id;
9033
9034       begin
9035          Gen_Scope := Scope (Analyzed_S);
9036          while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9037             if Scope (Subp) = Scope (Gen_Scope) then
9038                return True;
9039             end if;
9040
9041             Gen_Scope := Scope (Gen_Scope);
9042          end loop;
9043
9044          return False;
9045       end From_Parent_Scope;
9046
9047       -----------------------------
9048       -- Valid_Actual_Subprogram --
9049       -----------------------------
9050
9051       procedure Valid_Actual_Subprogram (Act : Node_Id) is
9052          Act_E : Entity_Id;
9053
9054       begin
9055          if Is_Entity_Name (Act) then
9056             Act_E := Entity (Act);
9057
9058          elsif Nkind (Act) = N_Selected_Component
9059            and then Is_Entity_Name (Selector_Name (Act))
9060          then
9061             Act_E := Entity (Selector_Name (Act));
9062
9063          else
9064             Act_E := Empty;
9065          end if;
9066
9067          if (Present (Act_E) and then Is_Overloadable (Act_E))
9068            or else Nkind_In (Act, N_Attribute_Reference,
9069                                   N_Indexed_Component,
9070                                   N_Character_Literal,
9071                                   N_Explicit_Dereference)
9072          then
9073             return;
9074          end if;
9075
9076          Error_Msg_NE
9077            ("expect subprogram or entry name in instantiation of&",
9078             Instantiation_Node, Formal_Sub);
9079          Abandon_Instantiation (Instantiation_Node);
9080
9081       end Valid_Actual_Subprogram;
9082
9083    --  Start of processing for Instantiate_Formal_Subprogram
9084
9085    begin
9086       New_Spec := New_Copy_Tree (Specification (Formal));
9087
9088       --  The tree copy has created the proper instantiation sloc for the
9089       --  new specification. Use this location for all other constructed
9090       --  declarations.
9091
9092       Loc := Sloc (Defining_Unit_Name (New_Spec));
9093
9094       --  Create new entity for the actual (New_Copy_Tree does not)
9095
9096       Set_Defining_Unit_Name
9097         (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9098
9099       --  Create new entities for the each of the formals in the
9100       --  specification of the renaming declaration built for the actual.
9101
9102       if Present (Parameter_Specifications (New_Spec)) then
9103          declare
9104             F : Node_Id;
9105          begin
9106             F := First (Parameter_Specifications (New_Spec));
9107             while Present (F) loop
9108                Set_Defining_Identifier (F,
9109                   Make_Defining_Identifier (Sloc (F),
9110                     Chars => Chars (Defining_Identifier (F))));
9111                Next (F);
9112             end loop;
9113          end;
9114       end if;
9115
9116       --  Find entity of actual. If the actual is an attribute reference, it
9117       --  cannot be resolved here (its formal is missing) but is handled
9118       --  instead in Attribute_Renaming. If the actual is overloaded, it is
9119       --  fully resolved subsequently, when the renaming declaration for the
9120       --  formal is analyzed. If it is an explicit dereference, resolve the
9121       --  prefix but not the actual itself, to prevent interpretation as call.
9122
9123       if Present (Actual) then
9124          Loc := Sloc (Actual);
9125          Set_Sloc (New_Spec, Loc);
9126
9127          if Nkind (Actual) = N_Operator_Symbol then
9128             Find_Direct_Name (Actual);
9129
9130          elsif Nkind (Actual) = N_Explicit_Dereference then
9131             Analyze (Prefix (Actual));
9132
9133          elsif Nkind (Actual) /= N_Attribute_Reference then
9134             Analyze (Actual);
9135          end if;
9136
9137          Valid_Actual_Subprogram (Actual);
9138          Nam := Actual;
9139
9140       elsif Present (Default_Name (Formal)) then
9141          if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9142                                                  N_Selected_Component,
9143                                                  N_Indexed_Component,
9144                                                  N_Character_Literal)
9145            and then Present (Entity (Default_Name (Formal)))
9146          then
9147             Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9148          else
9149             Nam := New_Copy (Default_Name (Formal));
9150             Set_Sloc (Nam, Loc);
9151          end if;
9152
9153       elsif Box_Present (Formal) then
9154
9155          --  Actual is resolved at the point of instantiation. Create an
9156          --  identifier or operator with the same name as the formal.
9157
9158          if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9159             Nam := Make_Operator_Symbol (Loc,
9160               Chars =>  Chars (Formal_Sub),
9161               Strval => No_String);
9162          else
9163             Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9164          end if;
9165
9166       elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9167         and then Null_Present (Specification (Formal))
9168       then
9169          --  Generate null body for procedure, for use in the instance
9170
9171          Decl_Node :=
9172            Make_Subprogram_Body (Loc,
9173              Specification              => New_Spec,
9174              Declarations               => New_List,
9175              Handled_Statement_Sequence =>
9176                Make_Handled_Sequence_Of_Statements (Loc,
9177                  Statements => New_List (Make_Null_Statement (Loc))));
9178
9179          Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9180          return Decl_Node;
9181
9182       else
9183          Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9184          Error_Msg_NE
9185            ("missing actual&", Instantiation_Node, Formal_Sub);
9186          Error_Msg_NE
9187            ("\in instantiation of & declared#",
9188               Instantiation_Node, Scope (Analyzed_S));
9189          Abandon_Instantiation (Instantiation_Node);
9190       end if;
9191
9192       Decl_Node :=
9193         Make_Subprogram_Renaming_Declaration (Loc,
9194           Specification => New_Spec,
9195           Name          => Nam);
9196
9197       --  If we do not have an actual and the formal specified <> then set to
9198       --  get proper default.
9199
9200       if No (Actual) and then Box_Present (Formal) then
9201          Set_From_Default (Decl_Node);
9202       end if;
9203
9204       --  Gather possible interpretations for the actual before analyzing the
9205       --  instance. If overloaded, it will be resolved when analyzing the
9206       --  renaming declaration.
9207
9208       if Box_Present (Formal)
9209         and then No (Actual)
9210       then
9211          Analyze (Nam);
9212
9213          if Is_Child_Unit (Scope (Analyzed_S))
9214            and then Present (Entity (Nam))
9215          then
9216             if not Is_Overloaded (Nam) then
9217                if From_Parent_Scope (Entity (Nam)) then
9218                   Set_Is_Immediately_Visible (Entity (Nam), False);
9219                   Set_Entity (Nam, Empty);
9220                   Set_Etype (Nam, Empty);
9221
9222                   Analyze (Nam);
9223                   Set_Is_Immediately_Visible (Entity (Nam));
9224                end if;
9225
9226             else
9227                declare
9228                   I  : Interp_Index;
9229                   It : Interp;
9230
9231                begin
9232                   Get_First_Interp (Nam, I, It);
9233                   while Present (It.Nam) loop
9234                      if From_Parent_Scope (It.Nam) then
9235                         Remove_Interp (I);
9236                      end if;
9237
9238                      Get_Next_Interp (I, It);
9239                   end loop;
9240                end;
9241             end if;
9242          end if;
9243       end if;
9244
9245       --  The generic instantiation freezes the actual. This can only be done
9246       --  once the actual is resolved, in the analysis of the renaming
9247       --  declaration. To make the formal subprogram entity available, we set
9248       --  Corresponding_Formal_Spec to point to the formal subprogram entity.
9249       --  This is also needed in Analyze_Subprogram_Renaming for the processing
9250       --  of formal abstract subprograms.
9251
9252       Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9253
9254       --  We cannot analyze the renaming declaration, and thus find the actual,
9255       --  until all the actuals are assembled in the instance. For subsequent
9256       --  checks of other actuals, indicate the node that will hold the
9257       --  instance of this formal.
9258
9259       Set_Instance_Of (Analyzed_S, Nam);
9260
9261       if Nkind (Actual) = N_Selected_Component
9262         and then Is_Task_Type (Etype (Prefix (Actual)))
9263         and then not Is_Frozen (Etype (Prefix (Actual)))
9264       then
9265          --  The renaming declaration will create a body, which must appear
9266          --  outside of the instantiation, We move the renaming declaration
9267          --  out of the instance, and create an additional renaming inside,
9268          --  to prevent freezing anomalies.
9269
9270          declare
9271             Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9272
9273          begin
9274             Set_Defining_Unit_Name (New_Spec, Anon_Id);
9275             Insert_Before (Instantiation_Node, Decl_Node);
9276             Analyze (Decl_Node);
9277
9278             --  Now create renaming within the instance
9279
9280             Decl_Node :=
9281               Make_Subprogram_Renaming_Declaration (Loc,
9282                 Specification => New_Copy_Tree (New_Spec),
9283                 Name => New_Occurrence_Of (Anon_Id, Loc));
9284
9285             Set_Defining_Unit_Name (Specification (Decl_Node),
9286               Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9287          end;
9288       end if;
9289
9290       return Decl_Node;
9291    end Instantiate_Formal_Subprogram;
9292
9293    ------------------------
9294    -- Instantiate_Object --
9295    ------------------------
9296
9297    function Instantiate_Object
9298      (Formal          : Node_Id;
9299       Actual          : Node_Id;
9300       Analyzed_Formal : Node_Id) return List_Id
9301    is
9302       Gen_Obj     : constant Entity_Id  := Defining_Identifier (Formal);
9303       A_Gen_Obj   : constant Entity_Id  :=
9304                       Defining_Identifier (Analyzed_Formal);
9305       Acc_Def     : Node_Id             := Empty;
9306       Act_Assoc   : constant Node_Id    := Parent (Actual);
9307       Actual_Decl : Node_Id             := Empty;
9308       Decl_Node   : Node_Id;
9309       Def         : Node_Id;
9310       Ftyp        : Entity_Id;
9311       List        : constant List_Id    := New_List;
9312       Loc         : constant Source_Ptr := Sloc (Actual);
9313       Orig_Ftyp   : constant Entity_Id  := Etype (A_Gen_Obj);
9314       Subt_Decl   : Node_Id             := Empty;
9315       Subt_Mark   : Node_Id             := Empty;
9316
9317    begin
9318       if Present (Subtype_Mark (Formal)) then
9319          Subt_Mark := Subtype_Mark (Formal);
9320       else
9321          Check_Access_Definition (Formal);
9322          Acc_Def := Access_Definition (Formal);
9323       end if;
9324
9325       --  Sloc for error message on missing actual
9326
9327       Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9328
9329       if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9330          Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9331       end if;
9332
9333       Set_Parent (List, Parent (Actual));
9334
9335       --  OUT present
9336
9337       if Out_Present (Formal) then
9338
9339          --  An IN OUT generic actual must be a name. The instantiation is a
9340          --  renaming declaration. The actual is the name being renamed. We
9341          --  use the actual directly, rather than a copy, because it is not
9342          --  used further in the list of actuals, and because a copy or a use
9343          --  of relocate_node is incorrect if the instance is nested within a
9344          --  generic. In order to simplify ASIS searches, the Generic_Parent
9345          --  field links the declaration to the generic association.
9346
9347          if No (Actual) then
9348             Error_Msg_NE
9349               ("missing actual&",
9350                Instantiation_Node, Gen_Obj);
9351             Error_Msg_NE
9352               ("\in instantiation of & declared#",
9353                  Instantiation_Node, Scope (A_Gen_Obj));
9354             Abandon_Instantiation (Instantiation_Node);
9355          end if;
9356
9357          if Present (Subt_Mark) then
9358             Decl_Node :=
9359               Make_Object_Renaming_Declaration (Loc,
9360                 Defining_Identifier => New_Copy (Gen_Obj),
9361                 Subtype_Mark        => New_Copy_Tree (Subt_Mark),
9362                 Name                => Actual);
9363
9364          else pragma Assert (Present (Acc_Def));
9365             Decl_Node :=
9366               Make_Object_Renaming_Declaration (Loc,
9367                 Defining_Identifier => New_Copy (Gen_Obj),
9368                 Access_Definition   => New_Copy_Tree (Acc_Def),
9369                 Name                => Actual);
9370          end if;
9371
9372          Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9373
9374          --  The analysis of the actual may produce insert_action nodes, so
9375          --  the declaration must have a context in which to attach them.
9376
9377          Append (Decl_Node, List);
9378          Analyze (Actual);
9379
9380          --  Return if the analysis of the actual reported some error
9381
9382          if Etype (Actual) = Any_Type then
9383             return List;
9384          end if;
9385
9386          --  This check is performed here because Analyze_Object_Renaming will
9387          --  not check it when Comes_From_Source is False. Note though that the
9388          --  check for the actual being the name of an object will be performed
9389          --  in Analyze_Object_Renaming.
9390
9391          if Is_Object_Reference (Actual)
9392            and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9393          then
9394             Error_Msg_N
9395               ("illegal discriminant-dependent component for in out parameter",
9396                Actual);
9397          end if;
9398
9399          --  The actual has to be resolved in order to check that it is a
9400          --  variable (due to cases such as F (1), where F returns access to an
9401          --  array, and for overloaded prefixes).
9402
9403          Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9404
9405          --  If the type of the formal is not itself a formal, and the
9406          --  current unit is a child unit, the formal type must be declared
9407          --  in a parent, and must be retrieved by visibility.
9408
9409          if Ftyp = Orig_Ftyp
9410            and then Is_Generic_Unit (Scope (Ftyp))
9411            and then Is_Child_Unit (Scope (A_Gen_Obj))
9412          then
9413             declare
9414                Temp : constant Node_Id :=
9415                         New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9416             begin
9417                Set_Entity (Temp, Empty);
9418                Find_Type (Temp);
9419                Ftyp := Entity (Temp);
9420             end;
9421          end if;
9422
9423          if Is_Private_Type (Ftyp)
9424            and then not Is_Private_Type (Etype (Actual))
9425            and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9426                       or else Base_Type (Etype (Actual)) = Ftyp)
9427          then
9428             --  If the actual has the type of the full view of the formal, or
9429             --  else a non-private subtype of the formal, then the visibility
9430             --  of the formal type has changed. Add to the actuals a subtype
9431             --  declaration that will force the exchange of views in the body
9432             --  of the instance as well.
9433
9434             Subt_Decl :=
9435               Make_Subtype_Declaration (Loc,
9436                  Defining_Identifier => Make_Temporary (Loc, 'P'),
9437                  Subtype_Indication  => New_Occurrence_Of (Ftyp, Loc));
9438
9439             Prepend (Subt_Decl, List);
9440
9441             Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9442             Exchange_Declarations (Ftyp);
9443          end if;
9444
9445          Resolve (Actual, Ftyp);
9446
9447          if not Denotes_Variable (Actual) then
9448             Error_Msg_NE
9449               ("actual for& must be a variable", Actual, Gen_Obj);
9450
9451          elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9452
9453             --  Ada 2005 (AI-423): For a generic formal object of mode in out,
9454             --  the type of the actual shall resolve to a specific anonymous
9455             --  access type.
9456
9457             if Ada_Version < Ada_2005
9458               or else
9459                 Ekind (Base_Type (Ftyp)) /=
9460                   E_Anonymous_Access_Type
9461               or else
9462                 Ekind (Base_Type (Etype (Actual))) /=
9463                   E_Anonymous_Access_Type
9464             then
9465                Error_Msg_NE ("type of actual does not match type of&",
9466                              Actual, Gen_Obj);
9467             end if;
9468          end if;
9469
9470          Note_Possible_Modification (Actual, Sure => True);
9471
9472          --  Check for instantiation of atomic/volatile actual for
9473          --  non-atomic/volatile formal (RM C.6 (12)).
9474
9475          if Is_Atomic_Object (Actual)
9476            and then not Is_Atomic (Orig_Ftyp)
9477          then
9478             Error_Msg_N
9479               ("cannot instantiate non-atomic formal object " &
9480                "with atomic actual", Actual);
9481
9482          elsif Is_Volatile_Object (Actual)
9483            and then not Is_Volatile (Orig_Ftyp)
9484          then
9485             Error_Msg_N
9486               ("cannot instantiate non-volatile formal object " &
9487                "with volatile actual", Actual);
9488          end if;
9489
9490       --  Formal in-parameter
9491
9492       else
9493          --  The instantiation of a generic formal in-parameter is constant
9494          --  declaration. The actual is the expression for that declaration.
9495
9496          if Present (Actual) then
9497             if Present (Subt_Mark) then
9498                Def := Subt_Mark;
9499             else pragma Assert (Present (Acc_Def));
9500                Def := Acc_Def;
9501             end if;
9502
9503             Decl_Node :=
9504               Make_Object_Declaration (Loc,
9505                 Defining_Identifier    => New_Copy (Gen_Obj),
9506                 Constant_Present       => True,
9507                 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9508                 Object_Definition      => New_Copy_Tree (Def),
9509                 Expression             => Actual);
9510
9511             Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9512
9513             --  A generic formal object of a tagged type is defined to be
9514             --  aliased so the new constant must also be treated as aliased.
9515
9516             if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9517                Set_Aliased_Present (Decl_Node);
9518             end if;
9519
9520             Append (Decl_Node, List);
9521
9522             --  No need to repeat (pre-)analysis of some expression nodes
9523             --  already handled in Preanalyze_Actuals.
9524
9525             if Nkind (Actual) /= N_Allocator then
9526                Analyze (Actual);
9527
9528                --  Return if the analysis of the actual reported some error
9529
9530                if Etype (Actual) = Any_Type then
9531                   return List;
9532                end if;
9533             end if;
9534
9535             declare
9536                Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9537                Typ         : Entity_Id;
9538
9539             begin
9540                Typ := Get_Instance_Of (Formal_Type);
9541
9542                Freeze_Before (Instantiation_Node, Typ);
9543
9544                --  If the actual is an aggregate, perform name resolution on
9545                --  its components (the analysis of an aggregate does not do it)
9546                --  to capture local names that may be hidden if the generic is
9547                --  a child unit.
9548
9549                if Nkind (Actual) = N_Aggregate then
9550                   Preanalyze_And_Resolve (Actual, Typ);
9551                end if;
9552
9553                if Is_Limited_Type (Typ)
9554                  and then not OK_For_Limited_Init (Typ, Actual)
9555                then
9556                   Error_Msg_N
9557                     ("initialization not allowed for limited types", Actual);
9558                   Explain_Limited_Type (Typ, Actual);
9559                end if;
9560             end;
9561
9562          elsif Present (Default_Expression (Formal)) then
9563
9564             --  Use default to construct declaration
9565
9566             if Present (Subt_Mark) then
9567                Def := Subt_Mark;
9568             else pragma Assert (Present (Acc_Def));
9569                Def := Acc_Def;
9570             end if;
9571
9572             Decl_Node :=
9573               Make_Object_Declaration (Sloc (Formal),
9574                 Defining_Identifier    => New_Copy (Gen_Obj),
9575                 Constant_Present       => True,
9576                 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9577                 Object_Definition      => New_Copy (Def),
9578                 Expression             => New_Copy_Tree
9579                                             (Default_Expression (Formal)));
9580
9581             Append (Decl_Node, List);
9582             Set_Analyzed (Expression (Decl_Node), False);
9583
9584          else
9585             Error_Msg_NE
9586               ("missing actual&",
9587                 Instantiation_Node, Gen_Obj);
9588             Error_Msg_NE ("\in instantiation of & declared#",
9589               Instantiation_Node, Scope (A_Gen_Obj));
9590
9591             if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9592
9593                --  Create dummy constant declaration so that instance can be
9594                --  analyzed, to minimize cascaded visibility errors.
9595
9596                if Present (Subt_Mark) then
9597                   Def := Subt_Mark;
9598                else pragma Assert (Present (Acc_Def));
9599                   Def := Acc_Def;
9600                end if;
9601
9602                Decl_Node :=
9603                  Make_Object_Declaration (Loc,
9604                    Defining_Identifier    => New_Copy (Gen_Obj),
9605                    Constant_Present       => True,
9606                    Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9607                    Object_Definition      => New_Copy (Def),
9608                    Expression             =>
9609                      Make_Attribute_Reference (Sloc (Gen_Obj),
9610                        Attribute_Name => Name_First,
9611                        Prefix         => New_Copy (Def)));
9612
9613                Append (Decl_Node, List);
9614
9615             else
9616                Abandon_Instantiation (Instantiation_Node);
9617             end if;
9618          end if;
9619       end if;
9620
9621       if Nkind (Actual) in N_Has_Entity then
9622          Actual_Decl := Parent (Entity (Actual));
9623       end if;
9624
9625       --  Ada 2005 (AI-423): For a formal object declaration with a null
9626       --  exclusion or an access definition that has a null exclusion: If the
9627       --  actual matching the formal object declaration denotes a generic
9628       --  formal object of another generic unit G, and the instantiation
9629       --  containing the actual occurs within the body of G or within the body
9630       --  of a generic unit declared within the declarative region of G, then
9631       --  the declaration of the formal object of G must have a null exclusion.
9632       --  Otherwise, the subtype of the actual matching the formal object
9633       --  declaration shall exclude null.
9634
9635       if Ada_Version >= Ada_2005
9636         and then Present (Actual_Decl)
9637         and then
9638           Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9639                                  N_Object_Declaration)
9640         and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9641         and then not Has_Null_Exclusion (Actual_Decl)
9642         and then Has_Null_Exclusion (Analyzed_Formal)
9643       then
9644          Error_Msg_Sloc := Sloc (Analyzed_Formal);
9645          Error_Msg_N
9646            ("actual must exclude null to match generic formal#", Actual);
9647       end if;
9648
9649       return List;
9650    end Instantiate_Object;
9651
9652    ------------------------------
9653    -- Instantiate_Package_Body --
9654    ------------------------------
9655
9656    procedure Instantiate_Package_Body
9657      (Body_Info     : Pending_Body_Info;
9658       Inlined_Body  : Boolean := False;
9659       Body_Optional : Boolean := False)
9660    is
9661       Act_Decl    : constant Node_Id    := Body_Info.Act_Decl;
9662       Inst_Node   : constant Node_Id    := Body_Info.Inst_Node;
9663       Loc         : constant Source_Ptr := Sloc (Inst_Node);
9664
9665       Gen_Id      : constant Node_Id    := Name (Inst_Node);
9666       Gen_Unit    : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
9667       Gen_Decl    : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
9668       Act_Spec    : constant Node_Id    := Specification (Act_Decl);
9669       Act_Decl_Id : constant Entity_Id  := Defining_Entity (Act_Spec);
9670
9671       Act_Body_Name : Node_Id;
9672       Gen_Body      : Node_Id;
9673       Gen_Body_Id   : Node_Id;
9674       Act_Body      : Node_Id;
9675       Act_Body_Id   : Entity_Id;
9676
9677       Parent_Installed : Boolean := False;
9678       Save_Style_Check : constant Boolean := Style_Check;
9679
9680       Par_Ent : Entity_Id := Empty;
9681       Par_Vis : Boolean   := False;
9682
9683       Vis_Prims_List : Elist_Id := No_Elist;
9684       --  List of primitives made temporarily visible in the instantiation
9685       --  to match the visibility of the formal type
9686
9687    begin
9688       Gen_Body_Id := Corresponding_Body (Gen_Decl);
9689
9690       --  The instance body may already have been processed, as the parent of
9691       --  another instance that is inlined (Load_Parent_Of_Generic).
9692
9693       if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9694          return;
9695       end if;
9696
9697       Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9698
9699       --  Re-establish the state of information on which checks are suppressed.
9700       --  This information was set in Body_Info at the point of instantiation,
9701       --  and now we restore it so that the instance is compiled using the
9702       --  check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9703
9704       Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9705       Scope_Suppress           := Body_Info.Scope_Suppress;
9706       Opt.Ada_Version          := Body_Info.Version;
9707
9708       if No (Gen_Body_Id) then
9709          Load_Parent_Of_Generic
9710            (Inst_Node, Specification (Gen_Decl), Body_Optional);
9711          Gen_Body_Id := Corresponding_Body (Gen_Decl);
9712       end if;
9713
9714       --  Establish global variable for sloc adjustment and for error recovery
9715
9716       Instantiation_Node := Inst_Node;
9717
9718       if Present (Gen_Body_Id) then
9719          Save_Env (Gen_Unit, Act_Decl_Id);
9720          Style_Check := False;
9721          Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9722
9723          Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9724
9725          Create_Instantiation_Source
9726            (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9727
9728          Act_Body :=
9729            Copy_Generic_Node
9730              (Original_Node (Gen_Body), Empty, Instantiating => True);
9731
9732          --  Build new name (possibly qualified) for body declaration
9733
9734          Act_Body_Id := New_Copy (Act_Decl_Id);
9735
9736          --  Some attributes of spec entity are not inherited by body entity
9737
9738          Set_Handler_Records (Act_Body_Id, No_List);
9739
9740          if Nkind (Defining_Unit_Name (Act_Spec)) =
9741                                            N_Defining_Program_Unit_Name
9742          then
9743             Act_Body_Name :=
9744               Make_Defining_Program_Unit_Name (Loc,
9745                 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9746                 Defining_Identifier => Act_Body_Id);
9747          else
9748             Act_Body_Name :=  Act_Body_Id;
9749          end if;
9750
9751          Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9752
9753          Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9754          Check_Generic_Actuals (Act_Decl_Id, False);
9755
9756          --  Install primitives hidden at the point of the instantiation but
9757          --  visible when processing the generic formals
9758
9759          declare
9760             E : Entity_Id;
9761
9762          begin
9763             E := First_Entity (Act_Decl_Id);
9764             while Present (E) loop
9765                if Is_Type (E)
9766                  and then Is_Generic_Actual_Type (E)
9767                  and then Is_Tagged_Type (E)
9768                then
9769                   Install_Hidden_Primitives
9770                     (Prims_List => Vis_Prims_List,
9771                      Gen_T      => Generic_Parent_Type (Parent (E)),
9772                      Act_T      => E);
9773                end if;
9774
9775                Next_Entity (E);
9776             end loop;
9777          end;
9778
9779          --  If it is a child unit, make the parent instance (which is an
9780          --  instance of the parent of the generic) visible. The parent
9781          --  instance is the prefix of the name of the generic unit.
9782
9783          if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9784            and then Nkind (Gen_Id) = N_Expanded_Name
9785          then
9786             Par_Ent := Entity (Prefix (Gen_Id));
9787             Par_Vis := Is_Immediately_Visible (Par_Ent);
9788             Install_Parent (Par_Ent, In_Body => True);
9789             Parent_Installed := True;
9790
9791          elsif Is_Child_Unit (Gen_Unit) then
9792             Par_Ent := Scope (Gen_Unit);
9793             Par_Vis := Is_Immediately_Visible (Par_Ent);
9794             Install_Parent (Par_Ent, In_Body => True);
9795             Parent_Installed := True;
9796          end if;
9797
9798          --  If the instantiation is a library unit, and this is the main unit,
9799          --  then build the resulting compilation unit nodes for the instance.
9800          --  If this is a compilation unit but it is not the main unit, then it
9801          --  is the body of a unit in the context, that is being compiled
9802          --  because it is encloses some inlined unit or another generic unit
9803          --  being instantiated. In that case, this body is not part of the
9804          --  current compilation, and is not attached to the tree, but its
9805          --  parent must be set for analysis.
9806
9807          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9808
9809             --  Replace instance node with body of instance, and create new
9810             --  node for corresponding instance declaration.
9811
9812             Build_Instance_Compilation_Unit_Nodes
9813               (Inst_Node, Act_Body, Act_Decl);
9814             Analyze (Inst_Node);
9815
9816             if Parent (Inst_Node) = Cunit (Main_Unit) then
9817
9818                --  If the instance is a child unit itself, then set the scope
9819                --  of the expanded body to be the parent of the instantiation
9820                --  (ensuring that the fully qualified name will be generated
9821                --  for the elaboration subprogram).
9822
9823                if Nkind (Defining_Unit_Name (Act_Spec)) =
9824                                               N_Defining_Program_Unit_Name
9825                then
9826                   Set_Scope
9827                     (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
9828                end if;
9829             end if;
9830
9831          --  Case where instantiation is not a library unit
9832
9833          else
9834             --  If this is an early instantiation, i.e. appears textually
9835             --  before the corresponding body and must be elaborated first,
9836             --  indicate that the body instance is to be delayed.
9837
9838             Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
9839
9840             --  Now analyze the body. We turn off all checks if this is an
9841             --  internal unit, since there is no reason to have checks on for
9842             --  any predefined run-time library code. All such code is designed
9843             --  to be compiled with checks off.
9844
9845             --  Note that we do NOT apply this criterion to children of GNAT
9846             --  (or on VMS, children of DEC). The latter units must suppress
9847             --  checks explicitly if this is needed.
9848
9849             if Is_Predefined_File_Name
9850                  (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
9851             then
9852                Analyze (Act_Body, Suppress => All_Checks);
9853             else
9854                Analyze (Act_Body);
9855             end if;
9856          end if;
9857
9858          Inherit_Context (Gen_Body, Inst_Node);
9859
9860          --  Remove the parent instances if they have been placed on the scope
9861          --  stack to compile the body.
9862
9863          if Parent_Installed then
9864             Remove_Parent (In_Body => True);
9865
9866             --  Restore the previous visibility of the parent
9867
9868             Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
9869          end if;
9870
9871          Restore_Hidden_Primitives (Vis_Prims_List);
9872          Restore_Private_Views (Act_Decl_Id);
9873
9874          --  Remove the current unit from visibility if this is an instance
9875          --  that is not elaborated on the fly for inlining purposes.
9876
9877          if not Inlined_Body then
9878             Set_Is_Immediately_Visible (Act_Decl_Id, False);
9879          end if;
9880
9881          Restore_Env;
9882          Style_Check := Save_Style_Check;
9883
9884       --  If we have no body, and the unit requires a body, then complain. This
9885       --  complaint is suppressed if we have detected other errors (since a
9886       --  common reason for missing the body is that it had errors).
9887       --  In CodePeer mode, a warning has been emitted already, no need for
9888       --  further messages.
9889
9890       elsif Unit_Requires_Body (Gen_Unit)
9891         and then not Body_Optional
9892       then
9893          if CodePeer_Mode then
9894             null;
9895
9896          elsif Serious_Errors_Detected = 0 then
9897             Error_Msg_NE
9898               ("cannot find body of generic package &", Inst_Node, Gen_Unit);
9899
9900          --  Don't attempt to perform any cleanup actions if some other error
9901          --  was already detected, since this can cause blowups.
9902
9903          else
9904             return;
9905          end if;
9906
9907       --  Case of package that does not need a body
9908
9909       else
9910          --  If the instantiation of the declaration is a library unit, rewrite
9911          --  the original package instantiation as a package declaration in the
9912          --  compilation unit node.
9913
9914          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9915             Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
9916             Rewrite (Inst_Node, Act_Decl);
9917
9918             --  Generate elaboration entity, in case spec has elaboration code.
9919             --  This cannot be done when the instance is analyzed, because it
9920             --  is not known yet whether the body exists.
9921
9922             Set_Elaboration_Entity_Required (Act_Decl_Id, False);
9923             Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
9924
9925          --  If the instantiation is not a library unit, then append the
9926          --  declaration to the list of implicitly generated entities, unless
9927          --  it is already a list member which means that it was already
9928          --  processed
9929
9930          elsif not Is_List_Member (Act_Decl) then
9931             Mark_Rewrite_Insertion (Act_Decl);
9932             Insert_Before (Inst_Node, Act_Decl);
9933          end if;
9934       end if;
9935
9936       Expander_Mode_Restore;
9937    end Instantiate_Package_Body;
9938
9939    ---------------------------------
9940    -- Instantiate_Subprogram_Body --
9941    ---------------------------------
9942
9943    procedure Instantiate_Subprogram_Body
9944      (Body_Info     : Pending_Body_Info;
9945       Body_Optional : Boolean := False)
9946    is
9947       Act_Decl      : constant Node_Id    := Body_Info.Act_Decl;
9948       Inst_Node     : constant Node_Id    := Body_Info.Inst_Node;
9949       Loc           : constant Source_Ptr := Sloc (Inst_Node);
9950       Gen_Id        : constant Node_Id    := Name (Inst_Node);
9951       Gen_Unit      : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
9952       Gen_Decl      : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
9953       Anon_Id       : constant Entity_Id  :=
9954                         Defining_Unit_Name (Specification (Act_Decl));
9955       Pack_Id       : constant Entity_Id  :=
9956                         Defining_Unit_Name (Parent (Act_Decl));
9957       Decls         : List_Id;
9958       Gen_Body      : Node_Id;
9959       Gen_Body_Id   : Node_Id;
9960       Act_Body      : Node_Id;
9961       Pack_Body     : Node_Id;
9962       Prev_Formal   : Entity_Id;
9963       Ret_Expr      : Node_Id;
9964       Unit_Renaming : Node_Id;
9965
9966       Parent_Installed : Boolean := False;
9967       Save_Style_Check : constant Boolean := Style_Check;
9968
9969       Par_Ent : Entity_Id := Empty;
9970       Par_Vis : Boolean   := False;
9971
9972    begin
9973       Gen_Body_Id := Corresponding_Body (Gen_Decl);
9974
9975       --  Subprogram body may have been created already because of an inline
9976       --  pragma, or because of multiple elaborations of the enclosing package
9977       --  when several instances of the subprogram appear in the main unit.
9978
9979       if Present (Corresponding_Body (Act_Decl)) then
9980          return;
9981       end if;
9982
9983       Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9984
9985       --  Re-establish the state of information on which checks are suppressed.
9986       --  This information was set in Body_Info at the point of instantiation,
9987       --  and now we restore it so that the instance is compiled using the
9988       --  check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9989
9990       Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9991       Scope_Suppress           := Body_Info.Scope_Suppress;
9992       Opt.Ada_Version          := Body_Info.Version;
9993
9994       if No (Gen_Body_Id) then
9995
9996          --  For imported generic subprogram, no body to compile, complete
9997          --  the spec entity appropriately.
9998
9999          if Is_Imported (Gen_Unit) then
10000             Set_Is_Imported (Anon_Id);
10001             Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10002             Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10003             Set_Convention     (Anon_Id, Convention     (Gen_Unit));
10004             Set_Has_Completion (Anon_Id);
10005             return;
10006
10007          --  For other cases, compile the body
10008
10009          else
10010             Load_Parent_Of_Generic
10011               (Inst_Node, Specification (Gen_Decl), Body_Optional);
10012             Gen_Body_Id := Corresponding_Body (Gen_Decl);
10013          end if;
10014       end if;
10015
10016       Instantiation_Node := Inst_Node;
10017
10018       if Present (Gen_Body_Id) then
10019          Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10020
10021          if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10022
10023             --  Either body is not present, or context is non-expanding, as
10024             --  when compiling a subunit. Mark the instance as completed, and
10025             --  diagnose a missing body when needed.
10026
10027             if Expander_Active
10028               and then Operating_Mode = Generate_Code
10029             then
10030                Error_Msg_N
10031                  ("missing proper body for instantiation", Gen_Body);
10032             end if;
10033
10034             Set_Has_Completion (Anon_Id);
10035             return;
10036          end if;
10037
10038          Save_Env (Gen_Unit, Anon_Id);
10039          Style_Check := False;
10040          Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10041          Create_Instantiation_Source
10042            (Inst_Node,
10043             Gen_Body_Id,
10044             False,
10045             S_Adjustment);
10046
10047          Act_Body :=
10048            Copy_Generic_Node
10049              (Original_Node (Gen_Body), Empty, Instantiating => True);
10050
10051          --  Create proper defining name for the body, to correspond to
10052          --  the one in the spec.
10053
10054          Set_Defining_Unit_Name (Specification (Act_Body),
10055            Make_Defining_Identifier
10056              (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10057          Set_Corresponding_Spec (Act_Body, Anon_Id);
10058          Set_Has_Completion (Anon_Id);
10059          Check_Generic_Actuals (Pack_Id, False);
10060
10061          --  Generate a reference to link the visible subprogram instance to
10062          --  the generic body, which for navigation purposes is the only
10063          --  available source for the instance.
10064
10065          Generate_Reference
10066            (Related_Instance (Pack_Id),
10067              Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10068
10069          --  If it is a child unit, make the parent instance (which is an
10070          --  instance of the parent of the generic) visible. The parent
10071          --  instance is the prefix of the name of the generic unit.
10072
10073          if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10074            and then Nkind (Gen_Id) = N_Expanded_Name
10075          then
10076             Par_Ent := Entity (Prefix (Gen_Id));
10077             Par_Vis := Is_Immediately_Visible (Par_Ent);
10078             Install_Parent (Par_Ent, In_Body => True);
10079             Parent_Installed := True;
10080
10081          elsif Is_Child_Unit (Gen_Unit) then
10082             Par_Ent := Scope (Gen_Unit);
10083             Par_Vis := Is_Immediately_Visible (Par_Ent);
10084             Install_Parent (Par_Ent, In_Body => True);
10085             Parent_Installed := True;
10086          end if;
10087
10088          --  Inside its body, a reference to the generic unit is a reference
10089          --  to the instance. The corresponding renaming is the first
10090          --  declaration in the body.
10091
10092          Unit_Renaming :=
10093            Make_Subprogram_Renaming_Declaration (Loc,
10094              Specification =>
10095                Copy_Generic_Node (
10096                  Specification (Original_Node (Gen_Body)),
10097                  Empty,
10098                  Instantiating => True),
10099              Name => New_Occurrence_Of (Anon_Id, Loc));
10100
10101          --  If there is a formal subprogram with the same name as the unit
10102          --  itself, do not add this renaming declaration. This is a temporary
10103          --  fix for one ACVC test. ???
10104
10105          Prev_Formal := First_Entity (Pack_Id);
10106          while Present (Prev_Formal) loop
10107             if Chars (Prev_Formal) = Chars (Gen_Unit)
10108               and then Is_Overloadable (Prev_Formal)
10109             then
10110                exit;
10111             end if;
10112
10113             Next_Entity (Prev_Formal);
10114          end loop;
10115
10116          if Present (Prev_Formal) then
10117             Decls :=  New_List (Act_Body);
10118          else
10119             Decls :=  New_List (Unit_Renaming, Act_Body);
10120          end if;
10121
10122          --  The subprogram body is placed in the body of a dummy package body,
10123          --  whose spec contains the subprogram declaration as well as the
10124          --  renaming declarations for the generic parameters.
10125
10126          Pack_Body := Make_Package_Body (Loc,
10127            Defining_Unit_Name => New_Copy (Pack_Id),
10128            Declarations       => Decls);
10129
10130          Set_Corresponding_Spec (Pack_Body, Pack_Id);
10131
10132          --  If the instantiation is a library unit, then build resulting
10133          --  compilation unit nodes for the instance. The declaration of
10134          --  the enclosing package is the grandparent of the subprogram
10135          --  declaration. First replace the instantiation node as the unit
10136          --  of the corresponding compilation.
10137
10138          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10139             if Parent (Inst_Node) = Cunit (Main_Unit) then
10140                Set_Unit (Parent (Inst_Node), Inst_Node);
10141                Build_Instance_Compilation_Unit_Nodes
10142                  (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10143                Analyze (Inst_Node);
10144             else
10145                Set_Parent (Pack_Body, Parent (Inst_Node));
10146                Analyze (Pack_Body);
10147             end if;
10148
10149          else
10150             Insert_Before (Inst_Node, Pack_Body);
10151             Mark_Rewrite_Insertion (Pack_Body);
10152             Analyze (Pack_Body);
10153
10154             if Expander_Active then
10155                Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10156             end if;
10157          end if;
10158
10159          Inherit_Context (Gen_Body, Inst_Node);
10160
10161          Restore_Private_Views (Pack_Id, False);
10162
10163          if Parent_Installed then
10164             Remove_Parent (In_Body => True);
10165
10166             --  Restore the previous visibility of the parent
10167
10168             Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10169          end if;
10170
10171          Restore_Env;
10172          Style_Check := Save_Style_Check;
10173
10174       --  Body not found. Error was emitted already. If there were no previous
10175       --  errors, this may be an instance whose scope is a premature instance.
10176       --  In that case we must insure that the (legal) program does raise
10177       --  program error if executed. We generate a subprogram body for this
10178       --  purpose. See DEC ac30vso.
10179
10180       --  Should not reference proprietary DEC tests in comments ???
10181
10182       elsif Serious_Errors_Detected = 0
10183         and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10184       then
10185          if Body_Optional then
10186             return;
10187
10188          elsif Ekind (Anon_Id) = E_Procedure then
10189             Act_Body :=
10190               Make_Subprogram_Body (Loc,
10191                  Specification              =>
10192                    Make_Procedure_Specification (Loc,
10193                      Defining_Unit_Name         =>
10194                        Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10195                        Parameter_Specifications =>
10196                        New_Copy_List
10197                          (Parameter_Specifications (Parent (Anon_Id)))),
10198
10199                  Declarations               => Empty_List,
10200                  Handled_Statement_Sequence =>
10201                    Make_Handled_Sequence_Of_Statements (Loc,
10202                      Statements =>
10203                        New_List (
10204                          Make_Raise_Program_Error (Loc,
10205                            Reason =>
10206                              PE_Access_Before_Elaboration))));
10207
10208          else
10209             Ret_Expr :=
10210               Make_Raise_Program_Error (Loc,
10211                 Reason => PE_Access_Before_Elaboration);
10212
10213             Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10214             Set_Analyzed (Ret_Expr);
10215
10216             Act_Body :=
10217               Make_Subprogram_Body (Loc,
10218                 Specification =>
10219                   Make_Function_Specification (Loc,
10220                      Defining_Unit_Name         =>
10221                        Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10222                        Parameter_Specifications =>
10223                        New_Copy_List
10224                          (Parameter_Specifications (Parent (Anon_Id))),
10225                      Result_Definition =>
10226                        New_Occurrence_Of (Etype (Anon_Id), Loc)),
10227
10228                   Declarations               => Empty_List,
10229                   Handled_Statement_Sequence =>
10230                     Make_Handled_Sequence_Of_Statements (Loc,
10231                       Statements =>
10232                         New_List
10233                           (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10234          end if;
10235
10236          Pack_Body := Make_Package_Body (Loc,
10237            Defining_Unit_Name => New_Copy (Pack_Id),
10238            Declarations       => New_List (Act_Body));
10239
10240          Insert_After (Inst_Node, Pack_Body);
10241          Set_Corresponding_Spec (Pack_Body, Pack_Id);
10242          Analyze (Pack_Body);
10243       end if;
10244
10245       Expander_Mode_Restore;
10246    end Instantiate_Subprogram_Body;
10247
10248    ----------------------
10249    -- Instantiate_Type --
10250    ----------------------
10251
10252    function Instantiate_Type
10253      (Formal          : Node_Id;
10254       Actual          : Node_Id;
10255       Analyzed_Formal : Node_Id;
10256       Actual_Decls    : List_Id) return List_Id
10257    is
10258       Gen_T      : constant Entity_Id  := Defining_Identifier (Formal);
10259       A_Gen_T    : constant Entity_Id  :=
10260                      Defining_Identifier (Analyzed_Formal);
10261       Ancestor   : Entity_Id := Empty;
10262       Def        : constant Node_Id    := Formal_Type_Definition (Formal);
10263       Act_T      : Entity_Id;
10264       Decl_Node  : Node_Id;
10265       Decl_Nodes : List_Id;
10266       Loc        : Source_Ptr;
10267       Subt       : Entity_Id;
10268
10269       procedure Validate_Array_Type_Instance;
10270       procedure Validate_Access_Subprogram_Instance;
10271       procedure Validate_Access_Type_Instance;
10272       procedure Validate_Derived_Type_Instance;
10273       procedure Validate_Derived_Interface_Type_Instance;
10274       procedure Validate_Discriminated_Formal_Type;
10275       procedure Validate_Interface_Type_Instance;
10276       procedure Validate_Private_Type_Instance;
10277       procedure Validate_Incomplete_Type_Instance;
10278       --  These procedures perform validation tests for the named case.
10279       --  Validate_Discriminated_Formal_Type is shared by formal private
10280       --  types and Ada 2012 formal incomplete types.
10281
10282       function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10283       --  Check that base types are the same and that the subtypes match
10284       --  statically. Used in several of the above.
10285
10286       --------------------
10287       -- Subtypes_Match --
10288       --------------------
10289
10290       function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10291          T : constant Entity_Id := Get_Instance_Of (Gen_T);
10292
10293       begin
10294          return (Base_Type (T) = Base_Type (Act_T)
10295                   and then Subtypes_Statically_Match (T, Act_T))
10296
10297            or else (Is_Class_Wide_Type (Gen_T)
10298                      and then Is_Class_Wide_Type (Act_T)
10299                      and then
10300                        Subtypes_Match
10301                         (Get_Instance_Of (Root_Type (Gen_T)),
10302                          Root_Type (Act_T)))
10303
10304            or else
10305              ((Ekind (Gen_T) = E_Anonymous_Access_Subprogram_Type
10306                  or else Ekind (Gen_T) = E_Anonymous_Access_Type)
10307                and then Ekind (Act_T) = Ekind (Gen_T)
10308                and then
10309                  Subtypes_Statically_Match
10310                    (Designated_Type (Gen_T), Designated_Type (Act_T)));
10311       end Subtypes_Match;
10312
10313       -----------------------------------------
10314       -- Validate_Access_Subprogram_Instance --
10315       -----------------------------------------
10316
10317       procedure Validate_Access_Subprogram_Instance is
10318       begin
10319          if not Is_Access_Type (Act_T)
10320            or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10321          then
10322             Error_Msg_NE
10323               ("expect access type in instantiation of &", Actual, Gen_T);
10324             Abandon_Instantiation (Actual);
10325          end if;
10326
10327          Check_Mode_Conformant
10328            (Designated_Type (Act_T),
10329             Designated_Type (A_Gen_T),
10330             Actual,
10331             Get_Inst => True);
10332
10333          if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10334             if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10335                Error_Msg_NE
10336                  ("protected access type not allowed for formal &",
10337                   Actual, Gen_T);
10338             end if;
10339
10340          elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10341             Error_Msg_NE
10342               ("expect protected access type for formal &",
10343                Actual, Gen_T);
10344          end if;
10345       end Validate_Access_Subprogram_Instance;
10346
10347       -----------------------------------
10348       -- Validate_Access_Type_Instance --
10349       -----------------------------------
10350
10351       procedure Validate_Access_Type_Instance is
10352          Desig_Type : constant Entity_Id :=
10353                         Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10354          Desig_Act  : Entity_Id;
10355
10356       begin
10357          if not Is_Access_Type (Act_T) then
10358             Error_Msg_NE
10359               ("expect access type in instantiation of &", Actual, Gen_T);
10360             Abandon_Instantiation (Actual);
10361          end if;
10362
10363          if Is_Access_Constant (A_Gen_T) then
10364             if not Is_Access_Constant (Act_T) then
10365                Error_Msg_N
10366                  ("actual type must be access-to-constant type", Actual);
10367                Abandon_Instantiation (Actual);
10368             end if;
10369          else
10370             if Is_Access_Constant (Act_T) then
10371                Error_Msg_N
10372                  ("actual type must be access-to-variable type", Actual);
10373                Abandon_Instantiation (Actual);
10374
10375             elsif Ekind (A_Gen_T) = E_General_Access_Type
10376               and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10377             then
10378                Error_Msg_N -- CODEFIX
10379                  ("actual must be general access type!", Actual);
10380                Error_Msg_NE -- CODEFIX
10381                  ("add ALL to }!", Actual, Act_T);
10382                Abandon_Instantiation (Actual);
10383             end if;
10384          end if;
10385
10386          --  The designated subtypes, that is to say the subtypes introduced
10387          --  by an access type declaration (and not by a subtype declaration)
10388          --  must match.
10389
10390          Desig_Act := Designated_Type (Base_Type (Act_T));
10391
10392          --  The designated type may have been introduced through a limited_
10393          --  with clause, in which case retrieve the non-limited view. This
10394          --  applies to incomplete types as well as to class-wide types.
10395
10396          if From_With_Type (Desig_Act) then
10397             Desig_Act := Available_View (Desig_Act);
10398          end if;
10399
10400          if not Subtypes_Match
10401            (Desig_Type, Desig_Act) then
10402             Error_Msg_NE
10403               ("designated type of actual does not match that of formal &",
10404                  Actual, Gen_T);
10405             Abandon_Instantiation (Actual);
10406
10407          elsif Is_Access_Type (Designated_Type (Act_T))
10408            and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10409                       /=
10410                   Is_Constrained (Designated_Type (Desig_Type))
10411          then
10412             Error_Msg_NE
10413               ("designated type of actual does not match that of formal &",
10414                  Actual, Gen_T);
10415             Abandon_Instantiation (Actual);
10416          end if;
10417
10418          --  Ada 2005: null-exclusion indicators of the two types must agree
10419
10420          if Can_Never_Be_Null (A_Gen_T) /=  Can_Never_Be_Null (Act_T) then
10421             Error_Msg_NE
10422               ("non null exclusion of actual and formal & do not match",
10423                  Actual, Gen_T);
10424          end if;
10425       end Validate_Access_Type_Instance;
10426
10427       ----------------------------------
10428       -- Validate_Array_Type_Instance --
10429       ----------------------------------
10430
10431       procedure Validate_Array_Type_Instance is
10432          I1 : Node_Id;
10433          I2 : Node_Id;
10434          T2 : Entity_Id;
10435
10436          function Formal_Dimensions return Int;
10437          --  Count number of dimensions in array type formal
10438
10439          -----------------------
10440          -- Formal_Dimensions --
10441          -----------------------
10442
10443          function Formal_Dimensions return Int is
10444             Num   : Int := 0;
10445             Index : Node_Id;
10446
10447          begin
10448             if Nkind (Def) = N_Constrained_Array_Definition then
10449                Index := First (Discrete_Subtype_Definitions (Def));
10450             else
10451                Index := First (Subtype_Marks (Def));
10452             end if;
10453
10454             while Present (Index) loop
10455                Num := Num + 1;
10456                Next_Index (Index);
10457             end loop;
10458
10459             return Num;
10460          end Formal_Dimensions;
10461
10462       --  Start of processing for Validate_Array_Type_Instance
10463
10464       begin
10465          if not Is_Array_Type (Act_T) then
10466             Error_Msg_NE
10467               ("expect array type in instantiation of &", Actual, Gen_T);
10468             Abandon_Instantiation (Actual);
10469
10470          elsif Nkind (Def) = N_Constrained_Array_Definition then
10471             if not (Is_Constrained (Act_T)) then
10472                Error_Msg_NE
10473                  ("expect constrained array in instantiation of &",
10474                   Actual, Gen_T);
10475                Abandon_Instantiation (Actual);
10476             end if;
10477
10478          else
10479             if Is_Constrained (Act_T) then
10480                Error_Msg_NE
10481                  ("expect unconstrained array in instantiation of &",
10482                   Actual, Gen_T);
10483                Abandon_Instantiation (Actual);
10484             end if;
10485          end if;
10486
10487          if Formal_Dimensions /= Number_Dimensions (Act_T) then
10488             Error_Msg_NE
10489               ("dimensions of actual do not match formal &", Actual, Gen_T);
10490             Abandon_Instantiation (Actual);
10491          end if;
10492
10493          I1 := First_Index (A_Gen_T);
10494          I2 := First_Index (Act_T);
10495          for J in 1 .. Formal_Dimensions loop
10496
10497             --  If the indexes of the actual were given by a subtype_mark,
10498             --  the index was transformed into a range attribute. Retrieve
10499             --  the original type mark for checking.
10500
10501             if Is_Entity_Name (Original_Node (I2)) then
10502                T2 := Entity (Original_Node (I2));
10503             else
10504                T2 := Etype (I2);
10505             end if;
10506
10507             if not Subtypes_Match
10508                      (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10509             then
10510                Error_Msg_NE
10511                  ("index types of actual do not match those of formal &",
10512                   Actual, Gen_T);
10513                Abandon_Instantiation (Actual);
10514             end if;
10515
10516             Next_Index (I1);
10517             Next_Index (I2);
10518          end loop;
10519
10520          --  Check matching subtypes. Note that there are complex visibility
10521          --  issues when the generic is a child unit and some aspect of the
10522          --  generic type is declared in a parent unit of the generic. We do
10523          --  the test to handle this special case only after a direct check
10524          --  for static matching has failed.
10525
10526          if Subtypes_Match
10527            (Component_Type (A_Gen_T), Component_Type (Act_T))
10528              or else Subtypes_Match
10529                       (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10530                        Component_Type (Act_T))
10531          then
10532             null;
10533          else
10534             Error_Msg_NE
10535               ("component subtype of actual does not match that of formal &",
10536                Actual, Gen_T);
10537             Abandon_Instantiation (Actual);
10538          end if;
10539
10540          if Has_Aliased_Components (A_Gen_T)
10541            and then not Has_Aliased_Components (Act_T)
10542          then
10543             Error_Msg_NE
10544               ("actual must have aliased components to match formal type &",
10545                Actual, Gen_T);
10546          end if;
10547       end Validate_Array_Type_Instance;
10548
10549       -----------------------------------------------
10550       --  Validate_Derived_Interface_Type_Instance --
10551       -----------------------------------------------
10552
10553       procedure Validate_Derived_Interface_Type_Instance is
10554          Par  : constant Entity_Id := Entity (Subtype_Indication (Def));
10555          Elmt : Elmt_Id;
10556
10557       begin
10558          --  First apply interface instance checks
10559
10560          Validate_Interface_Type_Instance;
10561
10562          --  Verify that immediate parent interface is an ancestor of
10563          --  the actual.
10564
10565          if Present (Par)
10566            and then not Interface_Present_In_Ancestor (Act_T, Par)
10567          then
10568             Error_Msg_NE
10569               ("interface actual must include progenitor&", Actual, Par);
10570          end if;
10571
10572          --  Now verify that the actual includes all other ancestors of
10573          --  the formal.
10574
10575          Elmt := First_Elmt (Interfaces (A_Gen_T));
10576          while Present (Elmt) loop
10577             if not Interface_Present_In_Ancestor
10578                      (Act_T, Get_Instance_Of (Node (Elmt)))
10579             then
10580                Error_Msg_NE
10581                  ("interface actual must include progenitor&",
10582                     Actual, Node (Elmt));
10583             end if;
10584
10585             Next_Elmt (Elmt);
10586          end loop;
10587       end Validate_Derived_Interface_Type_Instance;
10588
10589       ------------------------------------
10590       -- Validate_Derived_Type_Instance --
10591       ------------------------------------
10592
10593       procedure Validate_Derived_Type_Instance is
10594          Actual_Discr   : Entity_Id;
10595          Ancestor_Discr : Entity_Id;
10596
10597       begin
10598          --  If the parent type in the generic declaration is itself a previous
10599          --  formal type, then it is local to the generic and absent from the
10600          --  analyzed generic definition. In that case the ancestor is the
10601          --  instance of the formal (which must have been instantiated
10602          --  previously), unless the ancestor is itself a formal derived type.
10603          --  In this latter case (which is the subject of Corrigendum 8652/0038
10604          --  (AI-202) the ancestor of the formals is the ancestor of its
10605          --  parent. Otherwise, the analyzed generic carries the parent type.
10606          --  If the parent type is defined in a previous formal package, then
10607          --  the scope of that formal package is that of the generic type
10608          --  itself, and it has already been mapped into the corresponding type
10609          --  in the actual package.
10610
10611          --  Common case: parent type defined outside of the generic
10612
10613          if Is_Entity_Name (Subtype_Mark (Def))
10614            and then Present (Entity (Subtype_Mark (Def)))
10615          then
10616             Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10617
10618          --  Check whether parent is defined in a previous formal package
10619
10620          elsif
10621            Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10622          then
10623             Ancestor :=
10624               Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10625
10626          --  The type may be a local derivation, or a type extension of a
10627          --  previous formal, or of a formal of a parent package.
10628
10629          elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10630           or else
10631             Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10632          then
10633             --  Check whether the parent is another derived formal type in the
10634             --  same generic unit.
10635
10636             if Etype (A_Gen_T) /= A_Gen_T
10637               and then Is_Generic_Type (Etype (A_Gen_T))
10638               and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10639               and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10640             then
10641                --  Locate ancestor of parent from the subtype declaration
10642                --  created for the actual.
10643
10644                declare
10645                   Decl : Node_Id;
10646
10647                begin
10648                   Decl := First (Actual_Decls);
10649                   while Present (Decl) loop
10650                      if Nkind (Decl) = N_Subtype_Declaration
10651                        and then Chars (Defining_Identifier (Decl)) =
10652                                                     Chars (Etype (A_Gen_T))
10653                      then
10654                         Ancestor := Generic_Parent_Type (Decl);
10655                         exit;
10656                      else
10657                         Next (Decl);
10658                      end if;
10659                   end loop;
10660                end;
10661
10662                pragma Assert (Present (Ancestor));
10663
10664             else
10665                Ancestor :=
10666                  Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10667             end if;
10668
10669          else
10670             Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10671          end if;
10672
10673          --  If the formal derived type has pragma Preelaborable_Initialization
10674          --  then the actual type must have preelaborable initialization.
10675
10676          if Known_To_Have_Preelab_Init (A_Gen_T)
10677            and then not Has_Preelaborable_Initialization (Act_T)
10678          then
10679             Error_Msg_NE
10680               ("actual for & must have preelaborable initialization",
10681                Actual, Gen_T);
10682          end if;
10683
10684          --  Ada 2005 (AI-251)
10685
10686          if Ada_Version >= Ada_2005
10687            and then Is_Interface (Ancestor)
10688          then
10689             if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10690                Error_Msg_NE
10691                  ("(Ada 2005) expected type implementing & in instantiation",
10692                   Actual, Ancestor);
10693             end if;
10694
10695          elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10696             Error_Msg_NE
10697               ("expect type derived from & in instantiation",
10698                Actual, First_Subtype (Ancestor));
10699             Abandon_Instantiation (Actual);
10700          end if;
10701
10702          --  Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10703          --  that the formal type declaration has been rewritten as a private
10704          --  extension.
10705
10706          if Ada_Version >= Ada_2005
10707            and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10708            and then Synchronized_Present (Parent (A_Gen_T))
10709          then
10710             --  The actual must be a synchronized tagged type
10711
10712             if not Is_Tagged_Type (Act_T) then
10713                Error_Msg_N
10714                  ("actual of synchronized type must be tagged", Actual);
10715                Abandon_Instantiation (Actual);
10716
10717             elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10718               and then Nkind (Type_Definition (Parent (Act_T))) =
10719                          N_Derived_Type_Definition
10720               and then not Synchronized_Present (Type_Definition
10721                              (Parent (Act_T)))
10722             then
10723                Error_Msg_N
10724                  ("actual of synchronized type must be synchronized", Actual);
10725                Abandon_Instantiation (Actual);
10726             end if;
10727          end if;
10728
10729          --  Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10730          --  removes the second instance of the phrase "or allow pass by copy".
10731
10732          if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10733             Error_Msg_N
10734               ("cannot have atomic actual type for non-atomic formal type",
10735                Actual);
10736
10737          elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10738             Error_Msg_N
10739               ("cannot have volatile actual type for non-volatile formal type",
10740                Actual);
10741          end if;
10742
10743          --  It should not be necessary to check for unknown discriminants on
10744          --  Formal, but for some reason Has_Unknown_Discriminants is false for
10745          --  A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10746          --  needs fixing. ???
10747
10748          if not Is_Indefinite_Subtype (A_Gen_T)
10749            and then not Unknown_Discriminants_Present (Formal)
10750            and then Is_Indefinite_Subtype (Act_T)
10751          then
10752             Error_Msg_N
10753               ("actual subtype must be constrained", Actual);
10754             Abandon_Instantiation (Actual);
10755          end if;
10756
10757          if not Unknown_Discriminants_Present (Formal) then
10758             if Is_Constrained (Ancestor) then
10759                if not Is_Constrained (Act_T) then
10760                   Error_Msg_N
10761                     ("actual subtype must be constrained", Actual);
10762                   Abandon_Instantiation (Actual);
10763                end if;
10764
10765             --  Ancestor is unconstrained, Check if generic formal and actual
10766             --  agree on constrainedness. The check only applies to array types
10767             --  and discriminated types.
10768
10769             elsif Is_Constrained (Act_T) then
10770                if Ekind (Ancestor) = E_Access_Type
10771                  or else
10772                    (not Is_Constrained (A_Gen_T)
10773                      and then Is_Composite_Type (A_Gen_T))
10774                then
10775                   Error_Msg_N
10776                     ("actual subtype must be unconstrained", Actual);
10777                   Abandon_Instantiation (Actual);
10778                end if;
10779
10780             --  A class-wide type is only allowed if the formal has unknown
10781             --  discriminants.
10782
10783             elsif Is_Class_Wide_Type (Act_T)
10784               and then not Has_Unknown_Discriminants (Ancestor)
10785             then
10786                Error_Msg_NE
10787                  ("actual for & cannot be a class-wide type", Actual, Gen_T);
10788                Abandon_Instantiation (Actual);
10789
10790             --  Otherwise, the formal and actual shall have the same number
10791             --  of discriminants and each discriminant of the actual must
10792             --  correspond to a discriminant of the formal.
10793
10794             elsif Has_Discriminants (Act_T)
10795               and then not Has_Unknown_Discriminants (Act_T)
10796               and then Has_Discriminants (Ancestor)
10797             then
10798                Actual_Discr   := First_Discriminant (Act_T);
10799                Ancestor_Discr := First_Discriminant (Ancestor);
10800                while Present (Actual_Discr)
10801                  and then Present (Ancestor_Discr)
10802                loop
10803                   if Base_Type (Act_T) /= Base_Type (Ancestor) and then
10804                     No (Corresponding_Discriminant (Actual_Discr))
10805                   then
10806                      Error_Msg_NE
10807                        ("discriminant & does not correspond " &
10808                         "to ancestor discriminant", Actual, Actual_Discr);
10809                      Abandon_Instantiation (Actual);
10810                   end if;
10811
10812                   Next_Discriminant (Actual_Discr);
10813                   Next_Discriminant (Ancestor_Discr);
10814                end loop;
10815
10816                if Present (Actual_Discr) or else Present (Ancestor_Discr) then
10817                   Error_Msg_NE
10818                     ("actual for & must have same number of discriminants",
10819                      Actual, Gen_T);
10820                   Abandon_Instantiation (Actual);
10821                end if;
10822
10823             --  This case should be caught by the earlier check for
10824             --  constrainedness, but the check here is added for completeness.
10825
10826             elsif Has_Discriminants (Act_T)
10827               and then not Has_Unknown_Discriminants (Act_T)
10828             then
10829                Error_Msg_NE
10830                  ("actual for & must not have discriminants", Actual, Gen_T);
10831                Abandon_Instantiation (Actual);
10832
10833             elsif Has_Discriminants (Ancestor) then
10834                Error_Msg_NE
10835                  ("actual for & must have known discriminants", Actual, Gen_T);
10836                Abandon_Instantiation (Actual);
10837             end if;
10838
10839             if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
10840                Error_Msg_N
10841                  ("constraint on actual is incompatible with formal", Actual);
10842                Abandon_Instantiation (Actual);
10843             end if;
10844          end if;
10845
10846          --  If the formal and actual types are abstract, check that there
10847          --  are no abstract primitives of the actual type that correspond to
10848          --  nonabstract primitives of the formal type (second sentence of
10849          --  RM95-3.9.3(9)).
10850
10851          if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
10852             Check_Abstract_Primitives : declare
10853                Gen_Prims  : constant Elist_Id :=
10854                              Primitive_Operations (A_Gen_T);
10855                Gen_Elmt   : Elmt_Id;
10856                Gen_Subp   : Entity_Id;
10857                Anc_Subp   : Entity_Id;
10858                Anc_Formal : Entity_Id;
10859                Anc_F_Type : Entity_Id;
10860
10861                Act_Prims  : constant Elist_Id  := Primitive_Operations (Act_T);
10862                Act_Elmt   : Elmt_Id;
10863                Act_Subp   : Entity_Id;
10864                Act_Formal : Entity_Id;
10865                Act_F_Type : Entity_Id;
10866
10867                Subprograms_Correspond : Boolean;
10868
10869                function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
10870                --  Returns true if T2 is derived directly or indirectly from
10871                --  T1, including derivations from interfaces. T1 and T2 are
10872                --  required to be specific tagged base types.
10873
10874                ------------------------
10875                -- Is_Tagged_Ancestor --
10876                ------------------------
10877
10878                function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
10879                is
10880                   Intfc_Elmt : Elmt_Id;
10881
10882                begin
10883                   --  The predicate is satisfied if the types are the same
10884
10885                   if T1 = T2 then
10886                      return True;
10887
10888                   --  If we've reached the top of the derivation chain then
10889                   --  we know that T1 is not an ancestor of T2.
10890
10891                   elsif Etype (T2) = T2 then
10892                      return False;
10893
10894                   --  Proceed to check T2's immediate parent
10895
10896                   elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
10897                      return True;
10898
10899                   --  Finally, check to see if T1 is an ancestor of any of T2's
10900                   --  progenitors.
10901
10902                   else
10903                      Intfc_Elmt := First_Elmt (Interfaces (T2));
10904                      while Present (Intfc_Elmt) loop
10905                         if Is_Ancestor (T1, Node (Intfc_Elmt)) then
10906                            return True;
10907                         end if;
10908
10909                         Next_Elmt (Intfc_Elmt);
10910                      end loop;
10911                   end if;
10912
10913                   return False;
10914                end Is_Tagged_Ancestor;
10915
10916             --  Start of processing for Check_Abstract_Primitives
10917
10918             begin
10919                --  Loop over all of the formal derived type's primitives
10920
10921                Gen_Elmt := First_Elmt (Gen_Prims);
10922                while Present (Gen_Elmt) loop
10923                   Gen_Subp := Node (Gen_Elmt);
10924
10925                   --  If the primitive of the formal is not abstract, then
10926                   --  determine whether there is a corresponding primitive of
10927                   --  the actual type that's abstract.
10928
10929                   if not Is_Abstract_Subprogram (Gen_Subp) then
10930                      Act_Elmt := First_Elmt (Act_Prims);
10931                      while Present (Act_Elmt) loop
10932                         Act_Subp := Node (Act_Elmt);
10933
10934                         --  If we find an abstract primitive of the actual,
10935                         --  then we need to test whether it corresponds to the
10936                         --  subprogram from which the generic formal primitive
10937                         --  is inherited.
10938
10939                         if Is_Abstract_Subprogram (Act_Subp) then
10940                            Anc_Subp := Alias (Gen_Subp);
10941
10942                            --  Test whether we have a corresponding primitive
10943                            --  by comparing names, kinds, formal types, and
10944                            --  result types.
10945
10946                            if Chars (Anc_Subp) = Chars (Act_Subp)
10947                              and then Ekind (Anc_Subp) = Ekind (Act_Subp)
10948                            then
10949                               Anc_Formal := First_Formal (Anc_Subp);
10950                               Act_Formal := First_Formal (Act_Subp);
10951                               while Present (Anc_Formal)
10952                                 and then Present (Act_Formal)
10953                               loop
10954                                  Anc_F_Type := Etype (Anc_Formal);
10955                                  Act_F_Type := Etype (Act_Formal);
10956
10957                                  if Ekind (Anc_F_Type)
10958                                       = E_Anonymous_Access_Type
10959                                  then
10960                                     Anc_F_Type := Designated_Type (Anc_F_Type);
10961
10962                                     if Ekind (Act_F_Type)
10963                                          = E_Anonymous_Access_Type
10964                                     then
10965                                        Act_F_Type :=
10966                                          Designated_Type (Act_F_Type);
10967                                     else
10968                                        exit;
10969                                     end if;
10970
10971                                  elsif
10972                                    Ekind (Act_F_Type) = E_Anonymous_Access_Type
10973                                  then
10974                                     exit;
10975                                  end if;
10976
10977                                  Anc_F_Type := Base_Type (Anc_F_Type);
10978                                  Act_F_Type := Base_Type (Act_F_Type);
10979
10980                                  --  If the formal is controlling, then the
10981                                  --  the type of the actual primitive's formal
10982                                  --  must be derived directly or indirectly
10983                                  --  from the type of the ancestor primitive's
10984                                  --  formal.
10985
10986                                  if Is_Controlling_Formal (Anc_Formal) then
10987                                     if not Is_Tagged_Ancestor
10988                                              (Anc_F_Type, Act_F_Type)
10989                                     then
10990                                        exit;
10991                                     end if;
10992
10993                                  --  Otherwise the types of the formals must
10994                                  --  be the same.
10995
10996                                  elsif Anc_F_Type /= Act_F_Type then
10997                                     exit;
10998                                  end if;
10999
11000                                  Next_Entity (Anc_Formal);
11001                                  Next_Entity (Act_Formal);
11002                               end loop;
11003
11004                               --  If we traversed through all of the formals
11005                               --  then so far the subprograms correspond, so
11006                               --  now check that any result types correspond.
11007
11008                               if No (Anc_Formal) and then No (Act_Formal) then
11009                                  Subprograms_Correspond := True;
11010
11011                                  if Ekind (Act_Subp) = E_Function then
11012                                     Anc_F_Type := Etype (Anc_Subp);
11013                                     Act_F_Type := Etype (Act_Subp);
11014
11015                                     if Ekind (Anc_F_Type)
11016                                          = E_Anonymous_Access_Type
11017                                     then
11018                                        Anc_F_Type :=
11019                                          Designated_Type (Anc_F_Type);
11020
11021                                        if Ekind (Act_F_Type)
11022                                             = E_Anonymous_Access_Type
11023                                        then
11024                                           Act_F_Type :=
11025                                             Designated_Type (Act_F_Type);
11026                                        else
11027                                           Subprograms_Correspond := False;
11028                                        end if;
11029
11030                                     elsif
11031                                       Ekind (Act_F_Type)
11032                                         = E_Anonymous_Access_Type
11033                                     then
11034                                        Subprograms_Correspond := False;
11035                                     end if;
11036
11037                                     Anc_F_Type := Base_Type (Anc_F_Type);
11038                                     Act_F_Type := Base_Type (Act_F_Type);
11039
11040                                     --  Now either the result types must be
11041                                     --  the same or, if the result type is
11042                                     --  controlling, the result type of the
11043                                     --  actual primitive must descend from the
11044                                     --  result type of the ancestor primitive.
11045
11046                                     if Subprograms_Correspond
11047                                       and then Anc_F_Type /= Act_F_Type
11048                                       and then
11049                                         Has_Controlling_Result (Anc_Subp)
11050                                       and then
11051                                         not Is_Tagged_Ancestor
11052                                               (Anc_F_Type, Act_F_Type)
11053                                     then
11054                                        Subprograms_Correspond := False;
11055                                     end if;
11056                                  end if;
11057
11058                                  --  Found a matching subprogram belonging to
11059                                  --  formal ancestor type, so actual subprogram
11060                                  --  corresponds and this violates 3.9.3(9).
11061
11062                                  if Subprograms_Correspond then
11063                                     Error_Msg_NE
11064                                       ("abstract subprogram & overrides " &
11065                                        "nonabstract subprogram of ancestor",
11066                                        Actual,
11067                                        Act_Subp);
11068                                  end if;
11069                               end if;
11070                            end if;
11071                         end if;
11072
11073                         Next_Elmt (Act_Elmt);
11074                      end loop;
11075                   end if;
11076
11077                   Next_Elmt (Gen_Elmt);
11078                end loop;
11079             end Check_Abstract_Primitives;
11080          end if;
11081
11082          --  Verify that limitedness matches. If parent is a limited
11083          --  interface then  the generic formal is not unless declared
11084          --  explicitly so. If not declared limited, the actual cannot be
11085          --  limited (see AI05-0087).
11086
11087          --  Even though this AI is a binding interpretation, we enable the
11088          --  check only in Ada 2012 mode, because this improper construct
11089          --  shows up in user code and in existing B-tests.
11090
11091          if Is_Limited_Type (Act_T)
11092            and then not Is_Limited_Type (A_Gen_T)
11093            and then Ada_Version >= Ada_2012
11094          then
11095             if In_Instance then
11096                null;
11097             else
11098                Error_Msg_NE
11099                  ("actual for non-limited & cannot be a limited type", Actual,
11100                   Gen_T);
11101                Explain_Limited_Type (Act_T, Actual);
11102                Abandon_Instantiation (Actual);
11103             end if;
11104          end if;
11105       end Validate_Derived_Type_Instance;
11106
11107       ----------------------------------------
11108       -- Validate_Discriminated_Formal_Type --
11109       ----------------------------------------
11110
11111       procedure Validate_Discriminated_Formal_Type is
11112          Formal_Discr : Entity_Id;
11113          Actual_Discr : Entity_Id;
11114          Formal_Subt  : Entity_Id;
11115
11116       begin
11117          if Has_Discriminants (A_Gen_T) then
11118             if not Has_Discriminants (Act_T) then
11119                Error_Msg_NE
11120                  ("actual for & must have discriminants", Actual, Gen_T);
11121                Abandon_Instantiation (Actual);
11122
11123             elsif Is_Constrained (Act_T) then
11124                Error_Msg_NE
11125                  ("actual for & must be unconstrained", Actual, Gen_T);
11126                Abandon_Instantiation (Actual);
11127
11128             else
11129                Formal_Discr := First_Discriminant (A_Gen_T);
11130                Actual_Discr := First_Discriminant (Act_T);
11131                while Formal_Discr /= Empty loop
11132                   if Actual_Discr = Empty then
11133                      Error_Msg_NE
11134                        ("discriminants on actual do not match formal",
11135                         Actual, Gen_T);
11136                      Abandon_Instantiation (Actual);
11137                   end if;
11138
11139                   Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11140
11141                   --  Access discriminants match if designated types do
11142
11143                   if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11144                     and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11145                                 E_Anonymous_Access_Type
11146                     and then
11147                       Get_Instance_Of
11148                         (Designated_Type (Base_Type (Formal_Subt))) =
11149                            Designated_Type (Base_Type (Etype (Actual_Discr)))
11150                   then
11151                      null;
11152
11153                   elsif Base_Type (Formal_Subt) /=
11154                           Base_Type (Etype (Actual_Discr))
11155                   then
11156                      Error_Msg_NE
11157                        ("types of actual discriminants must match formal",
11158                         Actual, Gen_T);
11159                      Abandon_Instantiation (Actual);
11160
11161                   elsif not Subtypes_Statically_Match
11162                               (Formal_Subt, Etype (Actual_Discr))
11163                     and then Ada_Version >= Ada_95
11164                   then
11165                      Error_Msg_NE
11166                        ("subtypes of actual discriminants must match formal",
11167                         Actual, Gen_T);
11168                      Abandon_Instantiation (Actual);
11169                   end if;
11170
11171                   Next_Discriminant (Formal_Discr);
11172                   Next_Discriminant (Actual_Discr);
11173                end loop;
11174
11175                if Actual_Discr /= Empty then
11176                   Error_Msg_NE
11177                     ("discriminants on actual do not match formal",
11178                      Actual, Gen_T);
11179                   Abandon_Instantiation (Actual);
11180                end if;
11181             end if;
11182          end if;
11183       end Validate_Discriminated_Formal_Type;
11184
11185       ---------------------------------------
11186       -- Validate_Incomplete_Type_Instance --
11187       ---------------------------------------
11188
11189       procedure Validate_Incomplete_Type_Instance is
11190       begin
11191          if not Is_Tagged_Type (Act_T)
11192            and then Is_Tagged_Type (A_Gen_T)
11193          then
11194             Error_Msg_NE
11195               ("actual for & must be a tagged type", Actual, Gen_T);
11196          end if;
11197
11198          Validate_Discriminated_Formal_Type;
11199       end Validate_Incomplete_Type_Instance;
11200
11201       --------------------------------------
11202       -- Validate_Interface_Type_Instance --
11203       --------------------------------------
11204
11205       procedure Validate_Interface_Type_Instance is
11206       begin
11207          if not Is_Interface (Act_T) then
11208             Error_Msg_NE
11209               ("actual for formal interface type must be an interface",
11210                 Actual, Gen_T);
11211
11212          elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11213            or else
11214              Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11215            or else
11216              Is_Protected_Interface (A_Gen_T) /=
11217                Is_Protected_Interface (Act_T)
11218            or else
11219              Is_Synchronized_Interface (A_Gen_T) /=
11220                Is_Synchronized_Interface (Act_T)
11221          then
11222             Error_Msg_NE
11223               ("actual for interface& does not match (RM 12.5.5(4))",
11224                Actual, Gen_T);
11225          end if;
11226       end Validate_Interface_Type_Instance;
11227
11228       ------------------------------------
11229       -- Validate_Private_Type_Instance --
11230       ------------------------------------
11231
11232       procedure Validate_Private_Type_Instance is
11233       begin
11234          if Is_Limited_Type (Act_T)
11235            and then not Is_Limited_Type (A_Gen_T)
11236          then
11237             if In_Instance then
11238                null;
11239             else
11240                Error_Msg_NE
11241                  ("actual for non-limited & cannot be a limited type", Actual,
11242                   Gen_T);
11243                Explain_Limited_Type (Act_T, Actual);
11244                Abandon_Instantiation (Actual);
11245             end if;
11246
11247          elsif Known_To_Have_Preelab_Init (A_Gen_T)
11248            and then not Has_Preelaborable_Initialization (Act_T)
11249          then
11250             Error_Msg_NE
11251               ("actual for & must have preelaborable initialization", Actual,
11252                Gen_T);
11253
11254          elsif Is_Indefinite_Subtype (Act_T)
11255             and then not Is_Indefinite_Subtype (A_Gen_T)
11256             and then Ada_Version >= Ada_95
11257          then
11258             Error_Msg_NE
11259               ("actual for & must be a definite subtype", Actual, Gen_T);
11260
11261          elsif not Is_Tagged_Type (Act_T)
11262            and then Is_Tagged_Type (A_Gen_T)
11263          then
11264             Error_Msg_NE
11265               ("actual for & must be a tagged type", Actual, Gen_T);
11266          end if;
11267
11268          Validate_Discriminated_Formal_Type;
11269          Ancestor := Gen_T;
11270       end Validate_Private_Type_Instance;
11271
11272    --  Start of processing for Instantiate_Type
11273
11274    begin
11275       if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11276          Error_Msg_N ("duplicate instantiation of generic type", Actual);
11277          return New_List (Error);
11278
11279       elsif not Is_Entity_Name (Actual)
11280         or else not Is_Type (Entity (Actual))
11281       then
11282          Error_Msg_NE
11283            ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11284          Abandon_Instantiation (Actual);
11285
11286       else
11287          Act_T := Entity (Actual);
11288
11289          --  Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11290          --  as a generic actual parameter if the corresponding formal type
11291          --  does not have a known_discriminant_part, or is a formal derived
11292          --  type that is an Unchecked_Union type.
11293
11294          if Is_Unchecked_Union (Base_Type (Act_T)) then
11295             if not Has_Discriminants (A_Gen_T)
11296                      or else
11297                    (Is_Derived_Type (A_Gen_T)
11298                      and then
11299                     Is_Unchecked_Union (A_Gen_T))
11300             then
11301                null;
11302             else
11303                Error_Msg_N ("Unchecked_Union cannot be the actual for a" &
11304                  " discriminated formal type", Act_T);
11305
11306             end if;
11307          end if;
11308
11309          --  Deal with fixed/floating restrictions
11310
11311          if Is_Floating_Point_Type (Act_T) then
11312             Check_Restriction (No_Floating_Point, Actual);
11313          elsif Is_Fixed_Point_Type (Act_T) then
11314             Check_Restriction (No_Fixed_Point, Actual);
11315          end if;
11316
11317          --  Deal with error of using incomplete type as generic actual.
11318          --  This includes limited views of a type, even if the non-limited
11319          --  view may be available.
11320
11321          if Ekind (Act_T) = E_Incomplete_Type
11322            or else (Is_Class_Wide_Type (Act_T)
11323                       and then
11324                          Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11325          then
11326             --  If the formal is an incomplete type, the actual can be
11327             --  incomplete as well.
11328
11329             if Ekind (A_Gen_T) = E_Incomplete_Type then
11330                null;
11331
11332             elsif Is_Class_Wide_Type (Act_T)
11333               or else No (Full_View (Act_T))
11334             then
11335                Error_Msg_N ("premature use of incomplete type", Actual);
11336                Abandon_Instantiation (Actual);
11337             else
11338                Act_T := Full_View (Act_T);
11339                Set_Entity (Actual, Act_T);
11340
11341                if Has_Private_Component (Act_T) then
11342                   Error_Msg_N
11343                     ("premature use of type with private component", Actual);
11344                end if;
11345             end if;
11346
11347          --  Deal with error of premature use of private type as generic actual
11348
11349          elsif Is_Private_Type (Act_T)
11350            and then Is_Private_Type (Base_Type (Act_T))
11351            and then not Is_Generic_Type (Act_T)
11352            and then not Is_Derived_Type (Act_T)
11353            and then No (Full_View (Root_Type (Act_T)))
11354          then
11355             --  If the formal is an incomplete type, the actual can be
11356             --  private or incomplete as well.
11357
11358             if Ekind (A_Gen_T) = E_Incomplete_Type then
11359                null;
11360             else
11361                Error_Msg_N ("premature use of private type", Actual);
11362             end if;
11363
11364          elsif Has_Private_Component (Act_T) then
11365             Error_Msg_N
11366               ("premature use of type with private component", Actual);
11367          end if;
11368
11369          Set_Instance_Of (A_Gen_T, Act_T);
11370
11371          --  If the type is generic, the class-wide type may also be used
11372
11373          if Is_Tagged_Type (A_Gen_T)
11374            and then Is_Tagged_Type (Act_T)
11375            and then not Is_Class_Wide_Type (A_Gen_T)
11376          then
11377             Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11378               Class_Wide_Type (Act_T));
11379          end if;
11380
11381          if not Is_Abstract_Type (A_Gen_T)
11382            and then Is_Abstract_Type (Act_T)
11383          then
11384             Error_Msg_N
11385               ("actual of non-abstract formal cannot be abstract", Actual);
11386          end if;
11387
11388          --  A generic scalar type is a first subtype for which we generate
11389          --  an anonymous base type. Indicate that the instance of this base
11390          --  is the base type of the actual.
11391
11392          if Is_Scalar_Type (A_Gen_T) then
11393             Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11394          end if;
11395       end if;
11396
11397       if Error_Posted (Act_T) then
11398          null;
11399       else
11400          case Nkind (Def) is
11401             when N_Formal_Private_Type_Definition =>
11402                Validate_Private_Type_Instance;
11403
11404             when N_Formal_Incomplete_Type_Definition =>
11405                Validate_Incomplete_Type_Instance;
11406
11407             when N_Formal_Derived_Type_Definition =>
11408                Validate_Derived_Type_Instance;
11409
11410             when N_Formal_Discrete_Type_Definition =>
11411                if not Is_Discrete_Type (Act_T) then
11412                   Error_Msg_NE
11413                     ("expect discrete type in instantiation of&",
11414                        Actual, Gen_T);
11415                   Abandon_Instantiation (Actual);
11416                end if;
11417
11418             when N_Formal_Signed_Integer_Type_Definition =>
11419                if not Is_Signed_Integer_Type (Act_T) then
11420                   Error_Msg_NE
11421                     ("expect signed integer type in instantiation of&",
11422                      Actual, Gen_T);
11423                   Abandon_Instantiation (Actual);
11424                end if;
11425
11426             when N_Formal_Modular_Type_Definition =>
11427                if not Is_Modular_Integer_Type (Act_T) then
11428                   Error_Msg_NE
11429                     ("expect modular type in instantiation of &",
11430                        Actual, Gen_T);
11431                   Abandon_Instantiation (Actual);
11432                end if;
11433
11434             when N_Formal_Floating_Point_Definition =>
11435                if not Is_Floating_Point_Type (Act_T) then
11436                   Error_Msg_NE
11437                     ("expect float type in instantiation of &", Actual, Gen_T);
11438                   Abandon_Instantiation (Actual);
11439                end if;
11440
11441             when N_Formal_Ordinary_Fixed_Point_Definition =>
11442                if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11443                   Error_Msg_NE
11444                     ("expect ordinary fixed point type in instantiation of &",
11445                      Actual, Gen_T);
11446                   Abandon_Instantiation (Actual);
11447                end if;
11448
11449             when N_Formal_Decimal_Fixed_Point_Definition =>
11450                if not Is_Decimal_Fixed_Point_Type (Act_T) then
11451                   Error_Msg_NE
11452                     ("expect decimal type in instantiation of &",
11453                      Actual, Gen_T);
11454                   Abandon_Instantiation (Actual);
11455                end if;
11456
11457             when N_Array_Type_Definition =>
11458                Validate_Array_Type_Instance;
11459
11460             when N_Access_To_Object_Definition =>
11461                Validate_Access_Type_Instance;
11462
11463             when N_Access_Function_Definition |
11464                  N_Access_Procedure_Definition =>
11465                Validate_Access_Subprogram_Instance;
11466
11467             when N_Record_Definition           =>
11468                Validate_Interface_Type_Instance;
11469
11470             when N_Derived_Type_Definition     =>
11471                Validate_Derived_Interface_Type_Instance;
11472
11473             when others =>
11474                raise Program_Error;
11475
11476          end case;
11477       end if;
11478
11479       Subt := New_Copy (Gen_T);
11480
11481       --  Use adjusted sloc of subtype name as the location for other nodes in
11482       --  the subtype declaration.
11483
11484       Loc  := Sloc (Subt);
11485
11486       Decl_Node :=
11487         Make_Subtype_Declaration (Loc,
11488           Defining_Identifier => Subt,
11489           Subtype_Indication  => New_Reference_To (Act_T, Loc));
11490
11491       if Is_Private_Type (Act_T) then
11492          Set_Has_Private_View (Subtype_Indication (Decl_Node));
11493
11494       elsif Is_Access_Type (Act_T)
11495         and then Is_Private_Type (Designated_Type (Act_T))
11496       then
11497          Set_Has_Private_View (Subtype_Indication (Decl_Node));
11498       end if;
11499
11500       Decl_Nodes := New_List (Decl_Node);
11501
11502       --  Flag actual derived types so their elaboration produces the
11503       --  appropriate renamings for the primitive operations of the ancestor.
11504       --  Flag actual for formal private types as well, to determine whether
11505       --  operations in the private part may override inherited operations.
11506       --  If the formal has an interface list, the ancestor is not the
11507       --  parent, but the analyzed formal that includes the interface
11508       --  operations of all its progenitors.
11509
11510       --  Same treatment for formal private types, so we can check whether the
11511       --  type is tagged limited when validating derivations in the private
11512       --  part. (See AI05-096).
11513
11514       if Nkind (Def) = N_Formal_Derived_Type_Definition then
11515          if Present (Interface_List (Def)) then
11516             Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11517          else
11518             Set_Generic_Parent_Type (Decl_Node, Ancestor);
11519          end if;
11520
11521       elsif Nkind_In (Def,
11522         N_Formal_Private_Type_Definition,
11523         N_Formal_Incomplete_Type_Definition)
11524       then
11525          Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11526       end if;
11527
11528       --  If the actual is a synchronized type that implements an interface,
11529       --  the primitive operations are attached to the corresponding record,
11530       --  and we have to treat it as an additional generic actual, so that its
11531       --  primitive operations become visible in the instance. The task or
11532       --  protected type itself does not carry primitive operations.
11533
11534       if Is_Concurrent_Type (Act_T)
11535         and then Is_Tagged_Type (Act_T)
11536         and then Present (Corresponding_Record_Type (Act_T))
11537         and then Present (Ancestor)
11538         and then Is_Interface (Ancestor)
11539       then
11540          declare
11541             Corr_Rec  : constant Entity_Id :=
11542                           Corresponding_Record_Type (Act_T);
11543             New_Corr  : Entity_Id;
11544             Corr_Decl : Node_Id;
11545
11546          begin
11547             New_Corr := Make_Temporary (Loc, 'S');
11548             Corr_Decl :=
11549               Make_Subtype_Declaration (Loc,
11550                 Defining_Identifier => New_Corr,
11551                 Subtype_Indication  =>
11552                   New_Reference_To (Corr_Rec, Loc));
11553             Append_To (Decl_Nodes, Corr_Decl);
11554
11555             if Ekind (Act_T) = E_Task_Type then
11556                Set_Ekind (Subt, E_Task_Subtype);
11557             else
11558                Set_Ekind (Subt, E_Protected_Subtype);
11559             end if;
11560
11561             Set_Corresponding_Record_Type (Subt, Corr_Rec);
11562             Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11563             Set_Generic_Parent_Type (Decl_Node, Empty);
11564          end;
11565       end if;
11566
11567       return Decl_Nodes;
11568    end Instantiate_Type;
11569
11570    ---------------------
11571    -- Is_In_Main_Unit --
11572    ---------------------
11573
11574    function Is_In_Main_Unit (N : Node_Id) return Boolean is
11575       Unum         : constant Unit_Number_Type := Get_Source_Unit (N);
11576       Current_Unit : Node_Id;
11577
11578    begin
11579       if Unum = Main_Unit then
11580          return True;
11581
11582       --  If the current unit is a subunit then it is either the main unit or
11583       --  is being compiled as part of the main unit.
11584
11585       elsif Nkind (N) = N_Compilation_Unit then
11586          return Nkind (Unit (N)) = N_Subunit;
11587       end if;
11588
11589       Current_Unit := Parent (N);
11590       while Present (Current_Unit)
11591         and then Nkind (Current_Unit) /= N_Compilation_Unit
11592       loop
11593          Current_Unit := Parent (Current_Unit);
11594       end loop;
11595
11596       --  The instantiation node is in the main unit, or else the current node
11597       --  (perhaps as the result of nested instantiations) is in the main unit,
11598       --  or in the declaration of the main unit, which in this last case must
11599       --  be a body.
11600
11601       return Unum = Main_Unit
11602         or else Current_Unit = Cunit (Main_Unit)
11603         or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11604         or else (Present (Library_Unit (Current_Unit))
11605                   and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11606    end Is_In_Main_Unit;
11607
11608    ----------------------------
11609    -- Load_Parent_Of_Generic --
11610    ----------------------------
11611
11612    procedure Load_Parent_Of_Generic
11613      (N             : Node_Id;
11614       Spec          : Node_Id;
11615       Body_Optional : Boolean := False)
11616    is
11617       Comp_Unit          : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11618       Save_Style_Check   : constant Boolean := Style_Check;
11619       True_Parent        : Node_Id;
11620       Inst_Node          : Node_Id;
11621       OK                 : Boolean;
11622       Previous_Instances : constant Elist_Id := New_Elmt_List;
11623
11624       procedure Collect_Previous_Instances (Decls : List_Id);
11625       --  Collect all instantiations in the given list of declarations, that
11626       --  precede the generic that we need to load. If the bodies of these
11627       --  instantiations are available, we must analyze them, to ensure that
11628       --  the public symbols generated are the same when the unit is compiled
11629       --  to generate code, and when it is compiled in the context of a unit
11630       --  that needs a particular nested instance. This process is applied to
11631       --  both package and subprogram instances.
11632
11633       --------------------------------
11634       -- Collect_Previous_Instances --
11635       --------------------------------
11636
11637       procedure Collect_Previous_Instances (Decls : List_Id) is
11638          Decl : Node_Id;
11639
11640       begin
11641          Decl := First (Decls);
11642          while Present (Decl) loop
11643             if Sloc (Decl) >= Sloc (Inst_Node) then
11644                return;
11645
11646             --  If Decl is an instantiation, then record it as requiring
11647             --  instantiation of the corresponding body, except if it is an
11648             --  abbreviated instantiation generated internally for conformance
11649             --  checking purposes only for the case of a formal package
11650             --  declared without a box (see Instantiate_Formal_Package). Such
11651             --  an instantiation does not generate any code (the actual code
11652             --  comes from actual) and thus does not need to be analyzed here.
11653             --  If the instantiation appears with a generic package body it is
11654             --  not analyzed here either.
11655
11656             elsif Nkind (Decl) = N_Package_Instantiation
11657               and then not Is_Internal (Defining_Entity (Decl))
11658             then
11659                Append_Elmt (Decl, Previous_Instances);
11660
11661             --  For a subprogram instantiation, omit instantiations intrinsic
11662             --  operations (Unchecked_Conversions, etc.) that have no bodies.
11663
11664             elsif Nkind_In (Decl, N_Function_Instantiation,
11665                                   N_Procedure_Instantiation)
11666               and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11667             then
11668                Append_Elmt (Decl, Previous_Instances);
11669
11670             elsif Nkind (Decl) = N_Package_Declaration then
11671                Collect_Previous_Instances
11672                  (Visible_Declarations (Specification (Decl)));
11673                Collect_Previous_Instances
11674                  (Private_Declarations (Specification (Decl)));
11675
11676             --  Previous non-generic bodies may contain instances as well
11677
11678             elsif Nkind (Decl) = N_Package_Body
11679               and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11680             then
11681                Collect_Previous_Instances (Declarations (Decl));
11682
11683             elsif Nkind (Decl) = N_Subprogram_Body
11684               and then not Acts_As_Spec (Decl)
11685               and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11686             then
11687                Collect_Previous_Instances (Declarations (Decl));
11688             end if;
11689
11690             Next (Decl);
11691          end loop;
11692       end Collect_Previous_Instances;
11693
11694    --  Start of processing for Load_Parent_Of_Generic
11695
11696    begin
11697       if not In_Same_Source_Unit (N, Spec)
11698         or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11699         or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11700                    and then not Is_In_Main_Unit (Spec))
11701       then
11702          --  Find body of parent of spec, and analyze it. A special case arises
11703          --  when the parent is an instantiation, that is to say when we are
11704          --  currently instantiating a nested generic. In that case, there is
11705          --  no separate file for the body of the enclosing instance. Instead,
11706          --  the enclosing body must be instantiated as if it were a pending
11707          --  instantiation, in order to produce the body for the nested generic
11708          --  we require now. Note that in that case the generic may be defined
11709          --  in a package body, the instance defined in the same package body,
11710          --  and the original enclosing body may not be in the main unit.
11711
11712          Inst_Node := Empty;
11713
11714          True_Parent := Parent (Spec);
11715          while Present (True_Parent)
11716            and then Nkind (True_Parent) /= N_Compilation_Unit
11717          loop
11718             if Nkind (True_Parent) = N_Package_Declaration
11719                  and then
11720                Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11721             then
11722                --  Parent is a compilation unit that is an instantiation.
11723                --  Instantiation node has been replaced with package decl.
11724
11725                Inst_Node := Original_Node (True_Parent);
11726                exit;
11727
11728             elsif Nkind (True_Parent) = N_Package_Declaration
11729               and then Present (Generic_Parent (Specification (True_Parent)))
11730               and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11731             then
11732                --  Parent is an instantiation within another specification.
11733                --  Declaration for instance has been inserted before original
11734                --  instantiation node. A direct link would be preferable?
11735
11736                Inst_Node := Next (True_Parent);
11737                while Present (Inst_Node)
11738                  and then Nkind (Inst_Node) /= N_Package_Instantiation
11739                loop
11740                   Next (Inst_Node);
11741                end loop;
11742
11743                --  If the instance appears within a generic, and the generic
11744                --  unit is defined within a formal package of the enclosing
11745                --  generic, there is no generic body available, and none
11746                --  needed. A more precise test should be used ???
11747
11748                if No (Inst_Node) then
11749                   return;
11750                end if;
11751
11752                exit;
11753
11754             else
11755                True_Parent := Parent (True_Parent);
11756             end if;
11757          end loop;
11758
11759          --  Case where we are currently instantiating a nested generic
11760
11761          if Present (Inst_Node) then
11762             if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
11763
11764                --  Instantiation node and declaration of instantiated package
11765                --  were exchanged when only the declaration was needed.
11766                --  Restore instantiation node before proceeding with body.
11767
11768                Set_Unit (Parent (True_Parent), Inst_Node);
11769             end if;
11770
11771             --  Now complete instantiation of enclosing body, if it appears in
11772             --  some other unit. If it appears in the current unit, the body
11773             --  will have been instantiated already.
11774
11775             if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
11776
11777                --  We need to determine the expander mode to instantiate the
11778                --  enclosing body. Because the generic body we need may use
11779                --  global entities declared in the enclosing package (including
11780                --  aggregates) it is in general necessary to compile this body
11781                --  with expansion enabled, except if we are within a generic
11782                --  package, in which case the usual generic rule applies.
11783
11784                declare
11785                   Exp_Status         : Boolean := True;
11786                   Scop               : Entity_Id;
11787
11788                begin
11789                   --  Loop through scopes looking for generic package
11790
11791                   Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
11792                   while Present (Scop)
11793                     and then Scop /= Standard_Standard
11794                   loop
11795                      if Ekind (Scop) = E_Generic_Package then
11796                         Exp_Status := False;
11797                         exit;
11798                      end if;
11799
11800                      Scop := Scope (Scop);
11801                   end loop;
11802
11803                   --  Collect previous instantiations in the unit that contains
11804                   --  the desired generic.
11805
11806                   if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11807                     and then not Body_Optional
11808                   then
11809                      declare
11810                         Decl : Elmt_Id;
11811                         Info : Pending_Body_Info;
11812                         Par  : Node_Id;
11813
11814                      begin
11815                         Par := Parent (Inst_Node);
11816                         while Present (Par) loop
11817                            exit when Nkind (Parent (Par)) = N_Compilation_Unit;
11818                            Par := Parent (Par);
11819                         end loop;
11820
11821                         pragma Assert (Present (Par));
11822
11823                         if Nkind (Par) = N_Package_Body then
11824                            Collect_Previous_Instances (Declarations (Par));
11825
11826                         elsif Nkind (Par) = N_Package_Declaration then
11827                            Collect_Previous_Instances
11828                              (Visible_Declarations (Specification (Par)));
11829                            Collect_Previous_Instances
11830                              (Private_Declarations (Specification (Par)));
11831
11832                         else
11833                            --  Enclosing unit is a subprogram body. In this
11834                            --  case all instance bodies are processed in order
11835                            --  and there is no need to collect them separately.
11836
11837                            null;
11838                         end if;
11839
11840                         Decl := First_Elmt (Previous_Instances);
11841                         while Present (Decl) loop
11842                            Info :=
11843                              (Inst_Node                => Node (Decl),
11844                               Act_Decl                 =>
11845                                 Instance_Spec (Node (Decl)),
11846                               Expander_Status          => Exp_Status,
11847                               Current_Sem_Unit         =>
11848                                 Get_Code_Unit (Sloc (Node (Decl))),
11849                               Scope_Suppress           => Scope_Suppress,
11850                               Local_Suppress_Stack_Top =>
11851                                 Local_Suppress_Stack_Top,
11852                               Version                  => Ada_Version);
11853
11854                            --  Package instance
11855
11856                            if
11857                              Nkind (Node (Decl)) = N_Package_Instantiation
11858                            then
11859                               Instantiate_Package_Body
11860                                 (Info, Body_Optional => True);
11861
11862                            --  Subprogram instance
11863
11864                            else
11865                               --  The instance_spec is the wrapper package,
11866                               --  and the subprogram declaration is the last
11867                               --  declaration in the wrapper.
11868
11869                               Info.Act_Decl :=
11870                                 Last
11871                                   (Visible_Declarations
11872                                     (Specification (Info.Act_Decl)));
11873
11874                               Instantiate_Subprogram_Body
11875                                 (Info, Body_Optional => True);
11876                            end if;
11877
11878                            Next_Elmt (Decl);
11879                         end loop;
11880                      end;
11881                   end if;
11882
11883                   Instantiate_Package_Body
11884                     (Body_Info =>
11885                        ((Inst_Node                => Inst_Node,
11886                          Act_Decl                 => True_Parent,
11887                          Expander_Status          => Exp_Status,
11888                          Current_Sem_Unit         =>
11889                            Get_Code_Unit (Sloc (Inst_Node)),
11890                          Scope_Suppress           => Scope_Suppress,
11891                          Local_Suppress_Stack_Top =>
11892                            Local_Suppress_Stack_Top,
11893                            Version                => Ada_Version)),
11894                      Body_Optional => Body_Optional);
11895                end;
11896             end if;
11897
11898          --  Case where we are not instantiating a nested generic
11899
11900          else
11901             Opt.Style_Check := False;
11902             Expander_Mode_Save_And_Set (True);
11903             Load_Needed_Body (Comp_Unit, OK);
11904             Opt.Style_Check := Save_Style_Check;
11905             Expander_Mode_Restore;
11906
11907             if not OK
11908               and then Unit_Requires_Body (Defining_Entity (Spec))
11909               and then not Body_Optional
11910             then
11911                declare
11912                   Bname : constant Unit_Name_Type :=
11913                             Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
11914
11915                begin
11916                   --  In CodePeer mode, the missing body may make the analysis
11917                   --  incomplete, but we do not treat it as fatal.
11918
11919                   if CodePeer_Mode then
11920                      return;
11921
11922                   else
11923                      Error_Msg_Unit_1 := Bname;
11924                      Error_Msg_N ("this instantiation requires$!", N);
11925                      Error_Msg_File_1 :=
11926                        Get_File_Name (Bname, Subunit => False);
11927                      Error_Msg_N ("\but file{ was not found!", N);
11928                      raise Unrecoverable_Error;
11929                   end if;
11930                end;
11931             end if;
11932          end if;
11933       end if;
11934
11935       --  If loading parent of the generic caused an instantiation circularity,
11936       --  we abandon compilation at this point, because otherwise in some cases
11937       --  we get into trouble with infinite recursions after this point.
11938
11939       if Circularity_Detected then
11940          raise Unrecoverable_Error;
11941       end if;
11942    end Load_Parent_Of_Generic;
11943
11944    ---------------------------------
11945    -- Map_Formal_Package_Entities --
11946    ---------------------------------
11947
11948    procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
11949       E1 : Entity_Id;
11950       E2 : Entity_Id;
11951
11952    begin
11953       Set_Instance_Of (Form, Act);
11954
11955       --  Traverse formal and actual package to map the corresponding entities.
11956       --  We skip over internal entities that may be generated during semantic
11957       --  analysis, and find the matching entities by name, given that they
11958       --  must appear in the same order.
11959
11960       E1 := First_Entity (Form);
11961       E2 := First_Entity (Act);
11962       while Present (E1) and then E1 /= First_Private_Entity (Form) loop
11963          --  Could this test be a single condition???
11964          --  Seems like it could, and isn't FPE (Form) a constant anyway???
11965
11966          if not Is_Internal (E1)
11967            and then Present (Parent (E1))
11968            and then not Is_Class_Wide_Type (E1)
11969            and then not Is_Internal_Name (Chars (E1))
11970          then
11971             while Present (E2) and then Chars (E2) /= Chars (E1) loop
11972                Next_Entity (E2);
11973             end loop;
11974
11975             if No (E2) then
11976                exit;
11977             else
11978                Set_Instance_Of (E1, E2);
11979
11980                if Is_Type (E1) and then Is_Tagged_Type (E2) then
11981                   Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
11982                end if;
11983
11984                if Is_Constrained (E1) then
11985                   Set_Instance_Of (Base_Type (E1), Base_Type (E2));
11986                end if;
11987
11988                if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
11989                   Map_Formal_Package_Entities (E1, E2);
11990                end if;
11991             end if;
11992          end if;
11993
11994          Next_Entity (E1);
11995       end loop;
11996    end Map_Formal_Package_Entities;
11997
11998    -----------------------
11999    -- Move_Freeze_Nodes --
12000    -----------------------
12001
12002    procedure Move_Freeze_Nodes
12003      (Out_Of : Entity_Id;
12004       After  : Node_Id;
12005       L      : List_Id)
12006    is
12007       Decl      : Node_Id;
12008       Next_Decl : Node_Id;
12009       Next_Node : Node_Id := After;
12010       Spec      : Node_Id;
12011
12012       function Is_Outer_Type (T : Entity_Id) return Boolean;
12013       --  Check whether entity is declared in a scope external to that of the
12014       --  generic unit.
12015
12016       -------------------
12017       -- Is_Outer_Type --
12018       -------------------
12019
12020       function Is_Outer_Type (T : Entity_Id) return Boolean is
12021          Scop : Entity_Id := Scope (T);
12022
12023       begin
12024          if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12025             return True;
12026
12027          else
12028             while Scop /= Standard_Standard loop
12029                if Scop = Out_Of then
12030                   return False;
12031                else
12032                   Scop := Scope (Scop);
12033                end if;
12034             end loop;
12035
12036             return True;
12037          end if;
12038       end Is_Outer_Type;
12039
12040    --  Start of processing for Move_Freeze_Nodes
12041
12042    begin
12043       if No (L) then
12044          return;
12045       end if;
12046
12047       --  First remove the freeze nodes that may appear before all other
12048       --  declarations.
12049
12050       Decl := First (L);
12051       while Present (Decl)
12052         and then Nkind (Decl) = N_Freeze_Entity
12053         and then Is_Outer_Type (Entity (Decl))
12054       loop
12055          Decl := Remove_Head (L);
12056          Insert_After (Next_Node, Decl);
12057          Set_Analyzed (Decl, False);
12058          Next_Node := Decl;
12059          Decl := First (L);
12060       end loop;
12061
12062       --  Next scan the list of declarations and remove each freeze node that
12063       --  appears ahead of the current node.
12064
12065       while Present (Decl) loop
12066          while Present (Next (Decl))
12067            and then Nkind (Next (Decl)) = N_Freeze_Entity
12068            and then Is_Outer_Type (Entity (Next (Decl)))
12069          loop
12070             Next_Decl := Remove_Next (Decl);
12071             Insert_After (Next_Node, Next_Decl);
12072             Set_Analyzed (Next_Decl, False);
12073             Next_Node := Next_Decl;
12074          end loop;
12075
12076          --  If the declaration is a nested package or concurrent type, then
12077          --  recurse. Nested generic packages will have been processed from the
12078          --  inside out.
12079
12080          case Nkind (Decl) is
12081             when N_Package_Declaration =>
12082                Spec := Specification (Decl);
12083
12084             when N_Task_Type_Declaration =>
12085                Spec := Task_Definition (Decl);
12086
12087             when N_Protected_Type_Declaration =>
12088                Spec := Protected_Definition (Decl);
12089
12090             when others =>
12091                Spec := Empty;
12092          end case;
12093
12094          if Present (Spec) then
12095             Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12096             Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12097          end if;
12098
12099          Next (Decl);
12100       end loop;
12101    end Move_Freeze_Nodes;
12102
12103    ----------------
12104    -- Next_Assoc --
12105    ----------------
12106
12107    function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12108    begin
12109       return Generic_Renamings.Table (E).Next_In_HTable;
12110    end Next_Assoc;
12111
12112    ------------------------
12113    -- Preanalyze_Actuals --
12114    ------------------------
12115
12116    procedure Preanalyze_Actuals (N : Node_Id) is
12117       Assoc : Node_Id;
12118       Act   : Node_Id;
12119       Errs  : constant Int := Serious_Errors_Detected;
12120
12121       Cur : Entity_Id := Empty;
12122       --  Current homograph of the instance name
12123
12124       Vis : Boolean;
12125       --  Saved visibility status of the current homograph
12126
12127    begin
12128       Assoc := First (Generic_Associations (N));
12129
12130       --  If the instance is a child unit, its name may hide an outer homonym,
12131       --  so make it invisible to perform name resolution on the actuals.
12132
12133       if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12134         and then Present
12135           (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12136       then
12137          Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12138
12139          if Is_Compilation_Unit (Cur) then
12140             Vis := Is_Immediately_Visible (Cur);
12141             Set_Is_Immediately_Visible (Cur, False);
12142          else
12143             Cur := Empty;
12144          end if;
12145       end if;
12146
12147       while Present (Assoc) loop
12148          if Nkind (Assoc) /= N_Others_Choice then
12149             Act := Explicit_Generic_Actual_Parameter (Assoc);
12150
12151             --  Within a nested instantiation, a defaulted actual is an empty
12152             --  association, so nothing to analyze. If the subprogram actual
12153             --  is an attribute, analyze prefix only, because actual is not a
12154             --  complete attribute reference.
12155
12156             --  If actual is an allocator, analyze expression only. The full
12157             --  analysis can generate code, and if instance is a compilation
12158             --  unit we have to wait until the package instance is installed
12159             --  to have a proper place to insert this code.
12160
12161             --  String literals may be operators, but at this point we do not
12162             --  know whether the actual is a formal subprogram or a string.
12163
12164             if No (Act) then
12165                null;
12166
12167             elsif Nkind (Act) = N_Attribute_Reference then
12168                Analyze (Prefix (Act));
12169
12170             elsif Nkind (Act) = N_Explicit_Dereference then
12171                Analyze (Prefix (Act));
12172
12173             elsif Nkind (Act) = N_Allocator then
12174                declare
12175                   Expr : constant Node_Id := Expression (Act);
12176
12177                begin
12178                   if Nkind (Expr) = N_Subtype_Indication then
12179                      Analyze (Subtype_Mark (Expr));
12180
12181                      --  Analyze separately each discriminant constraint, when
12182                      --  given with a named association.
12183
12184                      declare
12185                         Constr : Node_Id;
12186
12187                      begin
12188                         Constr := First (Constraints (Constraint (Expr)));
12189                         while Present (Constr) loop
12190                            if Nkind (Constr) = N_Discriminant_Association then
12191                               Analyze (Expression (Constr));
12192                            else
12193                               Analyze (Constr);
12194                            end if;
12195
12196                            Next (Constr);
12197                         end loop;
12198                      end;
12199
12200                   else
12201                      Analyze (Expr);
12202                   end if;
12203                end;
12204
12205             elsif Nkind (Act) /= N_Operator_Symbol then
12206                Analyze (Act);
12207             end if;
12208
12209             if Errs /= Serious_Errors_Detected then
12210
12211                --  Do a minimal analysis of the generic, to prevent spurious
12212                --  warnings complaining about the generic being unreferenced,
12213                --  before abandoning the instantiation.
12214
12215                Analyze (Name (N));
12216
12217                if Is_Entity_Name (Name (N))
12218                  and then Etype (Name (N)) /= Any_Type
12219                then
12220                   Generate_Reference  (Entity (Name (N)), Name (N));
12221                   Set_Is_Instantiated (Entity (Name (N)));
12222                end if;
12223
12224                if Present (Cur) then
12225
12226                   --  For the case of a child instance hiding an outer homonym,
12227                   --  provide additional warning which might explain the error.
12228
12229                   Set_Is_Immediately_Visible (Cur, Vis);
12230                   Error_Msg_NE ("& hides outer unit with the same name?",
12231                     N, Defining_Unit_Name (N));
12232                end if;
12233
12234                Abandon_Instantiation (Act);
12235             end if;
12236          end if;
12237
12238          Next (Assoc);
12239       end loop;
12240
12241       if Present (Cur) then
12242          Set_Is_Immediately_Visible (Cur, Vis);
12243       end if;
12244    end Preanalyze_Actuals;
12245
12246    -------------------
12247    -- Remove_Parent --
12248    -------------------
12249
12250    procedure Remove_Parent (In_Body : Boolean := False) is
12251       S : Entity_Id := Current_Scope;
12252       --  S is the scope containing the instantiation just completed. The scope
12253       --  stack contains the parent instances of the instantiation, followed by
12254       --  the original S.
12255
12256       Cur_P  : Entity_Id;
12257       E      : Entity_Id;
12258       P      : Entity_Id;
12259       Hidden : Elmt_Id;
12260
12261    begin
12262       --  After child instantiation is complete, remove from scope stack the
12263       --  extra copy of the current scope, and then remove parent instances.
12264
12265       if not In_Body then
12266          Pop_Scope;
12267
12268          while Current_Scope /= S loop
12269             P := Current_Scope;
12270             End_Package_Scope (Current_Scope);
12271
12272             if In_Open_Scopes (P) then
12273                E := First_Entity (P);
12274                while Present (E) loop
12275                   Set_Is_Immediately_Visible (E, True);
12276                   Next_Entity (E);
12277                end loop;
12278
12279                --  If instantiation is declared in a block, it is the enclosing
12280                --  scope that might be a parent instance. Note that only one
12281                --  block can be involved, because the parent instances have
12282                --  been installed within it.
12283
12284                if Ekind (P) = E_Block then
12285                   Cur_P := Scope (P);
12286                else
12287                   Cur_P := P;
12288                end if;
12289
12290                if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12291                   --  We are within an instance of some sibling. Retain
12292                   --  visibility of parent, for proper subsequent cleanup, and
12293                   --  reinstall private declarations as well.
12294
12295                   Set_In_Private_Part (P);
12296                   Install_Private_Declarations (P);
12297                end if;
12298
12299             --  If the ultimate parent is a top-level unit recorded in
12300             --  Instance_Parent_Unit, then reset its visibility to what it was
12301             --  before instantiation. (It's not clear what the purpose is of
12302             --  testing whether Scope (P) is In_Open_Scopes, but that test was
12303             --  present before the ultimate parent test was added.???)
12304
12305             elsif not In_Open_Scopes (Scope (P))
12306               or else (P = Instance_Parent_Unit
12307                         and then not Parent_Unit_Visible)
12308             then
12309                Set_Is_Immediately_Visible (P, False);
12310
12311             --  If the current scope is itself an instantiation of a generic
12312             --  nested within P, and we are in the private part of body of this
12313             --  instantiation, restore the full views of P, that were removed
12314             --  in End_Package_Scope above. This obscure case can occur when a
12315             --  subunit of a generic contains an instance of a child unit of
12316             --  its generic parent unit.
12317
12318             elsif S = Current_Scope and then Is_Generic_Instance (S) then
12319                declare
12320                   Par : constant Entity_Id :=
12321                           Generic_Parent
12322                             (Specification (Unit_Declaration_Node (S)));
12323                begin
12324                   if Present (Par)
12325                     and then P = Scope (Par)
12326                     and then (In_Package_Body (S) or else In_Private_Part (S))
12327                   then
12328                      Set_In_Private_Part (P);
12329                      Install_Private_Declarations (P);
12330                   end if;
12331                end;
12332             end if;
12333          end loop;
12334
12335          --  Reset visibility of entities in the enclosing scope
12336
12337          Set_Is_Hidden_Open_Scope (Current_Scope, False);
12338
12339          Hidden := First_Elmt (Hidden_Entities);
12340          while Present (Hidden) loop
12341             Set_Is_Immediately_Visible (Node (Hidden), True);
12342             Next_Elmt (Hidden);
12343          end loop;
12344
12345       else
12346          --  Each body is analyzed separately, and there is no context that
12347          --  needs preserving from one body instance to the next, so remove all
12348          --  parent scopes that have been installed.
12349
12350          while Present (S) loop
12351             End_Package_Scope (S);
12352             Set_Is_Immediately_Visible (S, False);
12353             S := Current_Scope;
12354             exit when S = Standard_Standard;
12355          end loop;
12356       end if;
12357    end Remove_Parent;
12358
12359    -----------------
12360    -- Restore_Env --
12361    -----------------
12362
12363    procedure Restore_Env is
12364       Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12365
12366    begin
12367       if No (Current_Instantiated_Parent.Act_Id) then
12368          --  Restore environment after subprogram inlining
12369
12370          Restore_Private_Views (Empty);
12371       end if;
12372
12373       Current_Instantiated_Parent := Saved.Instantiated_Parent;
12374       Exchanged_Views             := Saved.Exchanged_Views;
12375       Hidden_Entities             := Saved.Hidden_Entities;
12376       Current_Sem_Unit            := Saved.Current_Sem_Unit;
12377       Parent_Unit_Visible         := Saved.Parent_Unit_Visible;
12378       Instance_Parent_Unit        := Saved.Instance_Parent_Unit;
12379
12380       Restore_Opt_Config_Switches (Saved.Switches);
12381
12382       Instance_Envs.Decrement_Last;
12383    end Restore_Env;
12384
12385    ---------------------------
12386    -- Restore_Private_Views --
12387    ---------------------------
12388
12389    procedure Restore_Private_Views
12390      (Pack_Id    : Entity_Id;
12391       Is_Package : Boolean := True)
12392    is
12393       M        : Elmt_Id;
12394       E        : Entity_Id;
12395       Typ      : Entity_Id;
12396       Dep_Elmt : Elmt_Id;
12397       Dep_Typ  : Node_Id;
12398
12399       procedure Restore_Nested_Formal (Formal : Entity_Id);
12400       --  Hide the generic formals of formal packages declared with box which
12401       --  were reachable in the current instantiation.
12402
12403       ---------------------------
12404       -- Restore_Nested_Formal --
12405       ---------------------------
12406
12407       procedure Restore_Nested_Formal (Formal : Entity_Id) is
12408          Ent : Entity_Id;
12409
12410       begin
12411          if Present (Renamed_Object (Formal))
12412            and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12413          then
12414             return;
12415
12416          elsif Present (Associated_Formal_Package (Formal)) then
12417             Ent := First_Entity (Formal);
12418             while Present (Ent) loop
12419                exit when Ekind (Ent) = E_Package
12420                  and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12421
12422                Set_Is_Hidden (Ent);
12423                Set_Is_Potentially_Use_Visible (Ent, False);
12424
12425                --  If package, then recurse
12426
12427                if Ekind (Ent) = E_Package then
12428                   Restore_Nested_Formal (Ent);
12429                end if;
12430
12431                Next_Entity (Ent);
12432             end loop;
12433          end if;
12434       end Restore_Nested_Formal;
12435
12436    --  Start of processing for Restore_Private_Views
12437
12438    begin
12439       M := First_Elmt (Exchanged_Views);
12440       while Present (M) loop
12441          Typ := Node (M);
12442
12443          --  Subtypes of types whose views have been exchanged, and that are
12444          --  defined within the instance, were not on the Private_Dependents
12445          --  list on entry to the instance, so they have to be exchanged
12446          --  explicitly now, in order to remain consistent with the view of the
12447          --  parent type.
12448
12449          if Ekind_In (Typ, E_Private_Type,
12450                            E_Limited_Private_Type,
12451                            E_Record_Type_With_Private)
12452          then
12453             Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12454             while Present (Dep_Elmt) loop
12455                Dep_Typ := Node (Dep_Elmt);
12456
12457                if Scope (Dep_Typ) = Pack_Id
12458                  and then Present (Full_View (Dep_Typ))
12459                then
12460                   Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12461                   Exchange_Declarations (Dep_Typ);
12462                end if;
12463
12464                Next_Elmt (Dep_Elmt);
12465             end loop;
12466          end if;
12467
12468          Exchange_Declarations (Node (M));
12469          Next_Elmt (M);
12470       end loop;
12471
12472       if No (Pack_Id) then
12473          return;
12474       end if;
12475
12476       --  Make the generic formal parameters private, and make the formal types
12477       --  into subtypes of the actuals again.
12478
12479       E := First_Entity (Pack_Id);
12480       while Present (E) loop
12481          Set_Is_Hidden (E, True);
12482
12483          if Is_Type (E)
12484            and then Nkind (Parent (E)) = N_Subtype_Declaration
12485          then
12486             Set_Is_Generic_Actual_Type (E, False);
12487
12488             --  An unusual case of aliasing: the actual may also be directly
12489             --  visible in the generic, and be private there, while it is fully
12490             --  visible in the context of the instance. The internal subtype
12491             --  is private in the instance but has full visibility like its
12492             --  parent in the enclosing scope. This enforces the invariant that
12493             --  the privacy status of all private dependents of a type coincide
12494             --  with that of the parent type. This can only happen when a
12495             --  generic child unit is instantiated within a sibling.
12496
12497             if Is_Private_Type (E)
12498               and then not Is_Private_Type (Etype (E))
12499             then
12500                Exchange_Declarations (E);
12501             end if;
12502
12503          elsif Ekind (E) = E_Package then
12504
12505             --  The end of the renaming list is the renaming of the generic
12506             --  package itself. If the instance is a subprogram, all entities
12507             --  in the corresponding package are renamings. If this entity is
12508             --  a formal package, make its own formals private as well. The
12509             --  actual in this case is itself the renaming of an instantiation.
12510             --  If the entity is not a package renaming, it is the entity
12511             --  created to validate formal package actuals: ignore it.
12512
12513             --  If the actual is itself a formal package for the enclosing
12514             --  generic, or the actual for such a formal package, it remains
12515             --  visible on exit from the instance, and therefore nothing needs
12516             --  to be done either, except to keep it accessible.
12517
12518             if Is_Package and then Renamed_Object (E) = Pack_Id then
12519                exit;
12520
12521             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12522                null;
12523
12524             elsif
12525               Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12526             then
12527                Set_Is_Hidden (E, False);
12528
12529             else
12530                declare
12531                   Act_P : constant Entity_Id := Renamed_Object (E);
12532                   Id    : Entity_Id;
12533
12534                begin
12535                   Id := First_Entity (Act_P);
12536                   while Present (Id)
12537                     and then Id /= First_Private_Entity (Act_P)
12538                   loop
12539                      exit when Ekind (Id) = E_Package
12540                                  and then Renamed_Object (Id) = Act_P;
12541
12542                      Set_Is_Hidden (Id, True);
12543                      Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12544
12545                      if Ekind (Id) = E_Package then
12546                         Restore_Nested_Formal (Id);
12547                      end if;
12548
12549                      Next_Entity (Id);
12550                   end loop;
12551                end;
12552             end if;
12553          end if;
12554
12555          Next_Entity (E);
12556       end loop;
12557    end Restore_Private_Views;
12558
12559    --------------
12560    -- Save_Env --
12561    --------------
12562
12563    procedure Save_Env
12564      (Gen_Unit : Entity_Id;
12565       Act_Unit : Entity_Id)
12566    is
12567    begin
12568       Init_Env;
12569       Set_Instance_Env (Gen_Unit, Act_Unit);
12570    end Save_Env;
12571
12572    ----------------------------
12573    -- Save_Global_References --
12574    ----------------------------
12575
12576    procedure Save_Global_References (N : Node_Id) is
12577       Gen_Scope : Entity_Id;
12578       E         : Entity_Id;
12579       N2        : Node_Id;
12580
12581       function Is_Global (E : Entity_Id) return Boolean;
12582       --  Check whether entity is defined outside of generic unit. Examine the
12583       --  scope of an entity, and the scope of the scope, etc, until we find
12584       --  either Standard, in which case the entity is global, or the generic
12585       --  unit itself, which indicates that the entity is local. If the entity
12586       --  is the generic unit itself, as in the case of a recursive call, or
12587       --  the enclosing generic unit, if different from the current scope, then
12588       --  it is local as well, because it will be replaced at the point of
12589       --  instantiation. On the other hand, if it is a reference to a child
12590       --  unit of a common ancestor, which appears in an instantiation, it is
12591       --  global because it is used to denote a specific compilation unit at
12592       --  the time the instantiations will be analyzed.
12593
12594       procedure Reset_Entity (N : Node_Id);
12595       --  Save semantic information on global entity so that it is not resolved
12596       --  again at instantiation time.
12597
12598       procedure Save_Entity_Descendants (N : Node_Id);
12599       --  Apply Save_Global_References to the two syntactic descendants of
12600       --  non-terminal nodes that carry an Associated_Node and are processed
12601       --  through Reset_Entity. Once the global entity (if any) has been
12602       --  captured together with its type, only two syntactic descendants need
12603       --  to be traversed to complete the processing of the tree rooted at N.
12604       --  This applies to Selected_Components, Expanded_Names, and to Operator
12605       --  nodes. N can also be a character literal, identifier, or operator
12606       --  symbol node, but the call has no effect in these cases.
12607
12608       procedure Save_Global_Defaults (N1, N2 : Node_Id);
12609       --  Default actuals in nested instances must be handled specially
12610       --  because there is no link to them from the original tree. When an
12611       --  actual subprogram is given by a default, we add an explicit generic
12612       --  association for it in the instantiation node. When we save the
12613       --  global references on the name of the instance, we recover the list
12614       --  of generic associations, and add an explicit one to the original
12615       --  generic tree, through which a global actual can be preserved.
12616       --  Similarly, if a child unit is instantiated within a sibling, in the
12617       --  context of the parent, we must preserve the identifier of the parent
12618       --  so that it can be properly resolved in a subsequent instantiation.
12619
12620       procedure Save_Global_Descendant (D : Union_Id);
12621       --  Apply Save_Global_References recursively to the descendents of the
12622       --  current node.
12623
12624       procedure Save_References (N : Node_Id);
12625       --  This is the recursive procedure that does the work, once the
12626       --  enclosing generic scope has been established.
12627
12628       ---------------
12629       -- Is_Global --
12630       ---------------
12631
12632       function Is_Global (E : Entity_Id) return Boolean is
12633          Se : Entity_Id;
12634
12635          function Is_Instance_Node (Decl : Node_Id) return Boolean;
12636          --  Determine whether the parent node of a reference to a child unit
12637          --  denotes an instantiation or a formal package, in which case the
12638          --  reference to the child unit is global, even if it appears within
12639          --  the current scope (e.g. when the instance appears within the body
12640          --  of an ancestor).
12641
12642          ----------------------
12643          -- Is_Instance_Node --
12644          ----------------------
12645
12646          function Is_Instance_Node (Decl : Node_Id) return Boolean is
12647          begin
12648             return Nkind (Decl) in N_Generic_Instantiation
12649                      or else
12650                    Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12651          end Is_Instance_Node;
12652
12653       --  Start of processing for Is_Global
12654
12655       begin
12656          if E = Gen_Scope then
12657             return False;
12658
12659          elsif E = Standard_Standard then
12660             return True;
12661
12662          elsif Is_Child_Unit (E)
12663            and then (Is_Instance_Node (Parent (N2))
12664                       or else (Nkind (Parent (N2)) = N_Expanded_Name
12665                                 and then N2 = Selector_Name (Parent (N2))
12666                                 and then
12667                                   Is_Instance_Node (Parent (Parent (N2)))))
12668          then
12669             return True;
12670
12671          else
12672             Se := Scope (E);
12673             while Se /= Gen_Scope loop
12674                if Se = Standard_Standard then
12675                   return True;
12676                else
12677                   Se := Scope (Se);
12678                end if;
12679             end loop;
12680
12681             return False;
12682          end if;
12683       end Is_Global;
12684
12685       ------------------
12686       -- Reset_Entity --
12687       ------------------
12688
12689       procedure Reset_Entity (N : Node_Id) is
12690
12691          procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12692          --  If the type of N2 is global to the generic unit, save the type in
12693          --  the generic node. Just as we perform name capture for explicit
12694          --  references within the generic, we must capture the global types
12695          --  of local entities because they may participate in resolution in
12696          --  the instance.
12697
12698          function Top_Ancestor (E : Entity_Id) return Entity_Id;
12699          --  Find the ultimate ancestor of the current unit. If it is not a
12700          --  generic unit, then the name of the current unit in the prefix of
12701          --  an expanded name must be replaced with its generic homonym to
12702          --  ensure that it will be properly resolved in an instance.
12703
12704          ---------------------
12705          -- Set_Global_Type --
12706          ---------------------
12707
12708          procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12709             Typ : constant Entity_Id := Etype (N2);
12710
12711          begin
12712             Set_Etype (N, Typ);
12713
12714             if Entity (N) /= N2
12715               and then Has_Private_View (Entity (N))
12716             then
12717                --  If the entity of N is not the associated node, this is a
12718                --  nested generic and it has an associated node as well, whose
12719                --  type is already the full view (see below). Indicate that the
12720                --  original node has a private view.
12721
12722                Set_Has_Private_View (N);
12723             end if;
12724
12725             --  If not a private type, nothing else to do
12726
12727             if not Is_Private_Type (Typ) then
12728                if Is_Array_Type (Typ)
12729                  and then Is_Private_Type (Component_Type (Typ))
12730                then
12731                   Set_Has_Private_View (N);
12732                end if;
12733
12734             --  If it is a derivation of a private type in a context where no
12735             --  full view is needed, nothing to do either.
12736
12737             elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
12738                null;
12739
12740             --  Otherwise mark the type for flipping and use the full view when
12741             --  available.
12742
12743             else
12744                Set_Has_Private_View (N);
12745
12746                if Present (Full_View (Typ)) then
12747                   Set_Etype (N2, Full_View (Typ));
12748                end if;
12749             end if;
12750          end Set_Global_Type;
12751
12752          ------------------
12753          -- Top_Ancestor --
12754          ------------------
12755
12756          function Top_Ancestor (E : Entity_Id) return Entity_Id is
12757             Par : Entity_Id;
12758
12759          begin
12760             Par := E;
12761             while Is_Child_Unit (Par) loop
12762                Par := Scope (Par);
12763             end loop;
12764
12765             return Par;
12766          end Top_Ancestor;
12767
12768       --  Start of processing for Reset_Entity
12769
12770       begin
12771          N2 := Get_Associated_Node (N);
12772          E := Entity (N2);
12773
12774          if Present (E) then
12775
12776             --  If the node is an entry call to an entry in an enclosing task,
12777             --  it is rewritten as a selected component. No global entity to
12778             --  preserve in this case, since the expansion will be redone in
12779             --  the instance.
12780
12781             if not Nkind_In (E, N_Defining_Identifier,
12782                                 N_Defining_Character_Literal,
12783                                 N_Defining_Operator_Symbol)
12784             then
12785                Set_Associated_Node (N, Empty);
12786                Set_Etype  (N, Empty);
12787                return;
12788             end if;
12789
12790             --  If the entity is an itype created as a subtype of an access
12791             --  type with a null exclusion restore source entity for proper
12792             --  visibility. The itype will be created anew in the instance.
12793
12794             if Is_Itype (E)
12795               and then Ekind (E) = E_Access_Subtype
12796               and then Is_Entity_Name (N)
12797               and then Chars (Etype (E)) = Chars (N)
12798             then
12799                E := Etype (E);
12800                Set_Entity (N2, E);
12801                Set_Etype  (N2, E);
12802             end if;
12803
12804             if Is_Global (E) then
12805                Set_Global_Type (N, N2);
12806
12807             elsif Nkind (N) = N_Op_Concat
12808               and then Is_Generic_Type (Etype (N2))
12809               and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
12810                          or else
12811                         Base_Type (Etype (Left_Opnd (N2)))  = Etype (N2))
12812               and then Is_Intrinsic_Subprogram (E)
12813             then
12814                null;
12815
12816             else
12817                --  Entity is local. Mark generic node as unresolved.
12818                --  Note that now it does not have an entity.
12819
12820                Set_Associated_Node (N, Empty);
12821                Set_Etype  (N, Empty);
12822             end if;
12823
12824             if Nkind (Parent (N)) in N_Generic_Instantiation
12825               and then N = Name (Parent (N))
12826             then
12827                Save_Global_Defaults (Parent (N), Parent (N2));
12828             end if;
12829
12830          elsif Nkind (Parent (N)) = N_Selected_Component
12831            and then Nkind (Parent (N2)) = N_Expanded_Name
12832          then
12833             if Is_Global (Entity (Parent (N2))) then
12834                Change_Selected_Component_To_Expanded_Name (Parent (N));
12835                Set_Associated_Node (Parent (N), Parent (N2));
12836                Set_Global_Type (Parent (N), Parent (N2));
12837                Save_Entity_Descendants (N);
12838
12839             --  If this is a reference to the current generic entity, replace
12840             --  by the name of the generic homonym of the current package. This
12841             --  is because in an instantiation Par.P.Q will not resolve to the
12842             --  name of the instance, whose enclosing scope is not necessarily
12843             --  Par. We use the generic homonym rather that the name of the
12844             --  generic itself because it may be hidden by a local declaration.
12845
12846             elsif In_Open_Scopes (Entity (Parent (N2)))
12847               and then not
12848                 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
12849             then
12850                if Ekind (Entity (Parent (N2))) = E_Generic_Package then
12851                   Rewrite (Parent (N),
12852                     Make_Identifier (Sloc (N),
12853                       Chars =>
12854                         Chars (Generic_Homonym (Entity (Parent (N2))))));
12855                else
12856                   Rewrite (Parent (N),
12857                     Make_Identifier (Sloc (N),
12858                       Chars => Chars (Selector_Name (Parent (N2)))));
12859                end if;
12860             end if;
12861
12862             if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
12863               and then Parent (N) = Name (Parent (Parent (N)))
12864             then
12865                Save_Global_Defaults
12866                  (Parent (Parent (N)), Parent (Parent ((N2))));
12867             end if;
12868
12869          --  A selected component may denote a static constant that has been
12870          --  folded. If the static constant is global to the generic, capture
12871          --  its value. Otherwise the folding will happen in any instantiation.
12872
12873          elsif Nkind (Parent (N)) = N_Selected_Component
12874            and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
12875          then
12876             if Present (Entity (Original_Node (Parent (N2))))
12877               and then Is_Global (Entity (Original_Node (Parent (N2))))
12878             then
12879                Rewrite (Parent (N), New_Copy (Parent (N2)));
12880                Set_Analyzed (Parent (N), False);
12881
12882             else
12883                null;
12884             end if;
12885
12886          --  A selected component may be transformed into a parameterless
12887          --  function call. If the called entity is global, rewrite the node
12888          --  appropriately, i.e. as an extended name for the global entity.
12889
12890          elsif Nkind (Parent (N)) = N_Selected_Component
12891            and then Nkind (Parent (N2)) = N_Function_Call
12892            and then N = Selector_Name (Parent (N))
12893          then
12894             if No (Parameter_Associations (Parent (N2))) then
12895                if Is_Global (Entity (Name (Parent (N2)))) then
12896                   Change_Selected_Component_To_Expanded_Name (Parent (N));
12897                   Set_Associated_Node (Parent (N), Name (Parent (N2)));
12898                   Set_Global_Type (Parent (N), Name (Parent (N2)));
12899                   Save_Entity_Descendants (N);
12900
12901                else
12902                   Set_Is_Prefixed_Call (Parent (N));
12903                   Set_Associated_Node (N, Empty);
12904                   Set_Etype (N, Empty);
12905                end if;
12906
12907             --  In Ada 2005, X.F may be a call to a primitive operation,
12908             --  rewritten as F (X). This rewriting will be done again in an
12909             --  instance, so keep the original node. Global entities will be
12910             --  captured as for other constructs. Indicate that this must
12911             --  resolve as a call, to prevent accidental overloading in the
12912             --  instance, if both a component and a primitive operation appear
12913             --  as candidates.
12914
12915             else
12916                Set_Is_Prefixed_Call (Parent (N));
12917             end if;
12918
12919          --  Entity is local. Reset in generic unit, so that node is resolved
12920          --  anew at the point of instantiation.
12921
12922          else
12923             Set_Associated_Node (N, Empty);
12924             Set_Etype (N, Empty);
12925          end if;
12926       end Reset_Entity;
12927
12928       -----------------------------
12929       -- Save_Entity_Descendants --
12930       -----------------------------
12931
12932       procedure Save_Entity_Descendants (N : Node_Id) is
12933       begin
12934          case Nkind (N) is
12935             when N_Binary_Op =>
12936                Save_Global_Descendant (Union_Id (Left_Opnd (N)));
12937                Save_Global_Descendant (Union_Id (Right_Opnd (N)));
12938
12939             when N_Unary_Op =>
12940                Save_Global_Descendant (Union_Id (Right_Opnd (N)));
12941
12942             when N_Expanded_Name | N_Selected_Component =>
12943                Save_Global_Descendant (Union_Id (Prefix (N)));
12944                Save_Global_Descendant (Union_Id (Selector_Name (N)));
12945
12946             when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
12947                null;
12948
12949             when others =>
12950                raise Program_Error;
12951          end case;
12952       end Save_Entity_Descendants;
12953
12954       --------------------------
12955       -- Save_Global_Defaults --
12956       --------------------------
12957
12958       procedure Save_Global_Defaults (N1, N2 : Node_Id) is
12959          Loc    : constant Source_Ptr := Sloc (N1);
12960          Assoc2 : constant List_Id    := Generic_Associations (N2);
12961          Gen_Id : constant Entity_Id  := Get_Generic_Entity (N2);
12962          Assoc1 : List_Id;
12963          Act1   : Node_Id;
12964          Act2   : Node_Id;
12965          Def    : Node_Id;
12966          Ndec   : Node_Id;
12967          Subp   : Entity_Id;
12968          Actual : Entity_Id;
12969
12970       begin
12971          Assoc1 := Generic_Associations (N1);
12972
12973          if Present (Assoc1) then
12974             Act1 := First (Assoc1);
12975          else
12976             Act1 := Empty;
12977             Set_Generic_Associations (N1, New_List);
12978             Assoc1 := Generic_Associations (N1);
12979          end if;
12980
12981          if Present (Assoc2) then
12982             Act2 := First (Assoc2);
12983          else
12984             return;
12985          end if;
12986
12987          while Present (Act1) and then Present (Act2) loop
12988             Next (Act1);
12989             Next (Act2);
12990          end loop;
12991
12992          --  Find the associations added for default subprograms
12993
12994          if Present (Act2) then
12995             while Nkind (Act2) /= N_Generic_Association
12996               or else No (Entity (Selector_Name (Act2)))
12997               or else not Is_Overloadable (Entity (Selector_Name (Act2)))
12998             loop
12999                Next (Act2);
13000             end loop;
13001
13002             --  Add a similar association if the default is global. The
13003             --  renaming declaration for the actual has been analyzed, and
13004             --  its alias is the program it renames. Link the actual in the
13005             --  original generic tree with the node in the analyzed tree.
13006
13007             while Present (Act2) loop
13008                Subp := Entity (Selector_Name (Act2));
13009                Def  := Explicit_Generic_Actual_Parameter (Act2);
13010
13011                --  Following test is defence against rubbish errors
13012
13013                if No (Alias (Subp)) then
13014                   return;
13015                end if;
13016
13017                --  Retrieve the resolved actual from the renaming declaration
13018                --  created for the instantiated formal.
13019
13020                Actual := Entity (Name (Parent (Parent (Subp))));
13021                Set_Entity (Def, Actual);
13022                Set_Etype (Def, Etype (Actual));
13023
13024                if Is_Global (Actual) then
13025                   Ndec :=
13026                     Make_Generic_Association (Loc,
13027                       Selector_Name => New_Occurrence_Of (Subp, Loc),
13028                         Explicit_Generic_Actual_Parameter =>
13029                           New_Occurrence_Of (Actual, Loc));
13030
13031                   Set_Associated_Node
13032                     (Explicit_Generic_Actual_Parameter (Ndec), Def);
13033
13034                   Append (Ndec, Assoc1);
13035
13036                --  If there are other defaults, add a dummy association in case
13037                --  there are other defaulted formals with the same name.
13038
13039                elsif Present (Next (Act2)) then
13040                   Ndec :=
13041                     Make_Generic_Association (Loc,
13042                       Selector_Name => New_Occurrence_Of (Subp, Loc),
13043                         Explicit_Generic_Actual_Parameter => Empty);
13044
13045                   Append (Ndec, Assoc1);
13046                end if;
13047
13048                Next (Act2);
13049             end loop;
13050          end if;
13051
13052          if Nkind (Name (N1)) = N_Identifier
13053            and then Is_Child_Unit (Gen_Id)
13054            and then Is_Global (Gen_Id)
13055            and then Is_Generic_Unit (Scope (Gen_Id))
13056            and then In_Open_Scopes (Scope (Gen_Id))
13057          then
13058             --  This is an instantiation of a child unit within a sibling, so
13059             --  that the generic parent is in scope. An eventual instance must
13060             --  occur within the scope of an instance of the parent. Make name
13061             --  in instance into an expanded name, to preserve the identifier
13062             --  of the parent, so it can be resolved subsequently.
13063
13064             Rewrite (Name (N2),
13065               Make_Expanded_Name (Loc,
13066                 Chars         => Chars (Gen_Id),
13067                 Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
13068                 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13069             Set_Entity (Name (N2), Gen_Id);
13070
13071             Rewrite (Name (N1),
13072                Make_Expanded_Name (Loc,
13073                 Chars         => Chars (Gen_Id),
13074                 Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
13075                 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13076
13077             Set_Associated_Node (Name (N1), Name (N2));
13078             Set_Associated_Node (Prefix (Name (N1)), Empty);
13079             Set_Associated_Node
13080               (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13081             Set_Etype (Name (N1), Etype (Gen_Id));
13082          end if;
13083
13084       end Save_Global_Defaults;
13085
13086       ----------------------------
13087       -- Save_Global_Descendant --
13088       ----------------------------
13089
13090       procedure Save_Global_Descendant (D : Union_Id) is
13091          N1 : Node_Id;
13092
13093       begin
13094          if D in Node_Range then
13095             if D = Union_Id (Empty) then
13096                null;
13097
13098             elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13099                Save_References (Node_Id (D));
13100             end if;
13101
13102          elsif D in List_Range then
13103             if D = Union_Id (No_List)
13104               or else Is_Empty_List (List_Id (D))
13105             then
13106                null;
13107
13108             else
13109                N1 := First (List_Id (D));
13110                while Present (N1) loop
13111                   Save_References (N1);
13112                   Next (N1);
13113                end loop;
13114             end if;
13115
13116          --  Element list or other non-node field, nothing to do
13117
13118          else
13119             null;
13120          end if;
13121       end Save_Global_Descendant;
13122
13123       ---------------------
13124       -- Save_References --
13125       ---------------------
13126
13127       --  This is the recursive procedure that does the work once the enclosing
13128       --  generic scope has been established. We have to treat specially a
13129       --  number of node rewritings that are required by semantic processing
13130       --  and which change the kind of nodes in the generic copy: typically
13131       --  constant-folding, replacing an operator node by a string literal, or
13132       --  a selected component by an expanded name. In each of those cases, the
13133       --  transformation is propagated to the generic unit.
13134
13135       procedure Save_References (N : Node_Id) is
13136          Loc : constant Source_Ptr := Sloc (N);
13137
13138       begin
13139          if N = Empty then
13140             null;
13141
13142          elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13143             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13144                Reset_Entity (N);
13145
13146             elsif Nkind (N) = N_Operator_Symbol
13147               and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13148             then
13149                Change_Operator_Symbol_To_String_Literal (N);
13150             end if;
13151
13152          elsif Nkind (N) in N_Op then
13153             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13154                if Nkind (N) = N_Op_Concat then
13155                   Set_Is_Component_Left_Opnd (N,
13156                     Is_Component_Left_Opnd (Get_Associated_Node (N)));
13157
13158                   Set_Is_Component_Right_Opnd (N,
13159                     Is_Component_Right_Opnd (Get_Associated_Node (N)));
13160                end if;
13161
13162                Reset_Entity (N);
13163
13164             else
13165                --  Node may be transformed into call to a user-defined operator
13166
13167                N2 := Get_Associated_Node (N);
13168
13169                if Nkind (N2) = N_Function_Call then
13170                   E := Entity (Name (N2));
13171
13172                   if Present (E)
13173                     and then Is_Global (E)
13174                   then
13175                      Set_Etype (N, Etype (N2));
13176                   else
13177                      Set_Associated_Node (N, Empty);
13178                      Set_Etype (N, Empty);
13179                   end if;
13180
13181                elsif Nkind_In (N2, N_Integer_Literal,
13182                                    N_Real_Literal,
13183                                    N_String_Literal)
13184                then
13185                   if Present (Original_Node (N2))
13186                     and then Nkind (Original_Node (N2)) = Nkind (N)
13187                   then
13188
13189                      --  Operation was constant-folded. Whenever possible,
13190                      --  recover semantic information from unfolded node,
13191                      --  for ASIS use.
13192
13193                      Set_Associated_Node (N, Original_Node (N2));
13194
13195                      if Nkind (N) = N_Op_Concat then
13196                         Set_Is_Component_Left_Opnd (N,
13197                           Is_Component_Left_Opnd  (Get_Associated_Node (N)));
13198                         Set_Is_Component_Right_Opnd (N,
13199                           Is_Component_Right_Opnd (Get_Associated_Node (N)));
13200                      end if;
13201
13202                      Reset_Entity (N);
13203
13204                   else
13205                      --  If original node is already modified, propagate
13206                      --  constant-folding to template.
13207
13208                      Rewrite (N, New_Copy (N2));
13209                      Set_Analyzed (N, False);
13210                   end if;
13211
13212                elsif Nkind (N2) = N_Identifier
13213                  and then Ekind (Entity (N2)) = E_Enumeration_Literal
13214                then
13215                   --  Same if call was folded into a literal, but in this case
13216                   --  retain the entity to avoid spurious ambiguities if it is
13217                   --  overloaded at the point of instantiation or inlining.
13218
13219                   Rewrite (N, New_Copy (N2));
13220                   Set_Analyzed (N, False);
13221                end if;
13222             end if;
13223
13224             --  Complete operands check if node has not been constant-folded
13225
13226             if Nkind (N) in N_Op then
13227                Save_Entity_Descendants (N);
13228             end if;
13229
13230          elsif Nkind (N) = N_Identifier then
13231             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13232
13233                --  If this is a discriminant reference, always save it. It is
13234                --  used in the instance to find the corresponding discriminant
13235                --  positionally rather than by name.
13236
13237                Set_Original_Discriminant
13238                  (N, Original_Discriminant (Get_Associated_Node (N)));
13239                Reset_Entity (N);
13240
13241             else
13242                N2 := Get_Associated_Node (N);
13243
13244                if Nkind (N2) = N_Function_Call then
13245                   E := Entity (Name (N2));
13246
13247                   --  Name resolves to a call to parameterless function. If
13248                   --  original entity is global, mark node as resolved.
13249
13250                   if Present (E)
13251                     and then Is_Global (E)
13252                   then
13253                      Set_Etype (N, Etype (N2));
13254                   else
13255                      Set_Associated_Node (N, Empty);
13256                      Set_Etype (N, Empty);
13257                   end if;
13258
13259                elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13260                  and then Is_Entity_Name (Original_Node (N2))
13261                then
13262                   --  Name resolves to named number that is constant-folded,
13263                   --  We must preserve the original name for ASIS use, and
13264                   --  undo the constant-folding, which will be repeated in
13265                   --  each instance.
13266
13267                   Set_Associated_Node (N, Original_Node (N2));
13268                   Reset_Entity (N);
13269
13270                elsif Nkind (N2) = N_String_Literal then
13271
13272                   --  Name resolves to string literal. Perform the same
13273                   --  replacement in generic.
13274
13275                   Rewrite (N, New_Copy (N2));
13276
13277                elsif Nkind (N2) = N_Explicit_Dereference then
13278
13279                   --  An identifier is rewritten as a dereference if it is the
13280                   --  prefix in an implicit dereference (call or attribute).
13281                   --  The analysis of an instantiation will expand the node
13282                   --  again, so we preserve the original tree but link it to
13283                   --  the resolved entity in case it is global.
13284
13285                   if Is_Entity_Name (Prefix (N2))
13286                     and then Present (Entity (Prefix (N2)))
13287                     and then Is_Global (Entity (Prefix (N2)))
13288                   then
13289                      Set_Associated_Node (N, Prefix (N2));
13290
13291                   elsif Nkind (Prefix (N2)) = N_Function_Call
13292                     and then Is_Global (Entity (Name (Prefix (N2))))
13293                   then
13294                      Rewrite (N,
13295                        Make_Explicit_Dereference (Loc,
13296                           Prefix => Make_Function_Call (Loc,
13297                             Name =>
13298                               New_Occurrence_Of (Entity (Name (Prefix (N2))),
13299                                                  Loc))));
13300
13301                   else
13302                      Set_Associated_Node (N, Empty);
13303                      Set_Etype (N, Empty);
13304                   end if;
13305
13306                --  The subtype mark of a nominally unconstrained object is
13307                --  rewritten as a subtype indication using the bounds of the
13308                --  expression. Recover the original subtype mark.
13309
13310                elsif Nkind (N2) = N_Subtype_Indication
13311                  and then Is_Entity_Name (Original_Node (N2))
13312                then
13313                   Set_Associated_Node (N, Original_Node (N2));
13314                   Reset_Entity (N);
13315
13316                else
13317                   null;
13318                end if;
13319             end if;
13320
13321          elsif Nkind (N) in N_Entity then
13322             null;
13323
13324          else
13325             declare
13326                Qual : Node_Id := Empty;
13327                Typ  : Entity_Id := Empty;
13328                Nam  : Node_Id;
13329
13330                use Atree.Unchecked_Access;
13331                --  This code section is part of implementing an untyped tree
13332                --  traversal, so it needs direct access to node fields.
13333
13334             begin
13335                if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13336                   N2 := Get_Associated_Node (N);
13337
13338                   if No (N2) then
13339                      Typ := Empty;
13340                   else
13341                      Typ := Etype (N2);
13342
13343                      --  In an instance within a generic, use the name of the
13344                      --  actual and not the original generic parameter. If the
13345                      --  actual is global in the current generic it must be
13346                      --  preserved for its instantiation.
13347
13348                      if Nkind (Parent (Typ)) = N_Subtype_Declaration
13349                        and then
13350                          Present (Generic_Parent_Type (Parent (Typ)))
13351                      then
13352                         Typ := Base_Type (Typ);
13353                         Set_Etype (N2, Typ);
13354                      end if;
13355                   end if;
13356
13357                   if No (N2)
13358                     or else No (Typ)
13359                     or else not Is_Global (Typ)
13360                   then
13361                      Set_Associated_Node (N, Empty);
13362
13363                      --  If the aggregate is an actual in a call, it has been
13364                      --  resolved in the current context, to some local type.
13365                      --  The enclosing call may have been disambiguated by the
13366                      --  aggregate, and this disambiguation might fail at
13367                      --  instantiation time because the type to which the
13368                      --  aggregate did resolve is not preserved. In order to
13369                      --  preserve some of this information, we wrap the
13370                      --  aggregate in a qualified expression, using the id of
13371                      --  its type. For further disambiguation we qualify the
13372                      --  type name with its scope (if visible) because both
13373                      --  id's will have corresponding entities in an instance.
13374                      --  This resolves most of the problems with missing type
13375                      --  information on aggregates in instances.
13376
13377                      if Nkind (N2) = Nkind (N)
13378                        and then
13379                          Nkind_In (Parent (N2), N_Procedure_Call_Statement,
13380                                                 N_Function_Call)
13381                        and then Comes_From_Source (Typ)
13382                      then
13383                         if Is_Immediately_Visible (Scope (Typ)) then
13384                            Nam := Make_Selected_Component (Loc,
13385                              Prefix =>
13386                                Make_Identifier (Loc, Chars (Scope (Typ))),
13387                              Selector_Name =>
13388                                Make_Identifier (Loc, Chars (Typ)));
13389                         else
13390                            Nam := Make_Identifier (Loc, Chars (Typ));
13391                         end if;
13392
13393                         Qual :=
13394                           Make_Qualified_Expression (Loc,
13395                             Subtype_Mark => Nam,
13396                             Expression => Relocate_Node (N));
13397                      end if;
13398                   end if;
13399
13400                   Save_Global_Descendant (Field1 (N));
13401                   Save_Global_Descendant (Field2 (N));
13402                   Save_Global_Descendant (Field3 (N));
13403                   Save_Global_Descendant (Field5 (N));
13404
13405                   if Present (Qual) then
13406                      Rewrite (N, Qual);
13407                   end if;
13408
13409                --  All other cases than aggregates
13410
13411                else
13412                   Save_Global_Descendant (Field1 (N));
13413                   Save_Global_Descendant (Field2 (N));
13414                   Save_Global_Descendant (Field3 (N));
13415                   Save_Global_Descendant (Field4 (N));
13416                   Save_Global_Descendant (Field5 (N));
13417                end if;
13418             end;
13419          end if;
13420
13421          --  If a node has aspects, references within their expressions must
13422          --  be saved separately, given that they are not directly in the
13423          --  tree.
13424
13425          if Has_Aspects (N) then
13426             declare
13427                Aspect : Node_Id;
13428             begin
13429                Aspect := First (Aspect_Specifications (N));
13430                while Present (Aspect) loop
13431                   Save_Global_References (Expression (Aspect));
13432                   Next (Aspect);
13433                end loop;
13434             end;
13435          end if;
13436       end Save_References;
13437
13438    --  Start of processing for Save_Global_References
13439
13440    begin
13441       Gen_Scope := Current_Scope;
13442
13443       --  If the generic unit is a child unit, references to entities in the
13444       --  parent are treated as local, because they will be resolved anew in
13445       --  the context of the instance of the parent.
13446
13447       while Is_Child_Unit (Gen_Scope)
13448         and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13449       loop
13450          Gen_Scope := Scope (Gen_Scope);
13451       end loop;
13452
13453       Save_References (N);
13454    end Save_Global_References;
13455
13456    --------------------------------------
13457    -- Set_Copied_Sloc_For_Inlined_Body --
13458    --------------------------------------
13459
13460    procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13461    begin
13462       Create_Instantiation_Source (N, E, True, S_Adjustment);
13463    end Set_Copied_Sloc_For_Inlined_Body;
13464
13465    ---------------------
13466    -- Set_Instance_Of --
13467    ---------------------
13468
13469    procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13470    begin
13471       Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13472       Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13473       Generic_Renamings.Increment_Last;
13474    end Set_Instance_Of;
13475
13476    --------------------
13477    -- Set_Next_Assoc --
13478    --------------------
13479
13480    procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13481    begin
13482       Generic_Renamings.Table (E).Next_In_HTable := Next;
13483    end Set_Next_Assoc;
13484
13485    -------------------
13486    -- Start_Generic --
13487    -------------------
13488
13489    procedure Start_Generic is
13490    begin
13491       --  ??? More things could be factored out in this routine.
13492       --  Should probably be done at a later stage.
13493
13494       Generic_Flags.Append (Inside_A_Generic);
13495       Inside_A_Generic := True;
13496
13497       Expander_Mode_Save_And_Set (False);
13498    end Start_Generic;
13499
13500    ----------------------
13501    -- Set_Instance_Env --
13502    ----------------------
13503
13504    procedure Set_Instance_Env
13505      (Gen_Unit : Entity_Id;
13506       Act_Unit : Entity_Id)
13507    is
13508    begin
13509       --  Regardless of the current mode, predefined units are analyzed in the
13510       --  most current Ada mode, and earlier version Ada checks do not apply
13511       --  to predefined units. Nothing needs to be done for non-internal units.
13512       --  These are always analyzed in the current mode.
13513
13514       if Is_Internal_File_Name
13515            (Fname              => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13516             Renamings_Included => True)
13517       then
13518          Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13519       end if;
13520
13521       Current_Instantiated_Parent :=
13522         (Gen_Id         => Gen_Unit,
13523          Act_Id         => Act_Unit,
13524          Next_In_HTable => Assoc_Null);
13525    end Set_Instance_Env;
13526
13527    -----------------
13528    -- Switch_View --
13529    -----------------
13530
13531    procedure Switch_View (T : Entity_Id) is
13532       BT        : constant Entity_Id := Base_Type (T);
13533       Priv_Elmt : Elmt_Id := No_Elmt;
13534       Priv_Sub  : Entity_Id;
13535
13536    begin
13537       --  T may be private but its base type may have been exchanged through
13538       --  some other occurrence, in which case there is nothing to switch
13539       --  besides T itself. Note that a private dependent subtype of a private
13540       --  type might not have been switched even if the base type has been,
13541       --  because of the last branch of Check_Private_View (see comment there).
13542
13543       if not Is_Private_Type (BT) then
13544          Prepend_Elmt (Full_View (T), Exchanged_Views);
13545          Exchange_Declarations (T);
13546          return;
13547       end if;
13548
13549       Priv_Elmt := First_Elmt (Private_Dependents (BT));
13550
13551       if Present (Full_View (BT)) then
13552          Prepend_Elmt (Full_View (BT), Exchanged_Views);
13553          Exchange_Declarations (BT);
13554       end if;
13555
13556       while Present (Priv_Elmt) loop
13557          Priv_Sub := (Node (Priv_Elmt));
13558
13559          --  We avoid flipping the subtype if the Etype of its full view is
13560          --  private because this would result in a malformed subtype. This
13561          --  occurs when the Etype of the subtype full view is the full view of
13562          --  the base type (and since the base types were just switched, the
13563          --  subtype is pointing to the wrong view). This is currently the case
13564          --  for tagged record types, access types (maybe more?) and needs to
13565          --  be resolved. ???
13566
13567          if Present (Full_View (Priv_Sub))
13568            and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
13569          then
13570             Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
13571             Exchange_Declarations (Priv_Sub);
13572          end if;
13573
13574          Next_Elmt (Priv_Elmt);
13575       end loop;
13576    end Switch_View;
13577
13578    -----------------
13579    -- True_Parent --
13580    -----------------
13581
13582    function True_Parent (N : Node_Id) return Node_Id is
13583    begin
13584       if Nkind (Parent (N)) = N_Subunit then
13585          return Parent (Corresponding_Stub (Parent (N)));
13586       else
13587          return Parent (N);
13588       end if;
13589    end True_Parent;
13590
13591    -----------------------------
13592    -- Valid_Default_Attribute --
13593    -----------------------------
13594
13595    procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
13596       Attr_Id : constant Attribute_Id :=
13597                   Get_Attribute_Id (Attribute_Name (Def));
13598       T       : constant Entity_Id := Entity (Prefix (Def));
13599       Is_Fun  : constant Boolean := (Ekind (Nam) = E_Function);
13600       F       : Entity_Id;
13601       Num_F   : Int;
13602       OK      : Boolean;
13603
13604    begin
13605       if No (T)
13606         or else T = Any_Id
13607       then
13608          return;
13609       end if;
13610
13611       Num_F := 0;
13612       F := First_Formal (Nam);
13613       while Present (F) loop
13614          Num_F := Num_F + 1;
13615          Next_Formal (F);
13616       end loop;
13617
13618       case Attr_Id is
13619          when Attribute_Adjacent |  Attribute_Ceiling   | Attribute_Copy_Sign |
13620               Attribute_Floor    |  Attribute_Fraction  | Attribute_Machine   |
13621               Attribute_Model    |  Attribute_Remainder | Attribute_Rounding  |
13622               Attribute_Unbiased_Rounding  =>
13623             OK := Is_Fun
13624                     and then Num_F = 1
13625                     and then Is_Floating_Point_Type (T);
13626
13627          when Attribute_Image    | Attribute_Pred       | Attribute_Succ |
13628               Attribute_Value    | Attribute_Wide_Image |
13629               Attribute_Wide_Value  =>
13630             OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
13631
13632          when Attribute_Max      |  Attribute_Min  =>
13633             OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
13634
13635          when Attribute_Input =>
13636             OK := (Is_Fun and then Num_F = 1);
13637
13638          when Attribute_Output | Attribute_Read | Attribute_Write =>
13639             OK := (not Is_Fun and then Num_F = 2);
13640
13641          when others =>
13642             OK := False;
13643       end case;
13644
13645       if not OK then
13646          Error_Msg_N ("attribute reference has wrong profile for subprogram",
13647            Def);
13648       end if;
13649    end Valid_Default_Attribute;
13650
13651 end Sem_Ch12;