OSDN Git Service

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