2ae6418baf7268935875cd97375f78135c8edd9c
[platform/upstream/gcc.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-2013, 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 Debug;    use Debug;
29 with Einfo;    use Einfo;
30 with Elists;   use Elists;
31 with Errout;   use Errout;
32 with Expander; use Expander;
33 with Exp_Disp; use Exp_Disp;
34 with Fname;    use Fname;
35 with Fname.UF; use Fname.UF;
36 with Freeze;   use Freeze;
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 with Warnsw;   use Warnsw;
80
81 with GNAT.HTable;
82
83 package body Sem_Ch12 is
84
85    ----------------------------------------------------------
86    -- Implementation of Generic Analysis and Instantiation --
87    ----------------------------------------------------------
88
89    --  GNAT implements generics by macro expansion. No attempt is made to share
90    --  generic instantiations (for now). Analysis of a generic definition does
91    --  not perform any expansion action, but the expander must be called on the
92    --  tree for each instantiation, because the expansion may of course depend
93    --  on the generic actuals. All of this is best achieved as follows:
94    --
95    --  a) Semantic analysis of a generic unit is performed on a copy of the
96    --  tree for the generic unit. All tree modifications that follow analysis
97    --  do not affect the original tree. Links are kept between the original
98    --  tree and the copy, in order to recognize non-local references within
99    --  the generic, and propagate them to each instance (recall that name
100    --  resolution is done on the generic declaration: generics are not really
101    --  macros!). This is summarized in the following diagram:
102
103    --              .-----------.               .----------.
104    --              |  semantic |<--------------|  generic |
105    --              |    copy   |               |    unit  |
106    --              |           |==============>|          |
107    --              |___________|    global     |__________|
108    --                             references     |   |  |
109    --                                            |   |  |
110    --                                          .-----|--|.
111    --                                          |  .-----|---.
112    --                                          |  |  .----------.
113    --                                          |  |  |  generic |
114    --                                          |__|  |          |
115    --                                             |__| instance |
116    --                                                |__________|
117
118    --  b) Each instantiation copies the original tree, and inserts into it a
119    --  series of declarations that describe the mapping between generic formals
120    --  and actuals. For example, a generic In OUT parameter is an object
121    --  renaming of the corresponding actual, etc. Generic IN parameters are
122    --  constant declarations.
123
124    --  c) In order to give the right visibility for these renamings, we use
125    --  a different scheme for package and subprogram instantiations. For
126    --  packages, the list of renamings is inserted into the package
127    --  specification, before the visible declarations of the package. The
128    --  renamings are analyzed before any of the text of the instance, and are
129    --  thus visible at the right place. Furthermore, outside of the instance,
130    --  the generic parameters are visible and denote their corresponding
131    --  actuals.
132
133    --  For subprograms, we create a container package to hold the renamings
134    --  and the subprogram instance itself. Analysis of the package makes the
135    --  renaming declarations visible to the subprogram. After analyzing the
136    --  package, the defining entity for the subprogram is touched-up so that
137    --  it appears declared in the current scope, and not inside the container
138    --  package.
139
140    --  If the instantiation is a compilation unit, the container package is
141    --  given the same name as the subprogram instance. This ensures that
142    --  the elaboration procedure called by the binder, using the compilation
143    --  unit name, calls in fact the elaboration procedure for the package.
144
145    --  Not surprisingly, private types complicate this approach. By saving in
146    --  the original generic object the non-local references, we guarantee that
147    --  the proper entities are referenced at the point of instantiation.
148    --  However, for private types, this by itself does not insure that the
149    --  proper VIEW of the entity is used (the full type may be visible at the
150    --  point of generic definition, but not at instantiation, or vice-versa).
151    --  In  order to reference the proper view, we special-case any reference
152    --  to private types in the generic object, by saving both views, one in
153    --  the generic and one in the semantic copy. At time of instantiation, we
154    --  check whether the two views are consistent, and exchange declarations if
155    --  necessary, in order to restore the correct visibility. Similarly, if
156    --  the instance view is private when the generic view was not, we perform
157    --  the exchange. After completing the instantiation, we restore the
158    --  current visibility. The flag Has_Private_View marks identifiers in the
159    --  the generic unit that require checking.
160
161    --  Visibility within nested generic units requires special handling.
162    --  Consider the following scheme:
163
164    --  type Global is ...         --  outside of generic unit.
165    --  generic ...
166    --  package Outer is
167    --     ...
168    --     type Semi_Global is ... --  global to inner.
169
170    --     generic ...                                         -- 1
171    --     procedure inner (X1 : Global;  X2 : Semi_Global);
172
173    --     procedure in2 is new inner (...);                   -- 4
174    --  end Outer;
175
176    --  package New_Outer is new Outer (...);                  -- 2
177    --  procedure New_Inner is new New_Outer.Inner (...);      -- 3
178
179    --  The semantic analysis of Outer captures all occurrences of Global.
180    --  The semantic analysis of Inner (at 1) captures both occurrences of
181    --  Global and Semi_Global.
182
183    --  At point 2 (instantiation of Outer), we also produce a generic copy
184    --  of Inner, even though Inner is, at that point, not being instantiated.
185    --  (This is just part of the semantic analysis of New_Outer).
186
187    --  Critically, references to Global within Inner must be preserved, while
188    --  references to Semi_Global should not preserved, because they must now
189    --  resolve to an entity within New_Outer. To distinguish between these, we
190    --  use a global variable, Current_Instantiated_Parent, which is set when
191    --  performing a generic copy during instantiation (at 2). This variable is
192    --  used when performing a generic copy that is not an instantiation, but
193    --  that is nested within one, as the occurrence of 1 within 2. The analysis
194    --  of a nested generic only preserves references that are global to the
195    --  enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
196    --  determine whether a reference is external to the given parent.
197
198    --  The instantiation at point 3 requires no special treatment. The method
199    --  works as well for further nestings of generic units, but of course the
200    --  variable Current_Instantiated_Parent must be stacked because nested
201    --  instantiations can occur, e.g. the occurrence of 4 within 2.
202
203    --  The instantiation of package and subprogram bodies is handled in a
204    --  similar manner, except that it is delayed until after semantic
205    --  analysis is complete. In this fashion complex cross-dependencies
206    --  between several package declarations and bodies containing generics
207    --  can be compiled which otherwise would diagnose spurious circularities.
208
209    --  For example, it is possible to compile two packages A and B that
210    --  have the following structure:
211
212    --    package A is                         package B is
213    --       generic ...                          generic ...
214    --       package G_A is                       package G_B is
215
216    --    with B;                              with A;
217    --    package body A is                    package body B is
218    --       package N_B is new G_B (..)          package N_A is new G_A (..)
219
220    --  The table Pending_Instantiations in package Inline is used to keep
221    --  track of body instantiations that are delayed in this manner. Inline
222    --  handles the actual calls to do the body instantiations. This activity
223    --  is part of Inline, since the processing occurs at the same point, and
224    --  for essentially the same reason, as the handling of inlined routines.
225
226    ----------------------------------------------
227    -- Detection of Instantiation Circularities --
228    ----------------------------------------------
229
230    --  If we have a chain of instantiations that is circular, this is static
231    --  error which must be detected at compile time. The detection of these
232    --  circularities is carried out at the point that we insert a generic
233    --  instance spec or body. If there is a circularity, then the analysis of
234    --  the offending spec or body will eventually result in trying to load the
235    --  same unit again, and we detect this problem as we analyze the package
236    --  instantiation for the second time.
237
238    --  At least in some cases after we have detected the circularity, we get
239    --  into trouble if we try to keep going. The following flag is set if a
240    --  circularity is detected, and used to abandon compilation after the
241    --  messages have been posted.
242
243    Circularity_Detected : Boolean := False;
244    --  This should really be reset on encountering a new main unit, but in
245    --  practice we are not using multiple main units so it is not critical.
246
247    -------------------------------------------------
248    -- Formal packages and partial parametrization --
249    -------------------------------------------------
250
251    --  When compiling a generic, a formal package is a local instantiation. If
252    --  declared with a box, its generic formals are visible in the enclosing
253    --  generic. If declared with a partial list of actuals, those actuals that
254    --  are defaulted (covered by an Others clause, or given an explicit box
255    --  initialization) are also visible in the enclosing generic, while those
256    --  that have a corresponding actual are not.
257
258    --  In our source model of instantiation, the same visibility must be
259    --  present in the spec and body of an instance: the names of the formals
260    --  that are defaulted must be made visible within the instance, and made
261    --  invisible (hidden) after the instantiation is complete, so that they
262    --  are not accessible outside of the instance.
263
264    --  In a generic, a formal package is treated like a special instantiation.
265    --  Our Ada 95 compiler handled formals with and without box in different
266    --  ways. With partial parametrization, we use a single model for both.
267    --  We create a package declaration that consists of the specification of
268    --  the generic package, and a set of declarations that map the actuals
269    --  into local renamings, just as we do for bona fide instantiations. For
270    --  defaulted parameters and formals with a box, we copy directly the
271    --  declarations of the formal into this local package. The result is a
272    --  a package whose visible declarations may include generic formals. This
273    --  package is only used for type checking and visibility analysis, and
274    --  never reaches the back-end, so it can freely violate the placement
275    --  rules for generic formal declarations.
276
277    --  The list of declarations (renamings and copies of formals) is built
278    --  by Analyze_Associations, just as for regular instantiations.
279
280    --  At the point of instantiation, conformance checking must be applied only
281    --  to those parameters that were specified in the formal. We perform this
282    --  checking by creating another internal instantiation, this one including
283    --  only the renamings and the formals (the rest of the package spec is not
284    --  relevant to conformance checking). We can then traverse two lists: the
285    --  list of actuals in the instance that corresponds to the formal package,
286    --  and the list of actuals produced for this bogus instantiation. We apply
287    --  the conformance rules to those actuals that are not defaulted (i.e.
288    --  which still appear as generic formals.
289
290    --  When we compile an instance body we must make the right parameters
291    --  visible again. The predicate Is_Generic_Formal indicates which of the
292    --  formals should have its Is_Hidden flag reset.
293
294    -----------------------
295    -- Local subprograms --
296    -----------------------
297
298    procedure Abandon_Instantiation (N : Node_Id);
299    pragma No_Return (Abandon_Instantiation);
300    --  Posts an error message "instantiation abandoned" at the indicated node
301    --  and then raises the exception Instantiation_Error to do it.
302
303    procedure Analyze_Formal_Array_Type
304      (T   : in out Entity_Id;
305       Def : Node_Id);
306    --  A formal array type is treated like an array type declaration, and
307    --  invokes Array_Type_Declaration (sem_ch3) whose first parameter is
308    --  in-out, because in the case of an anonymous type the entity is
309    --  actually created in the procedure.
310
311    --  The following procedures treat other kinds of formal parameters
312
313    procedure Analyze_Formal_Derived_Interface_Type
314      (N   : Node_Id;
315       T   : Entity_Id;
316       Def : Node_Id);
317
318    procedure Analyze_Formal_Derived_Type
319      (N   : Node_Id;
320       T   : Entity_Id;
321       Def : Node_Id);
322
323    procedure Analyze_Formal_Interface_Type
324      (N   : Node_Id;
325       T   : Entity_Id;
326       Def : Node_Id);
327
328    --  The following subprograms create abbreviated declarations for formal
329    --  scalar types. We introduce an anonymous base of the proper class for
330    --  each of them, and define the formals as constrained first subtypes of
331    --  their bases. The bounds are expressions that are non-static in the
332    --  generic.
333
334    procedure Analyze_Formal_Decimal_Fixed_Point_Type
335                                                 (T : Entity_Id; Def : Node_Id);
336    procedure Analyze_Formal_Discrete_Type       (T : Entity_Id; Def : Node_Id);
337    procedure Analyze_Formal_Floating_Type       (T : Entity_Id; Def : Node_Id);
338    procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
339    procedure Analyze_Formal_Modular_Type        (T : Entity_Id; Def : Node_Id);
340    procedure Analyze_Formal_Ordinary_Fixed_Point_Type
341                                                 (T : Entity_Id; Def : Node_Id);
342
343    procedure Analyze_Formal_Private_Type
344      (N   : Node_Id;
345       T   : Entity_Id;
346       Def : Node_Id);
347    --  Creates a new private type, which does not require completion
348
349    procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
350    --  Ada 2012: Creates a new incomplete type whose actual does not freeze
351
352    procedure Analyze_Generic_Formal_Part (N : Node_Id);
353    --  Analyze generic formal part
354
355    procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
356    --  Create a new access type with the given designated type
357
358    function Analyze_Associations
359      (I_Node  : Node_Id;
360       Formals : List_Id;
361       F_Copy  : List_Id) return List_Id;
362    --  At instantiation time, build the list of associations between formals
363    --  and actuals. Each association becomes a renaming declaration for the
364    --  formal entity. F_Copy is the analyzed list of formals in the generic
365    --  copy. It is used to apply legality checks to the actuals. I_Node is the
366    --  instantiation node itself.
367
368    procedure Analyze_Subprogram_Instantiation
369      (N : Node_Id;
370       K : Entity_Kind);
371
372    procedure Build_Instance_Compilation_Unit_Nodes
373      (N        : Node_Id;
374       Act_Body : Node_Id;
375       Act_Decl : Node_Id);
376    --  This procedure is used in the case where the generic instance of a
377    --  subprogram body or package body is a library unit. In this case, the
378    --  original library unit node for the generic instantiation must be
379    --  replaced by the resulting generic body, and a link made to a new
380    --  compilation unit node for the generic declaration. The argument N is
381    --  the original generic instantiation. Act_Body and Act_Decl are the body
382    --  and declaration of the instance (either package body and declaration
383    --  nodes or subprogram body and declaration nodes depending on the case).
384    --  On return, the node N has been rewritten with the actual body.
385
386    procedure Check_Access_Definition (N : Node_Id);
387    --  Subsidiary routine to null exclusion processing. Perform an assertion
388    --  check on Ada version and the presence of an access definition in N.
389
390    procedure Check_Formal_Packages (P_Id : Entity_Id);
391    --  Apply the following to all formal packages in generic associations
392
393    procedure Check_Formal_Package_Instance
394      (Formal_Pack : Entity_Id;
395       Actual_Pack : Entity_Id);
396    --  Verify that the actuals of the actual instance match the actuals of
397    --  the template for a formal package that is not declared with a box.
398
399    procedure Check_Forward_Instantiation (Decl : Node_Id);
400    --  If the generic is a local entity and the corresponding body has not
401    --  been seen yet, flag enclosing packages to indicate that it will be
402    --  elaborated after the generic body. Subprograms declared in the same
403    --  package cannot be inlined by the front-end because front-end inlining
404    --  requires a strict linear order of elaboration.
405
406    function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
407    --  Check if some association between formals and actuals requires to make
408    --  visible primitives of a tagged type, and make those primitives visible.
409    --  Return the list of primitives whose visibility is modified (to restore
410    --  their visibility later through Restore_Hidden_Primitives). If no
411    --  candidate is found then return No_Elist.
412
413    procedure Check_Hidden_Child_Unit
414      (N           : Node_Id;
415       Gen_Unit    : Entity_Id;
416       Act_Decl_Id : Entity_Id);
417    --  If the generic unit is an implicit child instance within a parent
418    --  instance, we need to make an explicit test that it is not hidden by
419    --  a child instance of the same name and parent.
420
421    procedure Check_Generic_Actuals
422      (Instance      : Entity_Id;
423       Is_Formal_Box : Boolean);
424    --  Similar to previous one. Check the actuals in the instantiation,
425    --  whose views can change between the point of instantiation and the point
426    --  of instantiation of the body. In addition, mark the generic renamings
427    --  as generic actuals, so that they are not compatible with other actuals.
428    --  Recurse on an actual that is a formal package whose declaration has
429    --  a box.
430
431    function Contains_Instance_Of
432      (Inner : Entity_Id;
433       Outer : Entity_Id;
434       N     : Node_Id) return Boolean;
435    --  Inner is instantiated within the generic Outer. Check whether Inner
436    --  directly or indirectly contains an instance of Outer or of one of its
437    --  parents, in the case of a subunit. Each generic unit holds a list of
438    --  the entities instantiated within (at any depth). This procedure
439    --  determines whether the set of such lists contains a cycle, i.e. an
440    --  illegal circular instantiation.
441
442    function Denotes_Formal_Package
443      (Pack     : Entity_Id;
444       On_Exit  : Boolean := False;
445       Instance : Entity_Id := Empty) return Boolean;
446    --  Returns True if E is a formal package of an enclosing generic, or
447    --  the actual for such a formal in an enclosing instantiation. If such
448    --  a package is used as a formal in an nested generic, or as an actual
449    --  in a nested instantiation, the visibility of ITS formals should not
450    --  be modified. When called from within Restore_Private_Views, the flag
451    --  On_Exit is true, to indicate that the search for a possible enclosing
452    --  instance should ignore the current one. In that case Instance denotes
453    --  the declaration for which this is an actual. This declaration may be
454    --  an instantiation in the source, or the internal instantiation that
455    --  corresponds to the actual for a formal package.
456
457    function Earlier (N1, N2 : Node_Id) return Boolean;
458    --  Yields True if N1 and N2 appear in the same compilation unit,
459    --  ignoring subunits, and if N1 is to the left of N2 in a left-to-right
460    --  traversal of the tree for the unit. Used to determine the placement
461    --  of freeze nodes for instance bodies that may depend on other instances.
462
463    function Find_Actual_Type
464      (Typ       : Entity_Id;
465       Gen_Type  : Entity_Id) return Entity_Id;
466    --  When validating the actual types of a child instance, check whether
467    --  the formal is a formal type of the parent unit, and retrieve the current
468    --  actual for it. Typ is the entity in the analyzed formal type declaration
469    --  (component or index type of an array type, or designated type of an
470    --  access formal) and Gen_Type is the enclosing analyzed formal array
471    --  or access type. The desired actual may be a formal of a parent, or may
472    --  be declared in a formal package of a parent. In both cases it is a
473    --  generic actual type because it appears within a visible instance.
474    --  Finally, it may be declared in a parent unit without being a formal
475    --  of that unit, in which case it must be retrieved by visibility.
476    --  Ambiguities may still arise if two homonyms are declared in two formal
477    --  packages, and the prefix of the formal type may be needed to resolve
478    --  the ambiguity in the instance ???
479
480    function In_Same_Declarative_Part
481      (F_Node : Node_Id;
482       Inst   : Node_Id) return Boolean;
483    --  True if the instantiation Inst and the given freeze_node F_Node appear
484    --  within the same declarative part, ignoring subunits, but with no inter-
485    --  vening subprograms or concurrent units. Used to find the proper plave
486    --  for the freeze node of an instance, when the generic is declared in a
487    --  previous instance. If predicate is true, the freeze node of the instance
488    --  can be placed after the freeze node of the previous instance, Otherwise
489    --  it has to be placed at the end of the current declarative part.
490
491    function In_Main_Context (E : Entity_Id) return Boolean;
492    --  Check whether an instantiation is in the context of the main unit.
493    --  Used to determine whether its body should be elaborated to allow
494    --  front-end inlining.
495
496    procedure Set_Instance_Env
497      (Gen_Unit : Entity_Id;
498       Act_Unit : Entity_Id);
499    --  Save current instance on saved environment, to be used to determine
500    --  the global status of entities in nested instances. Part of Save_Env.
501    --  called after verifying that the generic unit is legal for the instance,
502    --  The procedure also examines whether the generic unit is a predefined
503    --  unit, in order to set configuration switches accordingly. As a result
504    --  the procedure must be called after analyzing and freezing the actuals.
505
506    procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
507    --  Associate analyzed generic parameter with corresponding
508    --  instance. Used for semantic checks at instantiation time.
509
510    function Has_Been_Exchanged (E : Entity_Id) return Boolean;
511    --  Traverse the Exchanged_Views list to see if a type was private
512    --  and has already been flipped during this phase of instantiation.
513
514    procedure Hide_Current_Scope;
515    --  When instantiating a generic child unit, the parent context must be
516    --  present, but the instance and all entities that may be generated
517    --  must be inserted in the current scope. We leave the current scope
518    --  on the stack, but make its entities invisible to avoid visibility
519    --  problems. This is reversed at the end of the instantiation. This is
520    --  not done for the instantiation of the bodies, which only require the
521    --  instances of the generic parents to be in scope.
522
523    procedure Install_Body
524      (Act_Body : Node_Id;
525       N        : Node_Id;
526       Gen_Body : Node_Id;
527       Gen_Decl : Node_Id);
528    --  If the instantiation happens textually before the body of the generic,
529    --  the instantiation of the body must be analyzed after the generic body,
530    --  and not at the point of instantiation. Such early instantiations can
531    --  happen if the generic and the instance appear in  a package declaration
532    --  because the generic body can only appear in the corresponding package
533    --  body. Early instantiations can also appear if generic, instance and
534    --  body are all in the declarative part of a subprogram or entry. Entities
535    --  of packages that are early instantiations are delayed, and their freeze
536    --  node appears after the generic body.
537
538    procedure Insert_Freeze_Node_For_Instance
539      (N      : Node_Id;
540       F_Node : Node_Id);
541    --  N denotes a package or a subprogram instantiation and F_Node is the
542    --  associated freeze node. Insert the freeze node before the first source
543    --  body which follows immediately after N. If no such body is found, the
544    --  freeze node is inserted at the end of the declarative region which
545    --  contains N.
546
547    procedure Freeze_Subprogram_Body
548      (Inst_Node : Node_Id;
549       Gen_Body  : Node_Id;
550       Pack_Id   : Entity_Id);
551    --  The generic body may appear textually after the instance, including
552    --  in the proper body of a stub, or within a different package instance.
553    --  Given that the instance can only be elaborated after the generic, we
554    --  place freeze_nodes for the instance and/or for packages that may enclose
555    --  the instance and the generic, so that the back-end can establish the
556    --  proper order of elaboration.
557
558    procedure Init_Env;
559    --  Establish environment for subsequent instantiation. Separated from
560    --  Save_Env because data-structures for visibility handling must be
561    --  initialized before call to Check_Generic_Child_Unit.
562
563    procedure Install_Formal_Packages (Par : Entity_Id);
564    --  Install the visible part of any formal of the parent that is a formal
565    --  package. Note that for the case of a formal package with a box, this
566    --  includes the formal part of the formal package (12.7(10/2)).
567
568    procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
569    --  When compiling an instance of a child unit the parent (which is
570    --  itself an instance) is an enclosing scope that must be made
571    --  immediately visible. This procedure is also used to install the non-
572    --  generic parent of a generic child unit when compiling its body, so
573    --  that full views of types in the parent are made visible.
574
575    procedure Remove_Parent (In_Body : Boolean := False);
576    --  Reverse effect after instantiation of child is complete
577
578    procedure Install_Hidden_Primitives
579      (Prims_List : in out Elist_Id;
580       Gen_T      : Entity_Id;
581       Act_T      : Entity_Id);
582    --  Remove suffix 'P' from hidden primitives of Act_T to match the
583    --  visibility of primitives of Gen_T. The list of primitives to which
584    --  the suffix is removed is added to Prims_List to restore them later.
585
586    procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
587    --  Restore suffix 'P' to primitives of Prims_List and leave Prims_List
588    --  set to No_Elist.
589
590    procedure Inline_Instance_Body
591      (N        : Node_Id;
592       Gen_Unit : Entity_Id;
593       Act_Decl : Node_Id);
594    --  If front-end inlining is requested, instantiate the package body,
595    --  and preserve the visibility of its compilation unit, to insure
596    --  that successive instantiations succeed.
597
598    --  The functions Instantiate_XXX perform various legality checks and build
599    --  the declarations for instantiated generic parameters. In all of these
600    --  Formal is the entity in the generic unit, Actual is the entity of
601    --  expression in the generic associations, and Analyzed_Formal is the
602    --  formal in the generic copy, which contains the semantic information to
603    --  be used to validate the actual.
604
605    function Instantiate_Object
606      (Formal          : Node_Id;
607       Actual          : Node_Id;
608       Analyzed_Formal : Node_Id) return List_Id;
609
610    function Instantiate_Type
611      (Formal          : Node_Id;
612       Actual          : Node_Id;
613       Analyzed_Formal : Node_Id;
614       Actual_Decls    : List_Id) return List_Id;
615
616    function Instantiate_Formal_Subprogram
617      (Formal          : Node_Id;
618       Actual          : Node_Id;
619       Analyzed_Formal : Node_Id) return Node_Id;
620
621    function Instantiate_Formal_Package
622      (Formal          : Node_Id;
623       Actual          : Node_Id;
624       Analyzed_Formal : Node_Id) return List_Id;
625    --  If the formal package is declared with a box, special visibility rules
626    --  apply to its formals: they are in the visible part of the package. This
627    --  is true in the declarative region of the formal package, that is to say
628    --  in the enclosing generic or instantiation. For an instantiation, the
629    --  parameters of the formal package are made visible in an explicit step.
630    --  Furthermore, if the actual has a visible USE clause, these formals must
631    --  be made potentially use-visible as well. On exit from the enclosing
632    --  instantiation, the reverse must be done.
633
634    --  For a formal package declared without a box, there are conformance rules
635    --  that apply to the actuals in the generic declaration and the actuals of
636    --  the actual package in the enclosing instantiation. The simplest way to
637    --  apply these rules is to repeat the instantiation of the formal package
638    --  in the context of the enclosing instance, and compare the generic
639    --  associations of this instantiation with those of the actual package.
640    --  This internal instantiation only needs to contain the renamings of the
641    --  formals: the visible and private declarations themselves need not be
642    --  created.
643
644    --  In Ada 2005, the formal package may be only partially parameterized.
645    --  In that case the visibility step must make visible those actuals whose
646    --  corresponding formals were given with a box. A final complication
647    --  involves inherited operations from formal derived types, which must
648    --  be visible if the type is.
649
650    function Is_In_Main_Unit (N : Node_Id) return Boolean;
651    --  Test if given node is in the main unit
652
653    procedure Load_Parent_Of_Generic
654      (N             : Node_Id;
655       Spec          : Node_Id;
656       Body_Optional : Boolean := False);
657    --  If the generic appears in a separate non-generic library unit, load the
658    --  corresponding body to retrieve the body of the generic. N is the node
659    --  for the generic instantiation, Spec is the generic package declaration.
660    --
661    --  Body_Optional is a flag that indicates that the body is being loaded to
662    --  ensure that temporaries are generated consistently when there are other
663    --  instances in the current declarative part that precede the one being
664    --  loaded. In that case a missing body is acceptable.
665
666    procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
667    --  Add the context clause of the unit containing a generic unit to a
668    --  compilation unit that is, or contains, an instantiation.
669
670    function Get_Associated_Node (N : Node_Id) return Node_Id;
671    --  In order to propagate semantic information back from the analyzed copy
672    --  to the original generic, we maintain links between selected nodes in the
673    --  generic and their corresponding copies. At the end of generic analysis,
674    --  the routine Save_Global_References traverses the generic tree, examines
675    --  the semantic information, and preserves the links to those nodes that
676    --  contain global information. At instantiation, the information from the
677    --  associated node is placed on the new copy, so that name resolution is
678    --  not repeated.
679    --
680    --  Three kinds of source nodes have associated nodes:
681    --
682    --    a) those that can reference (denote) entities, that is identifiers,
683    --       character literals, expanded_names, operator symbols, operators,
684    --       and attribute reference nodes. These nodes have an Entity field
685    --       and are the set of nodes that are in N_Has_Entity.
686    --
687    --    b) aggregates (N_Aggregate and N_Extension_Aggregate)
688    --
689    --    c) selected components (N_Selected_Component)
690    --
691    --  For the first class, the associated node preserves the entity if it is
692    --  global. If the generic contains nested instantiations, the associated
693    --  node itself has been recopied, and a chain of them must be followed.
694    --
695    --  For aggregates, the associated node allows retrieval of the type, which
696    --  may otherwise not appear in the generic. The view of this type may be
697    --  different between generic and instantiation, and the full view can be
698    --  installed before the instantiation is analyzed. For aggregates of type
699    --  extensions, the same view exchange may have to be performed for some of
700    --  the ancestor types, if their view is private at the point of
701    --  instantiation.
702    --
703    --  Nodes that are selected components in the parse tree may be rewritten
704    --  as expanded names after resolution, and must be treated as potential
705    --  entity holders, which is why they also have an Associated_Node.
706    --
707    --  Nodes that do not come from source, such as freeze nodes, do not appear
708    --  in the generic tree, and need not have an associated node.
709    --
710    --  The associated node is stored in the Associated_Node field. Note that
711    --  this field overlaps Entity, which is fine, because the whole point is
712    --  that we don't need or want the normal Entity field in this situation.
713
714    procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
715    --  Within the generic part, entities in the formal package are
716    --  visible. To validate subsequent type declarations, indicate
717    --  the correspondence between the entities in the analyzed formal,
718    --  and the entities in  the actual package. There are three packages
719    --  involved in the instantiation of a formal package: the parent
720    --  generic P1 which appears in the generic declaration, the fake
721    --  instantiation P2 which appears in the analyzed generic, and whose
722    --  visible entities may be used in subsequent formals, and the actual
723    --  P3 in the instance. To validate subsequent formals, me indicate
724    --  that the entities in P2 are mapped into those of P3. The mapping of
725    --  entities has to be done recursively for nested packages.
726
727    procedure Move_Freeze_Nodes
728      (Out_Of : Entity_Id;
729       After  : Node_Id;
730       L      : List_Id);
731    --  Freeze nodes can be generated in the analysis of a generic unit, but
732    --  will not be seen by the back-end. It is necessary to move those nodes
733    --  to the enclosing scope if they freeze an outer entity. We place them
734    --  at the end of the enclosing generic package, which is semantically
735    --  neutral.
736
737    procedure Preanalyze_Actuals (N : Node_Id);
738    --  Analyze actuals to perform name resolution. Full resolution is done
739    --  later, when the expected types are known, but names have to be captured
740    --  before installing parents of generics, that are not visible for the
741    --  actuals themselves.
742
743    function True_Parent (N : Node_Id) return Node_Id;
744    --  For a subunit, return parent of corresponding stub, else return
745    --  parent of node.
746
747    procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
748    --  Verify that an attribute that appears as the default for a formal
749    --  subprogram is a function or procedure with the correct profile.
750
751    -------------------------------------------
752    -- Data Structures for Generic Renamings --
753    -------------------------------------------
754
755    --  The map Generic_Renamings associates generic entities with their
756    --  corresponding actuals. Currently used to validate type instances. It
757    --  will eventually be used for all generic parameters to eliminate the
758    --  need for overload resolution in the instance.
759
760    type Assoc_Ptr is new Int;
761
762    Assoc_Null : constant Assoc_Ptr := -1;
763
764    type Assoc is record
765       Gen_Id         : Entity_Id;
766       Act_Id         : Entity_Id;
767       Next_In_HTable : Assoc_Ptr;
768    end record;
769
770    package Generic_Renamings is new Table.Table
771      (Table_Component_Type => Assoc,
772       Table_Index_Type     => Assoc_Ptr,
773       Table_Low_Bound      => 0,
774       Table_Initial        => 10,
775       Table_Increment      => 100,
776       Table_Name           => "Generic_Renamings");
777
778    --  Variable to hold enclosing instantiation. When the environment is
779    --  saved for a subprogram inlining, the corresponding Act_Id is empty.
780
781    Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
782
783    --  Hash table for associations
784
785    HTable_Size : constant := 37;
786    type HTable_Range is range 0 .. HTable_Size - 1;
787
788    procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
789    function  Next_Assoc     (E : Assoc_Ptr) return Assoc_Ptr;
790    function Get_Gen_Id      (E : Assoc_Ptr) return Entity_Id;
791    function Hash            (F : Entity_Id) return HTable_Range;
792
793    package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
794       Header_Num => HTable_Range,
795       Element    => Assoc,
796       Elmt_Ptr   => Assoc_Ptr,
797       Null_Ptr   => Assoc_Null,
798       Set_Next   => Set_Next_Assoc,
799       Next       => Next_Assoc,
800       Key        => Entity_Id,
801       Get_Key    => Get_Gen_Id,
802       Hash       => Hash,
803       Equal      => "=");
804
805    Exchanged_Views : Elist_Id;
806    --  This list holds the private views that have been exchanged during
807    --  instantiation to restore the visibility of the generic declaration.
808    --  (see comments above). After instantiation, the current visibility is
809    --  reestablished by means of a traversal of this list.
810
811    Hidden_Entities : Elist_Id;
812    --  This list holds the entities of the current scope that are removed
813    --  from immediate visibility when instantiating a child unit. Their
814    --  visibility is restored in Remove_Parent.
815
816    --  Because instantiations can be recursive, the following must be saved
817    --  on entry and restored on exit from an instantiation (spec or body).
818    --  This is done by the two procedures Save_Env and Restore_Env. For
819    --  package and subprogram instantiations (but not for the body instances)
820    --  the action of Save_Env is done in two steps: Init_Env is called before
821    --  Check_Generic_Child_Unit, because setting the parent instances requires
822    --  that the visibility data structures be properly initialized. Once the
823    --  generic is unit is validated, Set_Instance_Env completes Save_Env.
824
825    Parent_Unit_Visible : Boolean := False;
826    --  Parent_Unit_Visible is used when the generic is a child unit, and
827    --  indicates whether the ultimate parent of the generic is visible in the
828    --  instantiation environment. It is used to reset the visibility of the
829    --  parent at the end of the instantiation (see Remove_Parent).
830
831    Instance_Parent_Unit : Entity_Id := Empty;
832    --  This records the ultimate parent unit of an instance of a generic
833    --  child unit and is used in conjunction with Parent_Unit_Visible to
834    --  indicate the unit to which the Parent_Unit_Visible flag corresponds.
835
836    type Instance_Env is record
837       Instantiated_Parent  : Assoc;
838       Exchanged_Views      : Elist_Id;
839       Hidden_Entities      : Elist_Id;
840       Current_Sem_Unit     : Unit_Number_Type;
841       Parent_Unit_Visible  : Boolean   := False;
842       Instance_Parent_Unit : Entity_Id := Empty;
843       Switches             : Config_Switches_Type;
844    end record;
845
846    package Instance_Envs is new Table.Table (
847      Table_Component_Type => Instance_Env,
848      Table_Index_Type     => Int,
849      Table_Low_Bound      => 0,
850      Table_Initial        => 32,
851      Table_Increment      => 100,
852      Table_Name           => "Instance_Envs");
853
854    procedure Restore_Private_Views
855      (Pack_Id    : Entity_Id;
856       Is_Package : Boolean := True);
857    --  Restore the private views of external types, and unmark the generic
858    --  renamings of actuals, so that they become compatible subtypes again.
859    --  For subprograms, Pack_Id is the package constructed to hold the
860    --  renamings.
861
862    procedure Switch_View (T : Entity_Id);
863    --  Switch the partial and full views of a type and its private
864    --  dependents (i.e. its subtypes and derived types).
865
866    ------------------------------------
867    -- Structures for Error Reporting --
868    ------------------------------------
869
870    Instantiation_Node : Node_Id;
871    --  Used by subprograms that validate instantiation of formal parameters
872    --  where there might be no actual on which to place the error message.
873    --  Also used to locate the instantiation node for generic subunits.
874
875    Instantiation_Error : exception;
876    --  When there is a semantic error in the generic parameter matching,
877    --  there is no point in continuing the instantiation, because the
878    --  number of cascaded errors is unpredictable. This exception aborts
879    --  the instantiation process altogether.
880
881    S_Adjustment : Sloc_Adjustment;
882    --  Offset created for each node in an instantiation, in order to keep
883    --  track of the source position of the instantiation in each of its nodes.
884    --  A subsequent semantic error or warning on a construct of the instance
885    --  points to both places: the original generic node, and the point of
886    --  instantiation. See Sinput and Sinput.L for additional details.
887
888    ------------------------------------------------------------
889    -- Data structure for keeping track when inside a Generic --
890    ------------------------------------------------------------
891
892    --  The following table is used to save values of the Inside_A_Generic
893    --  flag (see spec of Sem) when they are saved by Start_Generic.
894
895    package Generic_Flags is new Table.Table (
896      Table_Component_Type => Boolean,
897      Table_Index_Type     => Int,
898      Table_Low_Bound      => 0,
899      Table_Initial        => 32,
900      Table_Increment      => 200,
901      Table_Name           => "Generic_Flags");
902
903    ---------------------------
904    -- Abandon_Instantiation --
905    ---------------------------
906
907    procedure Abandon_Instantiation (N : Node_Id) is
908    begin
909       Error_Msg_N ("\instantiation abandoned!", N);
910       raise Instantiation_Error;
911    end Abandon_Instantiation;
912
913    --------------------------
914    -- Analyze_Associations --
915    --------------------------
916
917    function Analyze_Associations
918      (I_Node  : Node_Id;
919       Formals : List_Id;
920       F_Copy  : List_Id) return List_Id
921    is
922       Actuals_To_Freeze : constant Elist_Id  := New_Elmt_List;
923       Assoc             : constant List_Id   := New_List;
924       Default_Actuals   : constant Elist_Id  := New_Elmt_List;
925       Gen_Unit          : constant Entity_Id :=
926                             Defining_Entity (Parent (F_Copy));
927
928       Actuals         : List_Id;
929       Actual          : Node_Id;
930       Analyzed_Formal : Node_Id;
931       First_Named     : Node_Id := Empty;
932       Formal          : Node_Id;
933       Match           : Node_Id;
934       Named           : Node_Id;
935       Saved_Formal    : Node_Id;
936
937       Default_Formals : constant List_Id := New_List;
938       --  If an Others_Choice is present, some of the formals may be defaulted.
939       --  To simplify the treatment of visibility in an instance, we introduce
940       --  individual defaults for each such formal. These defaults are
941       --  appended to the list of associations and replace the Others_Choice.
942
943       Found_Assoc : Node_Id;
944       --  Association for the current formal being match. Empty if there are
945       --  no remaining actuals, or if there is no named association with the
946       --  name of the formal.
947
948       Is_Named_Assoc : Boolean;
949       Num_Matched    : Int := 0;
950       Num_Actuals    : Int := 0;
951
952       Others_Present : Boolean := False;
953       Others_Choice  : Node_Id := Empty;
954       --  In Ada 2005, indicates partial parametrization of a formal
955       --  package. As usual an other association must be last in the list.
956
957       procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
958       --  Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
959       --  cannot have a named association for it. AI05-0025 extends this rule
960       --  to formals of formal packages by AI05-0025, and it also applies to
961       --  box-initialized formals.
962
963       function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
964       --  Determine whether the parameter types and the return type of Subp
965       --  are fully defined at the point of instantiation.
966
967       function Matching_Actual
968         (F   : Entity_Id;
969          A_F : Entity_Id) return Node_Id;
970       --  Find actual that corresponds to a given a formal parameter. If the
971       --  actuals are positional, return the next one, if any. If the actuals
972       --  are named, scan the parameter associations to find the right one.
973       --  A_F is the corresponding entity in the analyzed generic,which is
974       --  placed on the selector name for ASIS use.
975       --
976       --  In Ada 2005, a named association may be given with a box, in which
977       --  case Matching_Actual sets Found_Assoc to the generic association,
978       --  but return Empty for the actual itself. In this case the code below
979       --  creates a corresponding declaration for the formal.
980
981       function Partial_Parametrization return Boolean;
982       --  Ada 2005: if no match is found for a given formal, check if the
983       --  association for it includes a box, or whether the associations
984       --  include an Others clause.
985
986       procedure Process_Default (F : Entity_Id);
987       --  Add a copy of the declaration of generic formal  F to the list of
988       --  associations, and add an explicit box association for F  if there
989       --  is none yet, and the default comes from an Others_Choice.
990
991       function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
992       --  Determine whether Subp renames one of the subprograms defined in the
993       --  generated package Standard.
994
995       procedure Set_Analyzed_Formal;
996       --  Find the node in the generic copy that corresponds to a given formal.
997       --  The semantic information on this node is used to perform legality
998       --  checks on the actuals. Because semantic analysis can introduce some
999       --  anonymous entities or modify the declaration node itself, the
1000       --  correspondence between the two lists is not one-one. In addition to
1001       --  anonymous types, the presence a formal equality will introduce an
1002       --  implicit declaration for the corresponding inequality.
1003
1004       ----------------------------------------
1005       -- Check_Overloaded_Formal_Subprogram --
1006       ----------------------------------------
1007
1008       procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1009          Temp_Formal : Entity_Id;
1010
1011       begin
1012          Temp_Formal := First (Formals);
1013          while Present (Temp_Formal) loop
1014             if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1015               and then Temp_Formal /= Formal
1016               and then
1017                 Chars (Defining_Unit_Name (Specification (Formal))) =
1018                 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1019             then
1020                if Present (Found_Assoc) then
1021                   Error_Msg_N
1022                     ("named association not allowed for overloaded formal",
1023                      Found_Assoc);
1024
1025                else
1026                   Error_Msg_N
1027                     ("named association not allowed for overloaded formal",
1028                      Others_Choice);
1029                end if;
1030
1031                Abandon_Instantiation (Instantiation_Node);
1032             end if;
1033
1034             Next (Temp_Formal);
1035          end loop;
1036       end Check_Overloaded_Formal_Subprogram;
1037
1038       -------------------------------
1039       -- Has_Fully_Defined_Profile --
1040       -------------------------------
1041
1042       function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1043          function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1044          --  Determine whethet type Typ is fully defined
1045
1046          ---------------------------
1047          -- Is_Fully_Defined_Type --
1048          ---------------------------
1049
1050          function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1051          begin
1052             --  A private type without a full view is not fully defined
1053
1054             if Is_Private_Type (Typ)
1055               and then No (Full_View (Typ))
1056             then
1057                return False;
1058
1059             --  An incomplete type is never fully defined
1060
1061             elsif Is_Incomplete_Type (Typ) then
1062                return False;
1063
1064             --  All other types are fully defined
1065
1066             else
1067                return True;
1068             end if;
1069          end Is_Fully_Defined_Type;
1070
1071          --  Local declarations
1072
1073          Param : Entity_Id;
1074
1075       --  Start of processing for Has_Fully_Defined_Profile
1076
1077       begin
1078          --  Check the parameters
1079
1080          Param := First_Formal (Subp);
1081          while Present (Param) loop
1082             if not Is_Fully_Defined_Type (Etype (Param)) then
1083                return False;
1084             end if;
1085
1086             Next_Formal (Param);
1087          end loop;
1088
1089          --  Check the return type
1090
1091          return Is_Fully_Defined_Type (Etype (Subp));
1092       end Has_Fully_Defined_Profile;
1093
1094       ---------------------
1095       -- Matching_Actual --
1096       ---------------------
1097
1098       function Matching_Actual
1099         (F   : Entity_Id;
1100          A_F : Entity_Id) return Node_Id
1101       is
1102          Prev  : Node_Id;
1103          Act   : Node_Id;
1104
1105       begin
1106          Is_Named_Assoc := False;
1107
1108          --  End of list of purely positional parameters
1109
1110          if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1111             Found_Assoc := Empty;
1112             Act         := Empty;
1113
1114          --  Case of positional parameter corresponding to current formal
1115
1116          elsif No (Selector_Name (Actual)) then
1117             Found_Assoc := Actual;
1118             Act :=  Explicit_Generic_Actual_Parameter (Actual);
1119             Num_Matched := Num_Matched + 1;
1120             Next (Actual);
1121
1122          --  Otherwise scan list of named actuals to find the one with the
1123          --  desired name. All remaining actuals have explicit names.
1124
1125          else
1126             Is_Named_Assoc := True;
1127             Found_Assoc := Empty;
1128             Act         := Empty;
1129             Prev        := Empty;
1130
1131             while Present (Actual) loop
1132                if Chars (Selector_Name (Actual)) = Chars (F) then
1133                   Set_Entity (Selector_Name (Actual), A_F);
1134                   Set_Etype  (Selector_Name (Actual), Etype (A_F));
1135                   Generate_Reference (A_F, Selector_Name (Actual));
1136                   Found_Assoc := Actual;
1137                   Act :=  Explicit_Generic_Actual_Parameter (Actual);
1138                   Num_Matched := Num_Matched + 1;
1139                   exit;
1140                end if;
1141
1142                Prev := Actual;
1143                Next (Actual);
1144             end loop;
1145
1146             --  Reset for subsequent searches. In most cases the named
1147             --  associations are in order. If they are not, we reorder them
1148             --  to avoid scanning twice the same actual. This is not just a
1149             --  question of efficiency: there may be multiple defaults with
1150             --  boxes that have the same name. In a nested instantiation we
1151             --  insert actuals for those defaults, and cannot rely on their
1152             --  names to disambiguate them.
1153
1154             if Actual = First_Named  then
1155                Next (First_Named);
1156
1157             elsif Present (Actual) then
1158                Insert_Before (First_Named, Remove_Next (Prev));
1159             end if;
1160
1161             Actual := First_Named;
1162          end if;
1163
1164          if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1165             Set_Used_As_Generic_Actual (Entity (Act));
1166          end if;
1167
1168          return Act;
1169       end Matching_Actual;
1170
1171       -----------------------------
1172       -- Partial_Parametrization --
1173       -----------------------------
1174
1175       function Partial_Parametrization return Boolean is
1176       begin
1177          return Others_Present
1178           or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1179       end Partial_Parametrization;
1180
1181       ---------------------
1182       -- Process_Default --
1183       ---------------------
1184
1185       procedure Process_Default (F : Entity_Id)  is
1186          Loc     : constant Source_Ptr := Sloc (I_Node);
1187          F_Id    : constant Entity_Id  := Defining_Entity (F);
1188          Decl    : Node_Id;
1189          Default : Node_Id;
1190          Id      : Entity_Id;
1191
1192       begin
1193          --  Append copy of formal declaration to associations, and create new
1194          --  defining identifier for it.
1195
1196          Decl := New_Copy_Tree (F);
1197          Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1198
1199          if Nkind (F) in N_Formal_Subprogram_Declaration then
1200             Set_Defining_Unit_Name (Specification (Decl), Id);
1201
1202          else
1203             Set_Defining_Identifier (Decl, Id);
1204          end if;
1205
1206          Append (Decl, Assoc);
1207
1208          if No (Found_Assoc) then
1209             Default :=
1210                Make_Generic_Association (Loc,
1211                  Selector_Name => New_Occurrence_Of (Id, Loc),
1212                  Explicit_Generic_Actual_Parameter => Empty);
1213             Set_Box_Present (Default);
1214             Append (Default, Default_Formals);
1215          end if;
1216       end Process_Default;
1217
1218       ---------------------------------
1219       -- Renames_Standard_Subprogram --
1220       ---------------------------------
1221
1222       function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1223          Id : Entity_Id;
1224
1225       begin
1226          Id := Alias (Subp);
1227          while Present (Id) loop
1228             if Scope (Id) = Standard_Standard then
1229                return True;
1230             end if;
1231
1232             Id := Alias (Id);
1233          end loop;
1234
1235          return False;
1236       end Renames_Standard_Subprogram;
1237
1238       -------------------------
1239       -- Set_Analyzed_Formal --
1240       -------------------------
1241
1242       procedure Set_Analyzed_Formal is
1243          Kind : Node_Kind;
1244
1245       begin
1246          while Present (Analyzed_Formal) loop
1247             Kind := Nkind (Analyzed_Formal);
1248
1249             case Nkind (Formal) is
1250
1251                when N_Formal_Subprogram_Declaration =>
1252                   exit when Kind in N_Formal_Subprogram_Declaration
1253                     and then
1254                       Chars
1255                         (Defining_Unit_Name (Specification (Formal))) =
1256                       Chars
1257                         (Defining_Unit_Name (Specification (Analyzed_Formal)));
1258
1259                when N_Formal_Package_Declaration =>
1260                   exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1261                                             N_Generic_Package_Declaration,
1262                                             N_Package_Declaration);
1263
1264                when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1265
1266                when others =>
1267
1268                   --  Skip freeze nodes, and nodes inserted to replace
1269                   --  unrecognized pragmas.
1270
1271                   exit when
1272                     Kind not in N_Formal_Subprogram_Declaration
1273                       and then not Nkind_In (Kind, N_Subprogram_Declaration,
1274                                                    N_Freeze_Entity,
1275                                                    N_Null_Statement,
1276                                                    N_Itype_Reference)
1277                       and then Chars (Defining_Identifier (Formal)) =
1278                                Chars (Defining_Identifier (Analyzed_Formal));
1279             end case;
1280
1281             Next (Analyzed_Formal);
1282          end loop;
1283       end Set_Analyzed_Formal;
1284
1285    --  Start of processing for Analyze_Associations
1286
1287    begin
1288       Actuals := Generic_Associations (I_Node);
1289
1290       if Present (Actuals) then
1291
1292          --  Check for an Others choice, indicating a partial parametrization
1293          --  for a formal package.
1294
1295          Actual := First (Actuals);
1296          while Present (Actual) loop
1297             if Nkind (Actual) = N_Others_Choice then
1298                Others_Present := True;
1299                Others_Choice  := Actual;
1300
1301                if Present (Next (Actual)) then
1302                   Error_Msg_N ("others must be last association", Actual);
1303                end if;
1304
1305                --  This subprogram is used both for formal packages and for
1306                --  instantiations. For the latter, associations must all be
1307                --  explicit.
1308
1309                if Nkind (I_Node) /= N_Formal_Package_Declaration
1310                  and then Comes_From_Source (I_Node)
1311                then
1312                   Error_Msg_N
1313                     ("others association not allowed in an instance",
1314                       Actual);
1315                end if;
1316
1317                --  In any case, nothing to do after the others association
1318
1319                exit;
1320
1321             elsif Box_Present (Actual)
1322               and then Comes_From_Source (I_Node)
1323               and then Nkind (I_Node) /= N_Formal_Package_Declaration
1324             then
1325                Error_Msg_N
1326                  ("box association not allowed in an instance", Actual);
1327             end if;
1328
1329             Next (Actual);
1330          end loop;
1331
1332          --  If named associations are present, save first named association
1333          --  (it may of course be Empty) to facilitate subsequent name search.
1334
1335          First_Named := First (Actuals);
1336          while Present (First_Named)
1337            and then Nkind (First_Named) /= N_Others_Choice
1338            and then No (Selector_Name (First_Named))
1339          loop
1340             Num_Actuals := Num_Actuals + 1;
1341             Next (First_Named);
1342          end loop;
1343       end if;
1344
1345       Named := First_Named;
1346       while Present (Named) loop
1347          if Nkind (Named) /= N_Others_Choice
1348            and then No (Selector_Name (Named))
1349          then
1350             Error_Msg_N ("invalid positional actual after named one", Named);
1351             Abandon_Instantiation (Named);
1352          end if;
1353
1354          --  A named association may lack an actual parameter, if it was
1355          --  introduced for a default subprogram that turns out to be local
1356          --  to the outer instantiation.
1357
1358          if Nkind (Named) /= N_Others_Choice
1359            and then Present (Explicit_Generic_Actual_Parameter (Named))
1360          then
1361             Num_Actuals := Num_Actuals + 1;
1362          end if;
1363
1364          Next (Named);
1365       end loop;
1366
1367       if Present (Formals) then
1368          Formal := First_Non_Pragma (Formals);
1369          Analyzed_Formal := First_Non_Pragma (F_Copy);
1370
1371          if Present (Actuals) then
1372             Actual := First (Actuals);
1373
1374          --  All formals should have default values
1375
1376          else
1377             Actual := Empty;
1378          end if;
1379
1380          while Present (Formal) loop
1381             Set_Analyzed_Formal;
1382             Saved_Formal := Next_Non_Pragma (Formal);
1383
1384             case Nkind (Formal) is
1385                when N_Formal_Object_Declaration =>
1386                   Match :=
1387                     Matching_Actual (
1388                       Defining_Identifier (Formal),
1389                       Defining_Identifier (Analyzed_Formal));
1390
1391                   if No (Match) and then Partial_Parametrization then
1392                      Process_Default (Formal);
1393                   else
1394                      Append_List
1395                        (Instantiate_Object (Formal, Match, Analyzed_Formal),
1396                         Assoc);
1397                   end if;
1398
1399                when N_Formal_Type_Declaration =>
1400                   Match :=
1401                     Matching_Actual (
1402                       Defining_Identifier (Formal),
1403                       Defining_Identifier (Analyzed_Formal));
1404
1405                   if No (Match) then
1406                      if Partial_Parametrization then
1407                         Process_Default (Formal);
1408
1409                      else
1410                         Error_Msg_Sloc := Sloc (Gen_Unit);
1411                         Error_Msg_NE
1412                           ("missing actual&",
1413                             Instantiation_Node,
1414                               Defining_Identifier (Formal));
1415                         Error_Msg_NE ("\in instantiation of & declared#",
1416                             Instantiation_Node, Gen_Unit);
1417                         Abandon_Instantiation (Instantiation_Node);
1418                      end if;
1419
1420                   else
1421                      Analyze (Match);
1422                      Append_List
1423                        (Instantiate_Type
1424                           (Formal, Match, Analyzed_Formal, Assoc),
1425                         Assoc);
1426
1427                      --  An instantiation is a freeze point for the actuals,
1428                      --  unless this is a rewritten formal package, or the
1429                      --  formal is an Ada 2012 formal incomplete type.
1430
1431                      if Nkind (I_Node) = N_Formal_Package_Declaration
1432                        or else
1433                          (Ada_Version >= Ada_2012
1434                            and then
1435                              Ekind (Defining_Identifier (Analyzed_Formal)) =
1436                                                             E_Incomplete_Type)
1437                      then
1438                         null;
1439
1440                      else
1441                         Append_Elmt (Entity (Match), Actuals_To_Freeze);
1442                      end if;
1443                   end if;
1444
1445                   --  A remote access-to-class-wide type is not a legal actual
1446                   --  for a generic formal of an access type (E.2.2(17/2)).
1447                   --  In GNAT an exception to this rule is introduced when
1448                   --  the formal is marked as remote using implementation
1449                   --  defined aspect/pragma Remote_Access_Type. In that case
1450                   --  the actual must be remote as well.
1451
1452                   --  If the current instantiation is the construction of a
1453                   --  local copy for a formal package the actuals may be
1454                   --  defaulted, and there is no matching actual to check.
1455
1456                   if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1457                     and then
1458                       Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1459                                             N_Access_To_Object_Definition
1460                      and then Present (Match)
1461                   then
1462                      declare
1463                         Formal_Ent : constant Entity_Id :=
1464                                         Defining_Identifier (Analyzed_Formal);
1465                      begin
1466                         if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1467                              = Is_Remote_Types (Formal_Ent)
1468                         then
1469                            --  Remoteness of formal and actual match
1470
1471                            null;
1472
1473                         elsif Is_Remote_Types (Formal_Ent) then
1474
1475                            --  Remote formal, non-remote actual
1476
1477                            Error_Msg_NE
1478                              ("actual for& must be remote", Match, Formal_Ent);
1479
1480                         else
1481                            --  Non-remote formal, remote actual
1482
1483                            Error_Msg_NE
1484                              ("actual for& may not be remote",
1485                               Match, Formal_Ent);
1486                         end if;
1487                      end;
1488                   end if;
1489
1490                when N_Formal_Subprogram_Declaration =>
1491                   Match :=
1492                     Matching_Actual
1493                       (Defining_Unit_Name (Specification (Formal)),
1494                        Defining_Unit_Name (Specification (Analyzed_Formal)));
1495
1496                   --  If the formal subprogram has the same name as another
1497                   --  formal subprogram of the generic, then a named
1498                   --  association is illegal (12.3(9)). Exclude named
1499                   --  associations that are generated for a nested instance.
1500
1501                   if Present (Match)
1502                     and then Is_Named_Assoc
1503                     and then Comes_From_Source (Found_Assoc)
1504                   then
1505                      Check_Overloaded_Formal_Subprogram (Formal);
1506                   end if;
1507
1508                   --  If there is no corresponding actual, this may be case of
1509                   --  partial parametrization, or else the formal has a default
1510                   --  or a box.
1511
1512                   if No (Match) and then Partial_Parametrization then
1513                      Process_Default (Formal);
1514
1515                      if Nkind (I_Node) = N_Formal_Package_Declaration then
1516                         Check_Overloaded_Formal_Subprogram (Formal);
1517                      end if;
1518
1519                   else
1520                      Append_To (Assoc,
1521                        Instantiate_Formal_Subprogram
1522                          (Formal, Match, Analyzed_Formal));
1523
1524                      --  An instantiation is a freeze point for the actuals,
1525                      --  unless this is a rewritten formal package.
1526
1527                      if Nkind (I_Node) /= N_Formal_Package_Declaration
1528                        and then Nkind (Match) = N_Identifier
1529                        and then Is_Subprogram (Entity (Match))
1530
1531                        --  The actual subprogram may rename a routine defined
1532                        --  in Standard. Avoid freezing such renamings because
1533                        --  subprograms coming from Standard cannot be frozen.
1534
1535                        and then
1536                          not Renames_Standard_Subprogram (Entity (Match))
1537
1538                        --  If the actual subprogram comes from a different
1539                        --  unit, it is already frozen, either by a body in
1540                        --  that unit or by the end of the declarative part
1541                        --  of the unit. This check avoids the freezing of
1542                        --  subprograms defined in Standard which are used
1543                        --  as generic actuals.
1544
1545                        and then In_Same_Code_Unit (Entity (Match), I_Node)
1546                        and then Has_Fully_Defined_Profile (Entity (Match))
1547                      then
1548                         --  Mark the subprogram as having a delayed freeze
1549                         --  since this may be an out-of-order action.
1550
1551                         Set_Has_Delayed_Freeze (Entity (Match));
1552                         Append_Elmt (Entity (Match), Actuals_To_Freeze);
1553                      end if;
1554                   end if;
1555
1556                   --  If this is a nested generic, preserve default for later
1557                   --  instantiations.
1558
1559                   if No (Match)
1560                     and then Box_Present (Formal)
1561                   then
1562                      Append_Elmt
1563                        (Defining_Unit_Name (Specification (Last (Assoc))),
1564                         Default_Actuals);
1565                   end if;
1566
1567                when N_Formal_Package_Declaration =>
1568                   Match :=
1569                     Matching_Actual (
1570                       Defining_Identifier (Formal),
1571                       Defining_Identifier (Original_Node (Analyzed_Formal)));
1572
1573                   if No (Match) then
1574                      if Partial_Parametrization then
1575                         Process_Default (Formal);
1576
1577                      else
1578                         Error_Msg_Sloc := Sloc (Gen_Unit);
1579                         Error_Msg_NE
1580                           ("missing actual&",
1581                             Instantiation_Node, Defining_Identifier (Formal));
1582                         Error_Msg_NE ("\in instantiation of & declared#",
1583                             Instantiation_Node, Gen_Unit);
1584
1585                         Abandon_Instantiation (Instantiation_Node);
1586                      end if;
1587
1588                   else
1589                      Analyze (Match);
1590                      Append_List
1591                        (Instantiate_Formal_Package
1592                          (Formal, Match, Analyzed_Formal),
1593                         Assoc);
1594                   end if;
1595
1596                --  For use type and use package appearing in the generic part,
1597                --  we have already copied them, so we can just move them where
1598                --  they belong (we mustn't recopy them since this would mess up
1599                --  the Sloc values).
1600
1601                when N_Use_Package_Clause |
1602                     N_Use_Type_Clause    =>
1603                   if Nkind (Original_Node (I_Node)) =
1604                                      N_Formal_Package_Declaration
1605                   then
1606                      Append (New_Copy_Tree (Formal), Assoc);
1607                   else
1608                      Remove (Formal);
1609                      Append (Formal, Assoc);
1610                   end if;
1611
1612                when others =>
1613                   raise Program_Error;
1614
1615             end case;
1616
1617             Formal := Saved_Formal;
1618             Next_Non_Pragma (Analyzed_Formal);
1619          end loop;
1620
1621          if Num_Actuals > Num_Matched then
1622             Error_Msg_Sloc := Sloc (Gen_Unit);
1623
1624             if Present (Selector_Name (Actual)) then
1625                Error_Msg_NE
1626                  ("unmatched actual&",
1627                     Actual, Selector_Name (Actual));
1628                Error_Msg_NE ("\in instantiation of& declared#",
1629                     Actual, Gen_Unit);
1630             else
1631                Error_Msg_NE
1632                  ("unmatched actual in instantiation of& declared#",
1633                    Actual, Gen_Unit);
1634             end if;
1635          end if;
1636
1637       elsif Present (Actuals) then
1638          Error_Msg_N
1639            ("too many actuals in generic instantiation", Instantiation_Node);
1640       end if;
1641
1642       --  An instantiation freezes all generic actuals. The only exceptions
1643       --  to this are incomplete types and subprograms which are not fully
1644       --  defined at the point of instantiation.
1645
1646       declare
1647          Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1648       begin
1649          while Present (Elmt) loop
1650             Freeze_Before (I_Node, Node (Elmt));
1651             Next_Elmt (Elmt);
1652          end loop;
1653       end;
1654
1655       --  If there are default subprograms, normalize the tree by adding
1656       --  explicit associations for them. This is required if the instance
1657       --  appears within a generic.
1658
1659       declare
1660          Elmt  : Elmt_Id;
1661          Subp  : Entity_Id;
1662          New_D : Node_Id;
1663
1664       begin
1665          Elmt := First_Elmt (Default_Actuals);
1666          while Present (Elmt) loop
1667             if No (Actuals) then
1668                Actuals := New_List;
1669                Set_Generic_Associations (I_Node, Actuals);
1670             end if;
1671
1672             Subp := Node (Elmt);
1673             New_D :=
1674               Make_Generic_Association (Sloc (Subp),
1675                 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1676                   Explicit_Generic_Actual_Parameter =>
1677                     New_Occurrence_Of (Subp, Sloc (Subp)));
1678             Mark_Rewrite_Insertion (New_D);
1679             Append_To (Actuals, New_D);
1680             Next_Elmt (Elmt);
1681          end loop;
1682       end;
1683
1684       --  If this is a formal package, normalize the parameter list by adding
1685       --  explicit box associations for the formals that are covered by an
1686       --  Others_Choice.
1687
1688       if not Is_Empty_List (Default_Formals) then
1689          Append_List (Default_Formals, Formals);
1690       end if;
1691
1692       return Assoc;
1693    end Analyze_Associations;
1694
1695    -------------------------------
1696    -- Analyze_Formal_Array_Type --
1697    -------------------------------
1698
1699    procedure Analyze_Formal_Array_Type
1700      (T   : in out Entity_Id;
1701       Def : Node_Id)
1702    is
1703       DSS : Node_Id;
1704
1705    begin
1706       --  Treated like a non-generic array declaration, with additional
1707       --  semantic checks.
1708
1709       Enter_Name (T);
1710
1711       if Nkind (Def) = N_Constrained_Array_Definition then
1712          DSS := First (Discrete_Subtype_Definitions (Def));
1713          while Present (DSS) loop
1714             if Nkind_In (DSS, N_Subtype_Indication,
1715                               N_Range,
1716                               N_Attribute_Reference)
1717             then
1718                Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1719             end if;
1720
1721             Next (DSS);
1722          end loop;
1723       end if;
1724
1725       Array_Type_Declaration (T, Def);
1726       Set_Is_Generic_Type (Base_Type (T));
1727
1728       if Ekind (Component_Type (T)) = E_Incomplete_Type
1729         and then No (Full_View (Component_Type (T)))
1730       then
1731          Error_Msg_N ("premature usage of incomplete type", Def);
1732
1733       --  Check that range constraint is not allowed on the component type
1734       --  of a generic formal array type (AARM 12.5.3(3))
1735
1736       elsif Is_Internal (Component_Type (T))
1737         and then Present (Subtype_Indication (Component_Definition (Def)))
1738         and then Nkind (Original_Node
1739                          (Subtype_Indication (Component_Definition (Def)))) =
1740                                                          N_Subtype_Indication
1741       then
1742          Error_Msg_N
1743            ("in a formal, a subtype indication can only be "
1744              & "a subtype mark (RM 12.5.3(3))",
1745              Subtype_Indication (Component_Definition (Def)));
1746       end if;
1747
1748    end Analyze_Formal_Array_Type;
1749
1750    ---------------------------------------------
1751    -- Analyze_Formal_Decimal_Fixed_Point_Type --
1752    ---------------------------------------------
1753
1754    --  As for other generic types, we create a valid type representation with
1755    --  legal but arbitrary attributes, whose values are never considered
1756    --  static. For all scalar types we introduce an anonymous base type, with
1757    --  the same attributes. We choose the corresponding integer type to be
1758    --  Standard_Integer.
1759    --  Here and in other similar routines, the Sloc of the generated internal
1760    --  type must be the same as the sloc of the defining identifier of the
1761    --  formal type declaration, to provide proper source navigation.
1762
1763    procedure Analyze_Formal_Decimal_Fixed_Point_Type
1764      (T   : Entity_Id;
1765       Def : Node_Id)
1766    is
1767       Loc : constant Source_Ptr := Sloc (Def);
1768
1769       Base : constant Entity_Id :=
1770                New_Internal_Entity
1771                  (E_Decimal_Fixed_Point_Type,
1772                   Current_Scope,
1773                   Sloc (Defining_Identifier (Parent (Def))), 'G');
1774
1775       Int_Base  : constant Entity_Id := Standard_Integer;
1776       Delta_Val : constant Ureal := Ureal_1;
1777       Digs_Val  : constant Uint  := Uint_6;
1778
1779    begin
1780       Enter_Name (T);
1781
1782       Set_Etype          (Base, Base);
1783       Set_Size_Info      (Base, Int_Base);
1784       Set_RM_Size        (Base, RM_Size (Int_Base));
1785       Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1786       Set_Digits_Value   (Base, Digs_Val);
1787       Set_Delta_Value    (Base, Delta_Val);
1788       Set_Small_Value    (Base, Delta_Val);
1789       Set_Scalar_Range   (Base,
1790         Make_Range (Loc,
1791           Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
1792           High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1793
1794       Set_Is_Generic_Type (Base);
1795       Set_Parent          (Base, Parent (Def));
1796
1797       Set_Ekind          (T, E_Decimal_Fixed_Point_Subtype);
1798       Set_Etype          (T, Base);
1799       Set_Size_Info      (T, Int_Base);
1800       Set_RM_Size        (T, RM_Size (Int_Base));
1801       Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1802       Set_Digits_Value   (T, Digs_Val);
1803       Set_Delta_Value    (T, Delta_Val);
1804       Set_Small_Value    (T, Delta_Val);
1805       Set_Scalar_Range   (T, Scalar_Range (Base));
1806       Set_Is_Constrained (T);
1807
1808       Check_Restriction (No_Fixed_Point, Def);
1809    end Analyze_Formal_Decimal_Fixed_Point_Type;
1810
1811    -------------------------------------------
1812    -- Analyze_Formal_Derived_Interface_Type --
1813    -------------------------------------------
1814
1815    procedure Analyze_Formal_Derived_Interface_Type
1816      (N   : Node_Id;
1817       T   : Entity_Id;
1818       Def : Node_Id)
1819    is
1820       Loc   : constant Source_Ptr := Sloc (Def);
1821
1822    begin
1823       --  Rewrite as a type declaration of a derived type. This ensures that
1824       --  the interface list and primitive operations are properly captured.
1825
1826       Rewrite (N,
1827         Make_Full_Type_Declaration (Loc,
1828           Defining_Identifier => T,
1829           Type_Definition     => Def));
1830       Analyze (N);
1831       Set_Is_Generic_Type (T);
1832    end Analyze_Formal_Derived_Interface_Type;
1833
1834    ---------------------------------
1835    -- Analyze_Formal_Derived_Type --
1836    ---------------------------------
1837
1838    procedure Analyze_Formal_Derived_Type
1839      (N   : Node_Id;
1840       T   : Entity_Id;
1841       Def : Node_Id)
1842    is
1843       Loc      : constant Source_Ptr := Sloc (Def);
1844       Unk_Disc : constant Boolean    := Unknown_Discriminants_Present (N);
1845       New_N    : Node_Id;
1846
1847    begin
1848       Set_Is_Generic_Type (T);
1849
1850       if Private_Present (Def) then
1851          New_N :=
1852            Make_Private_Extension_Declaration (Loc,
1853              Defining_Identifier           => T,
1854              Discriminant_Specifications   => Discriminant_Specifications (N),
1855              Unknown_Discriminants_Present => Unk_Disc,
1856              Subtype_Indication            => Subtype_Mark (Def),
1857              Interface_List                => Interface_List (Def));
1858
1859          Set_Abstract_Present     (New_N, Abstract_Present     (Def));
1860          Set_Limited_Present      (New_N, Limited_Present      (Def));
1861          Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1862
1863       else
1864          New_N :=
1865            Make_Full_Type_Declaration (Loc,
1866              Defining_Identifier => T,
1867              Discriminant_Specifications =>
1868                Discriminant_Specifications (Parent (T)),
1869              Type_Definition =>
1870                Make_Derived_Type_Definition (Loc,
1871                  Subtype_Indication => Subtype_Mark (Def)));
1872
1873          Set_Abstract_Present
1874            (Type_Definition (New_N), Abstract_Present (Def));
1875          Set_Limited_Present
1876            (Type_Definition (New_N), Limited_Present  (Def));
1877       end if;
1878
1879       Rewrite (N, New_N);
1880       Analyze (N);
1881
1882       if Unk_Disc then
1883          if not Is_Composite_Type (T) then
1884             Error_Msg_N
1885               ("unknown discriminants not allowed for elementary types", N);
1886          else
1887             Set_Has_Unknown_Discriminants (T);
1888             Set_Is_Constrained (T, False);
1889          end if;
1890       end if;
1891
1892       --  If the parent type has a known size, so does the formal, which makes
1893       --  legal representation clauses that involve the formal.
1894
1895       Set_Size_Known_At_Compile_Time
1896         (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1897    end Analyze_Formal_Derived_Type;
1898
1899    ----------------------------------
1900    -- Analyze_Formal_Discrete_Type --
1901    ----------------------------------
1902
1903    --  The operations defined for a discrete types are those of an enumeration
1904    --  type. The size is set to an arbitrary value, for use in analyzing the
1905    --  generic unit.
1906
1907    procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1908       Loc : constant Source_Ptr := Sloc (Def);
1909       Lo  : Node_Id;
1910       Hi  : Node_Id;
1911
1912       Base : constant Entity_Id :=
1913                New_Internal_Entity
1914                  (E_Floating_Point_Type, Current_Scope,
1915                   Sloc (Defining_Identifier (Parent (Def))), 'G');
1916
1917    begin
1918       Enter_Name          (T);
1919       Set_Ekind           (T, E_Enumeration_Subtype);
1920       Set_Etype           (T, Base);
1921       Init_Size           (T, 8);
1922       Init_Alignment      (T);
1923       Set_Is_Generic_Type (T);
1924       Set_Is_Constrained  (T);
1925
1926       --  For semantic analysis, the bounds of the type must be set to some
1927       --  non-static value. The simplest is to create attribute nodes for those
1928       --  bounds, that refer to the type itself. These bounds are never
1929       --  analyzed but serve as place-holders.
1930
1931       Lo :=
1932         Make_Attribute_Reference (Loc,
1933           Attribute_Name => Name_First,
1934           Prefix         => New_Reference_To (T, Loc));
1935       Set_Etype (Lo, T);
1936
1937       Hi :=
1938         Make_Attribute_Reference (Loc,
1939           Attribute_Name => Name_Last,
1940           Prefix         => New_Reference_To (T, Loc));
1941       Set_Etype (Hi, T);
1942
1943       Set_Scalar_Range (T,
1944         Make_Range (Loc,
1945           Low_Bound  => Lo,
1946           High_Bound => Hi));
1947
1948       Set_Ekind           (Base, E_Enumeration_Type);
1949       Set_Etype           (Base, Base);
1950       Init_Size           (Base, 8);
1951       Init_Alignment      (Base);
1952       Set_Is_Generic_Type (Base);
1953       Set_Scalar_Range    (Base, Scalar_Range (T));
1954       Set_Parent          (Base, Parent (Def));
1955    end Analyze_Formal_Discrete_Type;
1956
1957    ----------------------------------
1958    -- Analyze_Formal_Floating_Type --
1959    ---------------------------------
1960
1961    procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1962       Base : constant Entity_Id :=
1963                New_Internal_Entity
1964                  (E_Floating_Point_Type, Current_Scope,
1965                   Sloc (Defining_Identifier (Parent (Def))), 'G');
1966
1967    begin
1968       --  The various semantic attributes are taken from the predefined type
1969       --  Float, just so that all of them are initialized. Their values are
1970       --  never used because no constant folding or expansion takes place in
1971       --  the generic itself.
1972
1973       Enter_Name (T);
1974       Set_Ekind          (T, E_Floating_Point_Subtype);
1975       Set_Etype          (T, Base);
1976       Set_Size_Info      (T,              (Standard_Float));
1977       Set_RM_Size        (T, RM_Size      (Standard_Float));
1978       Set_Digits_Value   (T, Digits_Value (Standard_Float));
1979       Set_Scalar_Range   (T, Scalar_Range (Standard_Float));
1980       Set_Is_Constrained (T);
1981
1982       Set_Is_Generic_Type (Base);
1983       Set_Etype           (Base, Base);
1984       Set_Size_Info       (Base,              (Standard_Float));
1985       Set_RM_Size         (Base, RM_Size      (Standard_Float));
1986       Set_Digits_Value    (Base, Digits_Value (Standard_Float));
1987       Set_Scalar_Range    (Base, Scalar_Range (Standard_Float));
1988       Set_Parent          (Base, Parent (Def));
1989
1990       Check_Restriction (No_Floating_Point, Def);
1991    end Analyze_Formal_Floating_Type;
1992
1993    -----------------------------------
1994    -- Analyze_Formal_Interface_Type;--
1995    -----------------------------------
1996
1997    procedure Analyze_Formal_Interface_Type
1998       (N   : Node_Id;
1999        T   : Entity_Id;
2000        Def : Node_Id)
2001    is
2002       Loc   : constant Source_Ptr := Sloc (N);
2003       New_N : Node_Id;
2004
2005    begin
2006       New_N :=
2007         Make_Full_Type_Declaration (Loc,
2008           Defining_Identifier => T,
2009           Type_Definition => Def);
2010
2011       Rewrite (N, New_N);
2012       Analyze (N);
2013       Set_Is_Generic_Type (T);
2014    end Analyze_Formal_Interface_Type;
2015
2016    ---------------------------------
2017    -- Analyze_Formal_Modular_Type --
2018    ---------------------------------
2019
2020    procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2021    begin
2022       --  Apart from their entity kind, generic modular types are treated like
2023       --  signed integer types, and have the same attributes.
2024
2025       Analyze_Formal_Signed_Integer_Type (T, Def);
2026       Set_Ekind (T, E_Modular_Integer_Subtype);
2027       Set_Ekind (Etype (T), E_Modular_Integer_Type);
2028
2029    end Analyze_Formal_Modular_Type;
2030
2031    ---------------------------------------
2032    -- Analyze_Formal_Object_Declaration --
2033    ---------------------------------------
2034
2035    procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2036       E  : constant Node_Id := Default_Expression (N);
2037       Id : constant Node_Id := Defining_Identifier (N);
2038       K  : Entity_Kind;
2039       T  : Node_Id;
2040
2041    begin
2042       Enter_Name (Id);
2043
2044       --  Determine the mode of the formal object
2045
2046       if Out_Present (N) then
2047          K := E_Generic_In_Out_Parameter;
2048
2049          if not In_Present (N) then
2050             Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2051          end if;
2052
2053       else
2054          K := E_Generic_In_Parameter;
2055       end if;
2056
2057       if Present (Subtype_Mark (N)) then
2058          Find_Type (Subtype_Mark (N));
2059          T := Entity (Subtype_Mark (N));
2060
2061          --  Verify that there is no redundant null exclusion
2062
2063          if Null_Exclusion_Present (N) then
2064             if not Is_Access_Type (T) then
2065                Error_Msg_N
2066                  ("null exclusion can only apply to an access type", N);
2067
2068             elsif Can_Never_Be_Null (T) then
2069                Error_Msg_NE
2070                  ("`NOT NULL` not allowed (& already excludes null)",
2071                     N, T);
2072             end if;
2073          end if;
2074
2075       --  Ada 2005 (AI-423): Formal object with an access definition
2076
2077       else
2078          Check_Access_Definition (N);
2079          T := Access_Definition
2080                 (Related_Nod => N,
2081                  N           => Access_Definition (N));
2082       end if;
2083
2084       if Ekind (T) = E_Incomplete_Type then
2085          declare
2086             Error_Node : Node_Id;
2087
2088          begin
2089             if Present (Subtype_Mark (N)) then
2090                Error_Node := Subtype_Mark (N);
2091             else
2092                Check_Access_Definition (N);
2093                Error_Node := Access_Definition (N);
2094             end if;
2095
2096             Error_Msg_N ("premature usage of incomplete type", Error_Node);
2097          end;
2098       end if;
2099
2100       if K = E_Generic_In_Parameter then
2101
2102          --  Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2103
2104          if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2105             Error_Msg_N
2106               ("generic formal of mode IN must not be of limited type", N);
2107             Explain_Limited_Type (T, N);
2108          end if;
2109
2110          if Is_Abstract_Type (T) then
2111             Error_Msg_N
2112               ("generic formal of mode IN must not be of abstract type", N);
2113          end if;
2114
2115          if Present (E) then
2116             Preanalyze_Spec_Expression (E, T);
2117
2118             if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2119                Error_Msg_N
2120                  ("initialization not allowed for limited types", E);
2121                Explain_Limited_Type (T, E);
2122             end if;
2123          end if;
2124
2125          Set_Ekind (Id, K);
2126          Set_Etype (Id, T);
2127
2128       --  Case of generic IN OUT parameter
2129
2130       else
2131          --  If the formal has an unconstrained type, construct its actual
2132          --  subtype, as is done for subprogram formals. In this fashion, all
2133          --  its uses can refer to specific bounds.
2134
2135          Set_Ekind (Id, K);
2136          Set_Etype (Id, T);
2137
2138          if (Is_Array_Type (T)
2139               and then not Is_Constrained (T))
2140            or else
2141             (Ekind (T) = E_Record_Type
2142               and then Has_Discriminants (T))
2143          then
2144             declare
2145                Non_Freezing_Ref : constant Node_Id :=
2146                                     New_Reference_To (Id, Sloc (Id));
2147                Decl : Node_Id;
2148
2149             begin
2150                --  Make sure the actual subtype doesn't generate bogus freezing
2151
2152                Set_Must_Not_Freeze (Non_Freezing_Ref);
2153                Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2154                Insert_Before_And_Analyze (N, Decl);
2155                Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2156             end;
2157          else
2158             Set_Actual_Subtype (Id, T);
2159          end if;
2160
2161          if Present (E) then
2162             Error_Msg_N
2163               ("initialization not allowed for `IN OUT` formals", N);
2164          end if;
2165       end if;
2166
2167       if Has_Aspects (N) then
2168          Analyze_Aspect_Specifications (N, Id);
2169       end if;
2170    end Analyze_Formal_Object_Declaration;
2171
2172    ----------------------------------------------
2173    -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2174    ----------------------------------------------
2175
2176    procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2177      (T   : Entity_Id;
2178       Def : Node_Id)
2179    is
2180       Loc  : constant Source_Ptr := Sloc (Def);
2181       Base : constant Entity_Id :=
2182                New_Internal_Entity
2183                  (E_Ordinary_Fixed_Point_Type, Current_Scope,
2184                   Sloc (Defining_Identifier (Parent (Def))), 'G');
2185
2186    begin
2187       --  The semantic attributes are set for completeness only, their values
2188       --  will never be used, since all properties of the type are non-static.
2189
2190       Enter_Name (T);
2191       Set_Ekind            (T, E_Ordinary_Fixed_Point_Subtype);
2192       Set_Etype            (T, Base);
2193       Set_Size_Info        (T, Standard_Integer);
2194       Set_RM_Size          (T, RM_Size (Standard_Integer));
2195       Set_Small_Value      (T, Ureal_1);
2196       Set_Delta_Value      (T, Ureal_1);
2197       Set_Scalar_Range     (T,
2198         Make_Range (Loc,
2199           Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
2200           High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2201       Set_Is_Constrained   (T);
2202
2203       Set_Is_Generic_Type (Base);
2204       Set_Etype           (Base, Base);
2205       Set_Size_Info       (Base, Standard_Integer);
2206       Set_RM_Size         (Base, RM_Size (Standard_Integer));
2207       Set_Small_Value     (Base, Ureal_1);
2208       Set_Delta_Value     (Base, Ureal_1);
2209       Set_Scalar_Range    (Base, Scalar_Range (T));
2210       Set_Parent          (Base, Parent (Def));
2211
2212       Check_Restriction (No_Fixed_Point, Def);
2213    end Analyze_Formal_Ordinary_Fixed_Point_Type;
2214
2215    ----------------------------------------
2216    -- Analyze_Formal_Package_Declaration --
2217    ----------------------------------------
2218
2219    procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2220       Loc              : constant Source_Ptr := Sloc (N);
2221       Pack_Id          : constant Entity_Id  := Defining_Identifier (N);
2222       Formal           : Entity_Id;
2223       Gen_Id           : constant Node_Id    := Name (N);
2224       Gen_Decl         : Node_Id;
2225       Gen_Unit         : Entity_Id;
2226       New_N            : Node_Id;
2227       Parent_Installed : Boolean := False;
2228       Renaming         : Node_Id;
2229       Parent_Instance  : Entity_Id;
2230       Renaming_In_Par  : Entity_Id;
2231       Associations     : Boolean := True;
2232
2233       Vis_Prims_List : Elist_Id := No_Elist;
2234       --  List of primitives made temporarily visible in the instantiation
2235       --  to match the visibility of the formal type
2236
2237       function Build_Local_Package return Node_Id;
2238       --  The formal package is rewritten so that its parameters are replaced
2239       --  with corresponding declarations. For parameters with bona fide
2240       --  associations these declarations are created by Analyze_Associations
2241       --  as for a regular instantiation. For boxed parameters, we preserve
2242       --  the formal declarations and analyze them, in order to introduce
2243       --  entities of the right kind in the environment of the formal.
2244
2245       -------------------------
2246       -- Build_Local_Package --
2247       -------------------------
2248
2249       function Build_Local_Package return Node_Id is
2250          Decls     : List_Id;
2251          Pack_Decl : Node_Id;
2252
2253       begin
2254          --  Within the formal, the name of the generic package is a renaming
2255          --  of the formal (as for a regular instantiation).
2256
2257          Pack_Decl :=
2258            Make_Package_Declaration (Loc,
2259              Specification =>
2260                Copy_Generic_Node
2261                  (Specification (Original_Node (Gen_Decl)),
2262                     Empty, Instantiating => True));
2263
2264          Renaming := Make_Package_Renaming_Declaration (Loc,
2265              Defining_Unit_Name =>
2266                Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2267              Name => New_Occurrence_Of (Formal, Loc));
2268
2269          if Nkind (Gen_Id) = N_Identifier
2270            and then Chars (Gen_Id) = Chars (Pack_Id)
2271          then
2272             Error_Msg_NE
2273               ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2274          end if;
2275
2276          --  If the formal is declared with a box, or with an others choice,
2277          --  create corresponding declarations for all entities in the formal
2278          --  part, so that names with the proper types are available in the
2279          --  specification of the formal package.
2280
2281          --  On the other hand, if there are no associations, then all the
2282          --  formals must have defaults, and this will be checked by the
2283          --  call to Analyze_Associations.
2284
2285          if Box_Present (N)
2286            or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2287          then
2288             declare
2289                Formal_Decl : Node_Id;
2290
2291             begin
2292                --  TBA : for a formal package, need to recurse ???
2293
2294                Decls := New_List;
2295                Formal_Decl :=
2296                  First
2297                    (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2298                while Present (Formal_Decl) loop
2299                   Append_To
2300                     (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2301                   Next (Formal_Decl);
2302                end loop;
2303             end;
2304
2305          --  If generic associations are present, use Analyze_Associations to
2306          --  create the proper renaming declarations.
2307
2308          else
2309             declare
2310                Act_Tree : constant Node_Id :=
2311                             Copy_Generic_Node
2312                               (Original_Node (Gen_Decl), Empty,
2313                                Instantiating => True);
2314
2315             begin
2316                Generic_Renamings.Set_Last (0);
2317                Generic_Renamings_HTable.Reset;
2318                Instantiation_Node := N;
2319
2320                Decls :=
2321                  Analyze_Associations
2322                    (I_Node  => Original_Node (N),
2323                     Formals => Generic_Formal_Declarations (Act_Tree),
2324                     F_Copy  => Generic_Formal_Declarations (Gen_Decl));
2325
2326                Vis_Prims_List := Check_Hidden_Primitives (Decls);
2327             end;
2328          end if;
2329
2330          Append (Renaming, To => Decls);
2331
2332          --  Add generated declarations ahead of local declarations in
2333          --  the package.
2334
2335          if No (Visible_Declarations (Specification (Pack_Decl))) then
2336             Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2337          else
2338             Insert_List_Before
2339               (First (Visible_Declarations (Specification (Pack_Decl))),
2340                  Decls);
2341          end if;
2342
2343          return Pack_Decl;
2344       end Build_Local_Package;
2345
2346    --  Start of processing for Analyze_Formal_Package_Declaration
2347
2348    begin
2349       Text_IO_Kludge (Gen_Id);
2350
2351       Init_Env;
2352       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2353       Gen_Unit := Entity (Gen_Id);
2354
2355       --  Check for a formal package that is a package renaming
2356
2357       if Present (Renamed_Object (Gen_Unit)) then
2358
2359          --  Indicate that unit is used, before replacing it with renamed
2360          --  entity for use below.
2361
2362          if In_Extended_Main_Source_Unit (N) then
2363             Set_Is_Instantiated (Gen_Unit);
2364             Generate_Reference  (Gen_Unit, N);
2365          end if;
2366
2367          Gen_Unit := Renamed_Object (Gen_Unit);
2368       end if;
2369
2370       if Ekind (Gen_Unit) /= E_Generic_Package then
2371          Error_Msg_N ("expect generic package name", Gen_Id);
2372          Restore_Env;
2373          goto Leave;
2374
2375       elsif  Gen_Unit = Current_Scope then
2376          Error_Msg_N
2377            ("generic package cannot be used as a formal package of itself",
2378              Gen_Id);
2379          Restore_Env;
2380          goto Leave;
2381
2382       elsif In_Open_Scopes (Gen_Unit) then
2383          if Is_Compilation_Unit (Gen_Unit)
2384            and then Is_Child_Unit (Current_Scope)
2385          then
2386             --  Special-case the error when the formal is a parent, and
2387             --  continue analysis to minimize cascaded errors.
2388
2389             Error_Msg_N
2390               ("generic parent cannot be used as formal package "
2391                 & "of a child unit",
2392                 Gen_Id);
2393
2394          else
2395             Error_Msg_N
2396               ("generic package cannot be used as a formal package "
2397                 & "within itself",
2398                 Gen_Id);
2399             Restore_Env;
2400             goto Leave;
2401          end if;
2402       end if;
2403
2404       --  Check that name of formal package does not hide name of generic,
2405       --  or its leading prefix. This check must be done separately because
2406       --  the name of the generic has already been analyzed.
2407
2408       declare
2409          Gen_Name : Entity_Id;
2410
2411       begin
2412          Gen_Name := Gen_Id;
2413          while Nkind (Gen_Name) = N_Expanded_Name loop
2414             Gen_Name := Prefix (Gen_Name);
2415          end loop;
2416
2417          if Chars (Gen_Name) = Chars (Pack_Id) then
2418             Error_Msg_NE
2419              ("& is hidden within declaration of formal package",
2420                Gen_Id, Gen_Name);
2421          end if;
2422       end;
2423
2424       if Box_Present (N)
2425         or else No (Generic_Associations (N))
2426         or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2427       then
2428          Associations := False;
2429       end if;
2430
2431       --  If there are no generic associations, the generic parameters appear
2432       --  as local entities and are instantiated like them. We copy the generic
2433       --  package declaration as if it were an instantiation, and analyze it
2434       --  like a regular package, except that we treat the formals as
2435       --  additional visible components.
2436
2437       Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2438
2439       if In_Extended_Main_Source_Unit (N) then
2440          Set_Is_Instantiated (Gen_Unit);
2441          Generate_Reference  (Gen_Unit, N);
2442       end if;
2443
2444       Formal := New_Copy (Pack_Id);
2445       Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2446
2447       begin
2448          --  Make local generic without formals. The formals will be replaced
2449          --  with internal declarations.
2450
2451          New_N := Build_Local_Package;
2452
2453          --  If there are errors in the parameter list, Analyze_Associations
2454          --  raises Instantiation_Error. Patch the declaration to prevent
2455          --  further exception propagation.
2456
2457       exception
2458          when Instantiation_Error =>
2459
2460             Enter_Name (Formal);
2461             Set_Ekind  (Formal, E_Variable);
2462             Set_Etype  (Formal, Any_Type);
2463             Restore_Hidden_Primitives (Vis_Prims_List);
2464
2465             if Parent_Installed then
2466                Remove_Parent;
2467             end if;
2468
2469             goto Leave;
2470       end;
2471
2472       Rewrite (N, New_N);
2473       Set_Defining_Unit_Name (Specification (New_N), Formal);
2474       Set_Generic_Parent (Specification (N), Gen_Unit);
2475       Set_Instance_Env (Gen_Unit, Formal);
2476       Set_Is_Generic_Instance (Formal);
2477
2478       Enter_Name (Formal);
2479       Set_Ekind  (Formal, E_Package);
2480       Set_Etype  (Formal, Standard_Void_Type);
2481       Set_Inner_Instances (Formal, New_Elmt_List);
2482       Push_Scope  (Formal);
2483
2484       if Is_Child_Unit (Gen_Unit)
2485         and then Parent_Installed
2486       then
2487          --  Similarly, we have to make the name of the formal visible in the
2488          --  parent instance, to resolve properly fully qualified names that
2489          --  may appear in the generic unit. The parent instance has been
2490          --  placed on the scope stack ahead of the current scope.
2491
2492          Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2493
2494          Renaming_In_Par :=
2495            Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2496          Set_Ekind (Renaming_In_Par, E_Package);
2497          Set_Etype (Renaming_In_Par, Standard_Void_Type);
2498          Set_Scope (Renaming_In_Par, Parent_Instance);
2499          Set_Parent (Renaming_In_Par, Parent (Formal));
2500          Set_Renamed_Object (Renaming_In_Par, Formal);
2501          Append_Entity (Renaming_In_Par, Parent_Instance);
2502       end if;
2503
2504       Analyze (Specification (N));
2505
2506       --  The formals for which associations are provided are not visible
2507       --  outside of the formal package. The others are still declared by a
2508       --  formal parameter declaration.
2509
2510       --  If there are no associations, the only local entity to hide is the
2511       --  generated package renaming itself.
2512
2513       declare
2514          E : Entity_Id;
2515
2516       begin
2517          E := First_Entity (Formal);
2518          while Present (E) loop
2519             if Associations
2520               and then not Is_Generic_Formal (E)
2521             then
2522                Set_Is_Hidden (E);
2523             end if;
2524
2525             if Ekind (E) = E_Package
2526               and then Renamed_Entity (E) = Formal
2527             then
2528                Set_Is_Hidden (E);
2529                exit;
2530             end if;
2531
2532             Next_Entity (E);
2533          end loop;
2534       end;
2535
2536       End_Package_Scope (Formal);
2537       Restore_Hidden_Primitives (Vis_Prims_List);
2538
2539       if Parent_Installed then
2540          Remove_Parent;
2541       end if;
2542
2543       Restore_Env;
2544
2545       --  Inside the generic unit, the formal package is a regular package, but
2546       --  no body is needed for it. Note that after instantiation, the defining
2547       --  unit name we need is in the new tree and not in the original (see
2548       --  Package_Instantiation). A generic formal package is an instance, and
2549       --  can be used as an actual for an inner instance.
2550
2551       Set_Has_Completion (Formal, True);
2552
2553       --  Add semantic information to the original defining identifier.
2554       --  for ASIS use.
2555
2556       Set_Ekind (Pack_Id, E_Package);
2557       Set_Etype (Pack_Id, Standard_Void_Type);
2558       Set_Scope (Pack_Id, Scope (Formal));
2559       Set_Has_Completion (Pack_Id, True);
2560
2561    <<Leave>>
2562       if Has_Aspects (N) then
2563          Analyze_Aspect_Specifications (N, Pack_Id);
2564       end if;
2565    end Analyze_Formal_Package_Declaration;
2566
2567    ---------------------------------
2568    -- Analyze_Formal_Private_Type --
2569    ---------------------------------
2570
2571    procedure Analyze_Formal_Private_Type
2572      (N   : Node_Id;
2573       T   : Entity_Id;
2574       Def : Node_Id)
2575    is
2576    begin
2577       New_Private_Type (N, T, Def);
2578
2579       --  Set the size to an arbitrary but legal value
2580
2581       Set_Size_Info (T, Standard_Integer);
2582       Set_RM_Size   (T, RM_Size (Standard_Integer));
2583    end Analyze_Formal_Private_Type;
2584
2585    ------------------------------------
2586    -- Analyze_Formal_Incomplete_Type --
2587    ------------------------------------
2588
2589    procedure Analyze_Formal_Incomplete_Type
2590      (T   : Entity_Id;
2591       Def : Node_Id)
2592    is
2593    begin
2594       Enter_Name (T);
2595       Set_Ekind (T, E_Incomplete_Type);
2596       Set_Etype (T, T);
2597       Set_Private_Dependents (T, New_Elmt_List);
2598
2599       if Tagged_Present (Def) then
2600          Set_Is_Tagged_Type (T);
2601          Make_Class_Wide_Type (T);
2602          Set_Direct_Primitive_Operations (T, New_Elmt_List);
2603       end if;
2604    end Analyze_Formal_Incomplete_Type;
2605
2606    ----------------------------------------
2607    -- Analyze_Formal_Signed_Integer_Type --
2608    ----------------------------------------
2609
2610    procedure Analyze_Formal_Signed_Integer_Type
2611      (T   : Entity_Id;
2612       Def : Node_Id)
2613    is
2614       Base : constant Entity_Id :=
2615                New_Internal_Entity
2616                  (E_Signed_Integer_Type,
2617                   Current_Scope,
2618                   Sloc (Defining_Identifier (Parent (Def))), 'G');
2619
2620    begin
2621       Enter_Name (T);
2622
2623       Set_Ekind          (T, E_Signed_Integer_Subtype);
2624       Set_Etype          (T, Base);
2625       Set_Size_Info      (T, Standard_Integer);
2626       Set_RM_Size        (T, RM_Size (Standard_Integer));
2627       Set_Scalar_Range   (T, Scalar_Range (Standard_Integer));
2628       Set_Is_Constrained (T);
2629
2630       Set_Is_Generic_Type (Base);
2631       Set_Size_Info       (Base, Standard_Integer);
2632       Set_RM_Size         (Base, RM_Size (Standard_Integer));
2633       Set_Etype           (Base, Base);
2634       Set_Scalar_Range    (Base, Scalar_Range (Standard_Integer));
2635       Set_Parent          (Base, Parent (Def));
2636    end Analyze_Formal_Signed_Integer_Type;
2637
2638    -------------------------------------------
2639    -- Analyze_Formal_Subprogram_Declaration --
2640    -------------------------------------------
2641
2642    procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2643       Spec : constant Node_Id   := Specification (N);
2644       Def  : constant Node_Id   := Default_Name (N);
2645       Nam  : constant Entity_Id := Defining_Unit_Name (Spec);
2646       Subp : Entity_Id;
2647
2648    begin
2649       if Nam = Error then
2650          return;
2651       end if;
2652
2653       if Nkind (Nam) = N_Defining_Program_Unit_Name then
2654          Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2655          goto Leave;
2656       end if;
2657
2658       Analyze_Subprogram_Declaration (N);
2659       Set_Is_Formal_Subprogram (Nam);
2660       Set_Has_Completion (Nam);
2661
2662       if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2663          Set_Is_Abstract_Subprogram (Nam);
2664          Set_Is_Dispatching_Operation (Nam);
2665
2666          declare
2667             Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2668          begin
2669             if No (Ctrl_Type) then
2670                Error_Msg_N
2671                  ("abstract formal subprogram must have a controlling type",
2672                   N);
2673
2674             elsif Ada_Version >= Ada_2012
2675               and then Is_Incomplete_Type (Ctrl_Type)
2676             then
2677                Error_Msg_NE
2678                  ("controlling type of abstract formal subprogram cannot " &
2679                      "be incomplete type", N, Ctrl_Type);
2680
2681             else
2682                Check_Controlling_Formals (Ctrl_Type, Nam);
2683             end if;
2684          end;
2685       end if;
2686
2687       --  Default name is resolved at the point of instantiation
2688
2689       if Box_Present (N) then
2690          null;
2691
2692       --  Else default is bound at the point of generic declaration
2693
2694       elsif Present (Def) then
2695          if Nkind (Def) = N_Operator_Symbol then
2696             Find_Direct_Name (Def);
2697
2698          elsif Nkind (Def) /= N_Attribute_Reference then
2699             Analyze (Def);
2700
2701          else
2702             --  For an attribute reference, analyze the prefix and verify
2703             --  that it has the proper profile for the subprogram.
2704
2705             Analyze (Prefix (Def));
2706             Valid_Default_Attribute (Nam, Def);
2707             goto Leave;
2708          end if;
2709
2710          --  Default name may be overloaded, in which case the interpretation
2711          --  with the correct profile must be  selected, as for a renaming.
2712          --  If the definition is an indexed component, it must denote a
2713          --  member of an entry family. If it is a selected component, it
2714          --  can be a protected operation.
2715
2716          if Etype (Def) = Any_Type then
2717             goto Leave;
2718
2719          elsif Nkind (Def) = N_Selected_Component then
2720             if not Is_Overloadable (Entity (Selector_Name (Def))) then
2721                Error_Msg_N ("expect valid subprogram name as default", Def);
2722             end if;
2723
2724          elsif Nkind (Def) = N_Indexed_Component then
2725             if Is_Entity_Name (Prefix (Def)) then
2726                if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2727                   Error_Msg_N ("expect valid subprogram name as default", Def);
2728                end if;
2729
2730             elsif Nkind (Prefix (Def)) = N_Selected_Component then
2731                if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2732                                                           E_Entry_Family
2733                then
2734                   Error_Msg_N ("expect valid subprogram name as default", Def);
2735                end if;
2736
2737             else
2738                Error_Msg_N ("expect valid subprogram name as default", Def);
2739                goto Leave;
2740             end if;
2741
2742          elsif Nkind (Def) = N_Character_Literal then
2743
2744             --  Needs some type checks: subprogram should be parameterless???
2745
2746             Resolve (Def, (Etype (Nam)));
2747
2748          elsif not Is_Entity_Name (Def)
2749            or else not Is_Overloadable (Entity (Def))
2750          then
2751             Error_Msg_N ("expect valid subprogram name as default", Def);
2752             goto Leave;
2753
2754          elsif not Is_Overloaded (Def) then
2755             Subp := Entity (Def);
2756
2757             if Subp = Nam then
2758                Error_Msg_N ("premature usage of formal subprogram", Def);
2759
2760             elsif not Entity_Matches_Spec (Subp, Nam) then
2761                Error_Msg_N ("no visible entity matches specification", Def);
2762             end if;
2763
2764          --  More than one interpretation, so disambiguate as for a renaming
2765
2766          else
2767             declare
2768                I   : Interp_Index;
2769                I1  : Interp_Index := 0;
2770                It  : Interp;
2771                It1 : Interp;
2772
2773             begin
2774                Subp := Any_Id;
2775                Get_First_Interp (Def, I, It);
2776                while Present (It.Nam) loop
2777                   if Entity_Matches_Spec (It.Nam, Nam) then
2778                      if Subp /= Any_Id then
2779                         It1 := Disambiguate (Def, I1, I, Etype (Subp));
2780
2781                         if It1 = No_Interp then
2782                            Error_Msg_N ("ambiguous default subprogram", Def);
2783                         else
2784                            Subp := It1.Nam;
2785                         end if;
2786
2787                         exit;
2788
2789                      else
2790                         I1  := I;
2791                         Subp := It.Nam;
2792                      end if;
2793                   end if;
2794
2795                   Get_Next_Interp (I, It);
2796                end loop;
2797             end;
2798
2799             if Subp /= Any_Id then
2800
2801                --  Subprogram found, generate reference to it
2802
2803                Set_Entity (Def, Subp);
2804                Generate_Reference (Subp, Def);
2805
2806                if Subp = Nam then
2807                   Error_Msg_N ("premature usage of formal subprogram", Def);
2808
2809                elsif Ekind (Subp) /= E_Operator then
2810                   Check_Mode_Conformant (Subp, Nam);
2811                end if;
2812
2813             else
2814                Error_Msg_N ("no visible subprogram matches specification", N);
2815             end if;
2816          end if;
2817       end if;
2818
2819    <<Leave>>
2820       if Has_Aspects (N) then
2821          Analyze_Aspect_Specifications (N, Nam);
2822       end if;
2823
2824    end Analyze_Formal_Subprogram_Declaration;
2825
2826    -------------------------------------
2827    -- Analyze_Formal_Type_Declaration --
2828    -------------------------------------
2829
2830    procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2831       Def : constant Node_Id := Formal_Type_Definition (N);
2832       T   : Entity_Id;
2833
2834    begin
2835       T := Defining_Identifier (N);
2836
2837       if Present (Discriminant_Specifications (N))
2838         and then Nkind (Def) /= N_Formal_Private_Type_Definition
2839       then
2840          Error_Msg_N
2841            ("discriminants not allowed for this formal type", T);
2842       end if;
2843
2844       --  Enter the new name, and branch to specific routine
2845
2846       case Nkind (Def) is
2847          when N_Formal_Private_Type_Definition         =>
2848             Analyze_Formal_Private_Type (N, T, Def);
2849
2850          when N_Formal_Derived_Type_Definition         =>
2851             Analyze_Formal_Derived_Type (N, T, Def);
2852
2853          when N_Formal_Incomplete_Type_Definition         =>
2854             Analyze_Formal_Incomplete_Type (T, Def);
2855
2856          when N_Formal_Discrete_Type_Definition        =>
2857             Analyze_Formal_Discrete_Type (T, Def);
2858
2859          when N_Formal_Signed_Integer_Type_Definition  =>
2860             Analyze_Formal_Signed_Integer_Type (T, Def);
2861
2862          when N_Formal_Modular_Type_Definition         =>
2863             Analyze_Formal_Modular_Type (T, Def);
2864
2865          when N_Formal_Floating_Point_Definition       =>
2866             Analyze_Formal_Floating_Type (T, Def);
2867
2868          when N_Formal_Ordinary_Fixed_Point_Definition =>
2869             Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2870
2871          when N_Formal_Decimal_Fixed_Point_Definition  =>
2872             Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2873
2874          when N_Array_Type_Definition =>
2875             Analyze_Formal_Array_Type (T, Def);
2876
2877          when N_Access_To_Object_Definition            |
2878               N_Access_Function_Definition             |
2879               N_Access_Procedure_Definition            =>
2880             Analyze_Generic_Access_Type (T, Def);
2881
2882          --  Ada 2005: a interface declaration is encoded as an abstract
2883          --  record declaration or a abstract type derivation.
2884
2885          when N_Record_Definition                      =>
2886             Analyze_Formal_Interface_Type (N, T, Def);
2887
2888          when N_Derived_Type_Definition                =>
2889             Analyze_Formal_Derived_Interface_Type (N, T, Def);
2890
2891          when N_Error                                  =>
2892             null;
2893
2894          when others                                   =>
2895             raise Program_Error;
2896
2897       end case;
2898
2899       Set_Is_Generic_Type (T);
2900
2901       if Has_Aspects (N) then
2902          Analyze_Aspect_Specifications (N, T);
2903       end if;
2904    end Analyze_Formal_Type_Declaration;
2905
2906    ------------------------------------
2907    -- Analyze_Function_Instantiation --
2908    ------------------------------------
2909
2910    procedure Analyze_Function_Instantiation (N : Node_Id) is
2911    begin
2912       Analyze_Subprogram_Instantiation (N, E_Function);
2913    end Analyze_Function_Instantiation;
2914
2915    ---------------------------------
2916    -- Analyze_Generic_Access_Type --
2917    ---------------------------------
2918
2919    procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2920    begin
2921       Enter_Name (T);
2922
2923       if Nkind (Def) = N_Access_To_Object_Definition then
2924          Access_Type_Declaration (T, Def);
2925
2926          if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2927            and then No (Full_View (Designated_Type (T)))
2928            and then not Is_Generic_Type (Designated_Type (T))
2929          then
2930             Error_Msg_N ("premature usage of incomplete type", Def);
2931
2932          elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2933             Error_Msg_N
2934               ("only a subtype mark is allowed in a formal", Def);
2935          end if;
2936
2937       else
2938          Access_Subprogram_Declaration (T, Def);
2939       end if;
2940    end Analyze_Generic_Access_Type;
2941
2942    ---------------------------------
2943    -- Analyze_Generic_Formal_Part --
2944    ---------------------------------
2945
2946    procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2947       Gen_Parm_Decl : Node_Id;
2948
2949    begin
2950       --  The generic formals are processed in the scope of the generic unit,
2951       --  where they are immediately visible. The scope is installed by the
2952       --  caller.
2953
2954       Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2955
2956       while Present (Gen_Parm_Decl) loop
2957          Analyze (Gen_Parm_Decl);
2958          Next (Gen_Parm_Decl);
2959       end loop;
2960
2961       Generate_Reference_To_Generic_Formals (Current_Scope);
2962    end Analyze_Generic_Formal_Part;
2963
2964    ------------------------------------------
2965    -- Analyze_Generic_Package_Declaration  --
2966    ------------------------------------------
2967
2968    procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2969       Loc         : constant Source_Ptr := Sloc (N);
2970       Id          : Entity_Id;
2971       New_N       : Node_Id;
2972       Save_Parent : Node_Id;
2973       Renaming    : Node_Id;
2974       Decls       : constant List_Id :=
2975                       Visible_Declarations (Specification (N));
2976       Decl        : Node_Id;
2977
2978    begin
2979       Check_SPARK_Restriction ("generic is not allowed", N);
2980
2981       --  We introduce a renaming of the enclosing package, to have a usable
2982       --  entity as the prefix of an expanded name for a local entity of the
2983       --  form Par.P.Q, where P is the generic package. This is because a local
2984       --  entity named P may hide it, so that the usual visibility rules in
2985       --  the instance will not resolve properly.
2986
2987       Renaming :=
2988         Make_Package_Renaming_Declaration (Loc,
2989           Defining_Unit_Name =>
2990             Make_Defining_Identifier (Loc,
2991              Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2992           Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2993
2994       if Present (Decls) then
2995          Decl := First (Decls);
2996          while Present (Decl)
2997            and then Nkind (Decl) = N_Pragma
2998          loop
2999             Next (Decl);
3000          end loop;
3001
3002          if Present (Decl) then
3003             Insert_Before (Decl, Renaming);
3004          else
3005             Append (Renaming, Visible_Declarations (Specification (N)));
3006          end if;
3007
3008       else
3009          Set_Visible_Declarations (Specification (N), New_List (Renaming));
3010       end if;
3011
3012       --  Create copy of generic unit, and save for instantiation. If the unit
3013       --  is a child unit, do not copy the specifications for the parent, which
3014       --  are not part of the generic tree.
3015
3016       Save_Parent := Parent_Spec (N);
3017       Set_Parent_Spec (N, Empty);
3018
3019       New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3020       Set_Parent_Spec (New_N, Save_Parent);
3021       Rewrite (N, New_N);
3022       Id := Defining_Entity (N);
3023       Generate_Definition (Id);
3024
3025       --  Expansion is not applied to generic units
3026
3027       Start_Generic;
3028
3029       Enter_Name (Id);
3030       Set_Ekind    (Id, E_Generic_Package);
3031       Set_Etype    (Id, Standard_Void_Type);
3032       Set_Contract (Id, Make_Contract (Sloc (Id)));
3033
3034       --  Analyze aspects now, so that generated pragmas appear in the
3035       --  declarations before building and analyzing the generic copy.
3036
3037       if Has_Aspects (N) then
3038          Analyze_Aspect_Specifications (N, Id);
3039       end if;
3040
3041       Push_Scope (Id);
3042       Enter_Generic_Scope (Id);
3043       Set_Inner_Instances (Id, New_Elmt_List);
3044
3045       Set_Categorization_From_Pragmas (N);
3046       Set_Is_Pure (Id, Is_Pure (Current_Scope));
3047
3048       --  Link the declaration of the generic homonym in the generic copy to
3049       --  the package it renames, so that it is always resolved properly.
3050
3051       Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3052       Set_Entity (Associated_Node (Name (Renaming)), Id);
3053
3054       --  For a library unit, we have reconstructed the entity for the unit,
3055       --  and must reset it in the library tables.
3056
3057       if Nkind (Parent (N)) = N_Compilation_Unit then
3058          Set_Cunit_Entity (Current_Sem_Unit, Id);
3059       end if;
3060
3061       Analyze_Generic_Formal_Part (N);
3062
3063       --  After processing the generic formals, analysis proceeds as for a
3064       --  non-generic package.
3065
3066       Analyze (Specification (N));
3067
3068       Validate_Categorization_Dependency (N, Id);
3069
3070       End_Generic;
3071
3072       End_Package_Scope (Id);
3073       Exit_Generic_Scope (Id);
3074
3075       if Nkind (Parent (N)) /= N_Compilation_Unit then
3076          Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3077          Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3078          Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3079
3080       else
3081          Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3082          Validate_RT_RAT_Component (N);
3083
3084          --  If this is a spec without a body, check that generic parameters
3085          --  are referenced.
3086
3087          if not Body_Required (Parent (N)) then
3088             Check_References (Id);
3089          end if;
3090       end if;
3091
3092    end Analyze_Generic_Package_Declaration;
3093
3094    --------------------------------------------
3095    -- Analyze_Generic_Subprogram_Declaration --
3096    --------------------------------------------
3097
3098    procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3099       Spec        : Node_Id;
3100       Id          : Entity_Id;
3101       Formals     : List_Id;
3102       New_N       : Node_Id;
3103       Result_Type : Entity_Id;
3104       Save_Parent : Node_Id;
3105       Typ         : Entity_Id;
3106
3107    begin
3108       Check_SPARK_Restriction ("generic is not allowed", N);
3109
3110       --  Create copy of generic unit, and save for instantiation. If the unit
3111       --  is a child unit, do not copy the specifications for the parent, which
3112       --  are not part of the generic tree.
3113
3114       Save_Parent := Parent_Spec (N);
3115       Set_Parent_Spec (N, Empty);
3116
3117       New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3118       Set_Parent_Spec (New_N, Save_Parent);
3119       Rewrite (N, New_N);
3120
3121       --  The aspect specifications are not attached to the tree, and must
3122       --  be copied and attached to the generic copy explicitly.
3123
3124       if Present (Aspect_Specifications (New_N)) then
3125          declare
3126             Aspects : constant List_Id := Aspect_Specifications (N);
3127          begin
3128             Set_Has_Aspects (N, False);
3129             Move_Aspects (New_N, To => N);
3130             Set_Has_Aspects (Original_Node (N), False);
3131             Set_Aspect_Specifications (Original_Node (N), Aspects);
3132          end;
3133       end if;
3134
3135       Spec := Specification (N);
3136       Id := Defining_Entity (Spec);
3137       Generate_Definition (Id);
3138       Set_Contract (Id, Make_Contract (Sloc (Id)));
3139
3140       if Nkind (Id) = N_Defining_Operator_Symbol then
3141          Error_Msg_N
3142            ("operator symbol not allowed for generic subprogram", Id);
3143       end if;
3144
3145       Start_Generic;
3146
3147       Enter_Name (Id);
3148
3149       Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3150       Push_Scope (Id);
3151       Enter_Generic_Scope (Id);
3152       Set_Inner_Instances (Id, New_Elmt_List);
3153       Set_Is_Pure (Id, Is_Pure (Current_Scope));
3154
3155       Analyze_Generic_Formal_Part (N);
3156
3157       Formals := Parameter_Specifications (Spec);
3158
3159       if Present (Formals) then
3160          Process_Formals (Formals, Spec);
3161       end if;
3162
3163       if Nkind (Spec) = N_Function_Specification then
3164          Set_Ekind (Id, E_Generic_Function);
3165
3166          if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3167             Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3168             Set_Etype (Id, Result_Type);
3169
3170             --  Check restriction imposed by AI05-073: a generic function
3171             --  cannot return an abstract type or an access to such.
3172
3173             --  This is a binding interpretation should it apply to earlier
3174             --  versions of Ada as well as Ada 2012???
3175
3176             if Is_Abstract_Type (Designated_Type (Result_Type))
3177               and then Ada_Version >= Ada_2012
3178             then
3179                Error_Msg_N ("generic function cannot have an access result"
3180                  & " that designates an abstract type", Spec);
3181             end if;
3182
3183          else
3184             Find_Type (Result_Definition (Spec));
3185             Typ := Entity (Result_Definition (Spec));
3186
3187             if Is_Abstract_Type (Typ)
3188               and then Ada_Version >= Ada_2012
3189             then
3190                Error_Msg_N
3191                  ("generic function cannot have abstract result type", Spec);
3192             end if;
3193
3194             --  If a null exclusion is imposed on the result type, then create
3195             --  a null-excluding itype (an access subtype) and use it as the
3196             --  function's Etype.
3197
3198             if Is_Access_Type (Typ)
3199               and then Null_Exclusion_Present (Spec)
3200             then
3201                Set_Etype  (Id,
3202                  Create_Null_Excluding_Itype
3203                    (T           => Typ,
3204                     Related_Nod => Spec,
3205                     Scope_Id    => Defining_Unit_Name (Spec)));
3206             else
3207                Set_Etype (Id, Typ);
3208             end if;
3209          end if;
3210
3211       else
3212          Set_Ekind (Id, E_Generic_Procedure);
3213          Set_Etype (Id, Standard_Void_Type);
3214       end if;
3215
3216       --  For a library unit, we have reconstructed the entity for the unit,
3217       --  and must reset it in the library tables. We also make sure that
3218       --  Body_Required is set properly in the original compilation unit node.
3219
3220       if Nkind (Parent (N)) = N_Compilation_Unit then
3221          Set_Cunit_Entity (Current_Sem_Unit, Id);
3222          Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3223       end if;
3224
3225       Set_Categorization_From_Pragmas (N);
3226       Validate_Categorization_Dependency (N, Id);
3227
3228       Save_Global_References (Original_Node (N));
3229
3230       --  For ASIS purposes, convert any postcondition, precondition pragmas
3231       --  into aspects, if N is not a compilation unit by itself, in order to
3232       --  enable the analysis of expressions inside the corresponding PPC
3233       --  pragmas.
3234
3235       if ASIS_Mode and then Is_List_Member (N) then
3236          Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3237       end if;
3238
3239       --  To capture global references, analyze the expressions of aspects,
3240       --  and propagate information to original tree. Note that in this case
3241       --  analysis of attributes is not delayed until the freeze point.
3242
3243       --  It seems very hard to recreate the proper visibility of the generic
3244       --  subprogram at a later point because the analysis of an aspect may
3245       --  create pragmas after the generic copies have been made ???
3246
3247       if Has_Aspects (N) then
3248          declare
3249             Aspect : Node_Id;
3250
3251          begin
3252             Aspect := First (Aspect_Specifications (N));
3253             while Present (Aspect) loop
3254                if Get_Aspect_Id (Aspect) /= Aspect_Warnings then
3255                   Analyze (Expression (Aspect));
3256                end if;
3257
3258                Next (Aspect);
3259             end loop;
3260
3261             Aspect := First (Aspect_Specifications (Original_Node (N)));
3262             while Present (Aspect) loop
3263                Save_Global_References (Expression (Aspect));
3264                Next (Aspect);
3265             end loop;
3266          end;
3267       end if;
3268
3269       End_Generic;
3270       End_Scope;
3271       Exit_Generic_Scope (Id);
3272       Generate_Reference_To_Formals (Id);
3273
3274       List_Inherited_Pre_Post_Aspects (Id);
3275    end Analyze_Generic_Subprogram_Declaration;
3276
3277    -----------------------------------
3278    -- Analyze_Package_Instantiation --
3279    -----------------------------------
3280
3281    procedure Analyze_Package_Instantiation (N : Node_Id) is
3282       Loc    : constant Source_Ptr := Sloc (N);
3283       Gen_Id : constant Node_Id    := Name (N);
3284
3285       Act_Decl      : Node_Id;
3286       Act_Decl_Name : Node_Id;
3287       Act_Decl_Id   : Entity_Id;
3288       Act_Spec      : Node_Id;
3289       Act_Tree      : Node_Id;
3290
3291       Gen_Decl : Node_Id;
3292       Gen_Unit : Entity_Id;
3293
3294       Is_Actual_Pack : constant Boolean :=
3295                          Is_Internal (Defining_Entity (N));
3296
3297       Env_Installed    : Boolean := False;
3298       Parent_Installed : Boolean := False;
3299       Renaming_List    : List_Id;
3300       Unit_Renaming    : Node_Id;
3301       Needs_Body       : Boolean;
3302       Inline_Now       : Boolean := False;
3303
3304       Save_Style_Check : constant Boolean := Style_Check;
3305       --  Save style check mode for restore on exit
3306
3307       procedure Delay_Descriptors (E : Entity_Id);
3308       --  Delay generation of subprogram descriptors for given entity
3309
3310       function Might_Inline_Subp return Boolean;
3311       --  If inlining is active and the generic contains inlined subprograms,
3312       --  we instantiate the body. This may cause superfluous instantiations,
3313       --  but it is simpler than detecting the need for the body at the point
3314       --  of inlining, when the context of the instance is not available.
3315
3316       function Must_Inline_Subp return Boolean;
3317       --  If inlining is active and the generic contains inlined subprograms,
3318       --  return True if some of the inlined subprograms must be inlined by
3319       --  the frontend.
3320
3321       -----------------------
3322       -- Delay_Descriptors --
3323       -----------------------
3324
3325       procedure Delay_Descriptors (E : Entity_Id) is
3326       begin
3327          if not Delay_Subprogram_Descriptors (E) then
3328             Set_Delay_Subprogram_Descriptors (E);
3329             Pending_Descriptor.Append (E);
3330          end if;
3331       end Delay_Descriptors;
3332
3333       -----------------------
3334       -- Might_Inline_Subp --
3335       -----------------------
3336
3337       function Might_Inline_Subp return Boolean is
3338          E : Entity_Id;
3339
3340       begin
3341          if not Inline_Processing_Required then
3342             return False;
3343
3344          else
3345             E := First_Entity (Gen_Unit);
3346             while Present (E) loop
3347                if Is_Subprogram (E)
3348                  and then Is_Inlined (E)
3349                then
3350                   return True;
3351                end if;
3352
3353                Next_Entity (E);
3354             end loop;
3355          end if;
3356
3357          return False;
3358       end Might_Inline_Subp;
3359
3360       ----------------------
3361       -- Must_Inline_Subp --
3362       ----------------------
3363
3364       function Must_Inline_Subp return Boolean is
3365          E : Entity_Id;
3366
3367       begin
3368          if not Inline_Processing_Required then
3369             return False;
3370
3371          else
3372             E := First_Entity (Gen_Unit);
3373             while Present (E) loop
3374                if Is_Subprogram (E)
3375                  and then Is_Inlined (E)
3376                  and then Must_Inline (E)
3377                then
3378                   return True;
3379                end if;
3380
3381                Next_Entity (E);
3382             end loop;
3383          end if;
3384
3385          return False;
3386       end Must_Inline_Subp;
3387
3388       --  Local declarations
3389
3390       Vis_Prims_List : Elist_Id := No_Elist;
3391       --  List of primitives made temporarily visible in the instantiation
3392       --  to match the visibility of the formal type
3393
3394    --  Start of processing for Analyze_Package_Instantiation
3395
3396    begin
3397       Check_SPARK_Restriction ("generic is not allowed", N);
3398
3399       --  Very first thing: apply the special kludge for Text_IO processing
3400       --  in case we are instantiating one of the children of [Wide_]Text_IO.
3401
3402       Text_IO_Kludge (Name (N));
3403
3404       --  Make node global for error reporting
3405
3406       Instantiation_Node := N;
3407
3408       --  Turn off style checking in instances. If the check is enabled on the
3409       --  generic unit, a warning in an instance would just be noise. If not
3410       --  enabled on the generic, then a warning in an instance is just wrong.
3411
3412       Style_Check := False;
3413
3414       --  Case of instantiation of a generic package
3415
3416       if Nkind (N) = N_Package_Instantiation then
3417          Act_Decl_Id := New_Copy (Defining_Entity (N));
3418          Set_Comes_From_Source (Act_Decl_Id, True);
3419
3420          if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3421             Act_Decl_Name :=
3422               Make_Defining_Program_Unit_Name (Loc,
3423                 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3424                 Defining_Identifier => Act_Decl_Id);
3425          else
3426             Act_Decl_Name :=  Act_Decl_Id;
3427          end if;
3428
3429       --  Case of instantiation of a formal package
3430
3431       else
3432          Act_Decl_Id   := Defining_Identifier (N);
3433          Act_Decl_Name := Act_Decl_Id;
3434       end if;
3435
3436       Generate_Definition (Act_Decl_Id);
3437       Preanalyze_Actuals (N);
3438
3439       Init_Env;
3440       Env_Installed := True;
3441
3442       --  Reset renaming map for formal types. The mapping is established
3443       --  when analyzing the generic associations, but some mappings are
3444       --  inherited from formal packages of parent units, and these are
3445       --  constructed when the parents are installed.
3446
3447       Generic_Renamings.Set_Last (0);
3448       Generic_Renamings_HTable.Reset;
3449
3450       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3451       Gen_Unit := Entity (Gen_Id);
3452
3453       --  Verify that it is the name of a generic package
3454
3455       --  A visibility glitch: if the instance is a child unit and the generic
3456       --  is the generic unit of a parent instance (i.e. both the parent and
3457       --  the child units are instances of the same package) the name now
3458       --  denotes the renaming within the parent, not the intended generic
3459       --  unit. See if there is a homonym that is the desired generic. The
3460       --  renaming declaration must be visible inside the instance of the
3461       --  child, but not when analyzing the name in the instantiation itself.
3462
3463       if Ekind (Gen_Unit) = E_Package
3464         and then Present (Renamed_Entity (Gen_Unit))
3465         and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3466         and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3467         and then Present (Homonym (Gen_Unit))
3468       then
3469          Gen_Unit := Homonym (Gen_Unit);
3470       end if;
3471
3472       if Etype (Gen_Unit) = Any_Type then
3473          Restore_Env;
3474          goto Leave;
3475
3476       elsif Ekind (Gen_Unit) /= E_Generic_Package then
3477
3478          --  Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3479
3480          if From_With_Type (Gen_Unit) then
3481             Error_Msg_N
3482               ("cannot instantiate a limited withed package", Gen_Id);
3483          else
3484             Error_Msg_NE
3485               ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3486          end if;
3487
3488          Restore_Env;
3489          goto Leave;
3490       end if;
3491
3492       if In_Extended_Main_Source_Unit (N) then
3493          Set_Is_Instantiated (Gen_Unit);
3494          Generate_Reference  (Gen_Unit, N);
3495
3496          if Present (Renamed_Object (Gen_Unit)) then
3497             Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3498             Generate_Reference  (Renamed_Object (Gen_Unit), N);
3499          end if;
3500       end if;
3501
3502       if Nkind (Gen_Id) = N_Identifier
3503         and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3504       then
3505          Error_Msg_NE
3506            ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3507
3508       elsif Nkind (Gen_Id) = N_Expanded_Name
3509         and then Is_Child_Unit (Gen_Unit)
3510         and then Nkind (Prefix (Gen_Id)) = N_Identifier
3511         and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3512       then
3513          Error_Msg_N
3514            ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3515       end if;
3516
3517       Set_Entity (Gen_Id, Gen_Unit);
3518
3519       --  If generic is a renaming, get original generic unit
3520
3521       if Present (Renamed_Object (Gen_Unit))
3522         and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3523       then
3524          Gen_Unit := Renamed_Object (Gen_Unit);
3525       end if;
3526
3527       --  Verify that there are no circular instantiations
3528
3529       if In_Open_Scopes (Gen_Unit) then
3530          Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3531          Restore_Env;
3532          goto Leave;
3533
3534       elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3535          Error_Msg_Node_2 := Current_Scope;
3536          Error_Msg_NE
3537            ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3538          Circularity_Detected := True;
3539          Restore_Env;
3540          goto Leave;
3541
3542       else
3543          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3544
3545          --  Initialize renamings map, for error checking, and the list that
3546          --  holds private entities whose views have changed between generic
3547          --  definition and instantiation. If this is the instance created to
3548          --  validate an actual package, the instantiation environment is that
3549          --  of the enclosing instance.
3550
3551          Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3552
3553          --  Copy original generic tree, to produce text for instantiation
3554
3555          Act_Tree :=
3556            Copy_Generic_Node
3557              (Original_Node (Gen_Decl), Empty, Instantiating => True);
3558
3559          Act_Spec := Specification (Act_Tree);
3560
3561          --  If this is the instance created to validate an actual package,
3562          --  only the formals matter, do not examine the package spec itself.
3563
3564          if Is_Actual_Pack then
3565             Set_Visible_Declarations (Act_Spec, New_List);
3566             Set_Private_Declarations (Act_Spec, New_List);
3567          end if;
3568
3569          Renaming_List :=
3570            Analyze_Associations
3571              (I_Node  => N,
3572               Formals => Generic_Formal_Declarations (Act_Tree),
3573               F_Copy  => Generic_Formal_Declarations (Gen_Decl));
3574
3575          Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3576
3577          Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3578          Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3579          Set_Is_Generic_Instance (Act_Decl_Id);
3580
3581          Set_Generic_Parent (Act_Spec, Gen_Unit);
3582
3583          --  References to the generic in its own declaration or its body are
3584          --  references to the instance. Add a renaming declaration for the
3585          --  generic unit itself. This declaration, as well as the renaming
3586          --  declarations for the generic formals, must remain private to the
3587          --  unit: the formals, because this is the language semantics, and
3588          --  the unit because its use is an artifact of the implementation.
3589
3590          Unit_Renaming :=
3591            Make_Package_Renaming_Declaration (Loc,
3592              Defining_Unit_Name =>
3593                Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3594              Name => New_Reference_To (Act_Decl_Id, Loc));
3595
3596          Append (Unit_Renaming, Renaming_List);
3597
3598          --  The renaming declarations are the first local declarations of the
3599          --  new unit.
3600
3601          if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3602             Insert_List_Before
3603               (First (Visible_Declarations (Act_Spec)), Renaming_List);
3604          else
3605             Set_Visible_Declarations (Act_Spec, Renaming_List);
3606          end if;
3607
3608          Act_Decl :=
3609            Make_Package_Declaration (Loc,
3610              Specification => Act_Spec);
3611
3612          --  Save the instantiation node, for subsequent instantiation of the
3613          --  body, if there is one and we are generating code for the current
3614          --  unit. Mark the unit as having a body, to avoid a premature error
3615          --  message.
3616
3617          --  We instantiate the body if we are generating code, if we are
3618          --  generating cross-reference information, or if we are building
3619          --  trees for ASIS use.
3620
3621          declare
3622             Enclosing_Body_Present : Boolean := False;
3623             --  If the generic unit is not a compilation unit, then a body may
3624             --  be present in its parent even if none is required. We create a
3625             --  tentative pending instantiation for the body, which will be
3626             --  discarded if none is actually present.
3627
3628             Scop : Entity_Id;
3629
3630          begin
3631             if Scope (Gen_Unit) /= Standard_Standard
3632               and then not Is_Child_Unit (Gen_Unit)
3633             then
3634                Scop := Scope (Gen_Unit);
3635
3636                while Present (Scop)
3637                  and then Scop /= Standard_Standard
3638                loop
3639                   if Unit_Requires_Body (Scop) then
3640                      Enclosing_Body_Present := True;
3641                      exit;
3642
3643                   elsif In_Open_Scopes (Scop)
3644                     and then In_Package_Body (Scop)
3645                   then
3646                      Enclosing_Body_Present := True;
3647                      exit;
3648                   end if;
3649
3650                   exit when Is_Compilation_Unit (Scop);
3651                   Scop := Scope (Scop);
3652                end loop;
3653             end if;
3654
3655             --  If front-end inlining is enabled, and this is a unit for which
3656             --  code will be generated, we instantiate the body at once.
3657
3658             --  This is done if the instance is not the main unit, and if the
3659             --  generic is not a child unit of another generic, to avoid scope
3660             --  problems and the reinstallation of parent instances.
3661
3662             if Expander_Active
3663               and then (not Is_Child_Unit (Gen_Unit)
3664                          or else not Is_Generic_Unit (Scope (Gen_Unit)))
3665               and then Might_Inline_Subp
3666               and then not Is_Actual_Pack
3667             then
3668                if not Debug_Flag_Dot_K
3669                  and then Front_End_Inlining
3670                  and then (Is_In_Main_Unit (N)
3671                             or else In_Main_Context (Current_Scope))
3672                  and then Nkind (Parent (N)) /= N_Compilation_Unit
3673                then
3674                   Inline_Now := True;
3675
3676                elsif Debug_Flag_Dot_K
3677                  and then Must_Inline_Subp
3678                  and then (Is_In_Main_Unit (N)
3679                             or else In_Main_Context (Current_Scope))
3680                  and then Nkind (Parent (N)) /= N_Compilation_Unit
3681                then
3682                   Inline_Now := True;
3683
3684                --  In configurable_run_time mode we force the inlining of
3685                --  predefined subprograms marked Inline_Always, to minimize
3686                --  the use of the run-time library.
3687
3688                elsif Is_Predefined_File_Name
3689                        (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3690                  and then Configurable_Run_Time_Mode
3691                  and then Nkind (Parent (N)) /= N_Compilation_Unit
3692                then
3693                   Inline_Now := True;
3694                end if;
3695
3696                --  If the current scope is itself an instance within a child
3697                --  unit, there will be duplications in the scope stack, and the
3698                --  unstacking mechanism in Inline_Instance_Body will fail.
3699                --  This loses some rare cases of optimization, and might be
3700                --  improved some day, if we can find a proper abstraction for
3701                --  "the complete compilation context" that can be saved and
3702                --  restored. ???
3703
3704                if Is_Generic_Instance (Current_Scope) then
3705                   declare
3706                      Curr_Unit : constant Entity_Id :=
3707                                    Cunit_Entity (Current_Sem_Unit);
3708                   begin
3709                      if Curr_Unit /= Current_Scope
3710                        and then Is_Child_Unit (Curr_Unit)
3711                      then
3712                         Inline_Now := False;
3713                      end if;
3714                   end;
3715                end if;
3716             end if;
3717
3718             Needs_Body :=
3719               (Unit_Requires_Body (Gen_Unit)
3720                   or else Enclosing_Body_Present
3721                   or else Present (Corresponding_Body (Gen_Decl)))
3722                 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
3723                 and then not Is_Actual_Pack
3724                 and then not Inline_Now
3725                 and then (Operating_Mode = Generate_Code
3726                            or else (Operating_Mode = Check_Semantics
3727                                      and then ASIS_Mode));
3728
3729             --  If front_end_inlining is enabled, do not instantiate body if
3730             --  within a generic context.
3731
3732             if (Front_End_Inlining and then not Expander_Active)
3733               or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3734             then
3735                Needs_Body := False;
3736             end if;
3737
3738             --  If the current context is generic, and the package being
3739             --  instantiated is declared within a formal package, there is no
3740             --  body to instantiate until the enclosing generic is instantiated
3741             --  and there is an actual for the formal package. If the formal
3742             --  package has parameters, we build a regular package instance for
3743             --  it, that precedes the original formal package declaration.
3744
3745             if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3746                declare
3747                   Decl : constant Node_Id :=
3748                            Original_Node
3749                              (Unit_Declaration_Node (Scope (Gen_Unit)));
3750                begin
3751                   if Nkind (Decl) = N_Formal_Package_Declaration
3752                     or else (Nkind (Decl) = N_Package_Declaration
3753                               and then Is_List_Member (Decl)
3754                               and then Present (Next (Decl))
3755                               and then
3756                                 Nkind (Next (Decl)) =
3757                                                 N_Formal_Package_Declaration)
3758                   then
3759                      Needs_Body := False;
3760                   end if;
3761                end;
3762             end if;
3763          end;
3764
3765          --  For RCI unit calling stubs, we omit the instance body if the
3766          --  instance is the RCI library unit itself.
3767
3768          --  However there is a special case for nested instances: in this case
3769          --  we do generate the instance body, as it might be required, e.g.
3770          --  because it provides stream attributes for some type used in the
3771          --  profile of a remote subprogram. This is consistent with 12.3(12),
3772          --  which indicates that the instance body occurs at the place of the
3773          --  instantiation, and thus is part of the RCI declaration, which is
3774          --  present on all client partitions (this is E.2.3(18)).
3775
3776          --  Note that AI12-0002 may make it illegal at some point to have
3777          --  stream attributes defined in an RCI unit, in which case this
3778          --  special case will become unnecessary. In the meantime, there
3779          --  is known application code in production that depends on this
3780          --  being possible, so we definitely cannot eliminate the body in
3781          --  the case of nested instances for the time being.
3782
3783          --  When we generate a nested instance body, calling stubs for any
3784          --  relevant subprogram will be be inserted immediately after the
3785          --  subprogram declarations, and will take precedence over the
3786          --  subsequent (original) body. (The stub and original body will be
3787          --  complete homographs, but this is permitted in an instance).
3788          --  (Could we do better and remove the original body???)
3789
3790          if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3791            and then Comes_From_Source (N)
3792            and then Nkind (Parent (N)) = N_Compilation_Unit
3793          then
3794             Needs_Body := False;
3795          end if;
3796
3797          if Needs_Body then
3798
3799             --  Here is a defence against a ludicrous number of instantiations
3800             --  caused by a circular set of instantiation attempts.
3801
3802             if Pending_Instantiations.Last > Maximum_Instantiations then
3803                Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3804                Error_Msg_N ("too many instantiations, exceeds max of^", N);
3805                Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3806                raise Unrecoverable_Error;
3807             end if;
3808
3809             --  Indicate that the enclosing scopes contain an instantiation,
3810             --  and that cleanup actions should be delayed until after the
3811             --  instance body is expanded.
3812
3813             Check_Forward_Instantiation (Gen_Decl);
3814             if Nkind (N) = N_Package_Instantiation then
3815                declare
3816                   Enclosing_Master : Entity_Id;
3817
3818                begin
3819                   --  Loop to search enclosing masters
3820
3821                   Enclosing_Master := Current_Scope;
3822                   Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3823                      if Ekind (Enclosing_Master) = E_Package then
3824                         if Is_Compilation_Unit (Enclosing_Master) then
3825                            if In_Package_Body (Enclosing_Master) then
3826                               Delay_Descriptors
3827                                 (Body_Entity (Enclosing_Master));
3828                            else
3829                               Delay_Descriptors
3830                                 (Enclosing_Master);
3831                            end if;
3832
3833                            exit Scope_Loop;
3834
3835                         else
3836                            Enclosing_Master := Scope (Enclosing_Master);
3837                         end if;
3838
3839                      elsif Is_Generic_Unit (Enclosing_Master)
3840                        or else Ekind (Enclosing_Master) = E_Void
3841                      then
3842                         --  Cleanup actions will eventually be performed on the
3843                         --  enclosing subprogram or package instance, if any.
3844                         --  Enclosing scope is void in the formal part of a
3845                         --  generic subprogram.
3846
3847                         exit Scope_Loop;
3848
3849                      else
3850                         if Ekind (Enclosing_Master) = E_Entry
3851                           and then
3852                             Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3853                         then
3854                            if not Expander_Active then
3855                               exit Scope_Loop;
3856                            else
3857                               Enclosing_Master :=
3858                                 Protected_Body_Subprogram (Enclosing_Master);
3859                            end if;
3860                         end if;
3861
3862                         Set_Delay_Cleanups (Enclosing_Master);
3863
3864                         while Ekind (Enclosing_Master) = E_Block loop
3865                            Enclosing_Master := Scope (Enclosing_Master);
3866                         end loop;
3867
3868                         if Is_Subprogram (Enclosing_Master) then
3869                            Delay_Descriptors (Enclosing_Master);
3870
3871                         elsif Is_Task_Type (Enclosing_Master) then
3872                            declare
3873                               TBP : constant Node_Id :=
3874                                       Get_Task_Body_Procedure
3875                                         (Enclosing_Master);
3876                            begin
3877                               if Present (TBP) then
3878                                  Delay_Descriptors  (TBP);
3879                                  Set_Delay_Cleanups (TBP);
3880                               end if;
3881                            end;
3882                         end if;
3883
3884                         exit Scope_Loop;
3885                      end if;
3886                   end loop Scope_Loop;
3887                end;
3888
3889                --  Make entry in table
3890
3891                Pending_Instantiations.Append
3892                  ((Inst_Node                => N,
3893                    Act_Decl                 => Act_Decl,
3894                    Expander_Status          => Expander_Active,
3895                    Current_Sem_Unit         => Current_Sem_Unit,
3896                    Scope_Suppress           => Scope_Suppress,
3897                    Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3898                    Version                  => Ada_Version,
3899                    Version_Pragma           => Ada_Version_Pragma,
3900                    Warnings                 => Save_Warnings));
3901             end if;
3902          end if;
3903
3904          Set_Categorization_From_Pragmas (Act_Decl);
3905
3906          if Parent_Installed then
3907             Hide_Current_Scope;
3908          end if;
3909
3910          Set_Instance_Spec (N, Act_Decl);
3911
3912          --  If not a compilation unit, insert the package declaration before
3913          --  the original instantiation node.
3914
3915          if Nkind (Parent (N)) /= N_Compilation_Unit then
3916             Mark_Rewrite_Insertion (Act_Decl);
3917             Insert_Before (N, Act_Decl);
3918             Analyze (Act_Decl);
3919
3920          --  For an instantiation that is a compilation unit, place
3921          --  declaration on current node so context is complete for analysis
3922          --  (including nested instantiations). If this is the main unit,
3923          --  the declaration eventually replaces the instantiation node.
3924          --  If the instance body is created later, it replaces the
3925          --  instance node, and the declaration is attached to it
3926          --  (see Build_Instance_Compilation_Unit_Nodes).
3927
3928          else
3929             if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3930
3931                --  The entity for the current unit is the newly created one,
3932                --  and all semantic information is attached to it.
3933
3934                Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3935
3936                --  If this is the main unit, replace the main entity as well
3937
3938                if Current_Sem_Unit = Main_Unit then
3939                   Main_Unit_Entity := Act_Decl_Id;
3940                end if;
3941             end if;
3942
3943             Set_Unit (Parent (N), Act_Decl);
3944             Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3945             Set_Package_Instantiation (Act_Decl_Id, N);
3946
3947             --  Process aspect specifications of the instance node, if any, to
3948             --  take into account categorization pragmas before analyzing the
3949             --  instance.
3950
3951             if Has_Aspects (N) then
3952                Analyze_Aspect_Specifications (N, Act_Decl_Id);
3953             end if;
3954
3955             Analyze (Act_Decl);
3956             Set_Unit (Parent (N), N);
3957             Set_Body_Required (Parent (N), False);
3958
3959             --  We never need elaboration checks on instantiations, since by
3960             --  definition, the body instantiation is elaborated at the same
3961             --  time as the spec instantiation.
3962
3963             Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3964             Set_Kill_Elaboration_Checks       (Act_Decl_Id);
3965          end if;
3966
3967          Check_Elab_Instantiation (N);
3968
3969          if ABE_Is_Certain (N) and then Needs_Body then
3970             Pending_Instantiations.Decrement_Last;
3971          end if;
3972
3973          Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3974
3975          Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3976            First_Private_Entity (Act_Decl_Id));
3977
3978          --  If the instantiation will receive a body, the unit will be
3979          --  transformed into a package body, and receive its own elaboration
3980          --  entity. Otherwise, the nature of the unit is now a package
3981          --  declaration.
3982
3983          if Nkind (Parent (N)) = N_Compilation_Unit
3984            and then not Needs_Body
3985          then
3986             Rewrite (N, Act_Decl);
3987          end if;
3988
3989          if Present (Corresponding_Body (Gen_Decl))
3990            or else Unit_Requires_Body (Gen_Unit)
3991          then
3992             Set_Has_Completion (Act_Decl_Id);
3993          end if;
3994
3995          Check_Formal_Packages (Act_Decl_Id);
3996
3997          Restore_Hidden_Primitives (Vis_Prims_List);
3998          Restore_Private_Views (Act_Decl_Id);
3999
4000          Inherit_Context (Gen_Decl, N);
4001
4002          if Parent_Installed then
4003             Remove_Parent;
4004          end if;
4005
4006          Restore_Env;
4007          Env_Installed := False;
4008       end if;
4009
4010       Validate_Categorization_Dependency (N, Act_Decl_Id);
4011
4012       --  There used to be a check here to prevent instantiations in local
4013       --  contexts if the No_Local_Allocators restriction was active. This
4014       --  check was removed by a binding interpretation in AI-95-00130/07,
4015       --  but we retain the code for documentation purposes.
4016
4017       --  if Ekind (Act_Decl_Id) /= E_Void
4018       --    and then not Is_Library_Level_Entity (Act_Decl_Id)
4019       --  then
4020       --     Check_Restriction (No_Local_Allocators, N);
4021       --  end if;
4022
4023       if Inline_Now then
4024          Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4025       end if;
4026
4027       --  The following is a tree patch for ASIS: ASIS needs separate nodes to
4028       --  be used as defining identifiers for a formal package and for the
4029       --  corresponding expanded package.
4030
4031       if Nkind (N) = N_Formal_Package_Declaration then
4032          Act_Decl_Id := New_Copy (Defining_Entity (N));
4033          Set_Comes_From_Source (Act_Decl_Id, True);
4034          Set_Is_Generic_Instance (Act_Decl_Id, False);
4035          Set_Defining_Identifier (N, Act_Decl_Id);
4036       end if;
4037
4038       Style_Check := Save_Style_Check;
4039
4040       --  Check that if N is an instantiation of System.Dim_Float_IO or
4041       --  System.Dim_Integer_IO, the formal type has a dimension system.
4042
4043       if Nkind (N) = N_Package_Instantiation
4044         and then Is_Dim_IO_Package_Instantiation (N)
4045       then
4046          declare
4047             Assoc : constant Node_Id := First (Generic_Associations (N));
4048          begin
4049             if not Has_Dimension_System
4050                      (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4051             then
4052                Error_Msg_N ("type with a dimension system expected", Assoc);
4053             end if;
4054          end;
4055       end if;
4056
4057    <<Leave>>
4058       if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4059          Analyze_Aspect_Specifications (N, Act_Decl_Id);
4060       end if;
4061
4062    exception
4063       when Instantiation_Error =>
4064          if Parent_Installed then
4065             Remove_Parent;
4066          end if;
4067
4068          if Env_Installed then
4069             Restore_Env;
4070          end if;
4071
4072          Style_Check := Save_Style_Check;
4073    end Analyze_Package_Instantiation;
4074
4075    --------------------------
4076    -- Inline_Instance_Body --
4077    --------------------------
4078
4079    procedure Inline_Instance_Body
4080      (N        : Node_Id;
4081       Gen_Unit : Entity_Id;
4082       Act_Decl : Node_Id)
4083    is
4084       Vis          : Boolean;
4085       Gen_Comp     : constant Entity_Id :=
4086                       Cunit_Entity (Get_Source_Unit (Gen_Unit));
4087       Curr_Comp    : constant Node_Id := Cunit (Current_Sem_Unit);
4088       Curr_Scope   : Entity_Id := Empty;
4089       Curr_Unit    : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4090       Removed      : Boolean := False;
4091       Num_Scopes   : Int := 0;
4092
4093       Scope_Stack_Depth : constant Int :=
4094                             Scope_Stack.Last - Scope_Stack.First + 1;
4095
4096       Use_Clauses  : array (1 .. Scope_Stack_Depth) of Node_Id;
4097       Instances    : array (1 .. Scope_Stack_Depth) of Entity_Id;
4098       Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4099       List         : Elist_Id;
4100       Num_Inner    : Int := 0;
4101       N_Instances  : Int := 0;
4102       S            : Entity_Id;
4103
4104    begin
4105       --  Case of generic unit defined in another unit. We must remove the
4106       --  complete context of the current unit to install that of the generic.
4107
4108       if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4109
4110          --  Add some comments for the following two loops ???
4111
4112          S := Current_Scope;
4113          while Present (S) and then S /= Standard_Standard loop
4114             loop
4115                Num_Scopes := Num_Scopes + 1;
4116
4117                Use_Clauses (Num_Scopes) :=
4118                  (Scope_Stack.Table
4119                     (Scope_Stack.Last - Num_Scopes + 1).
4120                        First_Use_Clause);
4121                End_Use_Clauses (Use_Clauses (Num_Scopes));
4122
4123                exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4124                  or else Scope_Stack.Table
4125                            (Scope_Stack.Last - Num_Scopes).Entity
4126                              = Scope (S);
4127             end loop;
4128
4129             exit when Is_Generic_Instance (S)
4130               and then (In_Package_Body (S)
4131                           or else Ekind (S) = E_Procedure
4132                           or else Ekind (S) = E_Function);
4133             S := Scope (S);
4134          end loop;
4135
4136          Vis := Is_Immediately_Visible (Gen_Comp);
4137
4138          --  Find and save all enclosing instances
4139
4140          S := Current_Scope;
4141
4142          while Present (S)
4143            and then S /= Standard_Standard
4144          loop
4145             if Is_Generic_Instance (S) then
4146                N_Instances := N_Instances + 1;
4147                Instances (N_Instances) := S;
4148
4149                exit when In_Package_Body (S);
4150             end if;
4151
4152             S := Scope (S);
4153          end loop;
4154
4155          --  Remove context of current compilation unit, unless we are within a
4156          --  nested package instantiation, in which case the context has been
4157          --  removed previously.
4158
4159          --  If current scope is the body of a child unit, remove context of
4160          --  spec as well. If an enclosing scope is an instance body, the
4161          --  context has already been removed, but the entities in the body
4162          --  must be made invisible as well.
4163
4164          S := Current_Scope;
4165
4166          while Present (S)
4167            and then S /= Standard_Standard
4168          loop
4169             if Is_Generic_Instance (S)
4170               and then (In_Package_Body (S)
4171                           or else Ekind (S) = E_Procedure
4172                             or else Ekind (S) = E_Function)
4173             then
4174                --  We still have to remove the entities of the enclosing
4175                --  instance from direct visibility.
4176
4177                declare
4178                   E : Entity_Id;
4179                begin
4180                   E := First_Entity (S);
4181                   while Present (E) loop
4182                      Set_Is_Immediately_Visible (E, False);
4183                      Next_Entity (E);
4184                   end loop;
4185                end;
4186
4187                exit;
4188             end if;
4189
4190             if S = Curr_Unit
4191               or else (Ekind (Curr_Unit) = E_Package_Body
4192                         and then S = Spec_Entity (Curr_Unit))
4193               or else (Ekind (Curr_Unit) = E_Subprogram_Body
4194                         and then S =
4195                           Corresponding_Spec
4196                             (Unit_Declaration_Node (Curr_Unit)))
4197             then
4198                Removed := True;
4199
4200                --  Remove entities in current scopes from visibility, so that
4201                --  instance body is compiled in a clean environment.
4202
4203                List := Save_Scope_Stack (Handle_Use => False);
4204
4205                if Is_Child_Unit (S) then
4206
4207                   --  Remove child unit from stack, as well as inner scopes.
4208                   --  Removing the context of a child unit removes parent units
4209                   --  as well.
4210
4211                   while Current_Scope /= S loop
4212                      Num_Inner := Num_Inner + 1;
4213                      Inner_Scopes (Num_Inner) := Current_Scope;
4214                      Pop_Scope;
4215                   end loop;
4216
4217                   Pop_Scope;
4218                   Remove_Context (Curr_Comp);
4219                   Curr_Scope := S;
4220
4221                else
4222                   Remove_Context (Curr_Comp);
4223                end if;
4224
4225                if Ekind (Curr_Unit) = E_Package_Body then
4226                   Remove_Context (Library_Unit (Curr_Comp));
4227                end if;
4228             end if;
4229
4230             S := Scope (S);
4231          end loop;
4232          pragma Assert (Num_Inner < Num_Scopes);
4233
4234          Push_Scope (Standard_Standard);
4235          Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4236          Instantiate_Package_Body
4237            (Body_Info =>
4238              ((Inst_Node                => N,
4239                Act_Decl                 => Act_Decl,
4240                Expander_Status          => Expander_Active,
4241                Current_Sem_Unit         => Current_Sem_Unit,
4242                Scope_Suppress           => Scope_Suppress,
4243                Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4244                Version                  => Ada_Version,
4245                Version_Pragma           => Ada_Version_Pragma,
4246                Warnings                 => Save_Warnings)),
4247             Inlined_Body => True);
4248
4249          Pop_Scope;
4250
4251          --  Restore context
4252
4253          Set_Is_Immediately_Visible (Gen_Comp, Vis);
4254
4255          --  Reset Generic_Instance flag so that use clauses can be installed
4256          --  in the proper order. (See Use_One_Package for effect of enclosing
4257          --  instances on processing of use clauses).
4258
4259          for J in 1 .. N_Instances loop
4260             Set_Is_Generic_Instance (Instances (J), False);
4261          end loop;
4262
4263          if Removed then
4264             Install_Context (Curr_Comp);
4265
4266             if Present (Curr_Scope)
4267               and then Is_Child_Unit (Curr_Scope)
4268             then
4269                Push_Scope (Curr_Scope);
4270                Set_Is_Immediately_Visible (Curr_Scope);
4271
4272                --  Finally, restore inner scopes as well
4273
4274                for J in reverse 1 .. Num_Inner loop
4275                   Push_Scope (Inner_Scopes (J));
4276                end loop;
4277             end if;
4278
4279             Restore_Scope_Stack (List, Handle_Use => False);
4280
4281             if Present (Curr_Scope)
4282               and then
4283                 (In_Private_Part (Curr_Scope)
4284                   or else In_Package_Body (Curr_Scope))
4285             then
4286                --  Install private declaration of ancestor units, which are
4287                --  currently available. Restore_Scope_Stack and Install_Context
4288                --  only install the visible part of parents.
4289
4290                declare
4291                   Par : Entity_Id;
4292                begin
4293                   Par := Scope (Curr_Scope);
4294                   while (Present (Par))
4295                     and then Par /= Standard_Standard
4296                   loop
4297                      Install_Private_Declarations (Par);
4298                      Par := Scope (Par);
4299                   end loop;
4300                end;
4301             end if;
4302          end if;
4303
4304          --  Restore use clauses. For a child unit, use clauses in the parents
4305          --  are restored when installing the context, so only those in inner
4306          --  scopes (and those local to the child unit itself) need to be
4307          --  installed explicitly.
4308
4309          if Is_Child_Unit (Curr_Unit)
4310            and then Removed
4311          then
4312             for J in reverse 1 .. Num_Inner + 1 loop
4313                Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4314                  Use_Clauses (J);
4315                Install_Use_Clauses (Use_Clauses (J));
4316             end  loop;
4317
4318          else
4319             for J in reverse 1 .. Num_Scopes loop
4320                Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4321                  Use_Clauses (J);
4322                Install_Use_Clauses (Use_Clauses (J));
4323             end  loop;
4324          end if;
4325
4326          --  Restore status of instances. If one of them is a body, make its
4327          --  local entities visible again.
4328
4329          declare
4330             E    : Entity_Id;
4331             Inst : Entity_Id;
4332
4333          begin
4334             for J in 1 .. N_Instances loop
4335                Inst := Instances (J);
4336                Set_Is_Generic_Instance (Inst, True);
4337
4338                if In_Package_Body (Inst)
4339                  or else Ekind (S) = E_Procedure
4340                  or else Ekind (S) = E_Function
4341                then
4342                   E := First_Entity (Instances (J));
4343                   while Present (E) loop
4344                      Set_Is_Immediately_Visible (E);
4345                      Next_Entity (E);
4346                   end loop;
4347                end if;
4348             end loop;
4349          end;
4350
4351       --  If generic unit is in current unit, current context is correct
4352
4353       else
4354          Instantiate_Package_Body
4355            (Body_Info =>
4356              ((Inst_Node                => N,
4357                Act_Decl                 => Act_Decl,
4358                Expander_Status          => Expander_Active,
4359                Current_Sem_Unit         => Current_Sem_Unit,
4360                Scope_Suppress           => Scope_Suppress,
4361                Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4362                Version                  => Ada_Version,
4363                Version_Pragma           => Ada_Version_Pragma,
4364                Warnings                 => Save_Warnings)),
4365             Inlined_Body => True);
4366       end if;
4367    end Inline_Instance_Body;
4368
4369    -------------------------------------
4370    -- Analyze_Procedure_Instantiation --
4371    -------------------------------------
4372
4373    procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4374    begin
4375       Analyze_Subprogram_Instantiation (N, E_Procedure);
4376    end Analyze_Procedure_Instantiation;
4377
4378    -----------------------------------
4379    -- Need_Subprogram_Instance_Body --
4380    -----------------------------------
4381
4382    function Need_Subprogram_Instance_Body
4383      (N    : Node_Id;
4384       Subp : Entity_Id) return Boolean
4385    is
4386    begin
4387       --  Must be inlined (or inlined renaming)
4388
4389       if (Is_In_Main_Unit (N)
4390            or else Is_Inlined (Subp)
4391            or else Is_Inlined (Alias (Subp)))
4392
4393         --  Must be generating code or analyzing code in ASIS mode
4394
4395         and then (Operating_Mode = Generate_Code
4396                    or else (Operating_Mode = Check_Semantics
4397                              and then ASIS_Mode))
4398
4399         --  The body is needed when generating code (full expansion), in ASIS
4400         --  mode for other tools, and in SPARK mode (special expansion) for
4401         --  formal verification of the body itself.
4402
4403         and then (Expander_Active or ASIS_Mode)
4404
4405         --  No point in inlining if ABE is inevitable
4406
4407         and then not ABE_Is_Certain (N)
4408
4409         --  Or if subprogram is eliminated
4410
4411         and then not Is_Eliminated (Subp)
4412       then
4413          Pending_Instantiations.Append
4414            ((Inst_Node                => N,
4415              Act_Decl                 => Unit_Declaration_Node (Subp),
4416              Expander_Status          => Expander_Active,
4417              Current_Sem_Unit         => Current_Sem_Unit,
4418              Scope_Suppress           => Scope_Suppress,
4419              Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4420              Version                  => Ada_Version,
4421              Version_Pragma           => Ada_Version_Pragma,
4422              Warnings                 => Save_Warnings));
4423          return True;
4424
4425       --  Here if not inlined, or we ignore the inlining
4426
4427       else
4428          return False;
4429       end if;
4430    end Need_Subprogram_Instance_Body;
4431
4432    --------------------------------------
4433    -- Analyze_Subprogram_Instantiation --
4434    --------------------------------------
4435
4436    procedure Analyze_Subprogram_Instantiation
4437      (N : Node_Id;
4438       K : Entity_Kind)
4439    is
4440       Loc    : constant Source_Ptr := Sloc (N);
4441       Gen_Id : constant Node_Id    := Name (N);
4442
4443       Anon_Id : constant Entity_Id :=
4444                   Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4445                     Chars => New_External_Name
4446                                (Chars (Defining_Entity (N)), 'R'));
4447
4448       Act_Decl_Id : Entity_Id;
4449       Act_Decl    : Node_Id;
4450       Act_Spec    : Node_Id;
4451       Act_Tree    : Node_Id;
4452
4453       Env_Installed    : Boolean := False;
4454       Gen_Unit         : Entity_Id;
4455       Gen_Decl         : Node_Id;
4456       Pack_Id          : Entity_Id;
4457       Parent_Installed : Boolean := False;
4458       Renaming_List    : List_Id;
4459
4460       procedure Analyze_Instance_And_Renamings;
4461       --  The instance must be analyzed in a context that includes the mappings
4462       --  of generic parameters into actuals. We create a package declaration
4463       --  for this purpose, and a subprogram with an internal name within the
4464       --  package. The subprogram instance is simply an alias for the internal
4465       --  subprogram, declared in the current scope.
4466
4467       ------------------------------------
4468       -- Analyze_Instance_And_Renamings --
4469       ------------------------------------
4470
4471       procedure Analyze_Instance_And_Renamings is
4472          Def_Ent   : constant Entity_Id := Defining_Entity (N);
4473          Pack_Decl : Node_Id;
4474
4475       begin
4476          if Nkind (Parent (N)) = N_Compilation_Unit then
4477
4478             --  For the case of a compilation unit, the container package has
4479             --  the same name as the instantiation, to insure that the binder
4480             --  calls the elaboration procedure with the right name. Copy the
4481             --  entity of the instance, which may have compilation level flags
4482             --  (e.g. Is_Child_Unit) set.
4483
4484             Pack_Id := New_Copy (Def_Ent);
4485
4486          else
4487             --  Otherwise we use the name of the instantiation concatenated
4488             --  with its source position to ensure uniqueness if there are
4489             --  several instantiations with the same name.
4490
4491             Pack_Id :=
4492               Make_Defining_Identifier (Loc,
4493                 Chars => New_External_Name
4494                            (Related_Id   => Chars (Def_Ent),
4495                             Suffix       => "GP",
4496                             Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4497          end if;
4498
4499          Pack_Decl := Make_Package_Declaration (Loc,
4500            Specification => Make_Package_Specification (Loc,
4501              Defining_Unit_Name   => Pack_Id,
4502              Visible_Declarations => Renaming_List,
4503              End_Label            => Empty));
4504
4505          Set_Instance_Spec (N, Pack_Decl);
4506          Set_Is_Generic_Instance (Pack_Id);
4507          Set_Debug_Info_Needed (Pack_Id);
4508
4509          --  Case of not a compilation unit
4510
4511          if Nkind (Parent (N)) /= N_Compilation_Unit then
4512             Mark_Rewrite_Insertion (Pack_Decl);
4513             Insert_Before (N, Pack_Decl);
4514             Set_Has_Completion (Pack_Id);
4515
4516          --  Case of an instantiation that is a compilation unit
4517
4518          --  Place declaration on current node so context is complete for
4519          --  analysis (including nested instantiations), and for use in a
4520          --  context_clause (see Analyze_With_Clause).
4521
4522          else
4523             Set_Unit (Parent (N), Pack_Decl);
4524             Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4525          end if;
4526
4527          Analyze (Pack_Decl);
4528          Check_Formal_Packages (Pack_Id);
4529          Set_Is_Generic_Instance (Pack_Id, False);
4530
4531          --  Why do we clear Is_Generic_Instance??? We set it 20 lines
4532          --  above???
4533
4534          --  Body of the enclosing package is supplied when instantiating the
4535          --  subprogram body, after semantic analysis is completed.
4536
4537          if Nkind (Parent (N)) = N_Compilation_Unit then
4538
4539             --  Remove package itself from visibility, so it does not
4540             --  conflict with subprogram.
4541
4542             Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4543
4544             --  Set name and scope of internal subprogram so that the proper
4545             --  external name will be generated. The proper scope is the scope
4546             --  of the wrapper package. We need to generate debugging info for
4547             --  the internal subprogram, so set flag accordingly.
4548
4549             Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4550             Set_Scope (Anon_Id, Scope (Pack_Id));
4551
4552             --  Mark wrapper package as referenced, to avoid spurious warnings
4553             --  if the instantiation appears in various with_ clauses of
4554             --  subunits of the main unit.
4555
4556             Set_Referenced (Pack_Id);
4557          end if;
4558
4559          Set_Is_Generic_Instance (Anon_Id);
4560          Set_Debug_Info_Needed   (Anon_Id);
4561          Act_Decl_Id := New_Copy (Anon_Id);
4562
4563          Set_Parent            (Act_Decl_Id, Parent (Anon_Id));
4564          Set_Chars             (Act_Decl_Id, Chars (Defining_Entity (N)));
4565          Set_Sloc              (Act_Decl_Id, Sloc (Defining_Entity (N)));
4566          Set_Comes_From_Source (Act_Decl_Id, True);
4567
4568          --  The signature may involve types that are not frozen yet, but the
4569          --  subprogram will be frozen at the point the wrapper package is
4570          --  frozen, so it does not need its own freeze node. In fact, if one
4571          --  is created, it might conflict with the freezing actions from the
4572          --  wrapper package.
4573
4574          Set_Has_Delayed_Freeze (Anon_Id, False);
4575
4576          --  If the instance is a child unit, mark the Id accordingly. Mark
4577          --  the anonymous entity as well, which is the real subprogram and
4578          --  which is used when the instance appears in a context clause.
4579          --  Similarly, propagate the Is_Eliminated flag to handle properly
4580          --  nested eliminated subprograms.
4581
4582          Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4583          Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4584          New_Overloaded_Entity (Act_Decl_Id);
4585          Check_Eliminated  (Act_Decl_Id);
4586          Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4587
4588          --  In compilation unit case, kill elaboration checks on the
4589          --  instantiation, since they are never needed -- the body is
4590          --  instantiated at the same point as the spec.
4591
4592          if Nkind (Parent (N)) = N_Compilation_Unit then
4593             Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4594             Set_Kill_Elaboration_Checks       (Act_Decl_Id);
4595             Set_Is_Compilation_Unit (Anon_Id);
4596
4597             Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4598          end if;
4599
4600          --  The instance is not a freezing point for the new subprogram
4601
4602          Set_Is_Frozen (Act_Decl_Id, False);
4603
4604          if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4605             Valid_Operator_Definition (Act_Decl_Id);
4606          end if;
4607
4608          Set_Alias  (Act_Decl_Id, Anon_Id);
4609          Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4610          Set_Has_Completion (Act_Decl_Id);
4611          Set_Related_Instance (Pack_Id, Act_Decl_Id);
4612
4613          if Nkind (Parent (N)) = N_Compilation_Unit then
4614             Set_Body_Required (Parent (N), False);
4615          end if;
4616       end Analyze_Instance_And_Renamings;
4617
4618       --  Local variables
4619
4620       Vis_Prims_List : Elist_Id := No_Elist;
4621       --  List of primitives made temporarily visible in the instantiation
4622       --  to match the visibility of the formal type
4623
4624    --  Start of processing for Analyze_Subprogram_Instantiation
4625
4626    begin
4627       Check_SPARK_Restriction ("generic is not allowed", N);
4628
4629       --  Very first thing: apply the special kludge for Text_IO processing
4630       --  in case we are instantiating one of the children of [Wide_]Text_IO.
4631       --  Of course such an instantiation is bogus (these are packages, not
4632       --  subprograms), but we get a better error message if we do this.
4633
4634       Text_IO_Kludge (Gen_Id);
4635
4636       --  Make node global for error reporting
4637
4638       Instantiation_Node := N;
4639
4640       --  For package instantiations we turn off style checks, because they
4641       --  will have been emitted in the generic. For subprogram instantiations
4642       --  we want to apply at least the check on overriding indicators so we
4643       --  do not modify the style check status.
4644
4645       --  The renaming declarations for the actuals do not come from source and
4646       --  will not generate spurious warnings.
4647
4648       Preanalyze_Actuals (N);
4649
4650       Init_Env;
4651       Env_Installed := True;
4652       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4653       Gen_Unit := Entity (Gen_Id);
4654
4655       Generate_Reference (Gen_Unit, Gen_Id);
4656
4657       if Nkind (Gen_Id) = N_Identifier
4658         and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4659       then
4660          Error_Msg_NE
4661            ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4662       end if;
4663
4664       if Etype (Gen_Unit) = Any_Type then
4665          Restore_Env;
4666          return;
4667       end if;
4668
4669       --  Verify that it is a generic subprogram of the right kind, and that
4670       --  it does not lead to a circular instantiation.
4671
4672       if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
4673          Error_Msg_NE
4674            ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
4675
4676       elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
4677          Error_Msg_NE
4678            ("& is not the name of a generic function", Gen_Id, Gen_Unit);
4679
4680       elsif In_Open_Scopes (Gen_Unit) then
4681          Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4682
4683       else
4684          Set_Entity (Gen_Id, Gen_Unit);
4685          Set_Is_Instantiated (Gen_Unit);
4686
4687          if In_Extended_Main_Source_Unit (N) then
4688             Generate_Reference (Gen_Unit, N);
4689          end if;
4690
4691          --  If renaming, get original unit
4692
4693          if Present (Renamed_Object (Gen_Unit))
4694            and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4695                        or else
4696                      Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4697          then
4698             Gen_Unit := Renamed_Object (Gen_Unit);
4699             Set_Is_Instantiated (Gen_Unit);
4700             Generate_Reference  (Gen_Unit, N);
4701          end if;
4702
4703          if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4704             Error_Msg_Node_2 := Current_Scope;
4705             Error_Msg_NE
4706               ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4707             Circularity_Detected := True;
4708             Restore_Hidden_Primitives (Vis_Prims_List);
4709             goto Leave;
4710          end if;
4711
4712          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4713
4714          --  Initialize renamings map, for error checking
4715
4716          Generic_Renamings.Set_Last (0);
4717          Generic_Renamings_HTable.Reset;
4718
4719          Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4720
4721          --  Copy original generic tree, to produce text for instantiation
4722
4723          Act_Tree :=
4724            Copy_Generic_Node
4725              (Original_Node (Gen_Decl), Empty, Instantiating => True);
4726
4727          --  Inherit overriding indicator from instance node
4728
4729          Act_Spec := Specification (Act_Tree);
4730          Set_Must_Override     (Act_Spec, Must_Override (N));
4731          Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4732
4733          Renaming_List :=
4734            Analyze_Associations
4735              (I_Node  => N,
4736               Formals => Generic_Formal_Declarations (Act_Tree),
4737               F_Copy  => Generic_Formal_Declarations (Gen_Decl));
4738
4739          Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4740
4741          --  The subprogram itself cannot contain a nested instance, so the
4742          --  current parent is left empty.
4743
4744          Set_Instance_Env (Gen_Unit, Empty);
4745
4746          --  Build the subprogram declaration, which does not appear in the
4747          --  generic template, and give it a sloc consistent with that of the
4748          --  template.
4749
4750          Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4751          Set_Generic_Parent (Act_Spec, Gen_Unit);
4752          Act_Decl :=
4753            Make_Subprogram_Declaration (Sloc (Act_Spec),
4754              Specification => Act_Spec);
4755
4756          --  The aspects have been copied previously, but they have to be
4757          --  linked explicitly to the new subprogram declaration. Explicit
4758          --  pre/postconditions on the instance are analyzed below, in a
4759          --  separate step.
4760
4761          Move_Aspects (Act_Tree, To => Act_Decl);
4762          Set_Categorization_From_Pragmas (Act_Decl);
4763
4764          if Parent_Installed then
4765             Hide_Current_Scope;
4766          end if;
4767
4768          Append (Act_Decl, Renaming_List);
4769          Analyze_Instance_And_Renamings;
4770
4771          --  If the generic is marked Import (Intrinsic), then so is the
4772          --  instance. This indicates that there is no body to instantiate. If
4773          --  generic is marked inline, so it the instance, and the anonymous
4774          --  subprogram it renames. If inlined, or else if inlining is enabled
4775          --  for the compilation, we generate the instance body even if it is
4776          --  not within the main unit.
4777
4778          if Is_Intrinsic_Subprogram (Gen_Unit) then
4779             Set_Is_Intrinsic_Subprogram (Anon_Id);
4780             Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4781
4782             if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4783                Validate_Unchecked_Conversion (N, Act_Decl_Id);
4784             end if;
4785          end if;
4786
4787          --  Inherit convention from generic unit. Intrinsic convention, as for
4788          --  an instance of unchecked conversion, is not inherited because an
4789          --  explicit Ada instance has been created.
4790
4791          if Has_Convention_Pragma (Gen_Unit)
4792            and then Convention (Gen_Unit) /= Convention_Intrinsic
4793          then
4794             Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4795             Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4796          end if;
4797
4798          Generate_Definition (Act_Decl_Id);
4799          --  Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4800          --  ??? needed?
4801          Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4802
4803          --  Inherit all inlining-related flags which apply to the generic in
4804          --  the subprogram and its declaration.
4805
4806          Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4807          Set_Is_Inlined (Anon_Id,     Is_Inlined (Gen_Unit));
4808
4809          Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4810          Set_Has_Pragma_Inline (Anon_Id,     Has_Pragma_Inline (Gen_Unit));
4811
4812          Set_Has_Pragma_Inline_Always
4813            (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4814          Set_Has_Pragma_Inline_Always
4815            (Anon_Id,     Has_Pragma_Inline_Always (Gen_Unit));
4816
4817          if not Is_Intrinsic_Subprogram (Gen_Unit) then
4818             Check_Elab_Instantiation (N);
4819          end if;
4820
4821          if Is_Dispatching_Operation (Act_Decl_Id)
4822            and then Ada_Version >= Ada_2005
4823          then
4824             declare
4825                Formal : Entity_Id;
4826
4827             begin
4828                Formal := First_Formal (Act_Decl_Id);
4829                while Present (Formal) loop
4830                   if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4831                     and then Is_Controlling_Formal (Formal)
4832                     and then not Can_Never_Be_Null (Formal)
4833                   then
4834                      Error_Msg_NE ("access parameter& is controlling,",
4835                        N, Formal);
4836                      Error_Msg_NE
4837                        ("\corresponding parameter of & must be"
4838                        & " explicitly null-excluding", N, Gen_Id);
4839                   end if;
4840
4841                   Next_Formal (Formal);
4842                end loop;
4843             end;
4844          end if;
4845
4846          Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4847
4848          Validate_Categorization_Dependency (N, Act_Decl_Id);
4849
4850          if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4851             Inherit_Context (Gen_Decl, N);
4852
4853             Restore_Private_Views (Pack_Id, False);
4854
4855             --  If the context requires a full instantiation, mark node for
4856             --  subsequent construction of the body.
4857
4858             if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4859                Check_Forward_Instantiation (Gen_Decl);
4860
4861                --  The wrapper package is always delayed, because it does not
4862                --  constitute a freeze point, but to insure that the freeze
4863                --  node is placed properly, it is created directly when
4864                --  instantiating the body (otherwise the freeze node might
4865                --  appear to early for nested instantiations).
4866
4867             elsif Nkind (Parent (N)) = N_Compilation_Unit then
4868
4869                --  For ASIS purposes, indicate that the wrapper package has
4870                --  replaced the instantiation node.
4871
4872                Rewrite (N, Unit (Parent (N)));
4873                Set_Unit (Parent (N), N);
4874             end if;
4875
4876          elsif Nkind (Parent (N)) = N_Compilation_Unit then
4877
4878                --  Replace instance node for library-level instantiations of
4879                --  intrinsic subprograms, for ASIS use.
4880
4881                Rewrite (N, Unit (Parent (N)));
4882                Set_Unit (Parent (N), N);
4883          end if;
4884
4885          if Parent_Installed then
4886             Remove_Parent;
4887          end if;
4888
4889          Restore_Hidden_Primitives (Vis_Prims_List);
4890          Restore_Env;
4891          Env_Installed := False;
4892          Generic_Renamings.Set_Last (0);
4893          Generic_Renamings_HTable.Reset;
4894       end if;
4895
4896    <<Leave>>
4897       if Has_Aspects (N) then
4898          Analyze_Aspect_Specifications (N, Act_Decl_Id);
4899       end if;
4900
4901    exception
4902       when Instantiation_Error =>
4903          if Parent_Installed then
4904             Remove_Parent;
4905          end if;
4906
4907          if Env_Installed then
4908             Restore_Env;
4909          end if;
4910    end Analyze_Subprogram_Instantiation;
4911
4912    -------------------------
4913    -- Get_Associated_Node --
4914    -------------------------
4915
4916    function Get_Associated_Node (N : Node_Id) return Node_Id is
4917       Assoc : Node_Id;
4918
4919    begin
4920       Assoc := Associated_Node (N);
4921
4922       if Nkind (Assoc) /= Nkind (N) then
4923          return Assoc;
4924
4925       elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4926          return Assoc;
4927
4928       else
4929          --  If the node is part of an inner generic, it may itself have been
4930          --  remapped into a further generic copy. Associated_Node is otherwise
4931          --  used for the entity of the node, and will be of a different node
4932          --  kind, or else N has been rewritten as a literal or function call.
4933
4934          while Present (Associated_Node (Assoc))
4935            and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4936          loop
4937             Assoc := Associated_Node (Assoc);
4938          end loop;
4939
4940          --  Follow and additional link in case the final node was rewritten.
4941          --  This can only happen with nested generic units.
4942
4943          if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4944            and then Present (Associated_Node (Assoc))
4945            and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4946                                                         N_Explicit_Dereference,
4947                                                         N_Integer_Literal,
4948                                                         N_Real_Literal,
4949                                                         N_String_Literal))
4950          then
4951             Assoc := Associated_Node (Assoc);
4952          end if;
4953
4954          --  An additional special case: an unconstrained type in an object
4955          --  declaration may have been rewritten as a local subtype constrained
4956          --  by the expression in the declaration. We need to recover the
4957          --  original entity which may be global.
4958
4959          if Present (Original_Node (Assoc))
4960            and then Nkind (Parent (N)) = N_Object_Declaration
4961          then
4962             Assoc := Original_Node (Assoc);
4963          end if;
4964
4965          return Assoc;
4966       end if;
4967    end Get_Associated_Node;
4968
4969    -------------------------------------------
4970    -- Build_Instance_Compilation_Unit_Nodes --
4971    -------------------------------------------
4972
4973    procedure Build_Instance_Compilation_Unit_Nodes
4974      (N        : Node_Id;
4975       Act_Body : Node_Id;
4976       Act_Decl : Node_Id)
4977    is
4978       Decl_Cunit : Node_Id;
4979       Body_Cunit : Node_Id;
4980       Citem      : Node_Id;
4981       New_Main   : constant Entity_Id := Defining_Entity (Act_Decl);
4982       Old_Main   : constant Entity_Id := Cunit_Entity (Main_Unit);
4983
4984    begin
4985       --  A new compilation unit node is built for the instance declaration
4986
4987       Decl_Cunit :=
4988         Make_Compilation_Unit (Sloc (N),
4989           Context_Items  => Empty_List,
4990           Unit           => Act_Decl,
4991           Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
4992
4993       Set_Parent_Spec   (Act_Decl, Parent_Spec (N));
4994
4995       --  The new compilation unit is linked to its body, but both share the
4996       --  same file, so we do not set Body_Required on the new unit so as not
4997       --  to create a spurious dependency on a non-existent body in the ali.
4998       --  This simplifies CodePeer unit traversal.
4999
5000       --  We use the original instantiation compilation unit as the resulting
5001       --  compilation unit of the instance, since this is the main unit.
5002
5003       Rewrite (N, Act_Body);
5004       Body_Cunit := Parent (N);
5005
5006       --  The two compilation unit nodes are linked by the Library_Unit field
5007
5008       Set_Library_Unit (Decl_Cunit, Body_Cunit);
5009       Set_Library_Unit (Body_Cunit, Decl_Cunit);
5010
5011       --  Preserve the private nature of the package if needed
5012
5013       Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5014
5015       --  If the instance is not the main unit, its context, categorization
5016       --  and elaboration entity are not relevant to the compilation.
5017
5018       if Body_Cunit /= Cunit (Main_Unit) then
5019          Make_Instance_Unit (Body_Cunit, In_Main => False);
5020          return;
5021       end if;
5022
5023       --  The context clause items on the instantiation, which are now attached
5024       --  to the body compilation unit (since the body overwrote the original
5025       --  instantiation node), semantically belong on the spec, so copy them
5026       --  there. It's harmless to leave them on the body as well. In fact one
5027       --  could argue that they belong in both places.
5028
5029       Citem := First (Context_Items (Body_Cunit));
5030       while Present (Citem) loop
5031          Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5032          Next (Citem);
5033       end loop;
5034
5035       --  Propagate categorization flags on packages, so that they appear in
5036       --  the ali file for the spec of the unit.
5037
5038       if Ekind (New_Main) = E_Package then
5039          Set_Is_Pure           (Old_Main, Is_Pure (New_Main));
5040          Set_Is_Preelaborated  (Old_Main, Is_Preelaborated (New_Main));
5041          Set_Is_Remote_Types   (Old_Main, Is_Remote_Types (New_Main));
5042          Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5043          Set_Is_Remote_Call_Interface
5044            (Old_Main, Is_Remote_Call_Interface (New_Main));
5045       end if;
5046
5047       --  Make entry in Units table, so that binder can generate call to
5048       --  elaboration procedure for body, if any.
5049
5050       Make_Instance_Unit (Body_Cunit, In_Main => True);
5051       Main_Unit_Entity := New_Main;
5052       Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5053
5054       --  Build elaboration entity, since the instance may certainly generate
5055       --  elaboration code requiring a flag for protection.
5056
5057       Build_Elaboration_Entity (Decl_Cunit, New_Main);
5058    end Build_Instance_Compilation_Unit_Nodes;
5059
5060    -----------------------------
5061    -- Check_Access_Definition --
5062    -----------------------------
5063
5064    procedure Check_Access_Definition (N : Node_Id) is
5065    begin
5066       pragma Assert
5067         (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5068       null;
5069    end Check_Access_Definition;
5070
5071    -----------------------------------
5072    -- Check_Formal_Package_Instance --
5073    -----------------------------------
5074
5075    --  If the formal has specific parameters, they must match those of the
5076    --  actual. Both of them are instances, and the renaming declarations for
5077    --  their formal parameters appear in the same order in both. The analyzed
5078    --  formal has been analyzed in the context of the current instance.
5079
5080    procedure Check_Formal_Package_Instance
5081      (Formal_Pack : Entity_Id;
5082       Actual_Pack : Entity_Id)
5083    is
5084       E1 : Entity_Id := First_Entity (Actual_Pack);
5085       E2 : Entity_Id := First_Entity (Formal_Pack);
5086
5087       Expr1 : Node_Id;
5088       Expr2 : Node_Id;
5089
5090       procedure Check_Mismatch (B : Boolean);
5091       --  Common error routine for mismatch between the parameters of the
5092       --  actual instance and those of the formal package.
5093
5094       function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5095       --  The formal may come from a nested formal package, and the actual may
5096       --  have been constant-folded. To determine whether the two denote the
5097       --  same entity we may have to traverse several definitions to recover
5098       --  the ultimate entity that they refer to.
5099
5100       function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5101       --  Similarly, if the formal comes from a nested formal package, the
5102       --  actual may designate the formal through multiple renamings, which
5103       --  have to be followed to determine the original variable in question.
5104
5105       --------------------
5106       -- Check_Mismatch --
5107       --------------------
5108
5109       procedure Check_Mismatch (B : Boolean) is
5110          Kind : constant Node_Kind := Nkind (Parent (E2));
5111
5112       begin
5113          if Kind = N_Formal_Type_Declaration then
5114             return;
5115
5116          elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5117                                N_Formal_Package_Declaration)
5118            or else Kind in N_Formal_Subprogram_Declaration
5119          then
5120             null;
5121
5122          elsif B then
5123             Error_Msg_NE
5124               ("actual for & in actual instance does not match formal",
5125                Parent (Actual_Pack), E1);
5126          end if;
5127       end Check_Mismatch;
5128
5129       --------------------------------
5130       -- Same_Instantiated_Constant --
5131       --------------------------------
5132
5133       function Same_Instantiated_Constant
5134         (E1, E2 : Entity_Id) return Boolean
5135       is
5136          Ent : Entity_Id;
5137
5138       begin
5139          Ent := E2;
5140          while Present (Ent) loop
5141             if E1 = Ent then
5142                return True;
5143
5144             elsif Ekind (Ent) /= E_Constant then
5145                return False;
5146
5147             elsif Is_Entity_Name (Constant_Value (Ent)) then
5148                if  Entity (Constant_Value (Ent)) = E1 then
5149                   return True;
5150                else
5151                   Ent := Entity (Constant_Value (Ent));
5152                end if;
5153
5154             --  The actual may be a constant that has been folded. Recover
5155             --  original name.
5156
5157             elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5158                   Ent := Entity (Original_Node (Constant_Value (Ent)));
5159             else
5160                return False;
5161             end if;
5162          end loop;
5163
5164          return False;
5165       end Same_Instantiated_Constant;
5166
5167       --------------------------------
5168       -- Same_Instantiated_Variable --
5169       --------------------------------
5170
5171       function Same_Instantiated_Variable
5172         (E1, E2 : Entity_Id) return Boolean
5173       is
5174          function Original_Entity (E : Entity_Id) return Entity_Id;
5175          --  Follow chain of renamings to the ultimate ancestor
5176
5177          ---------------------
5178          -- Original_Entity --
5179          ---------------------
5180
5181          function Original_Entity (E : Entity_Id) return Entity_Id is
5182             Orig : Entity_Id;
5183
5184          begin
5185             Orig := E;
5186             while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5187               and then Present (Renamed_Object (Orig))
5188               and then Is_Entity_Name (Renamed_Object (Orig))
5189             loop
5190                Orig := Entity (Renamed_Object (Orig));
5191             end loop;
5192
5193             return Orig;
5194          end Original_Entity;
5195
5196       --  Start of processing for Same_Instantiated_Variable
5197
5198       begin
5199          return Ekind (E1) = Ekind (E2)
5200            and then Original_Entity (E1) = Original_Entity (E2);
5201       end Same_Instantiated_Variable;
5202
5203    --  Start of processing for Check_Formal_Package_Instance
5204
5205    begin
5206       while Present (E1)
5207         and then Present (E2)
5208       loop
5209          exit when Ekind (E1) = E_Package
5210            and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5211
5212          --  If the formal is the renaming of the formal package, this
5213          --  is the end of its formal part, which may occur before the
5214          --  end of the formal part in the actual in the presence of
5215          --  defaulted parameters in the formal package.
5216
5217          exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5218            and then Renamed_Entity (E2) = Scope (E2);
5219
5220          --  The analysis of the actual may generate additional internal
5221          --  entities. If the formal is defaulted, there is no corresponding
5222          --  analysis and the internal entities must be skipped, until we
5223          --  find corresponding entities again.
5224
5225          if Comes_From_Source (E2)
5226            and then not Comes_From_Source (E1)
5227            and then Chars (E1) /= Chars (E2)
5228          then
5229             while Present (E1)
5230               and then  Chars (E1) /= Chars (E2)
5231             loop
5232                Next_Entity (E1);
5233             end loop;
5234          end if;
5235
5236          if No (E1) then
5237             return;
5238
5239          --  If the formal entity comes from a formal declaration, it was
5240          --  defaulted in the formal package, and no check is needed on it.
5241
5242          elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5243             goto Next_E;
5244
5245          --  Ditto for defaulted formal subprograms.
5246
5247          elsif Is_Overloadable (E1)
5248            and then Nkind (Unit_Declaration_Node (E2)) in
5249                       N_Formal_Subprogram_Declaration
5250          then
5251             goto Next_E;
5252
5253          elsif Is_Type (E1) then
5254
5255             --  Subtypes must statically match. E1, E2 are the local entities
5256             --  that are subtypes of the actuals. Itypes generated for other
5257             --  parameters need not be checked, the check will be performed
5258             --  on the parameters themselves.
5259
5260             --  If E2 is a formal type declaration, it is a defaulted parameter
5261             --  and needs no checking.
5262
5263             if not Is_Itype (E1)
5264               and then not Is_Itype (E2)
5265             then
5266                Check_Mismatch
5267                  (not Is_Type (E2)
5268                    or else Etype (E1) /= Etype (E2)
5269                    or else not Subtypes_Statically_Match (E1, E2));
5270             end if;
5271
5272          elsif Ekind (E1) = E_Constant then
5273
5274             --  IN parameters must denote the same static value, or the same
5275             --  constant, or the literal null.
5276
5277             Expr1 := Expression (Parent (E1));
5278
5279             if Ekind (E2) /= E_Constant then
5280                Check_Mismatch (True);
5281                goto Next_E;
5282             else
5283                Expr2 := Expression (Parent (E2));
5284             end if;
5285
5286             if Is_Static_Expression (Expr1) then
5287
5288                if not Is_Static_Expression (Expr2) then
5289                   Check_Mismatch (True);
5290
5291                elsif Is_Discrete_Type (Etype (E1)) then
5292                   declare
5293                      V1 : constant Uint := Expr_Value (Expr1);
5294                      V2 : constant Uint := Expr_Value (Expr2);
5295                   begin
5296                      Check_Mismatch (V1 /= V2);
5297                   end;
5298
5299                elsif Is_Real_Type (Etype (E1)) then
5300                   declare
5301                      V1 : constant Ureal := Expr_Value_R (Expr1);
5302                      V2 : constant Ureal := Expr_Value_R (Expr2);
5303                   begin
5304                      Check_Mismatch (V1 /= V2);
5305                   end;
5306
5307                elsif Is_String_Type (Etype (E1))
5308                  and then Nkind (Expr1) = N_String_Literal
5309                then
5310                   if Nkind (Expr2) /= N_String_Literal then
5311                      Check_Mismatch (True);
5312                   else
5313                      Check_Mismatch
5314                        (not String_Equal (Strval (Expr1), Strval (Expr2)));
5315                   end if;
5316                end if;
5317
5318             elsif Is_Entity_Name (Expr1) then
5319                if Is_Entity_Name (Expr2) then
5320                   if Entity (Expr1) = Entity (Expr2) then
5321                      null;
5322                   else
5323                      Check_Mismatch
5324                        (not Same_Instantiated_Constant
5325                          (Entity (Expr1), Entity (Expr2)));
5326                   end if;
5327                else
5328                   Check_Mismatch (True);
5329                end if;
5330
5331             elsif Is_Entity_Name (Original_Node (Expr1))
5332               and then Is_Entity_Name (Expr2)
5333             and then
5334               Same_Instantiated_Constant
5335                 (Entity (Original_Node (Expr1)), Entity (Expr2))
5336             then
5337                null;
5338
5339             elsif Nkind (Expr1) = N_Null then
5340                Check_Mismatch (Nkind (Expr1) /= N_Null);
5341
5342             else
5343                Check_Mismatch (True);
5344             end if;
5345
5346          elsif Ekind (E1) = E_Variable then
5347             Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5348
5349          elsif Ekind (E1) = E_Package then
5350             Check_Mismatch
5351               (Ekind (E1) /= Ekind (E2)
5352                 or else Renamed_Object (E1) /= Renamed_Object (E2));
5353
5354          elsif Is_Overloadable (E1) then
5355
5356             --  Verify that the actual subprograms match. Note that actuals
5357             --  that are attributes are rewritten as subprograms. If the
5358             --  subprogram in the formal package is defaulted, no check is
5359             --  needed. Note that this can only happen in Ada 2005 when the
5360             --  formal package can be partially parameterized.
5361
5362             if Nkind (Unit_Declaration_Node (E1)) =
5363                                            N_Subprogram_Renaming_Declaration
5364               and then From_Default (Unit_Declaration_Node (E1))
5365             then
5366                null;
5367
5368             --  If the formal package has an "others"  box association that
5369             --  covers this formal, there is no need for a check either.
5370
5371             elsif Nkind (Unit_Declaration_Node (E2)) in
5372                     N_Formal_Subprogram_Declaration
5373               and then Box_Present (Unit_Declaration_Node (E2))
5374             then
5375                null;
5376
5377             --  No check needed if subprogram is a defaulted null procedure
5378
5379             elsif No (Alias (E2))
5380               and then Ekind (E2) = E_Procedure
5381               and then
5382                 Null_Present (Specification (Unit_Declaration_Node (E2)))
5383             then
5384                null;
5385
5386             --  Otherwise the actual in the formal and the actual in the
5387             --  instantiation of the formal must match, up to renamings.
5388
5389             else
5390                Check_Mismatch
5391                  (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5392             end if;
5393
5394          else
5395             raise Program_Error;
5396          end if;
5397
5398          <<Next_E>>
5399             Next_Entity (E1);
5400             Next_Entity (E2);
5401       end loop;
5402    end Check_Formal_Package_Instance;
5403
5404    ---------------------------
5405    -- Check_Formal_Packages --
5406    ---------------------------
5407
5408    procedure Check_Formal_Packages (P_Id : Entity_Id) is
5409       E        : Entity_Id;
5410       Formal_P : Entity_Id;
5411
5412    begin
5413       --  Iterate through the declarations in the instance, looking for package
5414       --  renaming declarations that denote instances of formal packages. Stop
5415       --  when we find the renaming of the current package itself. The
5416       --  declaration for a formal package without a box is followed by an
5417       --  internal entity that repeats the instantiation.
5418
5419       E := First_Entity (P_Id);
5420       while Present (E) loop
5421          if Ekind (E) = E_Package then
5422             if Renamed_Object (E) = P_Id then
5423                exit;
5424
5425             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5426                null;
5427
5428             elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5429                Formal_P := Next_Entity (E);
5430                Check_Formal_Package_Instance (Formal_P, E);
5431
5432                --  After checking, remove the internal validating package. It
5433                --  is only needed for semantic checks, and as it may contain
5434                --  generic formal declarations it should not reach gigi.
5435
5436                Remove (Unit_Declaration_Node (Formal_P));
5437             end if;
5438          end if;
5439
5440          Next_Entity (E);
5441       end loop;
5442    end Check_Formal_Packages;
5443
5444    ---------------------------------
5445    -- Check_Forward_Instantiation --
5446    ---------------------------------
5447
5448    procedure Check_Forward_Instantiation (Decl : Node_Id) is
5449       S        : Entity_Id;
5450       Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5451
5452    begin
5453       --  The instantiation appears before the generic body if we are in the
5454       --  scope of the unit containing the generic, either in its spec or in
5455       --  the package body, and before the generic body.
5456
5457       if Ekind (Gen_Comp) = E_Package_Body then
5458          Gen_Comp := Spec_Entity (Gen_Comp);
5459       end if;
5460
5461       if In_Open_Scopes (Gen_Comp)
5462         and then No (Corresponding_Body (Decl))
5463       then
5464          S := Current_Scope;
5465
5466          while Present (S)
5467            and then not Is_Compilation_Unit (S)
5468            and then not Is_Child_Unit (S)
5469          loop
5470             if Ekind (S) = E_Package then
5471                Set_Has_Forward_Instantiation (S);
5472             end if;
5473
5474             S := Scope (S);
5475          end loop;
5476       end if;
5477    end Check_Forward_Instantiation;
5478
5479    ---------------------------
5480    -- Check_Generic_Actuals --
5481    ---------------------------
5482
5483    --  The visibility of the actuals may be different between the point of
5484    --  generic instantiation and the instantiation of the body.
5485
5486    procedure Check_Generic_Actuals
5487      (Instance      : Entity_Id;
5488       Is_Formal_Box : Boolean)
5489    is
5490       E      : Entity_Id;
5491       Astype : Entity_Id;
5492
5493       function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5494       --  For a formal that is an array type, the component type is often a
5495       --  previous formal in the same unit. The privacy status of the component
5496       --  type will have been examined earlier in the traversal of the
5497       --  corresponding actuals, and this status should not be modified for
5498       --  the array (sub)type itself. However, if the base type of the array
5499       --  (sub)type is private, its full view must be restored in the body to
5500       --  be consistent with subsequent index subtypes, etc.
5501       --
5502       --  To detect this case we have to rescan the list of formals, which is
5503       --  usually short enough to ignore the resulting inefficiency.
5504
5505       -----------------------------
5506       -- Denotes_Previous_Actual --
5507       -----------------------------
5508
5509       function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5510          Prev : Entity_Id;
5511
5512       begin
5513          Prev := First_Entity (Instance);
5514          while Present (Prev) loop
5515             if Is_Type (Prev)
5516               and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5517               and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5518               and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5519             then
5520                return True;
5521
5522             elsif Prev = E then
5523                return False;
5524
5525             else
5526                Next_Entity (Prev);
5527             end if;
5528          end loop;
5529
5530          return False;
5531       end Denotes_Previous_Actual;
5532
5533    --  Start of processing for Check_Generic_Actuals
5534
5535    begin
5536       E := First_Entity (Instance);
5537       while Present (E) loop
5538          if Is_Type (E)
5539            and then Nkind (Parent (E)) = N_Subtype_Declaration
5540            and then Scope (Etype (E)) /= Instance
5541            and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5542          then
5543             if Is_Array_Type (E)
5544               and then not Is_Private_Type (Etype (E))
5545               and then Denotes_Previous_Actual (Component_Type (E))
5546             then
5547                null;
5548             else
5549                Check_Private_View (Subtype_Indication (Parent (E)));
5550             end if;
5551
5552             Set_Is_Generic_Actual_Type (E, True);
5553             Set_Is_Hidden (E, False);
5554             Set_Is_Potentially_Use_Visible (E,
5555               In_Use (Instance));
5556
5557             --  We constructed the generic actual type as a subtype of the
5558             --  supplied type. This means that it normally would not inherit
5559             --  subtype specific attributes of the actual, which is wrong for
5560             --  the generic case.
5561
5562             Astype := Ancestor_Subtype (E);
5563
5564             if No (Astype) then
5565
5566                --  This can happen when E is an itype that is the full view of
5567                --  a private type completed, e.g. with a constrained array. In
5568                --  that case, use the first subtype, which will carry size
5569                --  information. The base type itself is unconstrained and will
5570                --  not carry it.
5571
5572                Astype := First_Subtype (E);
5573             end if;
5574
5575             Set_Size_Info      (E,                (Astype));
5576             Set_RM_Size        (E, RM_Size        (Astype));
5577             Set_First_Rep_Item (E, First_Rep_Item (Astype));
5578
5579             if Is_Discrete_Or_Fixed_Point_Type (E) then
5580                Set_RM_Size (E, RM_Size (Astype));
5581
5582             --  In nested instances, the base type of an access actual may
5583             --  itself be private, and need to be exchanged.
5584
5585             elsif Is_Access_Type (E)
5586               and then Is_Private_Type (Etype (E))
5587             then
5588                Check_Private_View
5589                  (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5590             end if;
5591
5592          elsif Ekind (E) = E_Package then
5593
5594             --  If this is the renaming for the current instance, we're done.
5595             --  Otherwise it is a formal package. If the corresponding formal
5596             --  was declared with a box, the (instantiations of the) generic
5597             --  formal part are also visible. Otherwise, ignore the entity
5598             --  created to validate the actuals.
5599
5600             if Renamed_Object (E) = Instance then
5601                exit;
5602
5603             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5604                null;
5605
5606             --  The visibility of a formal of an enclosing generic is already
5607             --  correct.
5608
5609             elsif Denotes_Formal_Package (E) then
5610                null;
5611
5612             elsif Present (Associated_Formal_Package (E))
5613               and then not Is_Generic_Formal (E)
5614             then
5615                if Box_Present (Parent (Associated_Formal_Package (E))) then
5616                   Check_Generic_Actuals (Renamed_Object (E), True);
5617
5618                else
5619                   Check_Generic_Actuals (Renamed_Object (E), False);
5620                end if;
5621
5622                Set_Is_Hidden (E, False);
5623             end if;
5624
5625          --  If this is a subprogram instance (in a wrapper package) the
5626          --  actual is fully visible.
5627
5628          elsif Is_Wrapper_Package (Instance) then
5629             Set_Is_Hidden (E, False);
5630
5631          --  If the formal package is declared with a box, or if the formal
5632          --  parameter is defaulted, it is visible in the body.
5633
5634          elsif Is_Formal_Box
5635            or else Is_Visible_Formal (E)
5636          then
5637             Set_Is_Hidden (E, False);
5638          end if;
5639
5640          if Ekind (E) = E_Constant then
5641
5642             --  If the type of the actual is a private type declared in the
5643             --  enclosing scope of the generic unit, the body of the generic
5644             --  sees the full view of the type (because it has to appear in
5645             --  the corresponding package body). If the type is private now,
5646             --  exchange views to restore the proper visiblity in the instance.
5647
5648             declare
5649                Typ : constant Entity_Id := Base_Type (Etype (E));
5650                --  The type of the actual
5651
5652                Gen_Id : Entity_Id;
5653                --  The generic unit
5654
5655                Parent_Scope : Entity_Id;
5656                --  The enclosing scope of the generic unit
5657
5658             begin
5659                if Is_Wrapper_Package (Instance) then
5660                   Gen_Id :=
5661                      Generic_Parent
5662                        (Specification
5663                          (Unit_Declaration_Node
5664                            (Related_Instance (Instance))));
5665                else
5666                   Gen_Id :=
5667                     Generic_Parent (Package_Specification (Instance));
5668                end if;
5669
5670                Parent_Scope := Scope (Gen_Id);
5671
5672                --  The exchange is only needed if the generic is defined
5673                --  within a package which is not a common ancestor of the
5674                --  scope of the instance, and is not already in scope.
5675
5676                if Is_Private_Type (Typ)
5677                  and then Scope (Typ) = Parent_Scope
5678                  and then Scope (Instance) /= Parent_Scope
5679                  and then Ekind (Parent_Scope) = E_Package
5680                  and then not Is_Child_Unit (Gen_Id)
5681                then
5682                   Switch_View (Typ);
5683
5684                   --  If the type of the entity is a subtype, it may also have
5685                   --  to be made visible, together with the base type of its
5686                   --  full view, after exchange.
5687
5688                   if Is_Private_Type (Etype (E)) then
5689                      Switch_View (Etype (E));
5690                      Switch_View (Base_Type (Etype (E)));
5691                   end if;
5692                end if;
5693             end;
5694          end if;
5695
5696          Next_Entity (E);
5697       end loop;
5698    end Check_Generic_Actuals;
5699
5700    ------------------------------
5701    -- Check_Generic_Child_Unit --
5702    ------------------------------
5703
5704    procedure Check_Generic_Child_Unit
5705      (Gen_Id           : Node_Id;
5706       Parent_Installed : in out Boolean)
5707    is
5708       Loc      : constant Source_Ptr := Sloc (Gen_Id);
5709       Gen_Par  : Entity_Id := Empty;
5710       E        : Entity_Id;
5711       Inst_Par : Entity_Id;
5712       S        : Node_Id;
5713
5714       function Find_Generic_Child
5715         (Scop : Entity_Id;
5716          Id   : Node_Id) return Entity_Id;
5717       --  Search generic parent for possible child unit with the given name
5718
5719       function In_Enclosing_Instance return Boolean;
5720       --  Within an instance of the parent, the child unit may be denoted by
5721       --  a simple name, or an abbreviated expanded name. Examine enclosing
5722       --  scopes to locate a possible parent instantiation.
5723
5724       ------------------------
5725       -- Find_Generic_Child --
5726       ------------------------
5727
5728       function Find_Generic_Child
5729         (Scop : Entity_Id;
5730          Id   : Node_Id) return Entity_Id
5731       is
5732          E : Entity_Id;
5733
5734       begin
5735          --  If entity of name is already set, instance has already been
5736          --  resolved, e.g. in an enclosing instantiation.
5737
5738          if Present (Entity (Id)) then
5739             if Scope (Entity (Id)) = Scop then
5740                return Entity (Id);
5741             else
5742                return Empty;
5743             end if;
5744
5745          else
5746             E := First_Entity (Scop);
5747             while Present (E) loop
5748                if Chars (E) = Chars (Id)
5749                  and then Is_Child_Unit (E)
5750                then
5751                   if Is_Child_Unit (E)
5752                     and then not Is_Visible_Lib_Unit (E)
5753                   then
5754                      Error_Msg_NE
5755                        ("generic child unit& is not visible", Gen_Id, E);
5756                   end if;
5757
5758                   Set_Entity (Id, E);
5759                   return E;
5760                end if;
5761
5762                Next_Entity (E);
5763             end loop;
5764
5765             return Empty;
5766          end if;
5767       end Find_Generic_Child;
5768
5769       ---------------------------
5770       -- In_Enclosing_Instance --
5771       ---------------------------
5772
5773       function In_Enclosing_Instance return Boolean is
5774          Enclosing_Instance : Node_Id;
5775          Instance_Decl      : Node_Id;
5776
5777       begin
5778          --  We do not inline any call that contains instantiations, except
5779          --  for instantiations of Unchecked_Conversion, so if we are within
5780          --  an inlined body the current instance does not require parents.
5781
5782          if In_Inlined_Body then
5783             pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5784             return False;
5785          end if;
5786
5787          --  Loop to check enclosing scopes
5788
5789          Enclosing_Instance := Current_Scope;
5790          while Present (Enclosing_Instance) loop
5791             Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5792
5793             if Ekind (Enclosing_Instance) = E_Package
5794               and then Is_Generic_Instance (Enclosing_Instance)
5795               and then Present
5796                 (Generic_Parent (Specification (Instance_Decl)))
5797             then
5798                --  Check whether the generic we are looking for is a child of
5799                --  this instance.
5800
5801                E := Find_Generic_Child
5802                       (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5803                exit when Present (E);
5804
5805             else
5806                E := Empty;
5807             end if;
5808
5809             Enclosing_Instance := Scope (Enclosing_Instance);
5810          end loop;
5811
5812          if No (E) then
5813
5814             --  Not a child unit
5815
5816             Analyze (Gen_Id);
5817             return False;
5818
5819          else
5820             Rewrite (Gen_Id,
5821               Make_Expanded_Name (Loc,
5822                 Chars         => Chars (E),
5823                 Prefix        => New_Occurrence_Of (Enclosing_Instance, Loc),
5824                 Selector_Name => New_Occurrence_Of (E, Loc)));
5825
5826             Set_Entity (Gen_Id, E);
5827             Set_Etype  (Gen_Id, Etype (E));
5828             Parent_Installed := False;      -- Already in scope.
5829             return True;
5830          end if;
5831       end In_Enclosing_Instance;
5832
5833    --  Start of processing for Check_Generic_Child_Unit
5834
5835    begin
5836       --  If the name of the generic is given by a selected component, it may
5837       --  be the name of a generic child unit, and the prefix is the name of an
5838       --  instance of the parent, in which case the child unit must be visible.
5839       --  If this instance is not in scope, it must be placed there and removed
5840       --  after instantiation, because what is being instantiated is not the
5841       --  original child, but the corresponding child present in the instance
5842       --  of the parent.
5843
5844       --  If the child is instantiated within the parent, it can be given by
5845       --  a simple name. In this case the instance is already in scope, but
5846       --  the child generic must be recovered from the generic parent as well.
5847
5848       if Nkind (Gen_Id) = N_Selected_Component then
5849          S := Selector_Name (Gen_Id);
5850          Analyze (Prefix (Gen_Id));
5851          Inst_Par := Entity (Prefix (Gen_Id));
5852
5853          if Ekind (Inst_Par) = E_Package
5854            and then Present (Renamed_Object (Inst_Par))
5855          then
5856             Inst_Par := Renamed_Object (Inst_Par);
5857          end if;
5858
5859          if Ekind (Inst_Par) = E_Package then
5860             if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5861                Gen_Par := Generic_Parent (Parent (Inst_Par));
5862
5863             elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5864               and then
5865                 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5866             then
5867                Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5868             end if;
5869
5870          elsif Ekind (Inst_Par) = E_Generic_Package
5871            and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5872          then
5873             --  A formal package may be a real child package, and not the
5874             --  implicit instance within a parent. In this case the child is
5875             --  not visible and has to be retrieved explicitly as well.
5876
5877             Gen_Par := Inst_Par;
5878          end if;
5879
5880          if Present (Gen_Par) then
5881
5882             --  The prefix denotes an instantiation. The entity itself may be a
5883             --  nested generic, or a child unit.
5884
5885             E := Find_Generic_Child (Gen_Par, S);
5886
5887             if Present (E) then
5888                Change_Selected_Component_To_Expanded_Name (Gen_Id);
5889                Set_Entity (Gen_Id, E);
5890                Set_Etype (Gen_Id, Etype (E));
5891                Set_Entity (S, E);
5892                Set_Etype (S, Etype (E));
5893
5894                --  Indicate that this is a reference to the parent
5895
5896                if In_Extended_Main_Source_Unit (Gen_Id) then
5897                   Set_Is_Instantiated (Inst_Par);
5898                end if;
5899
5900                --  A common mistake is to replicate the naming scheme of a
5901                --  hierarchy by instantiating a generic child directly, rather
5902                --  than the implicit child in a parent instance:
5903
5904                --  generic .. package Gpar is ..
5905                --  generic .. package Gpar.Child is ..
5906                --  package Par is new Gpar ();
5907
5908                --  with Gpar.Child;
5909                --  package Par.Child is new Gpar.Child ();
5910                --                           rather than Par.Child
5911
5912                --  In this case the instantiation is within Par, which is an
5913                --  instance, but Gpar does not denote Par because we are not IN
5914                --  the instance of Gpar, so this is illegal. The test below
5915                --  recognizes this particular case.
5916
5917                if Is_Child_Unit (E)
5918                  and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5919                  and then (not In_Instance
5920                              or else Nkind (Parent (Parent (Gen_Id))) =
5921                                                          N_Compilation_Unit)
5922                then
5923                   Error_Msg_N
5924                     ("prefix of generic child unit must be instance of parent",
5925                       Gen_Id);
5926                end if;
5927
5928                if not In_Open_Scopes (Inst_Par)
5929                  and then Nkind (Parent (Gen_Id)) not in
5930                                            N_Generic_Renaming_Declaration
5931                then
5932                   Install_Parent (Inst_Par);
5933                   Parent_Installed := True;
5934
5935                elsif In_Open_Scopes (Inst_Par) then
5936
5937                   --  If the parent is already installed, install the actuals
5938                   --  for its formal packages. This is necessary when the child
5939                   --  instance is a child of the parent instance: in this case,
5940                   --  the parent is placed on the scope stack but the formal
5941                   --  packages are not made visible.
5942
5943                   Install_Formal_Packages (Inst_Par);
5944                end if;
5945
5946             else
5947                --  If the generic parent does not contain an entity that
5948                --  corresponds to the selector, the instance doesn't either.
5949                --  Analyzing the node will yield the appropriate error message.
5950                --  If the entity is not a child unit, then it is an inner
5951                --  generic in the parent.
5952
5953                Analyze (Gen_Id);
5954             end if;
5955
5956          else
5957             Analyze (Gen_Id);
5958
5959             if Is_Child_Unit (Entity (Gen_Id))
5960               and then
5961                 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5962               and then not In_Open_Scopes (Inst_Par)
5963             then
5964                Install_Parent (Inst_Par);
5965                Parent_Installed := True;
5966
5967             --  The generic unit may be the renaming of the implicit child
5968             --  present in an instance. In that case the parent instance is
5969             --  obtained from the name of the renamed entity.
5970
5971             elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5972               and then Present (Renamed_Entity (Entity (Gen_Id)))
5973               and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5974             then
5975                declare
5976                   Renamed_Package : constant Node_Id :=
5977                                       Name (Parent (Entity (Gen_Id)));
5978                begin
5979                   if Nkind (Renamed_Package) = N_Expanded_Name then
5980                      Inst_Par := Entity (Prefix (Renamed_Package));
5981                      Install_Parent (Inst_Par);
5982                      Parent_Installed := True;
5983                   end if;
5984                end;
5985             end if;
5986          end if;
5987
5988       elsif Nkind (Gen_Id) = N_Expanded_Name then
5989
5990          --  Entity already present, analyze prefix, whose meaning may be
5991          --  an instance in the current context. If it is an instance of
5992          --  a relative within another, the proper parent may still have
5993          --  to be installed, if they are not of the same generation.
5994
5995          Analyze (Prefix (Gen_Id));
5996
5997          --  In the unlikely case that a local declaration hides the name
5998          --  of the parent package, locate it on the homonym chain. If the
5999          --  context is an instance of the parent, the renaming entity is
6000          --  flagged as such.
6001
6002          Inst_Par := Entity (Prefix (Gen_Id));
6003          while Present (Inst_Par)
6004            and then not Is_Package_Or_Generic_Package (Inst_Par)
6005          loop
6006             Inst_Par := Homonym (Inst_Par);
6007          end loop;
6008
6009          pragma Assert (Present (Inst_Par));
6010          Set_Entity (Prefix (Gen_Id), Inst_Par);
6011
6012          if In_Enclosing_Instance then
6013             null;
6014
6015          elsif Present (Entity (Gen_Id))
6016            and then Is_Child_Unit (Entity (Gen_Id))
6017            and then not In_Open_Scopes (Inst_Par)
6018          then
6019             Install_Parent (Inst_Par);
6020             Parent_Installed := True;
6021          end if;
6022
6023       elsif In_Enclosing_Instance then
6024
6025          --  The child unit is found in some enclosing scope
6026
6027          null;
6028
6029       else
6030          Analyze (Gen_Id);
6031
6032          --  If this is the renaming of the implicit child in a parent
6033          --  instance, recover the parent name and install it.
6034
6035          if Is_Entity_Name (Gen_Id) then
6036             E := Entity (Gen_Id);
6037
6038             if Is_Generic_Unit (E)
6039               and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6040               and then Is_Child_Unit (Renamed_Object (E))
6041               and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6042               and then Nkind (Name (Parent (E))) = N_Expanded_Name
6043             then
6044                Rewrite (Gen_Id,
6045                  New_Copy_Tree (Name (Parent (E))));
6046                Inst_Par := Entity (Prefix (Gen_Id));
6047
6048                if not In_Open_Scopes (Inst_Par) then
6049                   Install_Parent (Inst_Par);
6050                   Parent_Installed := True;
6051                end if;
6052
6053             --  If it is a child unit of a non-generic parent, it may be
6054             --  use-visible and given by a direct name. Install parent as
6055             --  for other cases.
6056
6057             elsif Is_Generic_Unit (E)
6058               and then Is_Child_Unit (E)
6059               and then
6060                 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6061               and then not Is_Generic_Unit (Scope (E))
6062             then
6063                if not In_Open_Scopes (Scope (E)) then
6064                   Install_Parent (Scope (E));
6065                   Parent_Installed := True;
6066                end if;
6067             end if;
6068          end if;
6069       end if;
6070    end Check_Generic_Child_Unit;
6071
6072    -----------------------------
6073    -- Check_Hidden_Child_Unit --
6074    -----------------------------
6075
6076    procedure Check_Hidden_Child_Unit
6077      (N           : Node_Id;
6078       Gen_Unit    : Entity_Id;
6079       Act_Decl_Id : Entity_Id)
6080    is
6081       Gen_Id : constant Node_Id := Name (N);
6082
6083    begin
6084       if Is_Child_Unit (Gen_Unit)
6085         and then Is_Child_Unit (Act_Decl_Id)
6086         and then Nkind (Gen_Id) = N_Expanded_Name
6087         and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6088         and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6089       then
6090          Error_Msg_Node_2 := Scope (Act_Decl_Id);
6091          Error_Msg_NE
6092            ("generic unit & is implicitly declared in &",
6093              Defining_Unit_Name (N), Gen_Unit);
6094          Error_Msg_N ("\instance must have different name",
6095            Defining_Unit_Name (N));
6096       end if;
6097    end Check_Hidden_Child_Unit;
6098
6099    ------------------------
6100    -- Check_Private_View --
6101    ------------------------
6102
6103    procedure Check_Private_View (N : Node_Id) is
6104       T : constant Entity_Id := Etype (N);
6105       BT : Entity_Id;
6106
6107    begin
6108       --  Exchange views if the type was not private in the generic but is
6109       --  private at the point of instantiation. Do not exchange views if
6110       --  the scope of the type is in scope. This can happen if both generic
6111       --  and instance are sibling units, or if type is defined in a parent.
6112       --  In this case the visibility of the type will be correct for all
6113       --  semantic checks.
6114
6115       if Present (T) then
6116          BT := Base_Type (T);
6117
6118          if Is_Private_Type (T)
6119            and then not Has_Private_View (N)
6120            and then Present (Full_View (T))
6121            and then not In_Open_Scopes (Scope (T))
6122          then
6123             --  In the generic, the full type was visible. Save the private
6124             --  entity, for subsequent exchange.
6125
6126             Switch_View (T);
6127
6128          elsif Has_Private_View (N)
6129            and then not Is_Private_Type (T)
6130            and then not Has_Been_Exchanged (T)
6131            and then Etype (Get_Associated_Node (N)) /= T
6132          then
6133             --  Only the private declaration was visible in the generic. If
6134             --  the type appears in a subtype declaration, the subtype in the
6135             --  instance must have a view compatible with that of its parent,
6136             --  which must be exchanged (see corresponding code in Restore_
6137             --  Private_Views). Otherwise, if the type is defined in a parent
6138             --  unit, leave full visibility within instance, which is safe.
6139
6140             if In_Open_Scopes (Scope (Base_Type (T)))
6141               and then not Is_Private_Type (Base_Type (T))
6142               and then Comes_From_Source (Base_Type (T))
6143             then
6144                null;
6145
6146             elsif Nkind (Parent (N)) = N_Subtype_Declaration
6147               or else not In_Private_Part (Scope (Base_Type (T)))
6148             then
6149                Prepend_Elmt (T, Exchanged_Views);
6150                Exchange_Declarations (Etype (Get_Associated_Node (N)));
6151             end if;
6152
6153          --  For composite types with inconsistent representation exchange
6154          --  component types accordingly.
6155
6156          elsif Is_Access_Type (T)
6157            and then Is_Private_Type (Designated_Type (T))
6158            and then not Has_Private_View (N)
6159            and then Present (Full_View (Designated_Type (T)))
6160          then
6161             Switch_View (Designated_Type (T));
6162
6163          elsif Is_Array_Type (T) then
6164             if Is_Private_Type (Component_Type (T))
6165               and then not Has_Private_View (N)
6166               and then Present (Full_View (Component_Type (T)))
6167             then
6168                Switch_View (Component_Type (T));
6169             end if;
6170
6171             --  The normal exchange mechanism relies on the setting of a
6172             --  flag on the reference in the generic. However, an additional
6173             --  mechanism is needed for types that are not explicitly
6174             --  mentioned in the generic, but may be needed in expanded code
6175             --  in the instance. This includes component types of arrays and
6176             --  designated types of access types. This processing must also
6177             --  include the index types of arrays which we take care of here.
6178
6179             declare
6180                Indx : Node_Id;
6181                Typ  : Entity_Id;
6182
6183             begin
6184                Indx := First_Index (T);
6185                while Present (Indx) loop
6186                   Typ := Base_Type (Etype (Indx));
6187
6188                   if Is_Private_Type (Typ)
6189                     and then Present (Full_View (Typ))
6190                   then
6191                      Switch_View (Typ);
6192                   end if;
6193
6194                   Next_Index (Indx);
6195                end loop;
6196             end;
6197
6198          elsif Is_Private_Type (T)
6199            and then Present (Full_View (T))
6200            and then Is_Array_Type (Full_View (T))
6201            and then Is_Private_Type (Component_Type (Full_View (T)))
6202          then
6203             Switch_View (T);
6204
6205          --  Finally, a non-private subtype may have a private base type, which
6206          --  must be exchanged for consistency. This can happen when a package
6207          --  body is instantiated, when the scope stack is empty but in fact
6208          --  the subtype and the base type are declared in an enclosing scope.
6209
6210          --  Note that in this case we introduce an inconsistency in the view
6211          --  set, because we switch the base type BT, but there could be some
6212          --  private dependent subtypes of BT which remain unswitched. Such
6213          --  subtypes might need to be switched at a later point (see specific
6214          --  provision for that case in Switch_View).
6215
6216          elsif not Is_Private_Type (T)
6217            and then not Has_Private_View (N)
6218            and then Is_Private_Type (BT)
6219            and then Present (Full_View (BT))
6220            and then not Is_Generic_Type (BT)
6221            and then not In_Open_Scopes (BT)
6222          then
6223             Prepend_Elmt (Full_View (BT), Exchanged_Views);
6224             Exchange_Declarations (BT);
6225          end if;
6226       end if;
6227    end Check_Private_View;
6228
6229    -----------------------------
6230    -- Check_Hidden_Primitives --
6231    -----------------------------
6232
6233    function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6234       Actual : Node_Id;
6235       Gen_T  : Entity_Id;
6236       Result : Elist_Id := No_Elist;
6237
6238    begin
6239       if No (Assoc_List) then
6240          return No_Elist;
6241       end if;
6242
6243       --  Traverse the list of associations between formals and actuals
6244       --  searching for renamings of tagged types
6245
6246       Actual := First (Assoc_List);
6247       while Present (Actual) loop
6248          if Nkind (Actual) = N_Subtype_Declaration then
6249             Gen_T := Generic_Parent_Type (Actual);
6250
6251             if Present (Gen_T)
6252               and then Is_Tagged_Type (Gen_T)
6253             then
6254                --  Traverse the list of primitives of the actual types
6255                --  searching for hidden primitives that are visible in the
6256                --  corresponding generic formal; leave them visible and
6257                --  append them to Result to restore their decoration later.
6258
6259                Install_Hidden_Primitives
6260                  (Prims_List => Result,
6261                   Gen_T      => Gen_T,
6262                   Act_T      => Entity (Subtype_Indication (Actual)));
6263             end if;
6264          end if;
6265
6266          Next (Actual);
6267       end loop;
6268
6269       return Result;
6270    end Check_Hidden_Primitives;
6271
6272    --------------------------
6273    -- Contains_Instance_Of --
6274    --------------------------
6275
6276    function Contains_Instance_Of
6277      (Inner : Entity_Id;
6278       Outer : Entity_Id;
6279       N     : Node_Id) return Boolean
6280    is
6281       Elmt : Elmt_Id;
6282       Scop : Entity_Id;
6283
6284    begin
6285       Scop := Outer;
6286
6287       --  Verify that there are no circular instantiations. We check whether
6288       --  the unit contains an instance of the current scope or some enclosing
6289       --  scope (in case one of the instances appears in a subunit). Longer
6290       --  circularities involving subunits might seem too pathological to
6291       --  consider, but they were not too pathological for the authors of
6292       --  DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6293       --  enclosing generic scopes as containing an instance.
6294
6295       loop
6296          --  Within a generic subprogram body, the scope is not generic, to
6297          --  allow for recursive subprograms. Use the declaration to determine
6298          --  whether this is a generic unit.
6299
6300          if Ekind (Scop) = E_Generic_Package
6301            or else (Is_Subprogram (Scop)
6302                       and then Nkind (Unit_Declaration_Node (Scop)) =
6303                                         N_Generic_Subprogram_Declaration)
6304          then
6305             Elmt := First_Elmt (Inner_Instances (Inner));
6306
6307             while Present (Elmt) loop
6308                if Node (Elmt) = Scop then
6309                   Error_Msg_Node_2 := Inner;
6310                   Error_Msg_NE
6311                     ("circular Instantiation: & instantiated within &!",
6312                        N, Scop);
6313                   return True;
6314
6315                elsif Node (Elmt) = Inner then
6316                   return True;
6317
6318                elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6319                   Error_Msg_Node_2 := Inner;
6320                   Error_Msg_NE
6321                     ("circular Instantiation: & instantiated within &!",
6322                       N, Node (Elmt));
6323                   return True;
6324                end if;
6325
6326                Next_Elmt (Elmt);
6327             end loop;
6328
6329             --  Indicate that Inner is being instantiated within Scop
6330
6331             Append_Elmt (Inner, Inner_Instances (Scop));
6332          end if;
6333
6334          if Scop = Standard_Standard then
6335             exit;
6336          else
6337             Scop := Scope (Scop);
6338          end if;
6339       end loop;
6340
6341       return False;
6342    end Contains_Instance_Of;
6343
6344    -----------------------
6345    -- Copy_Generic_Node --
6346    -----------------------
6347
6348    function Copy_Generic_Node
6349      (N             : Node_Id;
6350       Parent_Id     : Node_Id;
6351       Instantiating : Boolean) return Node_Id
6352    is
6353       Ent   : Entity_Id;
6354       New_N : Node_Id;
6355
6356       function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6357       --  Check the given value of one of the Fields referenced by the current
6358       --  node to determine whether to copy it recursively. The field may hold
6359       --  a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6360       --  Char) in which case it need not be copied.
6361
6362       procedure Copy_Descendants;
6363       --  Common utility for various nodes
6364
6365       function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6366       --  Make copy of element list
6367
6368       function Copy_Generic_List
6369         (L         : List_Id;
6370          Parent_Id : Node_Id) return List_Id;
6371       --  Apply Copy_Node recursively to the members of a node list
6372
6373       function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6374       --  True if an identifier is part of the defining program unit name of
6375       --  a child unit. The entity of such an identifier must be kept (for
6376       --  ASIS use) even though as the name of an enclosing generic it would
6377       --  otherwise not be preserved in the generic tree.
6378
6379       ----------------------
6380       -- Copy_Descendants --
6381       ----------------------
6382
6383       procedure Copy_Descendants is
6384
6385          use Atree.Unchecked_Access;
6386          --  This code section is part of the implementation of an untyped
6387          --  tree traversal, so it needs direct access to node fields.
6388
6389       begin
6390          Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6391          Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6392          Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6393          Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6394          Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6395       end Copy_Descendants;
6396
6397       -----------------------------
6398       -- Copy_Generic_Descendant --
6399       -----------------------------
6400
6401       function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6402       begin
6403          if D = Union_Id (Empty) then
6404             return D;
6405
6406          elsif D in Node_Range then
6407             return Union_Id
6408               (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6409
6410          elsif D in List_Range then
6411             return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6412
6413          elsif D in Elist_Range then
6414             return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6415
6416          --  Nothing else is copyable (e.g. Uint values), return as is
6417
6418          else
6419             return D;
6420          end if;
6421       end Copy_Generic_Descendant;
6422
6423       ------------------------
6424       -- Copy_Generic_Elist --
6425       ------------------------
6426
6427       function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6428          M : Elmt_Id;
6429          L : Elist_Id;
6430
6431       begin
6432          if Present (E) then
6433             L := New_Elmt_List;
6434             M := First_Elmt (E);
6435             while Present (M) loop
6436                Append_Elmt
6437                  (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6438                Next_Elmt (M);
6439             end loop;
6440
6441             return L;
6442
6443          else
6444             return No_Elist;
6445          end if;
6446       end Copy_Generic_Elist;
6447
6448       -----------------------
6449       -- Copy_Generic_List --
6450       -----------------------
6451
6452       function Copy_Generic_List
6453         (L         : List_Id;
6454          Parent_Id : Node_Id) return List_Id
6455       is
6456          N     : Node_Id;
6457          New_L : List_Id;
6458
6459       begin
6460          if Present (L) then
6461             New_L := New_List;
6462             Set_Parent (New_L, Parent_Id);
6463
6464             N := First (L);
6465             while Present (N) loop
6466                Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6467                Next (N);
6468             end loop;
6469
6470             return New_L;
6471
6472          else
6473             return No_List;
6474          end if;
6475       end Copy_Generic_List;
6476
6477       ---------------------------
6478       -- In_Defining_Unit_Name --
6479       ---------------------------
6480
6481       function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6482       begin
6483          return Present (Parent (Nam))
6484            and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6485                       or else
6486                         (Nkind (Parent (Nam)) = N_Expanded_Name
6487                           and then In_Defining_Unit_Name (Parent (Nam))));
6488       end In_Defining_Unit_Name;
6489
6490    --  Start of processing for Copy_Generic_Node
6491
6492    begin
6493       if N = Empty then
6494          return N;
6495       end if;
6496
6497       New_N := New_Copy (N);
6498
6499       --  Copy aspects if present
6500
6501       if Has_Aspects (N) then
6502          Set_Has_Aspects (New_N, False);
6503          Set_Aspect_Specifications
6504            (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6505       end if;
6506
6507       if Instantiating then
6508          Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6509       end if;
6510
6511       if not Is_List_Member (N) then
6512          Set_Parent (New_N, Parent_Id);
6513       end if;
6514
6515       --  If defining identifier, then all fields have been copied already
6516
6517       if Nkind (New_N) in N_Entity then
6518          null;
6519
6520       --  Special casing for identifiers and other entity names and operators
6521
6522       elsif Nkind_In (New_N, N_Identifier,
6523                              N_Character_Literal,
6524                              N_Expanded_Name,
6525                              N_Operator_Symbol)
6526         or else Nkind (New_N) in N_Op
6527       then
6528          if not Instantiating then
6529
6530             --  Link both nodes in order to assign subsequently the entity of
6531             --  the copy to the original node, in case this is a global
6532             --  reference.
6533
6534             Set_Associated_Node (N, New_N);
6535
6536             --  If we are within an instantiation, this is a nested generic
6537             --  that has already been analyzed at the point of definition.
6538             --  We must preserve references that were global to the enclosing
6539             --  parent at that point. Other occurrences, whether global or
6540             --  local to the current generic, must be resolved anew, so we
6541             --  reset the entity in the generic copy. A global reference has a
6542             --  smaller depth than the parent, or else the same depth in case
6543             --  both are distinct compilation units.
6544
6545             --  A child unit is implicitly declared within the enclosing parent
6546             --  but is in fact global to it, and must be preserved.
6547
6548             --  It is also possible for Current_Instantiated_Parent to be
6549             --  defined, and for this not to be a nested generic, namely if
6550             --  the unit is loaded through Rtsfind. In that case, the entity of
6551             --  New_N is only a link to the associated node, and not a defining
6552             --  occurrence.
6553
6554             --  The entities for parent units in the defining_program_unit of a
6555             --  generic child unit are established when the context of the unit
6556             --  is first analyzed, before the generic copy is made. They are
6557             --  preserved in the copy for use in ASIS queries.
6558
6559             Ent := Entity (New_N);
6560
6561             if No (Current_Instantiated_Parent.Gen_Id) then
6562                if No (Ent)
6563                  or else Nkind (Ent) /= N_Defining_Identifier
6564                  or else not In_Defining_Unit_Name (N)
6565                then
6566                   Set_Associated_Node (New_N, Empty);
6567                end if;
6568
6569             elsif No (Ent)
6570               or else
6571                 not Nkind_In (Ent, N_Defining_Identifier,
6572                                    N_Defining_Character_Literal,
6573                                    N_Defining_Operator_Symbol)
6574               or else No (Scope (Ent))
6575               or else
6576                 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6577                   and then not Is_Child_Unit (Ent))
6578               or else
6579                 (Scope_Depth (Scope (Ent)) >
6580                              Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6581                   and then
6582                     Get_Source_Unit (Ent) =
6583                     Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6584             then
6585                Set_Associated_Node (New_N, Empty);
6586             end if;
6587
6588          --  Case of instantiating identifier or some other name or operator
6589
6590          else
6591             --  If the associated node is still defined, the entity in it
6592             --  is global, and must be copied to the instance. If this copy
6593             --  is being made for a body to inline, it is applied to an
6594             --  instantiated tree, and the entity is already present and
6595             --  must be also preserved.
6596
6597             declare
6598                Assoc : constant Node_Id := Get_Associated_Node (N);
6599
6600             begin
6601                if Present (Assoc) then
6602                   if Nkind (Assoc) = Nkind (N) then
6603                      Set_Entity (New_N, Entity (Assoc));
6604                      Check_Private_View (N);
6605
6606                   --  The name in the call may be a selected component if the
6607                   --  call has not been analyzed yet, as may be the case for
6608                   --  pre/post conditions in a generic unit.
6609
6610                   elsif Nkind (Assoc) = N_Function_Call
6611                     and then Is_Entity_Name (Name (Assoc))
6612                   then
6613                      Set_Entity (New_N, Entity (Name (Assoc)));
6614
6615                   elsif Nkind_In (Assoc, N_Defining_Identifier,
6616                                          N_Defining_Character_Literal,
6617                                          N_Defining_Operator_Symbol)
6618                     and then Expander_Active
6619                   then
6620                      --  Inlining case: we are copying a tree that contains
6621                      --  global entities, which are preserved in the copy to be
6622                      --  used for subsequent inlining.
6623
6624                      null;
6625
6626                   else
6627                      Set_Entity (New_N, Empty);
6628                   end if;
6629                end if;
6630             end;
6631          end if;
6632
6633          --  For expanded name, we must copy the Prefix and Selector_Name
6634
6635          if Nkind (N) = N_Expanded_Name then
6636             Set_Prefix
6637               (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6638
6639             Set_Selector_Name (New_N,
6640               Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6641
6642          --  For operators, we must copy the right operand
6643
6644          elsif Nkind (N) in N_Op then
6645             Set_Right_Opnd (New_N,
6646               Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6647
6648             --  And for binary operators, the left operand as well
6649
6650             if Nkind (N) in N_Binary_Op then
6651                Set_Left_Opnd (New_N,
6652                  Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6653             end if;
6654          end if;
6655
6656       --  Special casing for stubs
6657
6658       elsif Nkind (N) in N_Body_Stub then
6659
6660          --  In any case, we must copy the specification or defining
6661          --  identifier as appropriate.
6662
6663          if Nkind (N) = N_Subprogram_Body_Stub then
6664             Set_Specification (New_N,
6665               Copy_Generic_Node (Specification (N), New_N, Instantiating));
6666
6667          else
6668             Set_Defining_Identifier (New_N,
6669               Copy_Generic_Node
6670                 (Defining_Identifier (N), New_N, Instantiating));
6671          end if;
6672
6673          --  If we are not instantiating, then this is where we load and
6674          --  analyze subunits, i.e. at the point where the stub occurs. A
6675          --  more permissive system might defer this analysis to the point
6676          --  of instantiation, but this seems too complicated for now.
6677
6678          if not Instantiating then
6679             declare
6680                Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6681                Subunit      : Node_Id;
6682                Unum         : Unit_Number_Type;
6683                New_Body     : Node_Id;
6684
6685             begin
6686                --  Make sure that, if it is a subunit of the main unit that is
6687                --  preprocessed and if -gnateG is specified, the preprocessed
6688                --  file will be written.
6689
6690                Lib.Analysing_Subunit_Of_Main :=
6691                  Lib.In_Extended_Main_Source_Unit (N);
6692                Unum :=
6693                  Load_Unit
6694                    (Load_Name  => Subunit_Name,
6695                     Required   => False,
6696                     Subunit    => True,
6697                     Error_Node => N);
6698                Lib.Analysing_Subunit_Of_Main := False;
6699
6700                --  If the proper body is not found, a warning message will be
6701                --  emitted when analyzing the stub, or later at the point of
6702                --  instantiation. Here we just leave the stub as is.
6703
6704                if Unum = No_Unit then
6705                   Subunits_Missing := True;
6706                   goto Subunit_Not_Found;
6707                end if;
6708
6709                Subunit := Cunit (Unum);
6710
6711                if Nkind (Unit (Subunit)) /= N_Subunit then
6712                   Error_Msg_N
6713                     ("found child unit instead of expected SEPARATE subunit",
6714                      Subunit);
6715                   Error_Msg_Sloc := Sloc (N);
6716                   Error_Msg_N ("\to complete stub #", Subunit);
6717                   goto Subunit_Not_Found;
6718                end if;
6719
6720                --  We must create a generic copy of the subunit, in order to
6721                --  perform semantic analysis on it, and we must replace the
6722                --  stub in the original generic unit with the subunit, in order
6723                --  to preserve non-local references within.
6724
6725                --  Only the proper body needs to be copied. Library_Unit and
6726                --  context clause are simply inherited by the generic copy.
6727                --  Note that the copy (which may be recursive if there are
6728                --  nested subunits) must be done first, before attaching it to
6729                --  the enclosing generic.
6730
6731                New_Body :=
6732                  Copy_Generic_Node
6733                    (Proper_Body (Unit (Subunit)),
6734                     Empty, Instantiating => False);
6735
6736                --  Now place the original proper body in the original generic
6737                --  unit. This is a body, not a compilation unit.
6738
6739                Rewrite (N, Proper_Body (Unit (Subunit)));
6740                Set_Is_Compilation_Unit (Defining_Entity (N), False);
6741                Set_Was_Originally_Stub (N);
6742
6743                --  Finally replace the body of the subunit with its copy, and
6744                --  make this new subunit into the library unit of the generic
6745                --  copy, which does not have stubs any longer.
6746
6747                Set_Proper_Body (Unit (Subunit), New_Body);
6748                Set_Library_Unit (New_N, Subunit);
6749                Inherit_Context (Unit (Subunit), N);
6750             end;
6751
6752          --  If we are instantiating, this must be an error case, since
6753          --  otherwise we would have replaced the stub node by the proper body
6754          --  that corresponds. So just ignore it in the copy (i.e. we have
6755          --  copied it, and that is good enough).
6756
6757          else
6758             null;
6759          end if;
6760
6761          <<Subunit_Not_Found>> null;
6762
6763       --  If the node is a compilation unit, it is the subunit of a stub, which
6764       --  has been loaded already (see code below). In this case, the library
6765       --  unit field of N points to the parent unit (which is a compilation
6766       --  unit) and need not (and cannot!) be copied.
6767
6768       --  When the proper body of the stub is analyzed, the library_unit link
6769       --  is used to establish the proper context (see sem_ch10).
6770
6771       --  The other fields of a compilation unit are copied as usual
6772
6773       elsif Nkind (N) = N_Compilation_Unit then
6774
6775          --  This code can only be executed when not instantiating, because in
6776          --  the copy made for an instantiation, the compilation unit node has
6777          --  disappeared at the point that a stub is replaced by its proper
6778          --  body.
6779
6780          pragma Assert (not Instantiating);
6781
6782          Set_Context_Items (New_N,
6783            Copy_Generic_List (Context_Items (N), New_N));
6784
6785          Set_Unit (New_N,
6786            Copy_Generic_Node (Unit (N), New_N, False));
6787
6788          Set_First_Inlined_Subprogram (New_N,
6789            Copy_Generic_Node
6790              (First_Inlined_Subprogram (N), New_N, False));
6791
6792          Set_Aux_Decls_Node (New_N,
6793            Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6794
6795       --  For an assignment node, the assignment is known to be semantically
6796       --  legal if we are instantiating the template. This avoids incorrect
6797       --  diagnostics in generated code.
6798
6799       elsif Nkind (N) = N_Assignment_Statement then
6800
6801          --  Copy name and expression fields in usual manner
6802
6803          Set_Name (New_N,
6804            Copy_Generic_Node (Name (N), New_N, Instantiating));
6805
6806          Set_Expression (New_N,
6807            Copy_Generic_Node (Expression (N), New_N, Instantiating));
6808
6809          if Instantiating then
6810             Set_Assignment_OK (Name (New_N), True);
6811          end if;
6812
6813       elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6814          if not Instantiating then
6815             Set_Associated_Node (N, New_N);
6816
6817          else
6818             if Present (Get_Associated_Node (N))
6819               and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6820             then
6821                --  In the generic the aggregate has some composite type. If at
6822                --  the point of instantiation the type has a private view,
6823                --  install the full view (and that of its ancestors, if any).
6824
6825                declare
6826                   T   : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6827                   Rt  : Entity_Id;
6828
6829                begin
6830                   if Present (T)
6831                     and then Is_Private_Type (T)
6832                   then
6833                      Switch_View (T);
6834                   end if;
6835
6836                   if Present (T)
6837                     and then Is_Tagged_Type (T)
6838                     and then Is_Derived_Type (T)
6839                   then
6840                      Rt := Root_Type (T);
6841
6842                      loop
6843                         T := Etype (T);
6844
6845                         if Is_Private_Type (T) then
6846                            Switch_View (T);
6847                         end if;
6848
6849                         exit when T = Rt;
6850                      end loop;
6851                   end if;
6852                end;
6853             end if;
6854          end if;
6855
6856          --  Do not copy the associated node, which points to the generic copy
6857          --  of the aggregate.
6858
6859          declare
6860             use Atree.Unchecked_Access;
6861             --  This code section is part of the implementation of an untyped
6862             --  tree traversal, so it needs direct access to node fields.
6863
6864          begin
6865             Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6866             Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6867             Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6868             Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6869          end;
6870
6871       --  Allocators do not have an identifier denoting the access type, so we
6872       --  must locate it through the expression to check whether the views are
6873       --  consistent.
6874
6875       elsif Nkind (N) = N_Allocator
6876         and then Nkind (Expression (N)) = N_Qualified_Expression
6877         and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6878         and then Instantiating
6879       then
6880          declare
6881             T     : constant Node_Id :=
6882                       Get_Associated_Node (Subtype_Mark (Expression (N)));
6883             Acc_T : Entity_Id;
6884
6885          begin
6886             if Present (T) then
6887
6888                --  Retrieve the allocator node in the generic copy
6889
6890                Acc_T := Etype (Parent (Parent (T)));
6891                if Present (Acc_T)
6892                  and then Is_Private_Type (Acc_T)
6893                then
6894                   Switch_View (Acc_T);
6895                end if;
6896             end if;
6897
6898             Copy_Descendants;
6899          end;
6900
6901       --  For a proper body, we must catch the case of a proper body that
6902       --  replaces a stub. This represents the point at which a separate
6903       --  compilation unit, and hence template file, may be referenced, so we
6904       --  must make a new source instantiation entry for the template of the
6905       --  subunit, and ensure that all nodes in the subunit are adjusted using
6906       --  this new source instantiation entry.
6907
6908       elsif Nkind (N) in N_Proper_Body then
6909          declare
6910             Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6911
6912          begin
6913             if Instantiating and then Was_Originally_Stub (N) then
6914                Create_Instantiation_Source
6915                  (Instantiation_Node,
6916                   Defining_Entity (N),
6917                   False,
6918                   S_Adjustment);
6919             end if;
6920
6921             --  Now copy the fields of the proper body, using the new
6922             --  adjustment factor if one was needed as per test above.
6923
6924             Copy_Descendants;
6925
6926             --  Restore the original adjustment factor in case changed
6927
6928             S_Adjustment := Save_Adjustment;
6929          end;
6930
6931       --  Don't copy Ident or Comment pragmas, since the comment belongs to the
6932       --  generic unit, not to the instantiating unit.
6933
6934       elsif Nkind (N) = N_Pragma and then Instantiating then
6935          declare
6936             Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6937          begin
6938             if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6939                New_N := Make_Null_Statement (Sloc (N));
6940             else
6941                Copy_Descendants;
6942             end if;
6943          end;
6944
6945       elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6946
6947          --  No descendant fields need traversing
6948
6949          null;
6950
6951       elsif Nkind (N) = N_String_Literal
6952         and then Present (Etype (N))
6953         and then Instantiating
6954       then
6955          --  If the string is declared in an outer scope, the string_literal
6956          --  subtype created for it may have the wrong scope. We force the
6957          --  reanalysis of the constant to generate a new itype in the proper
6958          --  context.
6959
6960          Set_Etype (New_N, Empty);
6961          Set_Analyzed (New_N, False);
6962
6963       --  For the remaining nodes, copy their descendants recursively
6964
6965       else
6966          Copy_Descendants;
6967
6968          if Instantiating and then Nkind (N) = N_Subprogram_Body then
6969             Set_Generic_Parent (Specification (New_N), N);
6970
6971             --  Should preserve Corresponding_Spec??? (12.3(14))
6972          end if;
6973       end if;
6974
6975       return New_N;
6976    end Copy_Generic_Node;
6977
6978    ----------------------------
6979    -- Denotes_Formal_Package --
6980    ----------------------------
6981
6982    function Denotes_Formal_Package
6983      (Pack     : Entity_Id;
6984       On_Exit  : Boolean := False;
6985       Instance : Entity_Id := Empty) return Boolean
6986    is
6987       Par  : Entity_Id;
6988       Scop : constant Entity_Id := Scope (Pack);
6989       E    : Entity_Id;
6990
6991       function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6992       --  The package in question may be an actual for a previous formal
6993       --  package P of the current instance, so examine its actuals as well.
6994       --  This must be recursive over other formal packages.
6995
6996       ----------------------------------
6997       -- Is_Actual_Of_Previous_Formal --
6998       ----------------------------------
6999
7000       function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7001          E1 : Entity_Id;
7002
7003       begin
7004          E1 := First_Entity (P);
7005          while Present (E1) and then  E1 /= Instance loop
7006             if Ekind (E1) = E_Package
7007               and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7008             then
7009                if Renamed_Object (E1) = Pack then
7010                   return True;
7011
7012                elsif E1 = P or else  Renamed_Object (E1) = P then
7013                   return False;
7014
7015                elsif Is_Actual_Of_Previous_Formal (E1) then
7016                   return True;
7017                end if;
7018             end if;
7019
7020             Next_Entity (E1);
7021          end loop;
7022
7023          return False;
7024       end Is_Actual_Of_Previous_Formal;
7025
7026    --  Start of processing for Denotes_Formal_Package
7027
7028    begin
7029       if On_Exit then
7030          Par :=
7031            Instance_Envs.Table
7032              (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7033       else
7034          Par := Current_Instantiated_Parent.Act_Id;
7035       end if;
7036
7037       if Ekind (Scop) = E_Generic_Package
7038         or else Nkind (Unit_Declaration_Node (Scop)) =
7039                                          N_Generic_Subprogram_Declaration
7040       then
7041          return True;
7042
7043       elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7044         N_Formal_Package_Declaration
7045       then
7046          return True;
7047
7048       elsif No (Par) then
7049          return False;
7050
7051       else
7052          --  Check whether this package is associated with a formal package of
7053          --  the enclosing instantiation. Iterate over the list of renamings.
7054
7055          E := First_Entity (Par);
7056          while Present (E) loop
7057             if Ekind (E) /= E_Package
7058               or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7059             then
7060                null;
7061
7062             elsif Renamed_Object (E) = Par then
7063                return False;
7064
7065             elsif Renamed_Object (E) = Pack then
7066                return True;
7067
7068             elsif Is_Actual_Of_Previous_Formal (E) then
7069                return True;
7070
7071             end if;
7072
7073             Next_Entity (E);
7074          end loop;
7075
7076          return False;
7077       end if;
7078    end Denotes_Formal_Package;
7079
7080    -----------------
7081    -- End_Generic --
7082    -----------------
7083
7084    procedure End_Generic is
7085    begin
7086       --  ??? More things could be factored out in this routine. Should
7087       --  probably be done at a later stage.
7088
7089       Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7090       Generic_Flags.Decrement_Last;
7091
7092       Expander_Mode_Restore;
7093    end End_Generic;
7094
7095    -------------
7096    -- Earlier --
7097    -------------
7098
7099    function Earlier (N1, N2 : Node_Id) return Boolean is
7100       procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7101       --  Find distance from given node to enclosing compilation unit
7102
7103       ----------------
7104       -- Find_Depth --
7105       ----------------
7106
7107       procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7108       begin
7109          while Present (P)
7110            and then Nkind (P) /= N_Compilation_Unit
7111          loop
7112             P := True_Parent (P);
7113             D := D + 1;
7114          end loop;
7115       end Find_Depth;
7116
7117       --  Local declarations
7118
7119       D1 : Integer := 0;
7120       D2 : Integer := 0;
7121       P1 : Node_Id := N1;
7122       P2 : Node_Id := N2;
7123       T1 : Source_Ptr;
7124       T2 : Source_Ptr;
7125
7126    --  Start of processing for Earlier
7127
7128    begin
7129       Find_Depth (P1, D1);
7130       Find_Depth (P2, D2);
7131
7132       if P1 /= P2 then
7133          return False;
7134       else
7135          P1 := N1;
7136          P2 := N2;
7137       end if;
7138
7139       while D1 > D2 loop
7140          P1 := True_Parent (P1);
7141          D1 := D1 - 1;
7142       end loop;
7143
7144       while D2 > D1 loop
7145          P2 := True_Parent (P2);
7146          D2 := D2 - 1;
7147       end loop;
7148
7149       --  At this point P1 and P2 are at the same distance from the root.
7150       --  We examine their parents until we find a common declarative list.
7151       --  If we reach the root, N1 and N2 do not descend from the same
7152       --  declarative list (e.g. one is nested in the declarative part and
7153       --  the other is in a block in the statement part) and the earlier
7154       --  one is already frozen.
7155
7156       while not Is_List_Member (P1)
7157         or else not Is_List_Member (P2)
7158         or else List_Containing (P1) /= List_Containing (P2)
7159       loop
7160          P1 := True_Parent (P1);
7161          P2 := True_Parent (P2);
7162
7163          if Nkind (Parent (P1)) = N_Subunit then
7164             P1 := Corresponding_Stub (Parent (P1));
7165          end if;
7166
7167          if Nkind (Parent (P2)) = N_Subunit then
7168             P2 := Corresponding_Stub (Parent (P2));
7169          end if;
7170
7171          if P1 = P2 then
7172             return False;
7173          end if;
7174       end loop;
7175
7176       --  Expanded code usually shares the source location of the original
7177       --  construct it was generated for. This however may not necessarely
7178       --  reflect the true location of the code within the tree.
7179
7180       --  Before comparing the slocs of the two nodes, make sure that we are
7181       --  working with correct source locations. Assume that P1 is to the left
7182       --  of P2. If either one does not come from source, traverse the common
7183       --  list heading towards the other node and locate the first source
7184       --  statement.
7185
7186       --             P1                     P2
7187       --     ----+===+===+--------------+===+===+----
7188       --          expanded code          expanded code
7189
7190       if not Comes_From_Source (P1) then
7191          while Present (P1) loop
7192
7193             --  Neither P2 nor a source statement were located during the
7194             --  search. If we reach the end of the list, then P1 does not
7195             --  occur earlier than P2.
7196
7197             --                     ---->
7198             --   start --- P2 ----- P1 --- end
7199
7200             if No (Next (P1)) then
7201                return False;
7202
7203             --  We encounter P2 while going to the right of the list. This
7204             --  means that P1 does indeed appear earlier.
7205
7206             --             ---->
7207             --    start --- P1 ===== P2 --- end
7208             --                 expanded code in between
7209
7210             elsif P1 = P2 then
7211                return True;
7212
7213             --  No need to look any further since we have located a source
7214             --  statement.
7215
7216             elsif Comes_From_Source (P1) then
7217                exit;
7218             end if;
7219
7220             --  Keep going right
7221
7222             Next (P1);
7223          end loop;
7224       end if;
7225
7226       if not Comes_From_Source (P2) then
7227          while Present (P2) loop
7228
7229             --  Neither P1 nor a source statement were located during the
7230             --  search. If we reach the start of the list, then P1 does not
7231             --  occur earlier than P2.
7232
7233             --            <----
7234             --    start --- P2 --- P1 --- end
7235
7236             if No (Prev (P2)) then
7237                return False;
7238
7239             --  We encounter P1 while going to the left of the list. This
7240             --  means that P1 does indeed appear earlier.
7241
7242             --                     <----
7243             --    start --- P1 ===== P2 --- end
7244             --                 expanded code in between
7245
7246             elsif P2 = P1 then
7247                return True;
7248
7249             --  No need to look any further since we have located a source
7250             --  statement.
7251
7252             elsif Comes_From_Source (P2) then
7253                exit;
7254             end if;
7255
7256             --  Keep going left
7257
7258             Prev (P2);
7259          end loop;
7260       end if;
7261
7262       --  At this point either both nodes came from source or we approximated
7263       --  their source locations through neighbouring source statements.
7264
7265       T1 := Top_Level_Location (Sloc (P1));
7266       T2 := Top_Level_Location (Sloc (P2));
7267
7268       --  When two nodes come from the same instance, they have identical top
7269       --  level locations. To determine proper relation within the tree, check
7270       --  their locations within the template.
7271
7272       if T1 = T2 then
7273          return Sloc (P1) < Sloc (P2);
7274
7275       --  The two nodes either come from unrelated instances or do not come
7276       --  from instantiated code at all.
7277
7278       else
7279          return T1 < T2;
7280       end if;
7281    end Earlier;
7282
7283    ----------------------
7284    -- Find_Actual_Type --
7285    ----------------------
7286
7287    function Find_Actual_Type
7288      (Typ      : Entity_Id;
7289       Gen_Type : Entity_Id) return Entity_Id
7290    is
7291       Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7292       T         : Entity_Id;
7293
7294    begin
7295       --  Special processing only applies to child units
7296
7297       if not Is_Child_Unit (Gen_Scope) then
7298          return Get_Instance_Of (Typ);
7299
7300       --  If designated or component type is itself a formal of the child unit,
7301       --  its instance is available.
7302
7303       elsif Scope (Typ) = Gen_Scope then
7304          return Get_Instance_Of (Typ);
7305
7306       --  If the array or access type is not declared in the parent unit,
7307       --  no special processing needed.
7308
7309       elsif not Is_Generic_Type (Typ)
7310         and then Scope (Gen_Scope) /= Scope (Typ)
7311       then
7312          return Get_Instance_Of (Typ);
7313
7314       --  Otherwise, retrieve designated or component type by visibility
7315
7316       else
7317          T := Current_Entity (Typ);
7318          while Present (T) loop
7319             if In_Open_Scopes (Scope (T)) then
7320                return T;
7321
7322             elsif Is_Generic_Actual_Type (T) then
7323                return T;
7324             end if;
7325
7326             T := Homonym (T);
7327          end loop;
7328
7329          return Typ;
7330       end if;
7331    end Find_Actual_Type;
7332
7333    ----------------------------
7334    -- Freeze_Subprogram_Body --
7335    ----------------------------
7336
7337    procedure Freeze_Subprogram_Body
7338      (Inst_Node : Node_Id;
7339       Gen_Body  : Node_Id;
7340       Pack_Id   : Entity_Id)
7341   is
7342       Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7343       Par      : constant Entity_Id := Scope (Gen_Unit);
7344       E_G_Id   : Entity_Id;
7345       Enc_G    : Entity_Id;
7346       Enc_I    : Node_Id;
7347       F_Node   : Node_Id;
7348
7349       function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7350       --  Find innermost package body that encloses the given node, and which
7351       --  is not a compilation unit. Freeze nodes for the instance, or for its
7352       --  enclosing body, may be inserted after the enclosing_body of the
7353       --  generic unit. Used to determine proper placement of freeze node for
7354       --  both package and subprogram instances.
7355
7356       function Package_Freeze_Node (B : Node_Id) return Node_Id;
7357       --  Find entity for given package body, and locate or create a freeze
7358       --  node for it.
7359
7360       ----------------------------
7361       -- Enclosing_Package_Body --
7362       ----------------------------
7363
7364       function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7365          P : Node_Id;
7366
7367       begin
7368          P := Parent (N);
7369          while Present (P)
7370            and then Nkind (Parent (P)) /= N_Compilation_Unit
7371          loop
7372             if Nkind (P) = N_Package_Body then
7373                if Nkind (Parent (P)) = N_Subunit then
7374                   return Corresponding_Stub (Parent (P));
7375                else
7376                   return P;
7377                end if;
7378             end if;
7379
7380             P := True_Parent (P);
7381          end loop;
7382
7383          return Empty;
7384       end Enclosing_Package_Body;
7385
7386       -------------------------
7387       -- Package_Freeze_Node --
7388       -------------------------
7389
7390       function Package_Freeze_Node (B : Node_Id) return Node_Id is
7391          Id : Entity_Id;
7392
7393       begin
7394          if Nkind (B) = N_Package_Body then
7395             Id := Corresponding_Spec (B);
7396          else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7397             Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7398          end if;
7399
7400          Ensure_Freeze_Node (Id);
7401          return Freeze_Node (Id);
7402       end Package_Freeze_Node;
7403
7404    --  Start of processing of Freeze_Subprogram_Body
7405
7406    begin
7407       --  If the instance and the generic body appear within the same unit, and
7408       --  the instance precedes the generic, the freeze node for the instance
7409       --  must appear after that of the generic. If the generic is nested
7410       --  within another instance I2, then current instance must be frozen
7411       --  after I2. In both cases, the freeze nodes are those of enclosing
7412       --  packages. Otherwise, the freeze node is placed at the end of the
7413       --  current declarative part.
7414
7415       Enc_G  := Enclosing_Package_Body (Gen_Body);
7416       Enc_I  := Enclosing_Package_Body (Inst_Node);
7417       Ensure_Freeze_Node (Pack_Id);
7418       F_Node := Freeze_Node (Pack_Id);
7419
7420       if Is_Generic_Instance (Par)
7421         and then Present (Freeze_Node (Par))
7422         and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7423       then
7424          --  The parent was a premature instantiation. Insert freeze node at
7425          --  the end the current declarative part.
7426
7427          if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7428             Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7429
7430          --  Handle the following case:
7431          --
7432          --    package Parent_Inst is new ...
7433          --    Parent_Inst []
7434          --
7435          --    procedure P ...  --  this body freezes Parent_Inst
7436          --
7437          --    package Inst is new ...
7438          --
7439          --  In this particular scenario, the freeze node for Inst must be
7440          --  inserted in the same manner as that of Parent_Inst - before the
7441          --  next source body or at the end of the declarative list (body not
7442          --  available). If body P did not exist and Parent_Inst was frozen
7443          --  after Inst, either by a body following Inst or at the end of the
7444          --  declarative region, the freeze node for Inst must be inserted
7445          --  after that of Parent_Inst. This relation is established by
7446          --  comparing the Slocs of Parent_Inst freeze node and Inst.
7447
7448          elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7449                List_Containing (Inst_Node)
7450            and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7451          then
7452             Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7453
7454          else
7455             Insert_After (Freeze_Node (Par), F_Node);
7456          end if;
7457
7458       --  The body enclosing the instance should be frozen after the body that
7459       --  includes the generic, because the body of the instance may make
7460       --  references to entities therein. If the two are not in the same
7461       --  declarative part, or if the one enclosing the instance is frozen
7462       --  already, freeze the instance at the end of the current declarative
7463       --  part.
7464
7465       elsif Is_Generic_Instance (Par)
7466         and then Present (Freeze_Node (Par))
7467         and then Present (Enc_I)
7468       then
7469          if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7470            or else
7471              (Nkind (Enc_I) = N_Package_Body
7472                and then
7473                  In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7474          then
7475             --  The enclosing package may contain several instances. Rather
7476             --  than computing the earliest point at which to insert its freeze
7477             --  node, we place it at the end of the declarative part of the
7478             --  parent of the generic.
7479
7480             Insert_Freeze_Node_For_Instance
7481               (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7482          end if;
7483
7484          Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7485
7486       elsif Present (Enc_G)
7487         and then Present (Enc_I)
7488         and then Enc_G /= Enc_I
7489         and then Earlier (Inst_Node, Gen_Body)
7490       then
7491          if Nkind (Enc_G) = N_Package_Body then
7492             E_G_Id := Corresponding_Spec (Enc_G);
7493          else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7494             E_G_Id :=
7495               Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7496          end if;
7497
7498          --  Freeze package that encloses instance, and place node after the
7499          --  package that encloses generic. If enclosing package is already
7500          --  frozen we have to assume it is at the proper place. This may be a
7501          --  potential ABE that requires dynamic checking. Do not add a freeze
7502          --  node if the package that encloses the generic is inside the body
7503          --  that encloses the instance, because the freeze node would be in
7504          --  the wrong scope. Additional contortions needed if the bodies are
7505          --  within a subunit.
7506
7507          declare
7508             Enclosing_Body : Node_Id;
7509
7510          begin
7511             if Nkind (Enc_I) = N_Package_Body_Stub then
7512                Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7513             else
7514                Enclosing_Body := Enc_I;
7515             end if;
7516
7517             if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7518                Insert_Freeze_Node_For_Instance
7519                  (Enc_G, Package_Freeze_Node (Enc_I));
7520             end if;
7521          end;
7522
7523          --  Freeze enclosing subunit before instance
7524
7525          Ensure_Freeze_Node (E_G_Id);
7526
7527          if not Is_List_Member (Freeze_Node (E_G_Id)) then
7528             Insert_After (Enc_G, Freeze_Node (E_G_Id));
7529          end if;
7530
7531          Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7532
7533       else
7534          --  If none of the above, insert freeze node at the end of the current
7535          --  declarative part.
7536
7537          Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7538       end if;
7539    end Freeze_Subprogram_Body;
7540
7541    ----------------
7542    -- Get_Gen_Id --
7543    ----------------
7544
7545    function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7546    begin
7547       return Generic_Renamings.Table (E).Gen_Id;
7548    end Get_Gen_Id;
7549
7550    ---------------------
7551    -- Get_Instance_Of --
7552    ---------------------
7553
7554    function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7555       Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7556
7557    begin
7558       if Res /= Assoc_Null then
7559          return Generic_Renamings.Table (Res).Act_Id;
7560       else
7561          --  On exit, entity is not instantiated: not a generic parameter, or
7562          --  else parameter of an inner generic unit.
7563
7564          return A;
7565       end if;
7566    end Get_Instance_Of;
7567
7568    ------------------------------------
7569    -- Get_Package_Instantiation_Node --
7570    ------------------------------------
7571
7572    function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7573       Decl : Node_Id := Unit_Declaration_Node (A);
7574       Inst : Node_Id;
7575
7576    begin
7577       --  If the Package_Instantiation attribute has been set on the package
7578       --  entity, then use it directly when it (or its Original_Node) refers
7579       --  to an N_Package_Instantiation node. In principle it should be
7580       --  possible to have this field set in all cases, which should be
7581       --  investigated, and would allow this function to be significantly
7582       --  simplified. ???
7583
7584       Inst := Package_Instantiation (A);
7585
7586       if Present (Inst) then
7587          if Nkind (Inst) = N_Package_Instantiation then
7588             return Inst;
7589
7590          elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7591             return Original_Node (Inst);
7592          end if;
7593       end if;
7594
7595       --  If the instantiation is a compilation unit that does not need body
7596       --  then the instantiation node has been rewritten as a package
7597       --  declaration for the instance, and we return the original node.
7598
7599       --  If it is a compilation unit and the instance node has not been
7600       --  rewritten, then it is still the unit of the compilation. Finally, if
7601       --  a body is present, this is a parent of the main unit whose body has
7602       --  been compiled for inlining purposes, and the instantiation node has
7603       --  been rewritten with the instance body.
7604
7605       --  Otherwise the instantiation node appears after the declaration. If
7606       --  the entity is a formal package, the declaration may have been
7607       --  rewritten as a generic declaration (in the case of a formal with box)
7608       --  or left as a formal package declaration if it has actuals, and is
7609       --  found with a forward search.
7610
7611       if Nkind (Parent (Decl)) = N_Compilation_Unit then
7612          if Nkind (Decl) = N_Package_Declaration
7613            and then Present (Corresponding_Body (Decl))
7614          then
7615             Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7616          end if;
7617
7618          if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7619             return Original_Node (Decl);
7620          else
7621             return Unit (Parent (Decl));
7622          end if;
7623
7624       elsif Nkind (Decl) = N_Package_Declaration
7625         and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7626       then
7627          return Original_Node (Decl);
7628
7629       else
7630          Inst := Next (Decl);
7631          while not Nkind_In (Inst, N_Package_Instantiation,
7632                                    N_Formal_Package_Declaration)
7633          loop
7634             Next (Inst);
7635          end loop;
7636
7637          return Inst;
7638       end if;
7639    end Get_Package_Instantiation_Node;
7640
7641    ------------------------
7642    -- Has_Been_Exchanged --
7643    ------------------------
7644
7645    function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7646       Next : Elmt_Id;
7647
7648    begin
7649       Next := First_Elmt (Exchanged_Views);
7650       while Present (Next) loop
7651          if Full_View (Node (Next)) = E then
7652             return True;
7653          end if;
7654
7655          Next_Elmt (Next);
7656       end loop;
7657
7658       return False;
7659    end Has_Been_Exchanged;
7660
7661    ----------
7662    -- Hash --
7663    ----------
7664
7665    function Hash (F : Entity_Id) return HTable_Range is
7666    begin
7667       return HTable_Range (F mod HTable_Size);
7668    end Hash;
7669
7670    ------------------------
7671    -- Hide_Current_Scope --
7672    ------------------------
7673
7674    procedure Hide_Current_Scope is
7675       C : constant Entity_Id := Current_Scope;
7676       E : Entity_Id;
7677
7678    begin
7679       Set_Is_Hidden_Open_Scope (C);
7680
7681       E := First_Entity (C);
7682       while Present (E) loop
7683          if Is_Immediately_Visible (E) then
7684             Set_Is_Immediately_Visible (E, False);
7685             Append_Elmt (E, Hidden_Entities);
7686          end if;
7687
7688          Next_Entity (E);
7689       end loop;
7690
7691       --  Make the scope name invisible as well. This is necessary, but might
7692       --  conflict with calls to Rtsfind later on, in case the scope is a
7693       --  predefined one. There is no clean solution to this problem, so for
7694       --  now we depend on the user not redefining Standard itself in one of
7695       --  the parent units.
7696
7697       if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7698          Set_Is_Immediately_Visible (C, False);
7699          Append_Elmt (C, Hidden_Entities);
7700       end if;
7701
7702    end Hide_Current_Scope;
7703
7704    --------------
7705    -- Init_Env --
7706    --------------
7707
7708    procedure Init_Env is
7709       Saved : Instance_Env;
7710
7711    begin
7712       Saved.Instantiated_Parent  := Current_Instantiated_Parent;
7713       Saved.Exchanged_Views      := Exchanged_Views;
7714       Saved.Hidden_Entities      := Hidden_Entities;
7715       Saved.Current_Sem_Unit     := Current_Sem_Unit;
7716       Saved.Parent_Unit_Visible  := Parent_Unit_Visible;
7717       Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7718
7719       --  Save configuration switches. These may be reset if the unit is a
7720       --  predefined unit, and the current mode is not Ada 2005.
7721
7722       Save_Opt_Config_Switches (Saved.Switches);
7723
7724       Instance_Envs.Append (Saved);
7725
7726       Exchanged_Views := New_Elmt_List;
7727       Hidden_Entities := New_Elmt_List;
7728
7729       --  Make dummy entry for Instantiated parent. If generic unit is legal,
7730       --  this is set properly in Set_Instance_Env.
7731
7732       Current_Instantiated_Parent :=
7733         (Current_Scope, Current_Scope, Assoc_Null);
7734    end Init_Env;
7735
7736    ------------------------------
7737    -- In_Same_Declarative_Part --
7738    ------------------------------
7739
7740    function In_Same_Declarative_Part
7741      (F_Node : Node_Id;
7742       Inst   : Node_Id) return Boolean
7743    is
7744       Decls : constant Node_Id := Parent (F_Node);
7745       Nod   : Node_Id := Parent (Inst);
7746
7747    begin
7748       while Present (Nod) loop
7749          if Nod = Decls then
7750             return True;
7751
7752          elsif Nkind_In (Nod, N_Subprogram_Body,
7753                               N_Package_Body,
7754                               N_Package_Declaration,
7755                               N_Task_Body,
7756                               N_Protected_Body,
7757                               N_Block_Statement)
7758          then
7759             return False;
7760
7761          elsif Nkind (Nod) = N_Subunit then
7762             Nod := Corresponding_Stub (Nod);
7763
7764          elsif Nkind (Nod) = N_Compilation_Unit then
7765             return False;
7766
7767          else
7768             Nod := Parent (Nod);
7769          end if;
7770       end loop;
7771
7772       return False;
7773    end In_Same_Declarative_Part;
7774
7775    ---------------------
7776    -- In_Main_Context --
7777    ---------------------
7778
7779    function In_Main_Context (E : Entity_Id) return Boolean is
7780       Context : List_Id;
7781       Clause  : Node_Id;
7782       Nam     : Node_Id;
7783
7784    begin
7785       if not Is_Compilation_Unit (E)
7786         or else Ekind (E) /= E_Package
7787         or else In_Private_Part (E)
7788       then
7789          return False;
7790       end if;
7791
7792       Context := Context_Items (Cunit (Main_Unit));
7793
7794       Clause  := First (Context);
7795       while Present (Clause) loop
7796          if Nkind (Clause) = N_With_Clause then
7797             Nam := Name (Clause);
7798
7799             --  If the current scope is part of the context of the main unit,
7800             --  analysis of the corresponding with_clause is not complete, and
7801             --  the entity is not set. We use the Chars field directly, which
7802             --  might produce false positives in rare cases, but guarantees
7803             --  that we produce all the instance bodies we will need.
7804
7805             if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7806                  or else (Nkind (Nam) = N_Selected_Component
7807                            and then Chars (Selector_Name (Nam)) = Chars (E))
7808             then
7809                return True;
7810             end if;
7811          end if;
7812
7813          Next (Clause);
7814       end loop;
7815
7816       return False;
7817    end In_Main_Context;
7818
7819    ---------------------
7820    -- Inherit_Context --
7821    ---------------------
7822
7823    procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7824       Current_Context : List_Id;
7825       Current_Unit    : Node_Id;
7826       Item            : Node_Id;
7827       New_I           : Node_Id;
7828
7829       Clause   : Node_Id;
7830       OK       : Boolean;
7831       Lib_Unit : Node_Id;
7832
7833    begin
7834       if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7835
7836          --  The inherited context is attached to the enclosing compilation
7837          --  unit. This is either the main unit, or the declaration for the
7838          --  main unit (in case the instantiation appears within the package
7839          --  declaration and the main unit is its body).
7840
7841          Current_Unit := Parent (Inst);
7842          while Present (Current_Unit)
7843            and then Nkind (Current_Unit) /= N_Compilation_Unit
7844          loop
7845             Current_Unit := Parent (Current_Unit);
7846          end loop;
7847
7848          Current_Context := Context_Items (Current_Unit);
7849
7850          Item := First (Context_Items (Parent (Gen_Decl)));
7851          while Present (Item) loop
7852             if Nkind (Item) = N_With_Clause then
7853                Lib_Unit := Library_Unit (Item);
7854
7855                --  Take care to prevent direct cyclic with's
7856
7857                if Lib_Unit /= Current_Unit then
7858
7859                   --  Do not add a unit if it is already in the context
7860
7861                   Clause := First (Current_Context);
7862                   OK := True;
7863                   while Present (Clause) loop
7864                      if Nkind (Clause) = N_With_Clause and then
7865                        Library_Unit (Clause) = Lib_Unit
7866                      then
7867                         OK := False;
7868                         exit;
7869                      end if;
7870
7871                      Next (Clause);
7872                   end loop;
7873
7874                   if OK then
7875                      New_I := New_Copy (Item);
7876                      Set_Implicit_With (New_I, True);
7877                      Set_Implicit_With_From_Instantiation (New_I, True);
7878                      Append (New_I, Current_Context);
7879                   end if;
7880                end if;
7881             end if;
7882
7883             Next (Item);
7884          end loop;
7885       end if;
7886    end Inherit_Context;
7887
7888    ----------------
7889    -- Initialize --
7890    ----------------
7891
7892    procedure Initialize is
7893    begin
7894       Generic_Renamings.Init;
7895       Instance_Envs.Init;
7896       Generic_Flags.Init;
7897       Generic_Renamings_HTable.Reset;
7898       Circularity_Detected := False;
7899       Exchanged_Views      := No_Elist;
7900       Hidden_Entities      := No_Elist;
7901    end Initialize;
7902
7903    -------------------------------------
7904    -- Insert_Freeze_Node_For_Instance --
7905    -------------------------------------
7906
7907    procedure Insert_Freeze_Node_For_Instance
7908      (N      : Node_Id;
7909       F_Node : Node_Id)
7910    is
7911       Decl  : Node_Id;
7912       Decls : List_Id;
7913       Inst  : Entity_Id;
7914       Par_N : Node_Id;
7915
7916       function Enclosing_Body (N : Node_Id) return Node_Id;
7917       --  Find enclosing package or subprogram body, if any. Freeze node may
7918       --  be placed at end of current declarative list if previous instance
7919       --  and current one have different enclosing bodies.
7920
7921       function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7922       --  Find the local instance, if any, that declares the generic that is
7923       --  being instantiated. If present, the freeze node for this instance
7924       --  must follow the freeze node for the previous instance.
7925
7926       --------------------
7927       -- Enclosing_Body --
7928       --------------------
7929
7930       function Enclosing_Body (N : Node_Id) return Node_Id is
7931          P : Node_Id;
7932
7933       begin
7934          P := Parent (N);
7935          while Present (P)
7936            and then Nkind (Parent (P)) /= N_Compilation_Unit
7937          loop
7938             if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7939                if Nkind (Parent (P)) = N_Subunit then
7940                   return Corresponding_Stub (Parent (P));
7941                else
7942                   return P;
7943                end if;
7944             end if;
7945
7946             P := True_Parent (P);
7947          end loop;
7948
7949          return Empty;
7950       end Enclosing_Body;
7951
7952       -----------------------
7953       -- Previous_Instance --
7954       -----------------------
7955
7956       function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7957          S : Entity_Id;
7958
7959       begin
7960          S := Scope (Gen);
7961          while Present (S)
7962            and then S /= Standard_Standard
7963          loop
7964             if Is_Generic_Instance (S)
7965               and then In_Same_Source_Unit (S, N)
7966             then
7967                return S;
7968             end if;
7969
7970             S := Scope (S);
7971          end loop;
7972
7973          return Empty;
7974       end Previous_Instance;
7975
7976    --  Start of processing for Insert_Freeze_Node_For_Instance
7977
7978    begin
7979       if not Is_List_Member (F_Node) then
7980          Decl  := N;
7981          Decls := List_Containing (N);
7982          Inst  := Entity (F_Node);
7983          Par_N := Parent (Decls);
7984
7985          --  When processing a subprogram instantiation, utilize the actual
7986          --  subprogram instantiation rather than its package wrapper as it
7987          --  carries all the context information.
7988
7989          if Is_Wrapper_Package (Inst) then
7990             Inst := Related_Instance (Inst);
7991          end if;
7992
7993          --  If this is a package instance, check whether the generic is
7994          --  declared in a previous instance and the current instance is
7995          --  not within the previous one.
7996
7997          if Present (Generic_Parent (Parent (Inst)))
7998            and then Is_In_Main_Unit (N)
7999          then
8000             declare
8001                Enclosing_N : constant Node_Id := Enclosing_Body (N);
8002                Par_I       : constant Entity_Id :=
8003                                Previous_Instance
8004                                  (Generic_Parent (Parent (Inst)));
8005                Scop        : Entity_Id;
8006
8007             begin
8008                if Present (Par_I)
8009                  and then Earlier (N, Freeze_Node (Par_I))
8010                then
8011                   Scop := Scope (Inst);
8012
8013                   --  If the current instance is within the one that contains
8014                   --  the generic, the freeze node for the current one must
8015                   --  appear in the current declarative part. Ditto, if the
8016                   --  current instance is within another package instance or
8017                   --  within a body that does not enclose the current instance.
8018                   --  In these three cases the freeze node of the previous
8019                   --  instance is not relevant.
8020
8021                   while Present (Scop)
8022                     and then Scop /= Standard_Standard
8023                   loop
8024                      exit when Scop = Par_I
8025                        or else
8026                          (Is_Generic_Instance (Scop)
8027                            and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8028                      Scop := Scope (Scop);
8029                   end loop;
8030
8031                   --  Previous instance encloses current instance
8032
8033                   if Scop = Par_I then
8034                      null;
8035
8036                   --  If the next node is a source  body we must freeze in
8037                   --  the current scope as well.
8038
8039                   elsif Present (Next (N))
8040                     and then Nkind_In (Next (N),
8041                       N_Subprogram_Body, N_Package_Body)
8042                     and then Comes_From_Source (Next (N))
8043                   then
8044                      null;
8045
8046                   --  Current instance is within an unrelated instance
8047
8048                   elsif Is_Generic_Instance (Scop) then
8049                      null;
8050
8051                   --  Current instance is within an unrelated body
8052
8053                   elsif Present (Enclosing_N)
8054                      and then Enclosing_N /= Enclosing_Body (Par_I)
8055                   then
8056                      null;
8057
8058                   else
8059                      Insert_After (Freeze_Node (Par_I), F_Node);
8060                      return;
8061                   end if;
8062                end if;
8063             end;
8064          end if;
8065
8066          --  When the instantiation occurs in a package declaration, append the
8067          --  freeze node to the private declarations (if any).
8068
8069          if Nkind (Par_N) = N_Package_Specification
8070            and then Decls = Visible_Declarations (Par_N)
8071            and then Present (Private_Declarations (Par_N))
8072            and then not Is_Empty_List (Private_Declarations (Par_N))
8073          then
8074             Decls := Private_Declarations (Par_N);
8075             Decl  := First (Decls);
8076          end if;
8077
8078          --  Determine the proper freeze point of a package instantiation. We
8079          --  adhere to the general rule of a package or subprogram body causing
8080          --  freezing of anything before it in the same declarative region. In
8081          --  this case, the proper freeze point of a package instantiation is
8082          --  before the first source body which follows, or before a stub. This
8083          --  ensures that entities coming from the instance are already frozen
8084          --  and usable in source bodies.
8085
8086          if Nkind (Par_N) /= N_Package_Declaration
8087            and then Ekind (Inst) = E_Package
8088            and then Is_Generic_Instance (Inst)
8089            and then
8090              not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8091          then
8092             while Present (Decl) loop
8093                if (Nkind (Decl) in N_Unit_Body
8094                      or else
8095                    Nkind (Decl) in N_Body_Stub)
8096                  and then Comes_From_Source (Decl)
8097                then
8098                   Insert_Before (Decl, F_Node);
8099                   return;
8100                end if;
8101
8102                Next (Decl);
8103             end loop;
8104          end if;
8105
8106          --  In a package declaration, or if no previous body, insert at end
8107          --  of list.
8108
8109          Set_Sloc (F_Node, Sloc (Last (Decls)));
8110          Insert_After (Last (Decls), F_Node);
8111       end if;
8112    end Insert_Freeze_Node_For_Instance;
8113
8114    ------------------
8115    -- Install_Body --
8116    ------------------
8117
8118    procedure Install_Body
8119      (Act_Body : Node_Id;
8120       N        : Node_Id;
8121       Gen_Body : Node_Id;
8122       Gen_Decl : Node_Id)
8123    is
8124       Act_Id    : constant Entity_Id := Corresponding_Spec (Act_Body);
8125       Act_Unit  : constant Node_Id   := Unit (Cunit (Get_Source_Unit (N)));
8126       Gen_Id    : constant Entity_Id := Corresponding_Spec (Gen_Body);
8127       Par       : constant Entity_Id := Scope (Gen_Id);
8128       Gen_Unit  : constant Node_Id   :=
8129                     Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8130       Orig_Body : Node_Id := Gen_Body;
8131       F_Node    : Node_Id;
8132       Body_Unit : Node_Id;
8133
8134       Must_Delay : Boolean;
8135
8136       function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
8137       --  Find subprogram (if any) that encloses instance and/or generic body
8138
8139       function True_Sloc (N : Node_Id) return Source_Ptr;
8140       --  If the instance is nested inside a generic unit, the Sloc of the
8141       --  instance indicates the place of the original definition, not the
8142       --  point of the current enclosing instance. Pending a better usage of
8143       --  Slocs to indicate instantiation places, we determine the place of
8144       --  origin of a node by finding the maximum sloc of any ancestor node.
8145       --  Why is this not equivalent to Top_Level_Location ???
8146
8147       --------------------
8148       -- Enclosing_Subp --
8149       --------------------
8150
8151       function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
8152          Scop : Entity_Id;
8153
8154       begin
8155          Scop := Scope (Id);
8156          while Scop /= Standard_Standard
8157            and then not Is_Overloadable (Scop)
8158          loop
8159             Scop := Scope (Scop);
8160          end loop;
8161
8162          return Scop;
8163       end Enclosing_Subp;
8164
8165       ---------------
8166       -- True_Sloc --
8167       ---------------
8168
8169       function True_Sloc (N : Node_Id) return Source_Ptr is
8170          Res : Source_Ptr;
8171          N1  : Node_Id;
8172
8173       begin
8174          Res := Sloc (N);
8175          N1 := N;
8176          while Present (N1) and then N1 /= Act_Unit loop
8177             if Sloc (N1) > Res then
8178                Res := Sloc (N1);
8179             end if;
8180
8181             N1 := Parent (N1);
8182          end loop;
8183
8184          return Res;
8185       end True_Sloc;
8186
8187    --  Start of processing for Install_Body
8188
8189    begin
8190       --  If the body is a subunit, the freeze point is the corresponding stub
8191       --  in the current compilation, not the subunit itself.
8192
8193       if Nkind (Parent (Gen_Body)) = N_Subunit then
8194          Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8195       else
8196          Orig_Body := Gen_Body;
8197       end if;
8198
8199       Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8200
8201       --  If the instantiation and the generic definition appear in the same
8202       --  package declaration, this is an early instantiation. If they appear
8203       --  in the same declarative part, it is an early instantiation only if
8204       --  the generic body appears textually later, and the generic body is
8205       --  also in the main unit.
8206
8207       --  If instance is nested within a subprogram, and the generic body is
8208       --  not, the instance is delayed because the enclosing body is. If
8209       --  instance and body are within the same scope, or the same sub-
8210       --  program body, indicate explicitly that the instance is delayed.
8211
8212       Must_Delay :=
8213         (Gen_Unit = Act_Unit
8214           and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8215                                         N_Generic_Package_Declaration)
8216                       or else (Gen_Unit = Body_Unit
8217                                 and then True_Sloc (N) < Sloc (Orig_Body)))
8218           and then Is_In_Main_Unit (Gen_Unit)
8219           and then (Scope (Act_Id) = Scope (Gen_Id)
8220                       or else
8221                     Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
8222
8223       --  If this is an early instantiation, the freeze node is placed after
8224       --  the generic body. Otherwise, if the generic appears in an instance,
8225       --  we cannot freeze the current instance until the outer one is frozen.
8226       --  This is only relevant if the current instance is nested within some
8227       --  inner scope not itself within the outer instance. If this scope is
8228       --  a package body in the same declarative part as the outer instance,
8229       --  then that body needs to be frozen after the outer instance. Finally,
8230       --  if no delay is needed, we place the freeze node at the end of the
8231       --  current declarative part.
8232
8233       if Expander_Active then
8234          Ensure_Freeze_Node (Act_Id);
8235          F_Node := Freeze_Node (Act_Id);
8236
8237          if Must_Delay then
8238             Insert_After (Orig_Body, F_Node);
8239
8240          elsif Is_Generic_Instance (Par)
8241            and then Present (Freeze_Node (Par))
8242            and then Scope (Act_Id) /= Par
8243          then
8244             --  Freeze instance of inner generic after instance of enclosing
8245             --  generic.
8246
8247             if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8248
8249                --  Handle the following case:
8250
8251                --    package Parent_Inst is new ...
8252                --    Parent_Inst []
8253
8254                --    procedure P ...  --  this body freezes Parent_Inst
8255
8256                --    package Inst is new ...
8257
8258                --  In this particular scenario, the freeze node for Inst must
8259                --  be inserted in the same manner as that of Parent_Inst -
8260                --  before the next source body or at the end of the declarative
8261                --  list (body not available). If body P did not exist and
8262                --  Parent_Inst was frozen after Inst, either by a body
8263                --  following Inst or at the end of the declarative region, the
8264                --  freeze node for Inst must be inserted after that of
8265                --  Parent_Inst. This relation is established by comparing the
8266                --  Slocs of Parent_Inst freeze node and Inst.
8267
8268                if List_Containing (Get_Package_Instantiation_Node (Par)) =
8269                   List_Containing (N)
8270                  and then Sloc (Freeze_Node (Par)) < Sloc (N)
8271                then
8272                   Insert_Freeze_Node_For_Instance (N, F_Node);
8273                else
8274                   Insert_After (Freeze_Node (Par), F_Node);
8275                end if;
8276
8277             --  Freeze package enclosing instance of inner generic after
8278             --  instance of enclosing generic.
8279
8280             elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8281               and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8282             then
8283                declare
8284                   Enclosing :  Entity_Id;
8285
8286                begin
8287                   Enclosing := Corresponding_Spec (Parent (N));
8288
8289                   if No (Enclosing) then
8290                      Enclosing := Defining_Entity (Parent (N));
8291                   end if;
8292
8293                   Insert_Freeze_Node_For_Instance (N, F_Node);
8294                   Ensure_Freeze_Node (Enclosing);
8295
8296                   if not Is_List_Member (Freeze_Node (Enclosing)) then
8297
8298                      --  The enclosing context is a subunit, insert the freeze
8299                      --  node after the stub.
8300
8301                      if Nkind (Parent (Parent (N))) = N_Subunit then
8302                         Insert_Freeze_Node_For_Instance
8303                           (Corresponding_Stub (Parent (Parent (N))),
8304                            Freeze_Node (Enclosing));
8305
8306                      --  The enclosing context is a package with a stub body
8307                      --  which has already been replaced by the real body.
8308                      --  Insert the freeze node after the actual body.
8309
8310                      elsif Ekind (Enclosing) = E_Package
8311                        and then Present (Body_Entity (Enclosing))
8312                        and then Was_Originally_Stub
8313                                   (Parent (Body_Entity (Enclosing)))
8314                      then
8315                         Insert_Freeze_Node_For_Instance
8316                           (Parent (Body_Entity (Enclosing)),
8317                            Freeze_Node (Enclosing));
8318
8319                      --  The parent instance has been frozen before the body of
8320                      --  the enclosing package, insert the freeze node after
8321                      --  the body.
8322
8323                      elsif List_Containing (Freeze_Node (Par)) =
8324                            List_Containing (Parent (N))
8325                        and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8326                      then
8327                         Insert_Freeze_Node_For_Instance
8328                           (Parent (N), Freeze_Node (Enclosing));
8329
8330                      else
8331                         Insert_After
8332                           (Freeze_Node (Par), Freeze_Node (Enclosing));
8333                      end if;
8334                   end if;
8335                end;
8336
8337             else
8338                Insert_Freeze_Node_For_Instance (N, F_Node);
8339             end if;
8340
8341          else
8342             Insert_Freeze_Node_For_Instance (N, F_Node);
8343          end if;
8344       end if;
8345
8346       Set_Is_Frozen (Act_Id);
8347       Insert_Before (N, Act_Body);
8348       Mark_Rewrite_Insertion (Act_Body);
8349    end Install_Body;
8350
8351    -----------------------------
8352    -- Install_Formal_Packages --
8353    -----------------------------
8354
8355    procedure Install_Formal_Packages (Par : Entity_Id) is
8356       E     : Entity_Id;
8357       Gen   : Entity_Id;
8358       Gen_E : Entity_Id := Empty;
8359
8360    begin
8361       E := First_Entity (Par);
8362
8363       --  If we are installing an instance parent, locate the formal packages
8364       --  of its generic parent.
8365
8366       if Is_Generic_Instance (Par) then
8367          Gen   := Generic_Parent (Package_Specification (Par));
8368          Gen_E := First_Entity (Gen);
8369       end if;
8370
8371       while Present (E) loop
8372          if Ekind (E) = E_Package
8373            and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8374          then
8375             --  If this is the renaming for the parent instance, done
8376
8377             if Renamed_Object (E) = Par then
8378                exit;
8379
8380             --  The visibility of a formal of an enclosing generic is already
8381             --  correct.
8382
8383             elsif Denotes_Formal_Package (E) then
8384                null;
8385
8386             elsif Present (Associated_Formal_Package (E)) then
8387                Check_Generic_Actuals (Renamed_Object (E), True);
8388                Set_Is_Hidden (E, False);
8389
8390                --  Find formal package in generic unit that corresponds to
8391                --  (instance of) formal package in instance.
8392
8393                while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8394                   Next_Entity (Gen_E);
8395                end loop;
8396
8397                if Present (Gen_E) then
8398                   Map_Formal_Package_Entities (Gen_E, E);
8399                end if;
8400             end if;
8401          end if;
8402
8403          Next_Entity (E);
8404          if Present (Gen_E) then
8405             Next_Entity (Gen_E);
8406          end if;
8407       end loop;
8408    end Install_Formal_Packages;
8409
8410    --------------------
8411    -- Install_Parent --
8412    --------------------
8413
8414    procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8415       Ancestors : constant Elist_Id  := New_Elmt_List;
8416       S         : constant Entity_Id := Current_Scope;
8417       Inst_Par  : Entity_Id;
8418       First_Par : Entity_Id;
8419       Inst_Node : Node_Id;
8420       Gen_Par   : Entity_Id;
8421       First_Gen : Entity_Id;
8422       Elmt      : Elmt_Id;
8423
8424       procedure Install_Noninstance_Specs (Par : Entity_Id);
8425       --  Install the scopes of noninstance parent units ending with Par
8426
8427       procedure Install_Spec (Par : Entity_Id);
8428       --  The child unit is within the declarative part of the parent, so the
8429       --  declarations within the parent are immediately visible.
8430
8431       -------------------------------
8432       -- Install_Noninstance_Specs --
8433       -------------------------------
8434
8435       procedure Install_Noninstance_Specs (Par : Entity_Id) is
8436       begin
8437          if Present (Par)
8438            and then Par /= Standard_Standard
8439            and then not In_Open_Scopes (Par)
8440          then
8441             Install_Noninstance_Specs (Scope (Par));
8442             Install_Spec (Par);
8443          end if;
8444       end Install_Noninstance_Specs;
8445
8446       ------------------
8447       -- Install_Spec --
8448       ------------------
8449
8450       procedure Install_Spec (Par : Entity_Id) is
8451          Spec : constant Node_Id := Package_Specification (Par);
8452
8453       begin
8454          --  If this parent of the child instance is a top-level unit,
8455          --  then record the unit and its visibility for later resetting in
8456          --  Remove_Parent. We exclude units that are generic instances, as we
8457          --  only want to record this information for the ultimate top-level
8458          --  noninstance parent (is that always correct???).
8459
8460          if Scope (Par) = Standard_Standard
8461            and then not Is_Generic_Instance (Par)
8462          then
8463             Parent_Unit_Visible := Is_Immediately_Visible (Par);
8464             Instance_Parent_Unit := Par;
8465          end if;
8466
8467          --  Open the parent scope and make it and its declarations visible.
8468          --  If this point is not within a body, then only the visible
8469          --  declarations should be made visible, and installation of the
8470          --  private declarations is deferred until the appropriate point
8471          --  within analysis of the spec being instantiated (see the handling
8472          --  of parent visibility in Analyze_Package_Specification). This is
8473          --  relaxed in the case where the parent unit is Ada.Tags, to avoid
8474          --  private view problems that occur when compiling instantiations of
8475          --  a generic child of that package (Generic_Dispatching_Constructor).
8476          --  If the instance freezes a tagged type, inlinings of operations
8477          --  from Ada.Tags may need the full view of type Tag. If inlining took
8478          --  proper account of establishing visibility of inlined subprograms'
8479          --  parents then it should be possible to remove this
8480          --  special check. ???
8481
8482          Push_Scope (Par);
8483          Set_Is_Immediately_Visible   (Par);
8484          Install_Visible_Declarations (Par);
8485          Set_Use (Visible_Declarations (Spec));
8486
8487          if In_Body or else Is_RTU (Par, Ada_Tags) then
8488             Install_Private_Declarations (Par);
8489             Set_Use (Private_Declarations (Spec));
8490          end if;
8491       end Install_Spec;
8492
8493    --  Start of processing for Install_Parent
8494
8495    begin
8496       --  We need to install the parent instance to compile the instantiation
8497       --  of the child, but the child instance must appear in the current
8498       --  scope. Given that we cannot place the parent above the current scope
8499       --  in the scope stack, we duplicate the current scope and unstack both
8500       --  after the instantiation is complete.
8501
8502       --  If the parent is itself the instantiation of a child unit, we must
8503       --  also stack the instantiation of its parent, and so on. Each such
8504       --  ancestor is the prefix of the name in a prior instantiation.
8505
8506       --  If this is a nested instance, the parent unit itself resolves to
8507       --  a renaming of the parent instance, whose declaration we need.
8508
8509       --  Finally, the parent may be a generic (not an instance) when the
8510       --  child unit appears as a formal package.
8511
8512       Inst_Par := P;
8513
8514       if Present (Renamed_Entity (Inst_Par)) then
8515          Inst_Par := Renamed_Entity (Inst_Par);
8516       end if;
8517
8518       First_Par := Inst_Par;
8519
8520       Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8521
8522       First_Gen := Gen_Par;
8523
8524       while Present (Gen_Par)
8525         and then Is_Child_Unit (Gen_Par)
8526       loop
8527          --  Load grandparent instance as well
8528
8529          Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8530
8531          if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8532             Inst_Par := Entity (Prefix (Name (Inst_Node)));
8533
8534             if Present (Renamed_Entity (Inst_Par)) then
8535                Inst_Par := Renamed_Entity (Inst_Par);
8536             end if;
8537
8538             Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8539
8540             if Present (Gen_Par) then
8541                Prepend_Elmt (Inst_Par, Ancestors);
8542
8543             else
8544                --  Parent is not the name of an instantiation
8545
8546                Install_Noninstance_Specs (Inst_Par);
8547                exit;
8548             end if;
8549
8550          else
8551             --  Previous error
8552
8553             exit;
8554          end if;
8555       end loop;
8556
8557       if Present (First_Gen) then
8558          Append_Elmt (First_Par, Ancestors);
8559       else
8560          Install_Noninstance_Specs (First_Par);
8561       end if;
8562
8563       if not Is_Empty_Elmt_List (Ancestors) then
8564          Elmt := First_Elmt (Ancestors);
8565          while Present (Elmt) loop
8566             Install_Spec (Node (Elmt));
8567             Install_Formal_Packages (Node (Elmt));
8568             Next_Elmt (Elmt);
8569          end loop;
8570       end if;
8571
8572       if not In_Body then
8573          Push_Scope (S);
8574       end if;
8575    end Install_Parent;
8576
8577    -------------------------------
8578    -- Install_Hidden_Primitives --
8579    -------------------------------
8580
8581    procedure Install_Hidden_Primitives
8582      (Prims_List : in out Elist_Id;
8583       Gen_T      : Entity_Id;
8584       Act_T      : Entity_Id)
8585    is
8586       Elmt        : Elmt_Id;
8587       List        : Elist_Id := No_Elist;
8588       Prim_G_Elmt : Elmt_Id;
8589       Prim_A_Elmt : Elmt_Id;
8590       Prim_G      : Node_Id;
8591       Prim_A      : Node_Id;
8592
8593    begin
8594       --  No action needed in case of serious errors because we cannot trust
8595       --  in the order of primitives
8596
8597       if Serious_Errors_Detected > 0 then
8598          return;
8599
8600       --  No action possible if we don't have available the list of primitive
8601       --  operations
8602
8603       elsif No (Gen_T)
8604         or else not Is_Record_Type (Gen_T)
8605         or else not Is_Tagged_Type (Gen_T)
8606         or else not Is_Record_Type (Act_T)
8607         or else not Is_Tagged_Type (Act_T)
8608       then
8609          return;
8610
8611       --  There is no need to handle interface types since their primitives
8612       --  cannot be hidden
8613
8614       elsif Is_Interface (Gen_T) then
8615          return;
8616       end if;
8617
8618       Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8619
8620       if not Is_Class_Wide_Type (Act_T) then
8621          Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8622       else
8623          Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8624       end if;
8625
8626       loop
8627          --  Skip predefined primitives in the generic formal
8628
8629          while Present (Prim_G_Elmt)
8630            and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8631          loop
8632             Next_Elmt (Prim_G_Elmt);
8633          end loop;
8634
8635          --  Skip predefined primitives in the generic actual
8636
8637          while Present (Prim_A_Elmt)
8638            and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8639          loop
8640             Next_Elmt (Prim_A_Elmt);
8641          end loop;
8642
8643          exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8644
8645          Prim_G := Node (Prim_G_Elmt);
8646          Prim_A := Node (Prim_A_Elmt);
8647
8648          --  There is no need to handle interface primitives because their
8649          --  primitives are not hidden
8650
8651          exit when Present (Interface_Alias (Prim_G));
8652
8653          --  Here we install one hidden primitive
8654
8655          if Chars (Prim_G) /= Chars (Prim_A)
8656            and then Has_Suffix (Prim_A, 'P')
8657            and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8658          then
8659             Set_Chars (Prim_A, Chars (Prim_G));
8660
8661             if List = No_Elist then
8662                List := New_Elmt_List;
8663             end if;
8664
8665             Append_Elmt (Prim_A, List);
8666          end if;
8667
8668          Next_Elmt (Prim_A_Elmt);
8669          Next_Elmt (Prim_G_Elmt);
8670       end loop;
8671
8672       --  Append the elements to the list of temporarily visible primitives
8673       --  avoiding duplicates.
8674
8675       if Present (List) then
8676          if No (Prims_List) then
8677             Prims_List := New_Elmt_List;
8678          end if;
8679
8680          Elmt := First_Elmt (List);
8681          while Present (Elmt) loop
8682             Append_Unique_Elmt (Node (Elmt), Prims_List);
8683             Next_Elmt (Elmt);
8684          end loop;
8685       end if;
8686    end Install_Hidden_Primitives;
8687
8688    -------------------------------
8689    -- Restore_Hidden_Primitives --
8690    -------------------------------
8691
8692    procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8693       Prim_Elmt : Elmt_Id;
8694       Prim      : Node_Id;
8695
8696    begin
8697       if Prims_List /= No_Elist then
8698          Prim_Elmt := First_Elmt (Prims_List);
8699          while Present (Prim_Elmt) loop
8700             Prim := Node (Prim_Elmt);
8701             Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8702             Next_Elmt (Prim_Elmt);
8703          end loop;
8704
8705          Prims_List := No_Elist;
8706       end if;
8707    end Restore_Hidden_Primitives;
8708
8709    --------------------------------
8710    -- Instantiate_Formal_Package --
8711    --------------------------------
8712
8713    function Instantiate_Formal_Package
8714      (Formal          : Node_Id;
8715       Actual          : Node_Id;
8716       Analyzed_Formal : Node_Id) return List_Id
8717    is
8718       Loc         : constant Source_Ptr := Sloc (Actual);
8719       Actual_Pack : Entity_Id;
8720       Formal_Pack : Entity_Id;
8721       Gen_Parent  : Entity_Id;
8722       Decls       : List_Id;
8723       Nod         : Node_Id;
8724       Parent_Spec : Node_Id;
8725
8726       procedure Find_Matching_Actual
8727        (F    : Node_Id;
8728         Act  : in out Entity_Id);
8729       --  We need to associate each formal entity in the formal package with
8730       --  the corresponding entity in the actual package. The actual package
8731       --  has been analyzed and possibly expanded, and as a result there is
8732       --  no one-to-one correspondence between the two lists (for example,
8733       --  the actual may include subtypes, itypes, and inherited primitive
8734       --  operations, interspersed among the renaming declarations for the
8735       --  actuals) . We retrieve the corresponding actual by name because each
8736       --  actual has the same name as the formal, and they do appear in the
8737       --  same order.
8738
8739       function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8740       --  Retrieve entity of defining entity of  generic formal parameter.
8741       --  Only the declarations of formals need to be considered when
8742       --  linking them to actuals, but the declarative list may include
8743       --  internal entities generated during analysis, and those are ignored.
8744
8745       procedure Match_Formal_Entity
8746         (Formal_Node : Node_Id;
8747          Formal_Ent  : Entity_Id;
8748          Actual_Ent  : Entity_Id);
8749       --  Associates the formal entity with the actual. In the case where
8750       --  Formal_Ent is a formal package, this procedure iterates through all
8751       --  of its formals and enters associations between the actuals occurring
8752       --  in the formal package's corresponding actual package (given by
8753       --  Actual_Ent) and the formal package's formal parameters. This
8754       --  procedure recurses if any of the parameters is itself a package.
8755
8756       function Is_Instance_Of
8757         (Act_Spec : Entity_Id;
8758          Gen_Anc  : Entity_Id) return Boolean;
8759       --  The actual can be an instantiation of a generic within another
8760       --  instance, in which case there is no direct link from it to the
8761       --  original generic ancestor. In that case, we recognize that the
8762       --  ultimate ancestor is the same by examining names and scopes.
8763
8764       procedure Process_Nested_Formal (Formal : Entity_Id);
8765       --  If the current formal is declared with a box, its own formals are
8766       --  visible in the instance, as they were in the generic, and their
8767       --  Hidden flag must be reset. If some of these formals are themselves
8768       --  packages declared with a box, the processing must be recursive.
8769
8770       --------------------------
8771       -- Find_Matching_Actual --
8772       --------------------------
8773
8774       procedure Find_Matching_Actual
8775         (F   : Node_Id;
8776          Act : in out Entity_Id)
8777      is
8778          Formal_Ent : Entity_Id;
8779
8780       begin
8781          case Nkind (Original_Node (F)) is
8782             when N_Formal_Object_Declaration |
8783                  N_Formal_Type_Declaration   =>
8784                Formal_Ent := Defining_Identifier (F);
8785
8786                while Chars (Act) /= Chars (Formal_Ent) loop
8787                   Next_Entity (Act);
8788                end loop;
8789
8790             when N_Formal_Subprogram_Declaration |
8791                  N_Formal_Package_Declaration    |
8792                  N_Package_Declaration           |
8793                  N_Generic_Package_Declaration   =>
8794                Formal_Ent := Defining_Entity (F);
8795
8796                while Chars (Act) /= Chars (Formal_Ent) loop
8797                   Next_Entity (Act);
8798                end loop;
8799
8800             when others =>
8801                raise Program_Error;
8802          end case;
8803       end Find_Matching_Actual;
8804
8805       -------------------------
8806       -- Match_Formal_Entity --
8807       -------------------------
8808
8809       procedure Match_Formal_Entity
8810         (Formal_Node : Node_Id;
8811          Formal_Ent  : Entity_Id;
8812          Actual_Ent  : Entity_Id)
8813       is
8814          Act_Pkg   : Entity_Id;
8815
8816       begin
8817          Set_Instance_Of (Formal_Ent, Actual_Ent);
8818
8819          if Ekind (Actual_Ent) = E_Package then
8820
8821             --  Record associations for each parameter
8822
8823             Act_Pkg := Actual_Ent;
8824
8825             declare
8826                A_Ent  : Entity_Id := First_Entity (Act_Pkg);
8827                F_Ent  : Entity_Id;
8828                F_Node : Node_Id;
8829
8830                Gen_Decl : Node_Id;
8831                Formals  : List_Id;
8832                Actual   : Entity_Id;
8833
8834             begin
8835                --  Retrieve the actual given in the formal package declaration
8836
8837                Actual := Entity (Name (Original_Node (Formal_Node)));
8838
8839                --  The actual in the formal package declaration  may be a
8840                --  renamed generic package, in which case we want to retrieve
8841                --  the original generic in order to traverse its formal part.
8842
8843                if Present (Renamed_Entity (Actual)) then
8844                   Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8845                else
8846                   Gen_Decl := Unit_Declaration_Node (Actual);
8847                end if;
8848
8849                Formals := Generic_Formal_Declarations (Gen_Decl);
8850
8851                if Present (Formals) then
8852                   F_Node := First_Non_Pragma (Formals);
8853                else
8854                   F_Node := Empty;
8855                end if;
8856
8857                while Present (A_Ent)
8858                  and then Present (F_Node)
8859                  and then A_Ent /= First_Private_Entity (Act_Pkg)
8860                loop
8861                   F_Ent := Get_Formal_Entity (F_Node);
8862
8863                   if Present (F_Ent) then
8864
8865                      --  This is a formal of the original package. Record
8866                      --  association and recurse.
8867
8868                      Find_Matching_Actual (F_Node, A_Ent);
8869                      Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8870                      Next_Entity (A_Ent);
8871                   end if;
8872
8873                   Next_Non_Pragma (F_Node);
8874                end loop;
8875             end;
8876          end if;
8877       end Match_Formal_Entity;
8878
8879       -----------------------
8880       -- Get_Formal_Entity --
8881       -----------------------
8882
8883       function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8884          Kind : constant Node_Kind := Nkind (Original_Node (N));
8885       begin
8886          case Kind is
8887             when N_Formal_Object_Declaration     =>
8888                return Defining_Identifier (N);
8889
8890             when N_Formal_Type_Declaration       =>
8891                return Defining_Identifier (N);
8892
8893             when N_Formal_Subprogram_Declaration =>
8894                return Defining_Unit_Name (Specification (N));
8895
8896             when N_Formal_Package_Declaration    =>
8897                return Defining_Identifier (Original_Node (N));
8898
8899             when N_Generic_Package_Declaration   =>
8900                return Defining_Identifier (Original_Node (N));
8901
8902             --  All other declarations are introduced by semantic analysis and
8903             --  have no match in the actual.
8904
8905             when others =>
8906                return Empty;
8907          end case;
8908       end Get_Formal_Entity;
8909
8910       --------------------
8911       -- Is_Instance_Of --
8912       --------------------
8913
8914       function Is_Instance_Of
8915         (Act_Spec : Entity_Id;
8916          Gen_Anc  : Entity_Id) return Boolean
8917       is
8918          Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8919
8920       begin
8921          if No (Gen_Par) then
8922             return False;
8923
8924          --  Simplest case: the generic parent of the actual is the formal
8925
8926          elsif Gen_Par = Gen_Anc then
8927             return True;
8928
8929          elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8930             return False;
8931
8932          --  The actual may be obtained through several instantiations. Its
8933          --  scope must itself be an instance of a generic declared in the
8934          --  same scope as the formal. Any other case is detected above.
8935
8936          elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8937             return False;
8938
8939          else
8940             return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8941          end if;
8942       end Is_Instance_Of;
8943
8944       ---------------------------
8945       -- Process_Nested_Formal --
8946       ---------------------------
8947
8948       procedure Process_Nested_Formal (Formal : Entity_Id) is
8949          Ent : Entity_Id;
8950
8951       begin
8952          if Present (Associated_Formal_Package (Formal))
8953            and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8954          then
8955             Ent := First_Entity (Formal);
8956             while Present (Ent) loop
8957                Set_Is_Hidden (Ent, False);
8958                Set_Is_Visible_Formal (Ent);
8959                Set_Is_Potentially_Use_Visible
8960                  (Ent, Is_Potentially_Use_Visible (Formal));
8961
8962                if Ekind (Ent) = E_Package then
8963                   exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8964                   Process_Nested_Formal (Ent);
8965                end if;
8966
8967                Next_Entity (Ent);
8968             end loop;
8969          end if;
8970       end Process_Nested_Formal;
8971
8972    --  Start of processing for Instantiate_Formal_Package
8973
8974    begin
8975       Analyze (Actual);
8976
8977       if not Is_Entity_Name (Actual)
8978         or else  Ekind (Entity (Actual)) /= E_Package
8979       then
8980          Error_Msg_N
8981            ("expect package instance to instantiate formal", Actual);
8982          Abandon_Instantiation (Actual);
8983          raise Program_Error;
8984
8985       else
8986          Actual_Pack := Entity (Actual);
8987          Set_Is_Instantiated (Actual_Pack);
8988
8989          --  The actual may be a renamed package, or an outer generic formal
8990          --  package whose instantiation is converted into a renaming.
8991
8992          if Present (Renamed_Object (Actual_Pack)) then
8993             Actual_Pack := Renamed_Object (Actual_Pack);
8994          end if;
8995
8996          if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
8997             Gen_Parent  := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
8998             Formal_Pack := Defining_Identifier (Analyzed_Formal);
8999          else
9000             Gen_Parent :=
9001               Generic_Parent (Specification (Analyzed_Formal));
9002             Formal_Pack :=
9003               Defining_Unit_Name (Specification (Analyzed_Formal));
9004          end if;
9005
9006          if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9007             Parent_Spec := Package_Specification (Actual_Pack);
9008          else
9009             Parent_Spec := Parent (Actual_Pack);
9010          end if;
9011
9012          if Gen_Parent = Any_Id then
9013             Error_Msg_N
9014               ("previous error in declaration of formal package", Actual);
9015             Abandon_Instantiation (Actual);
9016
9017          elsif
9018            Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9019          then
9020             null;
9021
9022          else
9023             Error_Msg_NE
9024               ("actual parameter must be instance of&", Actual, Gen_Parent);
9025             Abandon_Instantiation (Actual);
9026          end if;
9027
9028          Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9029          Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9030
9031          Nod :=
9032            Make_Package_Renaming_Declaration (Loc,
9033              Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9034              Name               => New_Reference_To (Actual_Pack, Loc));
9035
9036          Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9037            Defining_Identifier (Formal));
9038          Decls := New_List (Nod);
9039
9040          --  If the formal F has a box, then the generic declarations are
9041          --  visible in the generic G. In an instance of G, the corresponding
9042          --  entities in the actual for F (which are the actuals for the
9043          --  instantiation of the generic that F denotes) must also be made
9044          --  visible for analysis of the current instance. On exit from the
9045          --  current instance, those entities are made private again. If the
9046          --  actual is currently in use, these entities are also use-visible.
9047
9048          --  The loop through the actual entities also steps through the formal
9049          --  entities and enters associations from formals to actuals into the
9050          --  renaming map. This is necessary to properly handle checking of
9051          --  actual parameter associations for later formals that depend on
9052          --  actuals declared in the formal package.
9053
9054          --  In Ada 2005, partial parametrization requires that we make visible
9055          --  the actuals corresponding to formals that were defaulted in the
9056          --  formal package. There formals are identified because they remain
9057          --  formal generics within the formal package, rather than being
9058          --  renamings of the actuals supplied.
9059
9060          declare
9061             Gen_Decl : constant Node_Id :=
9062                          Unit_Declaration_Node (Gen_Parent);
9063             Formals  : constant List_Id :=
9064                          Generic_Formal_Declarations (Gen_Decl);
9065
9066             Actual_Ent       : Entity_Id;
9067             Actual_Of_Formal : Node_Id;
9068             Formal_Node      : Node_Id;
9069             Formal_Ent       : Entity_Id;
9070
9071          begin
9072             if Present (Formals) then
9073                Formal_Node := First_Non_Pragma (Formals);
9074             else
9075                Formal_Node := Empty;
9076             end if;
9077
9078             Actual_Ent := First_Entity (Actual_Pack);
9079             Actual_Of_Formal :=
9080                First (Visible_Declarations (Specification (Analyzed_Formal)));
9081             while Present (Actual_Ent)
9082               and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9083             loop
9084                if Present (Formal_Node) then
9085                   Formal_Ent := Get_Formal_Entity (Formal_Node);
9086
9087                   if Present (Formal_Ent) then
9088                      Find_Matching_Actual (Formal_Node, Actual_Ent);
9089                      Match_Formal_Entity
9090                        (Formal_Node, Formal_Ent, Actual_Ent);
9091
9092                      --  We iterate at the same time over the actuals of the
9093                      --  local package created for the formal, to determine
9094                      --  which one of the formals of the original generic were
9095                      --  defaulted in the formal. The corresponding actual
9096                      --  entities are visible in the enclosing instance.
9097
9098                      if Box_Present (Formal)
9099                        or else
9100                          (Present (Actual_Of_Formal)
9101                            and then
9102                              Is_Generic_Formal
9103                                (Get_Formal_Entity (Actual_Of_Formal)))
9104                      then
9105                         Set_Is_Hidden (Actual_Ent, False);
9106                         Set_Is_Visible_Formal (Actual_Ent);
9107                         Set_Is_Potentially_Use_Visible
9108                           (Actual_Ent, In_Use (Actual_Pack));
9109
9110                         if Ekind (Actual_Ent) = E_Package then
9111                            Process_Nested_Formal (Actual_Ent);
9112                         end if;
9113
9114                      else
9115                         Set_Is_Hidden (Actual_Ent);
9116                         Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9117                      end if;
9118                   end if;
9119
9120                   Next_Non_Pragma (Formal_Node);
9121                   Next (Actual_Of_Formal);
9122
9123                else
9124                   --  No further formals to match, but the generic part may
9125                   --  contain inherited operation that are not hidden in the
9126                   --  enclosing instance.
9127
9128                   Next_Entity (Actual_Ent);
9129                end if;
9130             end loop;
9131
9132             --  Inherited subprograms generated by formal derived types are
9133             --  also visible if the types are.
9134
9135             Actual_Ent := First_Entity (Actual_Pack);
9136             while Present (Actual_Ent)
9137               and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9138             loop
9139                if Is_Overloadable (Actual_Ent)
9140                  and then
9141                    Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9142                  and then
9143                    not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9144                then
9145                   Set_Is_Hidden (Actual_Ent, False);
9146                   Set_Is_Potentially_Use_Visible
9147                     (Actual_Ent, In_Use (Actual_Pack));
9148                end if;
9149
9150                Next_Entity (Actual_Ent);
9151             end loop;
9152          end;
9153
9154          --  If the formal is not declared with a box, reanalyze it as an
9155          --  abbreviated instantiation, to verify the matching rules of 12.7.
9156          --  The actual checks are performed after the generic associations
9157          --  have been analyzed, to guarantee the same visibility for this
9158          --  instantiation and for the actuals.
9159
9160          --  In Ada 2005, the generic associations for the formal can include
9161          --  defaulted parameters. These are ignored during check. This
9162          --  internal instantiation is removed from the tree after conformance
9163          --  checking, because it contains formal declarations for those
9164          --  defaulted parameters, and those should not reach the back-end.
9165
9166          if not Box_Present (Formal) then
9167             declare
9168                I_Pack : constant Entity_Id :=
9169                           Make_Temporary (Sloc (Actual), 'P');
9170
9171             begin
9172                Set_Is_Internal (I_Pack);
9173
9174                Append_To (Decls,
9175                  Make_Package_Instantiation (Sloc (Actual),
9176                    Defining_Unit_Name => I_Pack,
9177                    Name =>
9178                      New_Occurrence_Of
9179                        (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9180                    Generic_Associations =>
9181                      Generic_Associations (Formal)));
9182             end;
9183          end if;
9184
9185          return Decls;
9186       end if;
9187    end Instantiate_Formal_Package;
9188
9189    -----------------------------------
9190    -- Instantiate_Formal_Subprogram --
9191    -----------------------------------
9192
9193    function Instantiate_Formal_Subprogram
9194      (Formal          : Node_Id;
9195       Actual          : Node_Id;
9196       Analyzed_Formal : Node_Id) return Node_Id
9197    is
9198       Loc        : Source_Ptr;
9199       Formal_Sub : constant Entity_Id :=
9200                      Defining_Unit_Name (Specification (Formal));
9201       Analyzed_S : constant Entity_Id :=
9202                      Defining_Unit_Name (Specification (Analyzed_Formal));
9203       Decl_Node  : Node_Id;
9204       Nam        : Node_Id;
9205       New_Spec   : Node_Id;
9206
9207       function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9208       --  If the generic is a child unit, the parent has been installed on the
9209       --  scope stack, but a default subprogram cannot resolve to something
9210       --  on the parent because that parent is not really part of the visible
9211       --  context (it is there to resolve explicit local entities). If the
9212       --  default has resolved in this way, we remove the entity from immediate
9213       --  visibility and analyze the node again to emit an error message or
9214       --  find another visible candidate.
9215
9216       procedure Valid_Actual_Subprogram (Act : Node_Id);
9217       --  Perform legality check and raise exception on failure
9218
9219       -----------------------
9220       -- From_Parent_Scope --
9221       -----------------------
9222
9223       function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9224          Gen_Scope : Node_Id;
9225
9226       begin
9227          Gen_Scope := Scope (Analyzed_S);
9228          while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9229             if Scope (Subp) = Scope (Gen_Scope) then
9230                return True;
9231             end if;
9232
9233             Gen_Scope := Scope (Gen_Scope);
9234          end loop;
9235
9236          return False;
9237       end From_Parent_Scope;
9238
9239       -----------------------------
9240       -- Valid_Actual_Subprogram --
9241       -----------------------------
9242
9243       procedure Valid_Actual_Subprogram (Act : Node_Id) is
9244          Act_E : Entity_Id;
9245
9246       begin
9247          if Is_Entity_Name (Act) then
9248             Act_E := Entity (Act);
9249
9250          elsif Nkind (Act) = N_Selected_Component
9251            and then Is_Entity_Name (Selector_Name (Act))
9252          then
9253             Act_E := Entity (Selector_Name (Act));
9254
9255          else
9256             Act_E := Empty;
9257          end if;
9258
9259          if (Present (Act_E) and then Is_Overloadable (Act_E))
9260            or else Nkind_In (Act, N_Attribute_Reference,
9261                                   N_Indexed_Component,
9262                                   N_Character_Literal,
9263                                   N_Explicit_Dereference)
9264          then
9265             return;
9266          end if;
9267
9268          Error_Msg_NE
9269            ("expect subprogram or entry name in instantiation of&",
9270             Instantiation_Node, Formal_Sub);
9271          Abandon_Instantiation (Instantiation_Node);
9272
9273       end Valid_Actual_Subprogram;
9274
9275    --  Start of processing for Instantiate_Formal_Subprogram
9276
9277    begin
9278       New_Spec := New_Copy_Tree (Specification (Formal));
9279
9280       --  The tree copy has created the proper instantiation sloc for the
9281       --  new specification. Use this location for all other constructed
9282       --  declarations.
9283
9284       Loc := Sloc (Defining_Unit_Name (New_Spec));
9285
9286       --  Create new entity for the actual (New_Copy_Tree does not)
9287
9288       Set_Defining_Unit_Name
9289         (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9290
9291       --  Create new entities for the each of the formals in the
9292       --  specification of the renaming declaration built for the actual.
9293
9294       if Present (Parameter_Specifications (New_Spec)) then
9295          declare
9296             F : Node_Id;
9297          begin
9298             F := First (Parameter_Specifications (New_Spec));
9299             while Present (F) loop
9300                Set_Defining_Identifier (F,
9301                   Make_Defining_Identifier (Sloc (F),
9302                     Chars => Chars (Defining_Identifier (F))));
9303                Next (F);
9304             end loop;
9305          end;
9306       end if;
9307
9308       --  Find entity of actual. If the actual is an attribute reference, it
9309       --  cannot be resolved here (its formal is missing) but is handled
9310       --  instead in Attribute_Renaming. If the actual is overloaded, it is
9311       --  fully resolved subsequently, when the renaming declaration for the
9312       --  formal is analyzed. If it is an explicit dereference, resolve the
9313       --  prefix but not the actual itself, to prevent interpretation as call.
9314
9315       if Present (Actual) then
9316          Loc := Sloc (Actual);
9317          Set_Sloc (New_Spec, Loc);
9318
9319          if Nkind (Actual) = N_Operator_Symbol then
9320             Find_Direct_Name (Actual);
9321
9322          elsif Nkind (Actual) = N_Explicit_Dereference then
9323             Analyze (Prefix (Actual));
9324
9325          elsif Nkind (Actual) /= N_Attribute_Reference then
9326             Analyze (Actual);
9327          end if;
9328
9329          Valid_Actual_Subprogram (Actual);
9330          Nam := Actual;
9331
9332       elsif Present (Default_Name (Formal)) then
9333          if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9334                                                  N_Selected_Component,
9335                                                  N_Indexed_Component,
9336                                                  N_Character_Literal)
9337            and then Present (Entity (Default_Name (Formal)))
9338          then
9339             Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9340          else
9341             Nam := New_Copy (Default_Name (Formal));
9342             Set_Sloc (Nam, Loc);
9343          end if;
9344
9345       elsif Box_Present (Formal) then
9346
9347          --  Actual is resolved at the point of instantiation. Create an
9348          --  identifier or operator with the same name as the formal.
9349
9350          if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9351             Nam := Make_Operator_Symbol (Loc,
9352               Chars =>  Chars (Formal_Sub),
9353               Strval => No_String);
9354          else
9355             Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9356          end if;
9357
9358       elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9359         and then Null_Present (Specification (Formal))
9360       then
9361          --  Generate null body for procedure, for use in the instance
9362
9363          Decl_Node :=
9364            Make_Subprogram_Body (Loc,
9365              Specification              => New_Spec,
9366              Declarations               => New_List,
9367              Handled_Statement_Sequence =>
9368                Make_Handled_Sequence_Of_Statements (Loc,
9369                  Statements => New_List (Make_Null_Statement (Loc))));
9370
9371          Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9372          return Decl_Node;
9373
9374       else
9375          Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9376          Error_Msg_NE
9377            ("missing actual&", Instantiation_Node, Formal_Sub);
9378          Error_Msg_NE
9379            ("\in instantiation of & declared#",
9380               Instantiation_Node, Scope (Analyzed_S));
9381          Abandon_Instantiation (Instantiation_Node);
9382       end if;
9383
9384       Decl_Node :=
9385         Make_Subprogram_Renaming_Declaration (Loc,
9386           Specification => New_Spec,
9387           Name          => Nam);
9388
9389       --  If we do not have an actual and the formal specified <> then set to
9390       --  get proper default.
9391
9392       if No (Actual) and then Box_Present (Formal) then
9393          Set_From_Default (Decl_Node);
9394       end if;
9395
9396       --  Gather possible interpretations for the actual before analyzing the
9397       --  instance. If overloaded, it will be resolved when analyzing the
9398       --  renaming declaration.
9399
9400       if Box_Present (Formal)
9401         and then No (Actual)
9402       then
9403          Analyze (Nam);
9404
9405          if Is_Child_Unit (Scope (Analyzed_S))
9406            and then Present (Entity (Nam))
9407          then
9408             if not Is_Overloaded (Nam) then
9409                if From_Parent_Scope (Entity (Nam)) then
9410                   Set_Is_Immediately_Visible (Entity (Nam), False);
9411                   Set_Entity (Nam, Empty);
9412                   Set_Etype (Nam, Empty);
9413
9414                   Analyze (Nam);
9415                   Set_Is_Immediately_Visible (Entity (Nam));
9416                end if;
9417
9418             else
9419                declare
9420                   I  : Interp_Index;
9421                   It : Interp;
9422
9423                begin
9424                   Get_First_Interp (Nam, I, It);
9425                   while Present (It.Nam) loop
9426                      if From_Parent_Scope (It.Nam) then
9427                         Remove_Interp (I);
9428                      end if;
9429
9430                      Get_Next_Interp (I, It);
9431                   end loop;
9432                end;
9433             end if;
9434          end if;
9435       end if;
9436
9437       --  The generic instantiation freezes the actual. This can only be done
9438       --  once the actual is resolved, in the analysis of the renaming
9439       --  declaration. To make the formal subprogram entity available, we set
9440       --  Corresponding_Formal_Spec to point to the formal subprogram entity.
9441       --  This is also needed in Analyze_Subprogram_Renaming for the processing
9442       --  of formal abstract subprograms.
9443
9444       Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9445
9446       --  We cannot analyze the renaming declaration, and thus find the actual,
9447       --  until all the actuals are assembled in the instance. For subsequent
9448       --  checks of other actuals, indicate the node that will hold the
9449       --  instance of this formal.
9450
9451       Set_Instance_Of (Analyzed_S, Nam);
9452
9453       if Nkind (Actual) = N_Selected_Component
9454         and then Is_Task_Type (Etype (Prefix (Actual)))
9455         and then not Is_Frozen (Etype (Prefix (Actual)))
9456       then
9457          --  The renaming declaration will create a body, which must appear
9458          --  outside of the instantiation, We move the renaming declaration
9459          --  out of the instance, and create an additional renaming inside,
9460          --  to prevent freezing anomalies.
9461
9462          declare
9463             Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9464
9465          begin
9466             Set_Defining_Unit_Name (New_Spec, Anon_Id);
9467             Insert_Before (Instantiation_Node, Decl_Node);
9468             Analyze (Decl_Node);
9469
9470             --  Now create renaming within the instance
9471
9472             Decl_Node :=
9473               Make_Subprogram_Renaming_Declaration (Loc,
9474                 Specification => New_Copy_Tree (New_Spec),
9475                 Name => New_Occurrence_Of (Anon_Id, Loc));
9476
9477             Set_Defining_Unit_Name (Specification (Decl_Node),
9478               Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9479          end;
9480       end if;
9481
9482       return Decl_Node;
9483    end Instantiate_Formal_Subprogram;
9484
9485    ------------------------
9486    -- Instantiate_Object --
9487    ------------------------
9488
9489    function Instantiate_Object
9490      (Formal          : Node_Id;
9491       Actual          : Node_Id;
9492       Analyzed_Formal : Node_Id) return List_Id
9493    is
9494       Gen_Obj     : constant Entity_Id  := Defining_Identifier (Formal);
9495       A_Gen_Obj   : constant Entity_Id  :=
9496                       Defining_Identifier (Analyzed_Formal);
9497       Acc_Def     : Node_Id             := Empty;
9498       Act_Assoc   : constant Node_Id    := Parent (Actual);
9499       Actual_Decl : Node_Id             := Empty;
9500       Decl_Node   : Node_Id;
9501       Def         : Node_Id;
9502       Ftyp        : Entity_Id;
9503       List        : constant List_Id    := New_List;
9504       Loc         : constant Source_Ptr := Sloc (Actual);
9505       Orig_Ftyp   : constant Entity_Id  := Etype (A_Gen_Obj);
9506       Subt_Decl   : Node_Id             := Empty;
9507       Subt_Mark   : Node_Id             := Empty;
9508
9509    begin
9510       if Present (Subtype_Mark (Formal)) then
9511          Subt_Mark := Subtype_Mark (Formal);
9512       else
9513          Check_Access_Definition (Formal);
9514          Acc_Def := Access_Definition (Formal);
9515       end if;
9516
9517       --  Sloc for error message on missing actual
9518
9519       Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9520
9521       if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9522          Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9523       end if;
9524
9525       Set_Parent (List, Parent (Actual));
9526
9527       --  OUT present
9528
9529       if Out_Present (Formal) then
9530
9531          --  An IN OUT generic actual must be a name. The instantiation is a
9532          --  renaming declaration. The actual is the name being renamed. We
9533          --  use the actual directly, rather than a copy, because it is not
9534          --  used further in the list of actuals, and because a copy or a use
9535          --  of relocate_node is incorrect if the instance is nested within a
9536          --  generic. In order to simplify ASIS searches, the Generic_Parent
9537          --  field links the declaration to the generic association.
9538
9539          if No (Actual) then
9540             Error_Msg_NE
9541               ("missing actual&",
9542                Instantiation_Node, Gen_Obj);
9543             Error_Msg_NE
9544               ("\in instantiation of & declared#",
9545                  Instantiation_Node, Scope (A_Gen_Obj));
9546             Abandon_Instantiation (Instantiation_Node);
9547          end if;
9548
9549          if Present (Subt_Mark) then
9550             Decl_Node :=
9551               Make_Object_Renaming_Declaration (Loc,
9552                 Defining_Identifier => New_Copy (Gen_Obj),
9553                 Subtype_Mark        => New_Copy_Tree (Subt_Mark),
9554                 Name                => Actual);
9555
9556          else pragma Assert (Present (Acc_Def));
9557             Decl_Node :=
9558               Make_Object_Renaming_Declaration (Loc,
9559                 Defining_Identifier => New_Copy (Gen_Obj),
9560                 Access_Definition   => New_Copy_Tree (Acc_Def),
9561                 Name                => Actual);
9562          end if;
9563
9564          Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9565
9566          --  The analysis of the actual may produce Insert_Action nodes, so
9567          --  the declaration must have a context in which to attach them.
9568
9569          Append (Decl_Node, List);
9570          Analyze (Actual);
9571
9572          --  Return if the analysis of the actual reported some error
9573
9574          if Etype (Actual) = Any_Type then
9575             return List;
9576          end if;
9577
9578          --  This check is performed here because Analyze_Object_Renaming will
9579          --  not check it when Comes_From_Source is False. Note though that the
9580          --  check for the actual being the name of an object will be performed
9581          --  in Analyze_Object_Renaming.
9582
9583          if Is_Object_Reference (Actual)
9584            and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9585          then
9586             Error_Msg_N
9587               ("illegal discriminant-dependent component for in out parameter",
9588                Actual);
9589          end if;
9590
9591          --  The actual has to be resolved in order to check that it is a
9592          --  variable (due to cases such as F (1), where F returns access to
9593          --  an array, and for overloaded prefixes).
9594
9595          Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9596
9597          --  If the type of the formal is not itself a formal, and the current
9598          --  unit is a child unit, the formal type must be declared in a
9599          --  parent, and must be retrieved by visibility.
9600
9601          if Ftyp = Orig_Ftyp
9602            and then Is_Generic_Unit (Scope (Ftyp))
9603            and then Is_Child_Unit (Scope (A_Gen_Obj))
9604          then
9605             declare
9606                Temp : constant Node_Id :=
9607                         New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9608             begin
9609                Set_Entity (Temp, Empty);
9610                Find_Type (Temp);
9611                Ftyp := Entity (Temp);
9612             end;
9613          end if;
9614
9615          if Is_Private_Type (Ftyp)
9616            and then not Is_Private_Type (Etype (Actual))
9617            and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9618                       or else Base_Type (Etype (Actual)) = Ftyp)
9619          then
9620             --  If the actual has the type of the full view of the formal, or
9621             --  else a non-private subtype of the formal, then the visibility
9622             --  of the formal type has changed. Add to the actuals a subtype
9623             --  declaration that will force the exchange of views in the body
9624             --  of the instance as well.
9625
9626             Subt_Decl :=
9627               Make_Subtype_Declaration (Loc,
9628                  Defining_Identifier => Make_Temporary (Loc, 'P'),
9629                  Subtype_Indication  => New_Occurrence_Of (Ftyp, Loc));
9630
9631             Prepend (Subt_Decl, List);
9632
9633             Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9634             Exchange_Declarations (Ftyp);
9635          end if;
9636
9637          Resolve (Actual, Ftyp);
9638
9639          if not Denotes_Variable (Actual) then
9640             Error_Msg_NE
9641               ("actual for& must be a variable", Actual, Gen_Obj);
9642
9643          elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9644
9645             --  Ada 2005 (AI-423): For a generic formal object of mode in out,
9646             --  the type of the actual shall resolve to a specific anonymous
9647             --  access type.
9648
9649             if Ada_Version < Ada_2005
9650               or else
9651                 Ekind (Base_Type (Ftyp)) /=
9652                   E_Anonymous_Access_Type
9653               or else
9654                 Ekind (Base_Type (Etype (Actual))) /=
9655                   E_Anonymous_Access_Type
9656             then
9657                Error_Msg_NE ("type of actual does not match type of&",
9658                              Actual, Gen_Obj);
9659             end if;
9660          end if;
9661
9662          Note_Possible_Modification (Actual, Sure => True);
9663
9664          --  Check for instantiation of atomic/volatile actual for
9665          --  non-atomic/volatile formal (RM C.6 (12)).
9666
9667          if Is_Atomic_Object (Actual)
9668            and then not Is_Atomic (Orig_Ftyp)
9669          then
9670             Error_Msg_N
9671               ("cannot instantiate non-atomic formal object " &
9672                "with atomic actual", Actual);
9673
9674          elsif Is_Volatile_Object (Actual)
9675            and then not Is_Volatile (Orig_Ftyp)
9676          then
9677             Error_Msg_N
9678               ("cannot instantiate non-volatile formal object " &
9679                "with volatile actual", Actual);
9680          end if;
9681
9682       --  Formal in-parameter
9683
9684       else
9685          --  The instantiation of a generic formal in-parameter is constant
9686          --  declaration. The actual is the expression for that declaration.
9687
9688          if Present (Actual) then
9689             if Present (Subt_Mark) then
9690                Def := Subt_Mark;
9691             else pragma Assert (Present (Acc_Def));
9692                Def := Acc_Def;
9693             end if;
9694
9695             Decl_Node :=
9696               Make_Object_Declaration (Loc,
9697                 Defining_Identifier    => New_Copy (Gen_Obj),
9698                 Constant_Present       => True,
9699                 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9700                 Object_Definition      => New_Copy_Tree (Def),
9701                 Expression             => Actual);
9702
9703             Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9704
9705             --  A generic formal object of a tagged type is defined to be
9706             --  aliased so the new constant must also be treated as aliased.
9707
9708             if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9709                Set_Aliased_Present (Decl_Node);
9710             end if;
9711
9712             Append (Decl_Node, List);
9713
9714             --  No need to repeat (pre-)analysis of some expression nodes
9715             --  already handled in Preanalyze_Actuals.
9716
9717             if Nkind (Actual) /= N_Allocator then
9718                Analyze (Actual);
9719
9720                --  Return if the analysis of the actual reported some error
9721
9722                if Etype (Actual) = Any_Type then
9723                   return List;
9724                end if;
9725             end if;
9726
9727             declare
9728                Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9729                Typ         : Entity_Id;
9730
9731             begin
9732                Typ := Get_Instance_Of (Formal_Type);
9733
9734                Freeze_Before (Instantiation_Node, Typ);
9735
9736                --  If the actual is an aggregate, perform name resolution on
9737                --  its components (the analysis of an aggregate does not do it)
9738                --  to capture local names that may be hidden if the generic is
9739                --  a child unit.
9740
9741                if Nkind (Actual) = N_Aggregate then
9742                   Preanalyze_And_Resolve (Actual, Typ);
9743                end if;
9744
9745                if Is_Limited_Type (Typ)
9746                  and then not OK_For_Limited_Init (Typ, Actual)
9747                then
9748                   Error_Msg_N
9749                     ("initialization not allowed for limited types", Actual);
9750                   Explain_Limited_Type (Typ, Actual);
9751                end if;
9752             end;
9753
9754          elsif Present (Default_Expression (Formal)) then
9755
9756             --  Use default to construct declaration
9757
9758             if Present (Subt_Mark) then
9759                Def := Subt_Mark;
9760             else pragma Assert (Present (Acc_Def));
9761                Def := Acc_Def;
9762             end if;
9763
9764             Decl_Node :=
9765               Make_Object_Declaration (Sloc (Formal),
9766                 Defining_Identifier    => New_Copy (Gen_Obj),
9767                 Constant_Present       => True,
9768                 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9769                 Object_Definition      => New_Copy (Def),
9770                 Expression             => New_Copy_Tree
9771                                             (Default_Expression (Formal)));
9772
9773             Append (Decl_Node, List);
9774             Set_Analyzed (Expression (Decl_Node), False);
9775
9776          else
9777             Error_Msg_NE
9778               ("missing actual&",
9779                 Instantiation_Node, Gen_Obj);
9780             Error_Msg_NE ("\in instantiation of & declared#",
9781               Instantiation_Node, Scope (A_Gen_Obj));
9782
9783             if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9784
9785                --  Create dummy constant declaration so that instance can be
9786                --  analyzed, to minimize cascaded visibility errors.
9787
9788                if Present (Subt_Mark) then
9789                   Def := Subt_Mark;
9790                else pragma Assert (Present (Acc_Def));
9791                   Def := Acc_Def;
9792                end if;
9793
9794                Decl_Node :=
9795                  Make_Object_Declaration (Loc,
9796                    Defining_Identifier    => New_Copy (Gen_Obj),
9797                    Constant_Present       => True,
9798                    Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9799                    Object_Definition      => New_Copy (Def),
9800                    Expression             =>
9801                      Make_Attribute_Reference (Sloc (Gen_Obj),
9802                        Attribute_Name => Name_First,
9803                        Prefix         => New_Copy (Def)));
9804
9805                Append (Decl_Node, List);
9806
9807             else
9808                Abandon_Instantiation (Instantiation_Node);
9809             end if;
9810          end if;
9811       end if;
9812
9813       if Nkind (Actual) in N_Has_Entity then
9814          Actual_Decl := Parent (Entity (Actual));
9815       end if;
9816
9817       --  Ada 2005 (AI-423): For a formal object declaration with a null
9818       --  exclusion or an access definition that has a null exclusion: If the
9819       --  actual matching the formal object declaration denotes a generic
9820       --  formal object of another generic unit G, and the instantiation
9821       --  containing the actual occurs within the body of G or within the body
9822       --  of a generic unit declared within the declarative region of G, then
9823       --  the declaration of the formal object of G must have a null exclusion.
9824       --  Otherwise, the subtype of the actual matching the formal object
9825       --  declaration shall exclude null.
9826
9827       if Ada_Version >= Ada_2005
9828         and then Present (Actual_Decl)
9829         and then
9830           Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9831                                  N_Object_Declaration)
9832         and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9833         and then not Has_Null_Exclusion (Actual_Decl)
9834         and then Has_Null_Exclusion (Analyzed_Formal)
9835       then
9836          Error_Msg_Sloc := Sloc (Analyzed_Formal);
9837          Error_Msg_N
9838            ("actual must exclude null to match generic formal#", Actual);
9839       end if;
9840
9841       return List;
9842    end Instantiate_Object;
9843
9844    ------------------------------
9845    -- Instantiate_Package_Body --
9846    ------------------------------
9847
9848    procedure Instantiate_Package_Body
9849      (Body_Info     : Pending_Body_Info;
9850       Inlined_Body  : Boolean := False;
9851       Body_Optional : Boolean := False)
9852    is
9853       Act_Decl    : constant Node_Id    := Body_Info.Act_Decl;
9854       Inst_Node   : constant Node_Id    := Body_Info.Inst_Node;
9855       Loc         : constant Source_Ptr := Sloc (Inst_Node);
9856
9857       Gen_Id      : constant Node_Id    := Name (Inst_Node);
9858       Gen_Unit    : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
9859       Gen_Decl    : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
9860       Act_Spec    : constant Node_Id    := Specification (Act_Decl);
9861       Act_Decl_Id : constant Entity_Id  := Defining_Entity (Act_Spec);
9862
9863       Act_Body_Name : Node_Id;
9864       Gen_Body      : Node_Id;
9865       Gen_Body_Id   : Node_Id;
9866       Act_Body      : Node_Id;
9867       Act_Body_Id   : Entity_Id;
9868
9869       Parent_Installed : Boolean := False;
9870       Save_Style_Check : constant Boolean := Style_Check;
9871
9872       Par_Ent : Entity_Id := Empty;
9873       Par_Vis : Boolean   := False;
9874
9875       Vis_Prims_List : Elist_Id := No_Elist;
9876       --  List of primitives made temporarily visible in the instantiation
9877       --  to match the visibility of the formal type
9878
9879    begin
9880       Gen_Body_Id := Corresponding_Body (Gen_Decl);
9881
9882       --  The instance body may already have been processed, as the parent of
9883       --  another instance that is inlined (Load_Parent_Of_Generic).
9884
9885       if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9886          return;
9887       end if;
9888
9889       Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9890
9891       --  Re-establish the state of information on which checks are suppressed.
9892       --  This information was set in Body_Info at the point of instantiation,
9893       --  and now we restore it so that the instance is compiled using the
9894       --  check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9895
9896       Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9897       Scope_Suppress           := Body_Info.Scope_Suppress;
9898       Opt.Ada_Version          := Body_Info.Version;
9899       Opt.Ada_Version_Pragma   := Body_Info.Version_Pragma;
9900       Restore_Warnings (Body_Info.Warnings);
9901
9902       if No (Gen_Body_Id) then
9903          Load_Parent_Of_Generic
9904            (Inst_Node, Specification (Gen_Decl), Body_Optional);
9905          Gen_Body_Id := Corresponding_Body (Gen_Decl);
9906       end if;
9907
9908       --  Establish global variable for sloc adjustment and for error recovery
9909
9910       Instantiation_Node := Inst_Node;
9911
9912       if Present (Gen_Body_Id) then
9913          Save_Env (Gen_Unit, Act_Decl_Id);
9914          Style_Check := False;
9915          Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9916
9917          Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9918
9919          Create_Instantiation_Source
9920            (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9921
9922          Act_Body :=
9923            Copy_Generic_Node
9924              (Original_Node (Gen_Body), Empty, Instantiating => True);
9925
9926          --  Build new name (possibly qualified) for body declaration
9927
9928          Act_Body_Id := New_Copy (Act_Decl_Id);
9929
9930          --  Some attributes of spec entity are not inherited by body entity
9931
9932          Set_Handler_Records (Act_Body_Id, No_List);
9933
9934          if Nkind (Defining_Unit_Name (Act_Spec)) =
9935                                            N_Defining_Program_Unit_Name
9936          then
9937             Act_Body_Name :=
9938               Make_Defining_Program_Unit_Name (Loc,
9939                 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9940                 Defining_Identifier => Act_Body_Id);
9941          else
9942             Act_Body_Name :=  Act_Body_Id;
9943          end if;
9944
9945          Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9946
9947          Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9948          Check_Generic_Actuals (Act_Decl_Id, False);
9949
9950          --  Install primitives hidden at the point of the instantiation but
9951          --  visible when processing the generic formals
9952
9953          declare
9954             E : Entity_Id;
9955
9956          begin
9957             E := First_Entity (Act_Decl_Id);
9958             while Present (E) loop
9959                if Is_Type (E)
9960                  and then Is_Generic_Actual_Type (E)
9961                  and then Is_Tagged_Type (E)
9962                then
9963                   Install_Hidden_Primitives
9964                     (Prims_List => Vis_Prims_List,
9965                      Gen_T      => Generic_Parent_Type (Parent (E)),
9966                      Act_T      => E);
9967                end if;
9968
9969                Next_Entity (E);
9970             end loop;
9971          end;
9972
9973          --  If it is a child unit, make the parent instance (which is an
9974          --  instance of the parent of the generic) visible. The parent
9975          --  instance is the prefix of the name of the generic unit.
9976
9977          if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9978            and then Nkind (Gen_Id) = N_Expanded_Name
9979          then
9980             Par_Ent := Entity (Prefix (Gen_Id));
9981             Par_Vis := Is_Immediately_Visible (Par_Ent);
9982             Install_Parent (Par_Ent, In_Body => True);
9983             Parent_Installed := True;
9984
9985          elsif Is_Child_Unit (Gen_Unit) then
9986             Par_Ent := Scope (Gen_Unit);
9987             Par_Vis := Is_Immediately_Visible (Par_Ent);
9988             Install_Parent (Par_Ent, In_Body => True);
9989             Parent_Installed := True;
9990          end if;
9991
9992          --  If the instantiation is a library unit, and this is the main unit,
9993          --  then build the resulting compilation unit nodes for the instance.
9994          --  If this is a compilation unit but it is not the main unit, then it
9995          --  is the body of a unit in the context, that is being compiled
9996          --  because it is encloses some inlined unit or another generic unit
9997          --  being instantiated. In that case, this body is not part of the
9998          --  current compilation, and is not attached to the tree, but its
9999          --  parent must be set for analysis.
10000
10001          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10002
10003             --  Replace instance node with body of instance, and create new
10004             --  node for corresponding instance declaration.
10005
10006             Build_Instance_Compilation_Unit_Nodes
10007               (Inst_Node, Act_Body, Act_Decl);
10008             Analyze (Inst_Node);
10009
10010             if Parent (Inst_Node) = Cunit (Main_Unit) then
10011
10012                --  If the instance is a child unit itself, then set the scope
10013                --  of the expanded body to be the parent of the instantiation
10014                --  (ensuring that the fully qualified name will be generated
10015                --  for the elaboration subprogram).
10016
10017                if Nkind (Defining_Unit_Name (Act_Spec)) =
10018                                               N_Defining_Program_Unit_Name
10019                then
10020                   Set_Scope
10021                     (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10022                end if;
10023             end if;
10024
10025          --  Case where instantiation is not a library unit
10026
10027          else
10028             --  If this is an early instantiation, i.e. appears textually
10029             --  before the corresponding body and must be elaborated first,
10030             --  indicate that the body instance is to be delayed.
10031
10032             Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10033
10034             --  Now analyze the body. We turn off all checks if this is an
10035             --  internal unit, since there is no reason to have checks on for
10036             --  any predefined run-time library code. All such code is designed
10037             --  to be compiled with checks off.
10038
10039             --  Note that we do NOT apply this criterion to children of GNAT
10040             --  (or on VMS, children of DEC). The latter units must suppress
10041             --  checks explicitly if this is needed.
10042
10043             if Is_Predefined_File_Name
10044                  (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10045             then
10046                Analyze (Act_Body, Suppress => All_Checks);
10047             else
10048                Analyze (Act_Body);
10049             end if;
10050          end if;
10051
10052          Inherit_Context (Gen_Body, Inst_Node);
10053
10054          --  Remove the parent instances if they have been placed on the scope
10055          --  stack to compile the body.
10056
10057          if Parent_Installed then
10058             Remove_Parent (In_Body => True);
10059
10060             --  Restore the previous visibility of the parent
10061
10062             Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10063          end if;
10064
10065          Restore_Hidden_Primitives (Vis_Prims_List);
10066          Restore_Private_Views (Act_Decl_Id);
10067
10068          --  Remove the current unit from visibility if this is an instance
10069          --  that is not elaborated on the fly for inlining purposes.
10070
10071          if not Inlined_Body then
10072             Set_Is_Immediately_Visible (Act_Decl_Id, False);
10073          end if;
10074
10075          Restore_Env;
10076          Style_Check := Save_Style_Check;
10077
10078       --  If we have no body, and the unit requires a body, then complain. This
10079       --  complaint is suppressed if we have detected other errors (since a
10080       --  common reason for missing the body is that it had errors).
10081       --  In CodePeer mode, a warning has been emitted already, no need for
10082       --  further messages.
10083
10084       elsif Unit_Requires_Body (Gen_Unit)
10085         and then not Body_Optional
10086       then
10087          if CodePeer_Mode then
10088             null;
10089
10090          elsif Serious_Errors_Detected = 0 then
10091             Error_Msg_NE
10092               ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10093
10094          --  Don't attempt to perform any cleanup actions if some other error
10095          --  was already detected, since this can cause blowups.
10096
10097          else
10098             return;
10099          end if;
10100
10101       --  Case of package that does not need a body
10102
10103       else
10104          --  If the instantiation of the declaration is a library unit, rewrite
10105          --  the original package instantiation as a package declaration in the
10106          --  compilation unit node.
10107
10108          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10109             Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10110             Rewrite (Inst_Node, Act_Decl);
10111
10112             --  Generate elaboration entity, in case spec has elaboration code.
10113             --  This cannot be done when the instance is analyzed, because it
10114             --  is not known yet whether the body exists.
10115
10116             Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10117             Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10118
10119          --  If the instantiation is not a library unit, then append the
10120          --  declaration to the list of implicitly generated entities, unless
10121          --  it is already a list member which means that it was already
10122          --  processed
10123
10124          elsif not Is_List_Member (Act_Decl) then
10125             Mark_Rewrite_Insertion (Act_Decl);
10126             Insert_Before (Inst_Node, Act_Decl);
10127          end if;
10128       end if;
10129
10130       Expander_Mode_Restore;
10131    end Instantiate_Package_Body;
10132
10133    ---------------------------------
10134    -- Instantiate_Subprogram_Body --
10135    ---------------------------------
10136
10137    procedure Instantiate_Subprogram_Body
10138      (Body_Info     : Pending_Body_Info;
10139       Body_Optional : Boolean := False)
10140    is
10141       Act_Decl      : constant Node_Id    := Body_Info.Act_Decl;
10142       Inst_Node     : constant Node_Id    := Body_Info.Inst_Node;
10143       Loc           : constant Source_Ptr := Sloc (Inst_Node);
10144       Gen_Id        : constant Node_Id    := Name (Inst_Node);
10145       Gen_Unit      : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
10146       Gen_Decl      : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
10147       Anon_Id       : constant Entity_Id  :=
10148                         Defining_Unit_Name (Specification (Act_Decl));
10149       Pack_Id       : constant Entity_Id  :=
10150                         Defining_Unit_Name (Parent (Act_Decl));
10151       Decls         : List_Id;
10152       Gen_Body      : Node_Id;
10153       Gen_Body_Id   : Node_Id;
10154       Act_Body      : Node_Id;
10155       Pack_Body     : Node_Id;
10156       Prev_Formal   : Entity_Id;
10157       Ret_Expr      : Node_Id;
10158       Unit_Renaming : Node_Id;
10159
10160       Parent_Installed : Boolean := False;
10161
10162       Saved_Style_Check : constant Boolean        := Style_Check;
10163       Saved_Warnings    : constant Warning_Record := Save_Warnings;
10164
10165       Par_Ent : Entity_Id := Empty;
10166       Par_Vis : Boolean   := False;
10167
10168    begin
10169       Gen_Body_Id := Corresponding_Body (Gen_Decl);
10170
10171       --  Subprogram body may have been created already because of an inline
10172       --  pragma, or because of multiple elaborations of the enclosing package
10173       --  when several instances of the subprogram appear in the main unit.
10174
10175       if Present (Corresponding_Body (Act_Decl)) then
10176          return;
10177       end if;
10178
10179       Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10180
10181       --  Re-establish the state of information on which checks are suppressed.
10182       --  This information was set in Body_Info at the point of instantiation,
10183       --  and now we restore it so that the instance is compiled using the
10184       --  check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10185
10186       Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10187       Scope_Suppress           := Body_Info.Scope_Suppress;
10188       Opt.Ada_Version          := Body_Info.Version;
10189       Opt.Ada_Version_Pragma   := Body_Info.Version_Pragma;
10190       Restore_Warnings (Body_Info.Warnings);
10191
10192       if No (Gen_Body_Id) then
10193
10194          --  For imported generic subprogram, no body to compile, complete
10195          --  the spec entity appropriately.
10196
10197          if Is_Imported (Gen_Unit) then
10198             Set_Is_Imported (Anon_Id);
10199             Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10200             Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10201             Set_Convention     (Anon_Id, Convention     (Gen_Unit));
10202             Set_Has_Completion (Anon_Id);
10203             return;
10204
10205          --  For other cases, compile the body
10206
10207          else
10208             Load_Parent_Of_Generic
10209               (Inst_Node, Specification (Gen_Decl), Body_Optional);
10210             Gen_Body_Id := Corresponding_Body (Gen_Decl);
10211          end if;
10212       end if;
10213
10214       Instantiation_Node := Inst_Node;
10215
10216       if Present (Gen_Body_Id) then
10217          Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10218
10219          if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10220
10221             --  Either body is not present, or context is non-expanding, as
10222             --  when compiling a subunit. Mark the instance as completed, and
10223             --  diagnose a missing body when needed.
10224
10225             if Expander_Active
10226               and then Operating_Mode = Generate_Code
10227             then
10228                Error_Msg_N
10229                  ("missing proper body for instantiation", Gen_Body);
10230             end if;
10231
10232             Set_Has_Completion (Anon_Id);
10233             return;
10234          end if;
10235
10236          Save_Env (Gen_Unit, Anon_Id);
10237          Style_Check := False;
10238          Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10239          Create_Instantiation_Source
10240            (Inst_Node,
10241             Gen_Body_Id,
10242             False,
10243             S_Adjustment);
10244
10245          Act_Body :=
10246            Copy_Generic_Node
10247              (Original_Node (Gen_Body), Empty, Instantiating => True);
10248
10249          --  Create proper defining name for the body, to correspond to
10250          --  the one in the spec.
10251
10252          Set_Defining_Unit_Name (Specification (Act_Body),
10253            Make_Defining_Identifier
10254              (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10255          Set_Corresponding_Spec (Act_Body, Anon_Id);
10256          Set_Has_Completion (Anon_Id);
10257          Check_Generic_Actuals (Pack_Id, False);
10258
10259          --  Generate a reference to link the visible subprogram instance to
10260          --  the generic body, which for navigation purposes is the only
10261          --  available source for the instance.
10262
10263          Generate_Reference
10264            (Related_Instance (Pack_Id),
10265              Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10266
10267          --  If it is a child unit, make the parent instance (which is an
10268          --  instance of the parent of the generic) visible. The parent
10269          --  instance is the prefix of the name of the generic unit.
10270
10271          if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10272            and then Nkind (Gen_Id) = N_Expanded_Name
10273          then
10274             Par_Ent := Entity (Prefix (Gen_Id));
10275             Par_Vis := Is_Immediately_Visible (Par_Ent);
10276             Install_Parent (Par_Ent, In_Body => True);
10277             Parent_Installed := True;
10278
10279          elsif Is_Child_Unit (Gen_Unit) then
10280             Par_Ent := Scope (Gen_Unit);
10281             Par_Vis := Is_Immediately_Visible (Par_Ent);
10282             Install_Parent (Par_Ent, In_Body => True);
10283             Parent_Installed := True;
10284          end if;
10285
10286          --  Inside its body, a reference to the generic unit is a reference
10287          --  to the instance. The corresponding renaming is the first
10288          --  declaration in the body.
10289
10290          Unit_Renaming :=
10291            Make_Subprogram_Renaming_Declaration (Loc,
10292              Specification =>
10293                Copy_Generic_Node (
10294                  Specification (Original_Node (Gen_Body)),
10295                  Empty,
10296                  Instantiating => True),
10297              Name => New_Occurrence_Of (Anon_Id, Loc));
10298
10299          --  If there is a formal subprogram with the same name as the unit
10300          --  itself, do not add this renaming declaration. This is a temporary
10301          --  fix for one ACVC test. ???
10302
10303          Prev_Formal := First_Entity (Pack_Id);
10304          while Present (Prev_Formal) loop
10305             if Chars (Prev_Formal) = Chars (Gen_Unit)
10306               and then Is_Overloadable (Prev_Formal)
10307             then
10308                exit;
10309             end if;
10310
10311             Next_Entity (Prev_Formal);
10312          end loop;
10313
10314          if Present (Prev_Formal) then
10315             Decls :=  New_List (Act_Body);
10316          else
10317             Decls :=  New_List (Unit_Renaming, Act_Body);
10318          end if;
10319
10320          --  The subprogram body is placed in the body of a dummy package body,
10321          --  whose spec contains the subprogram declaration as well as the
10322          --  renaming declarations for the generic parameters.
10323
10324          Pack_Body := Make_Package_Body (Loc,
10325            Defining_Unit_Name => New_Copy (Pack_Id),
10326            Declarations       => Decls);
10327
10328          Set_Corresponding_Spec (Pack_Body, Pack_Id);
10329
10330          --  If the instantiation is a library unit, then build resulting
10331          --  compilation unit nodes for the instance. The declaration of
10332          --  the enclosing package is the grandparent of the subprogram
10333          --  declaration. First replace the instantiation node as the unit
10334          --  of the corresponding compilation.
10335
10336          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10337             if Parent (Inst_Node) = Cunit (Main_Unit) then
10338                Set_Unit (Parent (Inst_Node), Inst_Node);
10339                Build_Instance_Compilation_Unit_Nodes
10340                  (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10341                Analyze (Inst_Node);
10342             else
10343                Set_Parent (Pack_Body, Parent (Inst_Node));
10344                Analyze (Pack_Body);
10345             end if;
10346
10347          else
10348             Insert_Before (Inst_Node, Pack_Body);
10349             Mark_Rewrite_Insertion (Pack_Body);
10350             Analyze (Pack_Body);
10351
10352             if Expander_Active then
10353                Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10354             end if;
10355          end if;
10356
10357          Inherit_Context (Gen_Body, Inst_Node);
10358
10359          Restore_Private_Views (Pack_Id, False);
10360
10361          if Parent_Installed then
10362             Remove_Parent (In_Body => True);
10363
10364             --  Restore the previous visibility of the parent
10365
10366             Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10367          end if;
10368
10369          Restore_Env;
10370          Style_Check := Saved_Style_Check;
10371          Restore_Warnings (Saved_Warnings);
10372
10373       --  Body not found. Error was emitted already. If there were no previous
10374       --  errors, this may be an instance whose scope is a premature instance.
10375       --  In that case we must insure that the (legal) program does raise
10376       --  program error if executed. We generate a subprogram body for this
10377       --  purpose. See DEC ac30vso.
10378
10379       --  Should not reference proprietary DEC tests in comments ???
10380
10381       elsif Serious_Errors_Detected = 0
10382         and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10383       then
10384          if Body_Optional then
10385             return;
10386
10387          elsif Ekind (Anon_Id) = E_Procedure then
10388             Act_Body :=
10389               Make_Subprogram_Body (Loc,
10390                  Specification              =>
10391                    Make_Procedure_Specification (Loc,
10392                      Defining_Unit_Name         =>
10393                        Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10394                        Parameter_Specifications =>
10395                        New_Copy_List
10396                          (Parameter_Specifications (Parent (Anon_Id)))),
10397
10398                  Declarations               => Empty_List,
10399                  Handled_Statement_Sequence =>
10400                    Make_Handled_Sequence_Of_Statements (Loc,
10401                      Statements =>
10402                        New_List (
10403                          Make_Raise_Program_Error (Loc,
10404                            Reason =>
10405                              PE_Access_Before_Elaboration))));
10406
10407          else
10408             Ret_Expr :=
10409               Make_Raise_Program_Error (Loc,
10410                 Reason => PE_Access_Before_Elaboration);
10411
10412             Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10413             Set_Analyzed (Ret_Expr);
10414
10415             Act_Body :=
10416               Make_Subprogram_Body (Loc,
10417                 Specification =>
10418                   Make_Function_Specification (Loc,
10419                      Defining_Unit_Name         =>
10420                        Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10421                        Parameter_Specifications =>
10422                        New_Copy_List
10423                          (Parameter_Specifications (Parent (Anon_Id))),
10424                      Result_Definition =>
10425                        New_Occurrence_Of (Etype (Anon_Id), Loc)),
10426
10427                   Declarations               => Empty_List,
10428                   Handled_Statement_Sequence =>
10429                     Make_Handled_Sequence_Of_Statements (Loc,
10430                       Statements =>
10431                         New_List
10432                           (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10433          end if;
10434
10435          Pack_Body := Make_Package_Body (Loc,
10436            Defining_Unit_Name => New_Copy (Pack_Id),
10437            Declarations       => New_List (Act_Body));
10438
10439          Insert_After (Inst_Node, Pack_Body);
10440          Set_Corresponding_Spec (Pack_Body, Pack_Id);
10441          Analyze (Pack_Body);
10442       end if;
10443
10444       Expander_Mode_Restore;
10445    end Instantiate_Subprogram_Body;
10446
10447    ----------------------
10448    -- Instantiate_Type --
10449    ----------------------
10450
10451    function Instantiate_Type
10452      (Formal          : Node_Id;
10453       Actual          : Node_Id;
10454       Analyzed_Formal : Node_Id;
10455       Actual_Decls    : List_Id) return List_Id
10456    is
10457       Gen_T      : constant Entity_Id  := Defining_Identifier (Formal);
10458       A_Gen_T    : constant Entity_Id  :=
10459                      Defining_Identifier (Analyzed_Formal);
10460       Ancestor   : Entity_Id := Empty;
10461       Def        : constant Node_Id    := Formal_Type_Definition (Formal);
10462       Act_T      : Entity_Id;
10463       Decl_Node  : Node_Id;
10464       Decl_Nodes : List_Id;
10465       Loc        : Source_Ptr;
10466       Subt       : Entity_Id;
10467
10468       procedure Validate_Array_Type_Instance;
10469       procedure Validate_Access_Subprogram_Instance;
10470       procedure Validate_Access_Type_Instance;
10471       procedure Validate_Derived_Type_Instance;
10472       procedure Validate_Derived_Interface_Type_Instance;
10473       procedure Validate_Discriminated_Formal_Type;
10474       procedure Validate_Interface_Type_Instance;
10475       procedure Validate_Private_Type_Instance;
10476       procedure Validate_Incomplete_Type_Instance;
10477       --  These procedures perform validation tests for the named case.
10478       --  Validate_Discriminated_Formal_Type is shared by formal private
10479       --  types and Ada 2012 formal incomplete types.
10480
10481       function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10482       --  Check that base types are the same and that the subtypes match
10483       --  statically. Used in several of the above.
10484
10485       --------------------
10486       -- Subtypes_Match --
10487       --------------------
10488
10489       function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10490          T : constant Entity_Id := Get_Instance_Of (Gen_T);
10491
10492       begin
10493          --  Some detailed comments would be useful here ???
10494
10495          return ((Base_Type (T) = Act_T
10496                    or else Base_Type (T) = Base_Type (Act_T))
10497                   and then Subtypes_Statically_Match (T, Act_T))
10498
10499            or else (Is_Class_Wide_Type (Gen_T)
10500                      and then Is_Class_Wide_Type (Act_T)
10501                      and then Subtypes_Match
10502                                 (Get_Instance_Of (Root_Type (Gen_T)),
10503                                  Root_Type (Act_T)))
10504
10505            or else
10506              (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10507                                E_Anonymous_Access_Type)
10508                and then Ekind (Act_T) = Ekind (Gen_T)
10509                and then Subtypes_Statically_Match
10510                           (Designated_Type (Gen_T), Designated_Type (Act_T)));
10511       end Subtypes_Match;
10512
10513       -----------------------------------------
10514       -- Validate_Access_Subprogram_Instance --
10515       -----------------------------------------
10516
10517       procedure Validate_Access_Subprogram_Instance is
10518       begin
10519          if not Is_Access_Type (Act_T)
10520            or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10521          then
10522             Error_Msg_NE
10523               ("expect access type in instantiation of &", Actual, Gen_T);
10524             Abandon_Instantiation (Actual);
10525          end if;
10526
10527          --  According to AI05-288, actuals for access_to_subprograms must be
10528          --  subtype conformant with the generic formal. Previous to AI05-288
10529          --  only mode conformance was required.
10530
10531          --  This is a binding interpretation that applies to previous versions
10532          --  of the language, but for now we retain the milder check in order
10533          --  to preserve ACATS tests. These will be protested eventually ???
10534
10535          if Ada_Version < Ada_2012 then
10536             Check_Mode_Conformant
10537               (Designated_Type (Act_T),
10538                Designated_Type (A_Gen_T),
10539                Actual,
10540                Get_Inst => True);
10541
10542          else
10543             Check_Subtype_Conformant
10544               (Designated_Type (Act_T),
10545                Designated_Type (A_Gen_T),
10546                Actual,
10547                Get_Inst => True);
10548          end if;
10549
10550          if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10551             if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10552                Error_Msg_NE
10553                  ("protected access type not allowed for formal &",
10554                   Actual, Gen_T);
10555             end if;
10556
10557          elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10558             Error_Msg_NE
10559               ("expect protected access type for formal &",
10560                Actual, Gen_T);
10561          end if;
10562       end Validate_Access_Subprogram_Instance;
10563
10564       -----------------------------------
10565       -- Validate_Access_Type_Instance --
10566       -----------------------------------
10567
10568       procedure Validate_Access_Type_Instance is
10569          Desig_Type : constant Entity_Id :=
10570                         Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10571          Desig_Act  : Entity_Id;
10572
10573       begin
10574          if not Is_Access_Type (Act_T) then
10575             Error_Msg_NE
10576               ("expect access type in instantiation of &", Actual, Gen_T);
10577             Abandon_Instantiation (Actual);
10578          end if;
10579
10580          if Is_Access_Constant (A_Gen_T) then
10581             if not Is_Access_Constant (Act_T) then
10582                Error_Msg_N
10583                  ("actual type must be access-to-constant type", Actual);
10584                Abandon_Instantiation (Actual);
10585             end if;
10586          else
10587             if Is_Access_Constant (Act_T) then
10588                Error_Msg_N
10589                  ("actual type must be access-to-variable type", Actual);
10590                Abandon_Instantiation (Actual);
10591
10592             elsif Ekind (A_Gen_T) = E_General_Access_Type
10593               and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10594             then
10595                Error_Msg_N -- CODEFIX
10596                  ("actual must be general access type!", Actual);
10597                Error_Msg_NE -- CODEFIX
10598                  ("add ALL to }!", Actual, Act_T);
10599                Abandon_Instantiation (Actual);
10600             end if;
10601          end if;
10602
10603          --  The designated subtypes, that is to say the subtypes introduced
10604          --  by an access type declaration (and not by a subtype declaration)
10605          --  must match.
10606
10607          Desig_Act := Designated_Type (Base_Type (Act_T));
10608
10609          --  The designated type may have been introduced through a limited_
10610          --  with clause, in which case retrieve the non-limited view. This
10611          --  applies to incomplete types as well as to class-wide types.
10612
10613          if From_With_Type (Desig_Act) then
10614             Desig_Act := Available_View (Desig_Act);
10615          end if;
10616
10617          if not Subtypes_Match
10618            (Desig_Type, Desig_Act) then
10619             Error_Msg_NE
10620               ("designated type of actual does not match that of formal &",
10621                  Actual, Gen_T);
10622             Abandon_Instantiation (Actual);
10623
10624          elsif Is_Access_Type (Designated_Type (Act_T))
10625            and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10626                       /=
10627                   Is_Constrained (Designated_Type (Desig_Type))
10628          then
10629             Error_Msg_NE
10630               ("designated type of actual does not match that of formal &",
10631                  Actual, Gen_T);
10632             Abandon_Instantiation (Actual);
10633          end if;
10634
10635          --  Ada 2005: null-exclusion indicators of the two types must agree
10636
10637          if Can_Never_Be_Null (A_Gen_T) /=  Can_Never_Be_Null (Act_T) then
10638             Error_Msg_NE
10639               ("non null exclusion of actual and formal & do not match",
10640                  Actual, Gen_T);
10641          end if;
10642       end Validate_Access_Type_Instance;
10643
10644       ----------------------------------
10645       -- Validate_Array_Type_Instance --
10646       ----------------------------------
10647
10648       procedure Validate_Array_Type_Instance is
10649          I1 : Node_Id;
10650          I2 : Node_Id;
10651          T2 : Entity_Id;
10652
10653          function Formal_Dimensions return Int;
10654          --  Count number of dimensions in array type formal
10655
10656          -----------------------
10657          -- Formal_Dimensions --
10658          -----------------------
10659
10660          function Formal_Dimensions return Int is
10661             Num   : Int := 0;
10662             Index : Node_Id;
10663
10664          begin
10665             if Nkind (Def) = N_Constrained_Array_Definition then
10666                Index := First (Discrete_Subtype_Definitions (Def));
10667             else
10668                Index := First (Subtype_Marks (Def));
10669             end if;
10670
10671             while Present (Index) loop
10672                Num := Num + 1;
10673                Next_Index (Index);
10674             end loop;
10675
10676             return Num;
10677          end Formal_Dimensions;
10678
10679       --  Start of processing for Validate_Array_Type_Instance
10680
10681       begin
10682          if not Is_Array_Type (Act_T) then
10683             Error_Msg_NE
10684               ("expect array type in instantiation of &", Actual, Gen_T);
10685             Abandon_Instantiation (Actual);
10686
10687          elsif Nkind (Def) = N_Constrained_Array_Definition then
10688             if not (Is_Constrained (Act_T)) then
10689                Error_Msg_NE
10690                  ("expect constrained array in instantiation of &",
10691                   Actual, Gen_T);
10692                Abandon_Instantiation (Actual);
10693             end if;
10694
10695          else
10696             if Is_Constrained (Act_T) then
10697                Error_Msg_NE
10698                  ("expect unconstrained array in instantiation of &",
10699                   Actual, Gen_T);
10700                Abandon_Instantiation (Actual);
10701             end if;
10702          end if;
10703
10704          if Formal_Dimensions /= Number_Dimensions (Act_T) then
10705             Error_Msg_NE
10706               ("dimensions of actual do not match formal &", Actual, Gen_T);
10707             Abandon_Instantiation (Actual);
10708          end if;
10709
10710          I1 := First_Index (A_Gen_T);
10711          I2 := First_Index (Act_T);
10712          for J in 1 .. Formal_Dimensions loop
10713
10714             --  If the indexes of the actual were given by a subtype_mark,
10715             --  the index was transformed into a range attribute. Retrieve
10716             --  the original type mark for checking.
10717
10718             if Is_Entity_Name (Original_Node (I2)) then
10719                T2 := Entity (Original_Node (I2));
10720             else
10721                T2 := Etype (I2);
10722             end if;
10723
10724             if not Subtypes_Match
10725                      (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10726             then
10727                Error_Msg_NE
10728                  ("index types of actual do not match those of formal &",
10729                   Actual, Gen_T);
10730                Abandon_Instantiation (Actual);
10731             end if;
10732
10733             Next_Index (I1);
10734             Next_Index (I2);
10735          end loop;
10736
10737          --  Check matching subtypes. Note that there are complex visibility
10738          --  issues when the generic is a child unit and some aspect of the
10739          --  generic type is declared in a parent unit of the generic. We do
10740          --  the test to handle this special case only after a direct check
10741          --  for static matching has failed. The case where both the component
10742          --  type and the array type are separate formals, and the component
10743          --  type is a private view may also require special checking in
10744          --  Subtypes_Match.
10745
10746          if Subtypes_Match
10747            (Component_Type (A_Gen_T), Component_Type (Act_T))
10748              or else Subtypes_Match
10749                (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10750                Component_Type (Act_T))
10751          then
10752             null;
10753          else
10754             Error_Msg_NE
10755               ("component subtype of actual does not match that of formal &",
10756                Actual, Gen_T);
10757             Abandon_Instantiation (Actual);
10758          end if;
10759
10760          if Has_Aliased_Components (A_Gen_T)
10761            and then not Has_Aliased_Components (Act_T)
10762          then
10763             Error_Msg_NE
10764               ("actual must have aliased components to match formal type &",
10765                Actual, Gen_T);
10766          end if;
10767       end Validate_Array_Type_Instance;
10768
10769       -----------------------------------------------
10770       --  Validate_Derived_Interface_Type_Instance --
10771       -----------------------------------------------
10772
10773       procedure Validate_Derived_Interface_Type_Instance is
10774          Par  : constant Entity_Id := Entity (Subtype_Indication (Def));
10775          Elmt : Elmt_Id;
10776
10777       begin
10778          --  First apply interface instance checks
10779
10780          Validate_Interface_Type_Instance;
10781
10782          --  Verify that immediate parent interface is an ancestor of
10783          --  the actual.
10784
10785          if Present (Par)
10786            and then not Interface_Present_In_Ancestor (Act_T, Par)
10787          then
10788             Error_Msg_NE
10789               ("interface actual must include progenitor&", Actual, Par);
10790          end if;
10791
10792          --  Now verify that the actual includes all other ancestors of
10793          --  the formal.
10794
10795          Elmt := First_Elmt (Interfaces (A_Gen_T));
10796          while Present (Elmt) loop
10797             if not Interface_Present_In_Ancestor
10798                      (Act_T, Get_Instance_Of (Node (Elmt)))
10799             then
10800                Error_Msg_NE
10801                  ("interface actual must include progenitor&",
10802                     Actual, Node (Elmt));
10803             end if;
10804
10805             Next_Elmt (Elmt);
10806          end loop;
10807       end Validate_Derived_Interface_Type_Instance;
10808
10809       ------------------------------------
10810       -- Validate_Derived_Type_Instance --
10811       ------------------------------------
10812
10813       procedure Validate_Derived_Type_Instance is
10814          Actual_Discr   : Entity_Id;
10815          Ancestor_Discr : Entity_Id;
10816
10817       begin
10818          --  If the parent type in the generic declaration is itself a previous
10819          --  formal type, then it is local to the generic and absent from the
10820          --  analyzed generic definition. In that case the ancestor is the
10821          --  instance of the formal (which must have been instantiated
10822          --  previously), unless the ancestor is itself a formal derived type.
10823          --  In this latter case (which is the subject of Corrigendum 8652/0038
10824          --  (AI-202) the ancestor of the formals is the ancestor of its
10825          --  parent. Otherwise, the analyzed generic carries the parent type.
10826          --  If the parent type is defined in a previous formal package, then
10827          --  the scope of that formal package is that of the generic type
10828          --  itself, and it has already been mapped into the corresponding type
10829          --  in the actual package.
10830
10831          --  Common case: parent type defined outside of the generic
10832
10833          if Is_Entity_Name (Subtype_Mark (Def))
10834            and then Present (Entity (Subtype_Mark (Def)))
10835          then
10836             Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10837
10838          --  Check whether parent is defined in a previous formal package
10839
10840          elsif
10841            Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10842          then
10843             Ancestor :=
10844               Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10845
10846          --  The type may be a local derivation, or a type extension of a
10847          --  previous formal, or of a formal of a parent package.
10848
10849          elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10850           or else
10851             Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10852          then
10853             --  Check whether the parent is another derived formal type in the
10854             --  same generic unit.
10855
10856             if Etype (A_Gen_T) /= A_Gen_T
10857               and then Is_Generic_Type (Etype (A_Gen_T))
10858               and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10859               and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10860             then
10861                --  Locate ancestor of parent from the subtype declaration
10862                --  created for the actual.
10863
10864                declare
10865                   Decl : Node_Id;
10866
10867                begin
10868                   Decl := First (Actual_Decls);
10869                   while Present (Decl) loop
10870                      if Nkind (Decl) = N_Subtype_Declaration
10871                        and then Chars (Defining_Identifier (Decl)) =
10872                                                     Chars (Etype (A_Gen_T))
10873                      then
10874                         Ancestor := Generic_Parent_Type (Decl);
10875                         exit;
10876                      else
10877                         Next (Decl);
10878                      end if;
10879                   end loop;
10880                end;
10881
10882                pragma Assert (Present (Ancestor));
10883
10884                --  The ancestor itself may be a previous formal that has been
10885                --  instantiated.
10886
10887                Ancestor := Get_Instance_Of (Ancestor);
10888
10889             else
10890                Ancestor :=
10891                  Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10892             end if;
10893
10894          --  An unusual case: the actual is a type declared in a parent unit,
10895          --  but is not a formal type so there is no instance_of for it.
10896          --  Retrieve it by analyzing the record extension.
10897
10898          elsif Is_Child_Unit (Scope (A_Gen_T))
10899            and then In_Open_Scopes (Scope (Act_T))
10900            and then Is_Generic_Instance (Scope (Act_T))
10901          then
10902             Analyze (Subtype_Mark (Def));
10903             Ancestor := Entity (Subtype_Mark (Def));
10904
10905          else
10906             Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10907          end if;
10908
10909          --  If the formal derived type has pragma Preelaborable_Initialization
10910          --  then the actual type must have preelaborable initialization.
10911
10912          if Known_To_Have_Preelab_Init (A_Gen_T)
10913            and then not Has_Preelaborable_Initialization (Act_T)
10914          then
10915             Error_Msg_NE
10916               ("actual for & must have preelaborable initialization",
10917                Actual, Gen_T);
10918          end if;
10919
10920          --  Ada 2005 (AI-251)
10921
10922          if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
10923             if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10924                Error_Msg_NE
10925                  ("(Ada 2005) expected type implementing & in instantiation",
10926                   Actual, Ancestor);
10927             end if;
10928
10929          elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10930             Error_Msg_NE
10931               ("expect type derived from & in instantiation",
10932                Actual, First_Subtype (Ancestor));
10933             Abandon_Instantiation (Actual);
10934          end if;
10935
10936          --  Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10937          --  that the formal type declaration has been rewritten as a private
10938          --  extension.
10939
10940          if Ada_Version >= Ada_2005
10941            and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10942            and then Synchronized_Present (Parent (A_Gen_T))
10943          then
10944             --  The actual must be a synchronized tagged type
10945
10946             if not Is_Tagged_Type (Act_T) then
10947                Error_Msg_N
10948                  ("actual of synchronized type must be tagged", Actual);
10949                Abandon_Instantiation (Actual);
10950
10951             elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10952               and then Nkind (Type_Definition (Parent (Act_T))) =
10953                          N_Derived_Type_Definition
10954               and then not Synchronized_Present (Type_Definition
10955                              (Parent (Act_T)))
10956             then
10957                Error_Msg_N
10958                  ("actual of synchronized type must be synchronized", Actual);
10959                Abandon_Instantiation (Actual);
10960             end if;
10961          end if;
10962
10963          --  Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10964          --  removes the second instance of the phrase "or allow pass by copy".
10965
10966          if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10967             Error_Msg_N
10968               ("cannot have atomic actual type for non-atomic formal type",
10969                Actual);
10970
10971          elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10972             Error_Msg_N
10973               ("cannot have volatile actual type for non-volatile formal type",
10974                Actual);
10975          end if;
10976
10977          --  It should not be necessary to check for unknown discriminants on
10978          --  Formal, but for some reason Has_Unknown_Discriminants is false for
10979          --  A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10980          --  needs fixing. ???
10981
10982          if not Is_Indefinite_Subtype (A_Gen_T)
10983            and then not Unknown_Discriminants_Present (Formal)
10984            and then Is_Indefinite_Subtype (Act_T)
10985          then
10986             Error_Msg_N
10987               ("actual subtype must be constrained", Actual);
10988             Abandon_Instantiation (Actual);
10989          end if;
10990
10991          if not Unknown_Discriminants_Present (Formal) then
10992             if Is_Constrained (Ancestor) then
10993                if not Is_Constrained (Act_T) then
10994                   Error_Msg_N
10995                     ("actual subtype must be constrained", Actual);
10996                   Abandon_Instantiation (Actual);
10997                end if;
10998
10999             --  Ancestor is unconstrained, Check if generic formal and actual
11000             --  agree on constrainedness. The check only applies to array types
11001             --  and discriminated types.
11002
11003             elsif Is_Constrained (Act_T) then
11004                if Ekind (Ancestor) = E_Access_Type
11005                  or else
11006                    (not Is_Constrained (A_Gen_T)
11007                      and then Is_Composite_Type (A_Gen_T))
11008                then
11009                   Error_Msg_N
11010                     ("actual subtype must be unconstrained", Actual);
11011                   Abandon_Instantiation (Actual);
11012                end if;
11013
11014             --  A class-wide type is only allowed if the formal has unknown
11015             --  discriminants.
11016
11017             elsif Is_Class_Wide_Type (Act_T)
11018               and then not Has_Unknown_Discriminants (Ancestor)
11019             then
11020                Error_Msg_NE
11021                  ("actual for & cannot be a class-wide type", Actual, Gen_T);
11022                Abandon_Instantiation (Actual);
11023
11024             --  Otherwise, the formal and actual shall have the same number
11025             --  of discriminants and each discriminant of the actual must
11026             --  correspond to a discriminant of the formal.
11027
11028             elsif Has_Discriminants (Act_T)
11029               and then not Has_Unknown_Discriminants (Act_T)
11030               and then Has_Discriminants (Ancestor)
11031             then
11032                Actual_Discr   := First_Discriminant (Act_T);
11033                Ancestor_Discr := First_Discriminant (Ancestor);
11034                while Present (Actual_Discr)
11035                  and then Present (Ancestor_Discr)
11036                loop
11037                   if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11038                     No (Corresponding_Discriminant (Actual_Discr))
11039                   then
11040                      Error_Msg_NE
11041                        ("discriminant & does not correspond " &
11042                         "to ancestor discriminant", Actual, Actual_Discr);
11043                      Abandon_Instantiation (Actual);
11044                   end if;
11045
11046                   Next_Discriminant (Actual_Discr);
11047                   Next_Discriminant (Ancestor_Discr);
11048                end loop;
11049
11050                if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11051                   Error_Msg_NE
11052                     ("actual for & must have same number of discriminants",
11053                      Actual, Gen_T);
11054                   Abandon_Instantiation (Actual);
11055                end if;
11056
11057             --  This case should be caught by the earlier check for
11058             --  constrainedness, but the check here is added for completeness.
11059
11060             elsif Has_Discriminants (Act_T)
11061               and then not Has_Unknown_Discriminants (Act_T)
11062             then
11063                Error_Msg_NE
11064                  ("actual for & must not have discriminants", Actual, Gen_T);
11065                Abandon_Instantiation (Actual);
11066
11067             elsif Has_Discriminants (Ancestor) then
11068                Error_Msg_NE
11069                  ("actual for & must have known discriminants", Actual, Gen_T);
11070                Abandon_Instantiation (Actual);
11071             end if;
11072
11073             if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
11074                Error_Msg_N
11075                  ("constraint on actual is incompatible with formal", Actual);
11076                Abandon_Instantiation (Actual);
11077             end if;
11078          end if;
11079
11080          --  If the formal and actual types are abstract, check that there
11081          --  are no abstract primitives of the actual type that correspond to
11082          --  nonabstract primitives of the formal type (second sentence of
11083          --  RM95-3.9.3(9)).
11084
11085          if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11086             Check_Abstract_Primitives : declare
11087                Gen_Prims  : constant Elist_Id :=
11088                              Primitive_Operations (A_Gen_T);
11089                Gen_Elmt   : Elmt_Id;
11090                Gen_Subp   : Entity_Id;
11091                Anc_Subp   : Entity_Id;
11092                Anc_Formal : Entity_Id;
11093                Anc_F_Type : Entity_Id;
11094
11095                Act_Prims  : constant Elist_Id  := Primitive_Operations (Act_T);
11096                Act_Elmt   : Elmt_Id;
11097                Act_Subp   : Entity_Id;
11098                Act_Formal : Entity_Id;
11099                Act_F_Type : Entity_Id;
11100
11101                Subprograms_Correspond : Boolean;
11102
11103                function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11104                --  Returns true if T2 is derived directly or indirectly from
11105                --  T1, including derivations from interfaces. T1 and T2 are
11106                --  required to be specific tagged base types.
11107
11108                ------------------------
11109                -- Is_Tagged_Ancestor --
11110                ------------------------
11111
11112                function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11113                is
11114                   Intfc_Elmt : Elmt_Id;
11115
11116                begin
11117                   --  The predicate is satisfied if the types are the same
11118
11119                   if T1 = T2 then
11120                      return True;
11121
11122                   --  If we've reached the top of the derivation chain then
11123                   --  we know that T1 is not an ancestor of T2.
11124
11125                   elsif Etype (T2) = T2 then
11126                      return False;
11127
11128                   --  Proceed to check T2's immediate parent
11129
11130                   elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11131                      return True;
11132
11133                   --  Finally, check to see if T1 is an ancestor of any of T2's
11134                   --  progenitors.
11135
11136                   else
11137                      Intfc_Elmt := First_Elmt (Interfaces (T2));
11138                      while Present (Intfc_Elmt) loop
11139                         if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11140                            return True;
11141                         end if;
11142
11143                         Next_Elmt (Intfc_Elmt);
11144                      end loop;
11145                   end if;
11146
11147                   return False;
11148                end Is_Tagged_Ancestor;
11149
11150             --  Start of processing for Check_Abstract_Primitives
11151
11152             begin
11153                --  Loop over all of the formal derived type's primitives
11154
11155                Gen_Elmt := First_Elmt (Gen_Prims);
11156                while Present (Gen_Elmt) loop
11157                   Gen_Subp := Node (Gen_Elmt);
11158
11159                   --  If the primitive of the formal is not abstract, then
11160                   --  determine whether there is a corresponding primitive of
11161                   --  the actual type that's abstract.
11162
11163                   if not Is_Abstract_Subprogram (Gen_Subp) then
11164                      Act_Elmt := First_Elmt (Act_Prims);
11165                      while Present (Act_Elmt) loop
11166                         Act_Subp := Node (Act_Elmt);
11167
11168                         --  If we find an abstract primitive of the actual,
11169                         --  then we need to test whether it corresponds to the
11170                         --  subprogram from which the generic formal primitive
11171                         --  is inherited.
11172
11173                         if Is_Abstract_Subprogram (Act_Subp) then
11174                            Anc_Subp := Alias (Gen_Subp);
11175
11176                            --  Test whether we have a corresponding primitive
11177                            --  by comparing names, kinds, formal types, and
11178                            --  result types.
11179
11180                            if Chars (Anc_Subp) = Chars (Act_Subp)
11181                              and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11182                            then
11183                               Anc_Formal := First_Formal (Anc_Subp);
11184                               Act_Formal := First_Formal (Act_Subp);
11185                               while Present (Anc_Formal)
11186                                 and then Present (Act_Formal)
11187                               loop
11188                                  Anc_F_Type := Etype (Anc_Formal);
11189                                  Act_F_Type := Etype (Act_Formal);
11190
11191                                  if Ekind (Anc_F_Type)
11192                                       = E_Anonymous_Access_Type
11193                                  then
11194                                     Anc_F_Type := Designated_Type (Anc_F_Type);
11195
11196                                     if Ekind (Act_F_Type)
11197                                          = E_Anonymous_Access_Type
11198                                     then
11199                                        Act_F_Type :=
11200                                          Designated_Type (Act_F_Type);
11201                                     else
11202                                        exit;
11203                                     end if;
11204
11205                                  elsif
11206                                    Ekind (Act_F_Type) = E_Anonymous_Access_Type
11207                                  then
11208                                     exit;
11209                                  end if;
11210
11211                                  Anc_F_Type := Base_Type (Anc_F_Type);
11212                                  Act_F_Type := Base_Type (Act_F_Type);
11213
11214                                  --  If the formal is controlling, then the
11215                                  --  the type of the actual primitive's formal
11216                                  --  must be derived directly or indirectly
11217                                  --  from the type of the ancestor primitive's
11218                                  --  formal.
11219
11220                                  if Is_Controlling_Formal (Anc_Formal) then
11221                                     if not Is_Tagged_Ancestor
11222                                              (Anc_F_Type, Act_F_Type)
11223                                     then
11224                                        exit;
11225                                     end if;
11226
11227                                  --  Otherwise the types of the formals must
11228                                  --  be the same.
11229
11230                                  elsif Anc_F_Type /= Act_F_Type then
11231                                     exit;
11232                                  end if;
11233
11234                                  Next_Entity (Anc_Formal);
11235                                  Next_Entity (Act_Formal);
11236                               end loop;
11237
11238                               --  If we traversed through all of the formals
11239                               --  then so far the subprograms correspond, so
11240                               --  now check that any result types correspond.
11241
11242                               if No (Anc_Formal) and then No (Act_Formal) then
11243                                  Subprograms_Correspond := True;
11244
11245                                  if Ekind (Act_Subp) = E_Function then
11246                                     Anc_F_Type := Etype (Anc_Subp);
11247                                     Act_F_Type := Etype (Act_Subp);
11248
11249                                     if Ekind (Anc_F_Type)
11250                                          = E_Anonymous_Access_Type
11251                                     then
11252                                        Anc_F_Type :=
11253                                          Designated_Type (Anc_F_Type);
11254
11255                                        if Ekind (Act_F_Type)
11256                                             = E_Anonymous_Access_Type
11257                                        then
11258                                           Act_F_Type :=
11259                                             Designated_Type (Act_F_Type);
11260                                        else
11261                                           Subprograms_Correspond := False;
11262                                        end if;
11263
11264                                     elsif
11265                                       Ekind (Act_F_Type)
11266                                         = E_Anonymous_Access_Type
11267                                     then
11268                                        Subprograms_Correspond := False;
11269                                     end if;
11270
11271                                     Anc_F_Type := Base_Type (Anc_F_Type);
11272                                     Act_F_Type := Base_Type (Act_F_Type);
11273
11274                                     --  Now either the result types must be
11275                                     --  the same or, if the result type is
11276                                     --  controlling, the result type of the
11277                                     --  actual primitive must descend from the
11278                                     --  result type of the ancestor primitive.
11279
11280                                     if Subprograms_Correspond
11281                                       and then Anc_F_Type /= Act_F_Type
11282                                       and then
11283                                         Has_Controlling_Result (Anc_Subp)
11284                                       and then
11285                                         not Is_Tagged_Ancestor
11286                                               (Anc_F_Type, Act_F_Type)
11287                                     then
11288                                        Subprograms_Correspond := False;
11289                                     end if;
11290                                  end if;
11291
11292                                  --  Found a matching subprogram belonging to
11293                                  --  formal ancestor type, so actual subprogram
11294                                  --  corresponds and this violates 3.9.3(9).
11295
11296                                  if Subprograms_Correspond then
11297                                     Error_Msg_NE
11298                                       ("abstract subprogram & overrides " &
11299                                        "nonabstract subprogram of ancestor",
11300                                        Actual,
11301                                        Act_Subp);
11302                                  end if;
11303                               end if;
11304                            end if;
11305                         end if;
11306
11307                         Next_Elmt (Act_Elmt);
11308                      end loop;
11309                   end if;
11310
11311                   Next_Elmt (Gen_Elmt);
11312                end loop;
11313             end Check_Abstract_Primitives;
11314          end if;
11315
11316          --  Verify that limitedness matches. If parent is a limited
11317          --  interface then  the generic formal is not unless declared
11318          --  explicitly so. If not declared limited, the actual cannot be
11319          --  limited (see AI05-0087).
11320
11321          --  Even though this AI is a binding interpretation, we enable the
11322          --  check only in Ada 2012 mode, because this improper construct
11323          --  shows up in user code and in existing B-tests.
11324
11325          if Is_Limited_Type (Act_T)
11326            and then not Is_Limited_Type (A_Gen_T)
11327            and then Ada_Version >= Ada_2012
11328          then
11329             if In_Instance then
11330                null;
11331             else
11332                Error_Msg_NE
11333                  ("actual for non-limited & cannot be a limited type", Actual,
11334                   Gen_T);
11335                Explain_Limited_Type (Act_T, Actual);
11336                Abandon_Instantiation (Actual);
11337             end if;
11338          end if;
11339       end Validate_Derived_Type_Instance;
11340
11341       ----------------------------------------
11342       -- Validate_Discriminated_Formal_Type --
11343       ----------------------------------------
11344
11345       procedure Validate_Discriminated_Formal_Type is
11346          Formal_Discr : Entity_Id;
11347          Actual_Discr : Entity_Id;
11348          Formal_Subt  : Entity_Id;
11349
11350       begin
11351          if Has_Discriminants (A_Gen_T) then
11352             if not Has_Discriminants (Act_T) then
11353                Error_Msg_NE
11354                  ("actual for & must have discriminants", Actual, Gen_T);
11355                Abandon_Instantiation (Actual);
11356
11357             elsif Is_Constrained (Act_T) then
11358                Error_Msg_NE
11359                  ("actual for & must be unconstrained", Actual, Gen_T);
11360                Abandon_Instantiation (Actual);
11361
11362             else
11363                Formal_Discr := First_Discriminant (A_Gen_T);
11364                Actual_Discr := First_Discriminant (Act_T);
11365                while Formal_Discr /= Empty loop
11366                   if Actual_Discr = Empty then
11367                      Error_Msg_NE
11368                        ("discriminants on actual do not match formal",
11369                         Actual, Gen_T);
11370                      Abandon_Instantiation (Actual);
11371                   end if;
11372
11373                   Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11374
11375                   --  Access discriminants match if designated types do
11376
11377                   if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11378                     and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11379                                 E_Anonymous_Access_Type
11380                     and then
11381                       Get_Instance_Of
11382                         (Designated_Type (Base_Type (Formal_Subt))) =
11383                            Designated_Type (Base_Type (Etype (Actual_Discr)))
11384                   then
11385                      null;
11386
11387                   elsif Base_Type (Formal_Subt) /=
11388                           Base_Type (Etype (Actual_Discr))
11389                   then
11390                      Error_Msg_NE
11391                        ("types of actual discriminants must match formal",
11392                         Actual, Gen_T);
11393                      Abandon_Instantiation (Actual);
11394
11395                   elsif not Subtypes_Statically_Match
11396                               (Formal_Subt, Etype (Actual_Discr))
11397                     and then Ada_Version >= Ada_95
11398                   then
11399                      Error_Msg_NE
11400                        ("subtypes of actual discriminants must match formal",
11401                         Actual, Gen_T);
11402                      Abandon_Instantiation (Actual);
11403                   end if;
11404
11405                   Next_Discriminant (Formal_Discr);
11406                   Next_Discriminant (Actual_Discr);
11407                end loop;
11408
11409                if Actual_Discr /= Empty then
11410                   Error_Msg_NE
11411                     ("discriminants on actual do not match formal",
11412                      Actual, Gen_T);
11413                   Abandon_Instantiation (Actual);
11414                end if;
11415             end if;
11416          end if;
11417       end Validate_Discriminated_Formal_Type;
11418
11419       ---------------------------------------
11420       -- Validate_Incomplete_Type_Instance --
11421       ---------------------------------------
11422
11423       procedure Validate_Incomplete_Type_Instance is
11424       begin
11425          if not Is_Tagged_Type (Act_T)
11426            and then Is_Tagged_Type (A_Gen_T)
11427          then
11428             Error_Msg_NE
11429               ("actual for & must be a tagged type", Actual, Gen_T);
11430          end if;
11431
11432          Validate_Discriminated_Formal_Type;
11433       end Validate_Incomplete_Type_Instance;
11434
11435       --------------------------------------
11436       -- Validate_Interface_Type_Instance --
11437       --------------------------------------
11438
11439       procedure Validate_Interface_Type_Instance is
11440       begin
11441          if not Is_Interface (Act_T) then
11442             Error_Msg_NE
11443               ("actual for formal interface type must be an interface",
11444                 Actual, Gen_T);
11445
11446          elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11447            or else
11448              Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11449            or else
11450              Is_Protected_Interface (A_Gen_T) /=
11451                Is_Protected_Interface (Act_T)
11452            or else
11453              Is_Synchronized_Interface (A_Gen_T) /=
11454                Is_Synchronized_Interface (Act_T)
11455          then
11456             Error_Msg_NE
11457               ("actual for interface& does not match (RM 12.5.5(4))",
11458                Actual, Gen_T);
11459          end if;
11460       end Validate_Interface_Type_Instance;
11461
11462       ------------------------------------
11463       -- Validate_Private_Type_Instance --
11464       ------------------------------------
11465
11466       procedure Validate_Private_Type_Instance is
11467       begin
11468          if Is_Limited_Type (Act_T)
11469            and then not Is_Limited_Type (A_Gen_T)
11470          then
11471             if In_Instance then
11472                null;
11473             else
11474                Error_Msg_NE
11475                  ("actual for non-limited & cannot be a limited type", Actual,
11476                   Gen_T);
11477                Explain_Limited_Type (Act_T, Actual);
11478                Abandon_Instantiation (Actual);
11479             end if;
11480
11481          elsif Known_To_Have_Preelab_Init (A_Gen_T)
11482            and then not Has_Preelaborable_Initialization (Act_T)
11483          then
11484             Error_Msg_NE
11485               ("actual for & must have preelaborable initialization", Actual,
11486                Gen_T);
11487
11488          elsif Is_Indefinite_Subtype (Act_T)
11489             and then not Is_Indefinite_Subtype (A_Gen_T)
11490             and then Ada_Version >= Ada_95
11491          then
11492             Error_Msg_NE
11493               ("actual for & must be a definite subtype", Actual, Gen_T);
11494
11495          elsif not Is_Tagged_Type (Act_T)
11496            and then Is_Tagged_Type (A_Gen_T)
11497          then
11498             Error_Msg_NE
11499               ("actual for & must be a tagged type", Actual, Gen_T);
11500          end if;
11501
11502          Validate_Discriminated_Formal_Type;
11503          Ancestor := Gen_T;
11504       end Validate_Private_Type_Instance;
11505
11506    --  Start of processing for Instantiate_Type
11507
11508    begin
11509       if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11510          Error_Msg_N ("duplicate instantiation of generic type", Actual);
11511          return New_List (Error);
11512
11513       elsif not Is_Entity_Name (Actual)
11514         or else not Is_Type (Entity (Actual))
11515       then
11516          Error_Msg_NE
11517            ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11518          Abandon_Instantiation (Actual);
11519
11520       else
11521          Act_T := Entity (Actual);
11522
11523          --  Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11524          --  as a generic actual parameter if the corresponding formal type
11525          --  does not have a known_discriminant_part, or is a formal derived
11526          --  type that is an Unchecked_Union type.
11527
11528          if Is_Unchecked_Union (Base_Type (Act_T)) then
11529             if not Has_Discriminants (A_Gen_T)
11530                      or else
11531                    (Is_Derived_Type (A_Gen_T)
11532                      and then
11533                     Is_Unchecked_Union (A_Gen_T))
11534             then
11535                null;
11536             else
11537                Error_Msg_N ("unchecked union cannot be the actual for a" &
11538                  " discriminated formal type", Act_T);
11539
11540             end if;
11541          end if;
11542
11543          --  Deal with fixed/floating restrictions
11544
11545          if Is_Floating_Point_Type (Act_T) then
11546             Check_Restriction (No_Floating_Point, Actual);
11547          elsif Is_Fixed_Point_Type (Act_T) then
11548             Check_Restriction (No_Fixed_Point, Actual);
11549          end if;
11550
11551          --  Deal with error of using incomplete type as generic actual.
11552          --  This includes limited views of a type, even if the non-limited
11553          --  view may be available.
11554
11555          if Ekind (Act_T) = E_Incomplete_Type
11556            or else (Is_Class_Wide_Type (Act_T)
11557                       and then
11558                          Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11559          then
11560             --  If the formal is an incomplete type, the actual can be
11561             --  incomplete as well.
11562
11563             if Ekind (A_Gen_T) = E_Incomplete_Type then
11564                null;
11565
11566             elsif Is_Class_Wide_Type (Act_T)
11567               or else No (Full_View (Act_T))
11568             then
11569                Error_Msg_N ("premature use of incomplete type", Actual);
11570                Abandon_Instantiation (Actual);
11571             else
11572                Act_T := Full_View (Act_T);
11573                Set_Entity (Actual, Act_T);
11574
11575                if Has_Private_Component (Act_T) then
11576                   Error_Msg_N
11577                     ("premature use of type with private component", Actual);
11578                end if;
11579             end if;
11580
11581          --  Deal with error of premature use of private type as generic actual
11582
11583          elsif Is_Private_Type (Act_T)
11584            and then Is_Private_Type (Base_Type (Act_T))
11585            and then not Is_Generic_Type (Act_T)
11586            and then not Is_Derived_Type (Act_T)
11587            and then No (Full_View (Root_Type (Act_T)))
11588          then
11589             --  If the formal is an incomplete type, the actual can be
11590             --  private or incomplete as well.
11591
11592             if Ekind (A_Gen_T) = E_Incomplete_Type then
11593                null;
11594             else
11595                Error_Msg_N ("premature use of private type", Actual);
11596             end if;
11597
11598          elsif Has_Private_Component (Act_T) then
11599             Error_Msg_N
11600               ("premature use of type with private component", Actual);
11601          end if;
11602
11603          Set_Instance_Of (A_Gen_T, Act_T);
11604
11605          --  If the type is generic, the class-wide type may also be used
11606
11607          if Is_Tagged_Type (A_Gen_T)
11608            and then Is_Tagged_Type (Act_T)
11609            and then not Is_Class_Wide_Type (A_Gen_T)
11610          then
11611             Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11612               Class_Wide_Type (Act_T));
11613          end if;
11614
11615          if not Is_Abstract_Type (A_Gen_T)
11616            and then Is_Abstract_Type (Act_T)
11617          then
11618             Error_Msg_N
11619               ("actual of non-abstract formal cannot be abstract", Actual);
11620          end if;
11621
11622          --  A generic scalar type is a first subtype for which we generate
11623          --  an anonymous base type. Indicate that the instance of this base
11624          --  is the base type of the actual.
11625
11626          if Is_Scalar_Type (A_Gen_T) then
11627             Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11628          end if;
11629       end if;
11630
11631       if Error_Posted (Act_T) then
11632          null;
11633       else
11634          case Nkind (Def) is
11635             when N_Formal_Private_Type_Definition =>
11636                Validate_Private_Type_Instance;
11637
11638             when N_Formal_Incomplete_Type_Definition =>
11639                Validate_Incomplete_Type_Instance;
11640
11641             when N_Formal_Derived_Type_Definition =>
11642                Validate_Derived_Type_Instance;
11643
11644             when N_Formal_Discrete_Type_Definition =>
11645                if not Is_Discrete_Type (Act_T) then
11646                   Error_Msg_NE
11647                     ("expect discrete type in instantiation of&",
11648                        Actual, Gen_T);
11649                   Abandon_Instantiation (Actual);
11650                end if;
11651
11652             when N_Formal_Signed_Integer_Type_Definition =>
11653                if not Is_Signed_Integer_Type (Act_T) then
11654                   Error_Msg_NE
11655                     ("expect signed integer type in instantiation of&",
11656                      Actual, Gen_T);
11657                   Abandon_Instantiation (Actual);
11658                end if;
11659
11660             when N_Formal_Modular_Type_Definition =>
11661                if not Is_Modular_Integer_Type (Act_T) then
11662                   Error_Msg_NE
11663                     ("expect modular type in instantiation of &",
11664                        Actual, Gen_T);
11665                   Abandon_Instantiation (Actual);
11666                end if;
11667
11668             when N_Formal_Floating_Point_Definition =>
11669                if not Is_Floating_Point_Type (Act_T) then
11670                   Error_Msg_NE
11671                     ("expect float type in instantiation of &", Actual, Gen_T);
11672                   Abandon_Instantiation (Actual);
11673                end if;
11674
11675             when N_Formal_Ordinary_Fixed_Point_Definition =>
11676                if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11677                   Error_Msg_NE
11678                     ("expect ordinary fixed point type in instantiation of &",
11679                      Actual, Gen_T);
11680                   Abandon_Instantiation (Actual);
11681                end if;
11682
11683             when N_Formal_Decimal_Fixed_Point_Definition =>
11684                if not Is_Decimal_Fixed_Point_Type (Act_T) then
11685                   Error_Msg_NE
11686                     ("expect decimal type in instantiation of &",
11687                      Actual, Gen_T);
11688                   Abandon_Instantiation (Actual);
11689                end if;
11690
11691             when N_Array_Type_Definition =>
11692                Validate_Array_Type_Instance;
11693
11694             when N_Access_To_Object_Definition =>
11695                Validate_Access_Type_Instance;
11696
11697             when N_Access_Function_Definition |
11698                  N_Access_Procedure_Definition =>
11699                Validate_Access_Subprogram_Instance;
11700
11701             when N_Record_Definition           =>
11702                Validate_Interface_Type_Instance;
11703
11704             when N_Derived_Type_Definition     =>
11705                Validate_Derived_Interface_Type_Instance;
11706
11707             when others =>
11708                raise Program_Error;
11709
11710          end case;
11711       end if;
11712
11713       Subt := New_Copy (Gen_T);
11714
11715       --  Use adjusted sloc of subtype name as the location for other nodes in
11716       --  the subtype declaration.
11717
11718       Loc  := Sloc (Subt);
11719
11720       Decl_Node :=
11721         Make_Subtype_Declaration (Loc,
11722           Defining_Identifier => Subt,
11723           Subtype_Indication  => New_Reference_To (Act_T, Loc));
11724
11725       if Is_Private_Type (Act_T) then
11726          Set_Has_Private_View (Subtype_Indication (Decl_Node));
11727
11728       elsif Is_Access_Type (Act_T)
11729         and then Is_Private_Type (Designated_Type (Act_T))
11730       then
11731          Set_Has_Private_View (Subtype_Indication (Decl_Node));
11732       end if;
11733
11734       Decl_Nodes := New_List (Decl_Node);
11735
11736       --  Flag actual derived types so their elaboration produces the
11737       --  appropriate renamings for the primitive operations of the ancestor.
11738       --  Flag actual for formal private types as well, to determine whether
11739       --  operations in the private part may override inherited operations.
11740       --  If the formal has an interface list, the ancestor is not the
11741       --  parent, but the analyzed formal that includes the interface
11742       --  operations of all its progenitors.
11743
11744       --  Same treatment for formal private types, so we can check whether the
11745       --  type is tagged limited when validating derivations in the private
11746       --  part. (See AI05-096).
11747
11748       if Nkind (Def) = N_Formal_Derived_Type_Definition then
11749          if Present (Interface_List (Def)) then
11750             Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11751          else
11752             Set_Generic_Parent_Type (Decl_Node, Ancestor);
11753          end if;
11754
11755       elsif Nkind_In (Def,
11756         N_Formal_Private_Type_Definition,
11757         N_Formal_Incomplete_Type_Definition)
11758       then
11759          Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11760       end if;
11761
11762       --  If the actual is a synchronized type that implements an interface,
11763       --  the primitive operations are attached to the corresponding record,
11764       --  and we have to treat it as an additional generic actual, so that its
11765       --  primitive operations become visible in the instance. The task or
11766       --  protected type itself does not carry primitive operations.
11767
11768       if Is_Concurrent_Type (Act_T)
11769         and then Is_Tagged_Type (Act_T)
11770         and then Present (Corresponding_Record_Type (Act_T))
11771         and then Present (Ancestor)
11772         and then Is_Interface (Ancestor)
11773       then
11774          declare
11775             Corr_Rec  : constant Entity_Id :=
11776                           Corresponding_Record_Type (Act_T);
11777             New_Corr  : Entity_Id;
11778             Corr_Decl : Node_Id;
11779
11780          begin
11781             New_Corr := Make_Temporary (Loc, 'S');
11782             Corr_Decl :=
11783               Make_Subtype_Declaration (Loc,
11784                 Defining_Identifier => New_Corr,
11785                 Subtype_Indication  =>
11786                   New_Reference_To (Corr_Rec, Loc));
11787             Append_To (Decl_Nodes, Corr_Decl);
11788
11789             if Ekind (Act_T) = E_Task_Type then
11790                Set_Ekind (Subt, E_Task_Subtype);
11791             else
11792                Set_Ekind (Subt, E_Protected_Subtype);
11793             end if;
11794
11795             Set_Corresponding_Record_Type (Subt, Corr_Rec);
11796             Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11797             Set_Generic_Parent_Type (Decl_Node, Empty);
11798          end;
11799       end if;
11800
11801       return Decl_Nodes;
11802    end Instantiate_Type;
11803
11804    ---------------------
11805    -- Is_In_Main_Unit --
11806    ---------------------
11807
11808    function Is_In_Main_Unit (N : Node_Id) return Boolean is
11809       Unum         : constant Unit_Number_Type := Get_Source_Unit (N);
11810       Current_Unit : Node_Id;
11811
11812    begin
11813       if Unum = Main_Unit then
11814          return True;
11815
11816       --  If the current unit is a subunit then it is either the main unit or
11817       --  is being compiled as part of the main unit.
11818
11819       elsif Nkind (N) = N_Compilation_Unit then
11820          return Nkind (Unit (N)) = N_Subunit;
11821       end if;
11822
11823       Current_Unit := Parent (N);
11824       while Present (Current_Unit)
11825         and then Nkind (Current_Unit) /= N_Compilation_Unit
11826       loop
11827          Current_Unit := Parent (Current_Unit);
11828       end loop;
11829
11830       --  The instantiation node is in the main unit, or else the current node
11831       --  (perhaps as the result of nested instantiations) is in the main unit,
11832       --  or in the declaration of the main unit, which in this last case must
11833       --  be a body.
11834
11835       return Unum = Main_Unit
11836         or else Current_Unit = Cunit (Main_Unit)
11837         or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11838         or else (Present (Library_Unit (Current_Unit))
11839                   and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11840    end Is_In_Main_Unit;
11841
11842    ----------------------------
11843    -- Load_Parent_Of_Generic --
11844    ----------------------------
11845
11846    procedure Load_Parent_Of_Generic
11847      (N             : Node_Id;
11848       Spec          : Node_Id;
11849       Body_Optional : Boolean := False)
11850    is
11851       Comp_Unit          : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11852       Saved_Style_Check  : constant Boolean := Style_Check;
11853       Saved_Warnings     : constant Warning_Record := Save_Warnings;
11854       True_Parent        : Node_Id;
11855       Inst_Node          : Node_Id;
11856       OK                 : Boolean;
11857       Previous_Instances : constant Elist_Id := New_Elmt_List;
11858
11859       procedure Collect_Previous_Instances (Decls : List_Id);
11860       --  Collect all instantiations in the given list of declarations, that
11861       --  precede the generic that we need to load. If the bodies of these
11862       --  instantiations are available, we must analyze them, to ensure that
11863       --  the public symbols generated are the same when the unit is compiled
11864       --  to generate code, and when it is compiled in the context of a unit
11865       --  that needs a particular nested instance. This process is applied to
11866       --  both package and subprogram instances.
11867
11868       --------------------------------
11869       -- Collect_Previous_Instances --
11870       --------------------------------
11871
11872       procedure Collect_Previous_Instances (Decls : List_Id) is
11873          Decl : Node_Id;
11874
11875       begin
11876          Decl := First (Decls);
11877          while Present (Decl) loop
11878             if Sloc (Decl) >= Sloc (Inst_Node) then
11879                return;
11880
11881             --  If Decl is an instantiation, then record it as requiring
11882             --  instantiation of the corresponding body, except if it is an
11883             --  abbreviated instantiation generated internally for conformance
11884             --  checking purposes only for the case of a formal package
11885             --  declared without a box (see Instantiate_Formal_Package). Such
11886             --  an instantiation does not generate any code (the actual code
11887             --  comes from actual) and thus does not need to be analyzed here.
11888             --  If the instantiation appears with a generic package body it is
11889             --  not analyzed here either.
11890
11891             elsif Nkind (Decl) = N_Package_Instantiation
11892               and then not Is_Internal (Defining_Entity (Decl))
11893             then
11894                Append_Elmt (Decl, Previous_Instances);
11895
11896             --  For a subprogram instantiation, omit instantiations intrinsic
11897             --  operations (Unchecked_Conversions, etc.) that have no bodies.
11898
11899             elsif Nkind_In (Decl, N_Function_Instantiation,
11900                                   N_Procedure_Instantiation)
11901               and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11902             then
11903                Append_Elmt (Decl, Previous_Instances);
11904
11905             elsif Nkind (Decl) = N_Package_Declaration then
11906                Collect_Previous_Instances
11907                  (Visible_Declarations (Specification (Decl)));
11908                Collect_Previous_Instances
11909                  (Private_Declarations (Specification (Decl)));
11910
11911             --  Previous non-generic bodies may contain instances as well
11912
11913             elsif Nkind (Decl) = N_Package_Body
11914               and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11915             then
11916                Collect_Previous_Instances (Declarations (Decl));
11917
11918             elsif Nkind (Decl) = N_Subprogram_Body
11919               and then not Acts_As_Spec (Decl)
11920               and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11921             then
11922                Collect_Previous_Instances (Declarations (Decl));
11923             end if;
11924
11925             Next (Decl);
11926          end loop;
11927       end Collect_Previous_Instances;
11928
11929    --  Start of processing for Load_Parent_Of_Generic
11930
11931    begin
11932       if not In_Same_Source_Unit (N, Spec)
11933         or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11934         or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11935                    and then not Is_In_Main_Unit (Spec))
11936       then
11937          --  Find body of parent of spec, and analyze it. A special case arises
11938          --  when the parent is an instantiation, that is to say when we are
11939          --  currently instantiating a nested generic. In that case, there is
11940          --  no separate file for the body of the enclosing instance. Instead,
11941          --  the enclosing body must be instantiated as if it were a pending
11942          --  instantiation, in order to produce the body for the nested generic
11943          --  we require now. Note that in that case the generic may be defined
11944          --  in a package body, the instance defined in the same package body,
11945          --  and the original enclosing body may not be in the main unit.
11946
11947          Inst_Node := Empty;
11948
11949          True_Parent := Parent (Spec);
11950          while Present (True_Parent)
11951            and then Nkind (True_Parent) /= N_Compilation_Unit
11952          loop
11953             if Nkind (True_Parent) = N_Package_Declaration
11954                  and then
11955                Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11956             then
11957                --  Parent is a compilation unit that is an instantiation.
11958                --  Instantiation node has been replaced with package decl.
11959
11960                Inst_Node := Original_Node (True_Parent);
11961                exit;
11962
11963             elsif Nkind (True_Parent) = N_Package_Declaration
11964               and then Present (Generic_Parent (Specification (True_Parent)))
11965               and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11966             then
11967                --  Parent is an instantiation within another specification.
11968                --  Declaration for instance has been inserted before original
11969                --  instantiation node. A direct link would be preferable?
11970
11971                Inst_Node := Next (True_Parent);
11972                while Present (Inst_Node)
11973                  and then Nkind (Inst_Node) /= N_Package_Instantiation
11974                loop
11975                   Next (Inst_Node);
11976                end loop;
11977
11978                --  If the instance appears within a generic, and the generic
11979                --  unit is defined within a formal package of the enclosing
11980                --  generic, there is no generic body available, and none
11981                --  needed. A more precise test should be used ???
11982
11983                if No (Inst_Node) then
11984                   return;
11985                end if;
11986
11987                exit;
11988
11989             else
11990                True_Parent := Parent (True_Parent);
11991             end if;
11992          end loop;
11993
11994          --  Case where we are currently instantiating a nested generic
11995
11996          if Present (Inst_Node) then
11997             if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
11998
11999                --  Instantiation node and declaration of instantiated package
12000                --  were exchanged when only the declaration was needed.
12001                --  Restore instantiation node before proceeding with body.
12002
12003                Set_Unit (Parent (True_Parent), Inst_Node);
12004             end if;
12005
12006             --  Now complete instantiation of enclosing body, if it appears in
12007             --  some other unit. If it appears in the current unit, the body
12008             --  will have been instantiated already.
12009
12010             if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12011
12012                --  We need to determine the expander mode to instantiate the
12013                --  enclosing body. Because the generic body we need may use
12014                --  global entities declared in the enclosing package (including
12015                --  aggregates) it is in general necessary to compile this body
12016                --  with expansion enabled, except if we are within a generic
12017                --  package, in which case the usual generic rule applies.
12018
12019                declare
12020                   Exp_Status         : Boolean := True;
12021                   Scop               : Entity_Id;
12022
12023                begin
12024                   --  Loop through scopes looking for generic package
12025
12026                   Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12027                   while Present (Scop)
12028                     and then Scop /= Standard_Standard
12029                   loop
12030                      if Ekind (Scop) = E_Generic_Package then
12031                         Exp_Status := False;
12032                         exit;
12033                      end if;
12034
12035                      Scop := Scope (Scop);
12036                   end loop;
12037
12038                   --  Collect previous instantiations in the unit that contains
12039                   --  the desired generic.
12040
12041                   if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12042                     and then not Body_Optional
12043                   then
12044                      declare
12045                         Decl : Elmt_Id;
12046                         Info : Pending_Body_Info;
12047                         Par  : Node_Id;
12048
12049                      begin
12050                         Par := Parent (Inst_Node);
12051                         while Present (Par) loop
12052                            exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12053                            Par := Parent (Par);
12054                         end loop;
12055
12056                         pragma Assert (Present (Par));
12057
12058                         if Nkind (Par) = N_Package_Body then
12059                            Collect_Previous_Instances (Declarations (Par));
12060
12061                         elsif Nkind (Par) = N_Package_Declaration then
12062                            Collect_Previous_Instances
12063                              (Visible_Declarations (Specification (Par)));
12064                            Collect_Previous_Instances
12065                              (Private_Declarations (Specification (Par)));
12066
12067                         else
12068                            --  Enclosing unit is a subprogram body. In this
12069                            --  case all instance bodies are processed in order
12070                            --  and there is no need to collect them separately.
12071
12072                            null;
12073                         end if;
12074
12075                         Decl := First_Elmt (Previous_Instances);
12076                         while Present (Decl) loop
12077                            Info :=
12078                              (Inst_Node                => Node (Decl),
12079                               Act_Decl                 =>
12080                                 Instance_Spec (Node (Decl)),
12081                               Expander_Status          => Exp_Status,
12082                               Current_Sem_Unit         =>
12083                                 Get_Code_Unit (Sloc (Node (Decl))),
12084                               Scope_Suppress           => Scope_Suppress,
12085                               Local_Suppress_Stack_Top =>
12086                                 Local_Suppress_Stack_Top,
12087                               Version                  => Ada_Version,
12088                               Version_Pragma           => Ada_Version_Pragma,
12089                               Warnings                 => Save_Warnings);
12090
12091                            --  Package instance
12092
12093                            if
12094                              Nkind (Node (Decl)) = N_Package_Instantiation
12095                            then
12096                               Instantiate_Package_Body
12097                                 (Info, Body_Optional => True);
12098
12099                            --  Subprogram instance
12100
12101                            else
12102                               --  The instance_spec is the wrapper package,
12103                               --  and the subprogram declaration is the last
12104                               --  declaration in the wrapper.
12105
12106                               Info.Act_Decl :=
12107                                 Last
12108                                   (Visible_Declarations
12109                                     (Specification (Info.Act_Decl)));
12110
12111                               Instantiate_Subprogram_Body
12112                                 (Info, Body_Optional => True);
12113                            end if;
12114
12115                            Next_Elmt (Decl);
12116                         end loop;
12117                      end;
12118                   end if;
12119
12120                   Instantiate_Package_Body
12121                     (Body_Info =>
12122                        ((Inst_Node                => Inst_Node,
12123                          Act_Decl                 => True_Parent,
12124                          Expander_Status          => Exp_Status,
12125                          Current_Sem_Unit         => Get_Code_Unit
12126                                                        (Sloc (Inst_Node)),
12127                          Scope_Suppress           => Scope_Suppress,
12128                          Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12129                          Version                  => Ada_Version,
12130                          Version_Pragma           => Ada_Version_Pragma,
12131                          Warnings                 => Save_Warnings)),
12132                      Body_Optional => Body_Optional);
12133                end;
12134             end if;
12135
12136          --  Case where we are not instantiating a nested generic
12137
12138          else
12139             Opt.Style_Check := False;
12140             Expander_Mode_Save_And_Set (True);
12141             Load_Needed_Body (Comp_Unit, OK);
12142             Opt.Style_Check := Saved_Style_Check;
12143             Restore_Warnings (Saved_Warnings);
12144             Expander_Mode_Restore;
12145
12146             if not OK
12147               and then Unit_Requires_Body (Defining_Entity (Spec))
12148               and then not Body_Optional
12149             then
12150                declare
12151                   Bname : constant Unit_Name_Type :=
12152                             Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12153
12154                begin
12155                   --  In CodePeer mode, the missing body may make the analysis
12156                   --  incomplete, but we do not treat it as fatal.
12157
12158                   if CodePeer_Mode then
12159                      return;
12160
12161                   else
12162                      Error_Msg_Unit_1 := Bname;
12163                      Error_Msg_N ("this instantiation requires$!", N);
12164                      Error_Msg_File_1 :=
12165                        Get_File_Name (Bname, Subunit => False);
12166                      Error_Msg_N ("\but file{ was not found!", N);
12167                      raise Unrecoverable_Error;
12168                   end if;
12169                end;
12170             end if;
12171          end if;
12172       end if;
12173
12174       --  If loading parent of the generic caused an instantiation circularity,
12175       --  we abandon compilation at this point, because otherwise in some cases
12176       --  we get into trouble with infinite recursions after this point.
12177
12178       if Circularity_Detected then
12179          raise Unrecoverable_Error;
12180       end if;
12181    end Load_Parent_Of_Generic;
12182
12183    ---------------------------------
12184    -- Map_Formal_Package_Entities --
12185    ---------------------------------
12186
12187    procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12188       E1 : Entity_Id;
12189       E2 : Entity_Id;
12190
12191    begin
12192       Set_Instance_Of (Form, Act);
12193
12194       --  Traverse formal and actual package to map the corresponding entities.
12195       --  We skip over internal entities that may be generated during semantic
12196       --  analysis, and find the matching entities by name, given that they
12197       --  must appear in the same order.
12198
12199       E1 := First_Entity (Form);
12200       E2 := First_Entity (Act);
12201       while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12202          --  Could this test be a single condition??? Seems like it could, and
12203          --  isn't FPE (Form) a constant anyway???
12204
12205          if not Is_Internal (E1)
12206            and then Present (Parent (E1))
12207            and then not Is_Class_Wide_Type (E1)
12208            and then not Is_Internal_Name (Chars (E1))
12209          then
12210             while Present (E2) and then Chars (E2) /= Chars (E1) loop
12211                Next_Entity (E2);
12212             end loop;
12213
12214             if No (E2) then
12215                exit;
12216             else
12217                Set_Instance_Of (E1, E2);
12218
12219                if Is_Type (E1) and then Is_Tagged_Type (E2) then
12220                   Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12221                end if;
12222
12223                if Is_Constrained (E1) then
12224                   Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12225                end if;
12226
12227                if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12228                   Map_Formal_Package_Entities (E1, E2);
12229                end if;
12230             end if;
12231          end if;
12232
12233          Next_Entity (E1);
12234       end loop;
12235    end Map_Formal_Package_Entities;
12236
12237    -----------------------
12238    -- Move_Freeze_Nodes --
12239    -----------------------
12240
12241    procedure Move_Freeze_Nodes
12242      (Out_Of : Entity_Id;
12243       After  : Node_Id;
12244       L      : List_Id)
12245    is
12246       Decl      : Node_Id;
12247       Next_Decl : Node_Id;
12248       Next_Node : Node_Id := After;
12249       Spec      : Node_Id;
12250
12251       function Is_Outer_Type (T : Entity_Id) return Boolean;
12252       --  Check whether entity is declared in a scope external to that of the
12253       --  generic unit.
12254
12255       -------------------
12256       -- Is_Outer_Type --
12257       -------------------
12258
12259       function Is_Outer_Type (T : Entity_Id) return Boolean is
12260          Scop : Entity_Id := Scope (T);
12261
12262       begin
12263          if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12264             return True;
12265
12266          else
12267             while Scop /= Standard_Standard loop
12268                if Scop = Out_Of then
12269                   return False;
12270                else
12271                   Scop := Scope (Scop);
12272                end if;
12273             end loop;
12274
12275             return True;
12276          end if;
12277       end Is_Outer_Type;
12278
12279    --  Start of processing for Move_Freeze_Nodes
12280
12281    begin
12282       if No (L) then
12283          return;
12284       end if;
12285
12286       --  First remove the freeze nodes that may appear before all other
12287       --  declarations.
12288
12289       Decl := First (L);
12290       while Present (Decl)
12291         and then Nkind (Decl) = N_Freeze_Entity
12292         and then Is_Outer_Type (Entity (Decl))
12293       loop
12294          Decl := Remove_Head (L);
12295          Insert_After (Next_Node, Decl);
12296          Set_Analyzed (Decl, False);
12297          Next_Node := Decl;
12298          Decl := First (L);
12299       end loop;
12300
12301       --  Next scan the list of declarations and remove each freeze node that
12302       --  appears ahead of the current node.
12303
12304       while Present (Decl) loop
12305          while Present (Next (Decl))
12306            and then Nkind (Next (Decl)) = N_Freeze_Entity
12307            and then Is_Outer_Type (Entity (Next (Decl)))
12308          loop
12309             Next_Decl := Remove_Next (Decl);
12310             Insert_After (Next_Node, Next_Decl);
12311             Set_Analyzed (Next_Decl, False);
12312             Next_Node := Next_Decl;
12313          end loop;
12314
12315          --  If the declaration is a nested package or concurrent type, then
12316          --  recurse. Nested generic packages will have been processed from the
12317          --  inside out.
12318
12319          case Nkind (Decl) is
12320             when N_Package_Declaration =>
12321                Spec := Specification (Decl);
12322
12323             when N_Task_Type_Declaration =>
12324                Spec := Task_Definition (Decl);
12325
12326             when N_Protected_Type_Declaration =>
12327                Spec := Protected_Definition (Decl);
12328
12329             when others =>
12330                Spec := Empty;
12331          end case;
12332
12333          if Present (Spec) then
12334             Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12335             Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12336          end if;
12337
12338          Next (Decl);
12339       end loop;
12340    end Move_Freeze_Nodes;
12341
12342    ----------------
12343    -- Next_Assoc --
12344    ----------------
12345
12346    function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12347    begin
12348       return Generic_Renamings.Table (E).Next_In_HTable;
12349    end Next_Assoc;
12350
12351    ------------------------
12352    -- Preanalyze_Actuals --
12353    ------------------------
12354
12355    procedure Preanalyze_Actuals (N : Node_Id) is
12356       Assoc : Node_Id;
12357       Act   : Node_Id;
12358       Errs  : constant Int := Serious_Errors_Detected;
12359
12360       Cur : Entity_Id := Empty;
12361       --  Current homograph of the instance name
12362
12363       Vis : Boolean;
12364       --  Saved visibility status of the current homograph
12365
12366    begin
12367       Assoc := First (Generic_Associations (N));
12368
12369       --  If the instance is a child unit, its name may hide an outer homonym,
12370       --  so make it invisible to perform name resolution on the actuals.
12371
12372       if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12373         and then Present
12374           (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12375       then
12376          Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12377
12378          if Is_Compilation_Unit (Cur) then
12379             Vis := Is_Immediately_Visible (Cur);
12380             Set_Is_Immediately_Visible (Cur, False);
12381          else
12382             Cur := Empty;
12383          end if;
12384       end if;
12385
12386       while Present (Assoc) loop
12387          if Nkind (Assoc) /= N_Others_Choice then
12388             Act := Explicit_Generic_Actual_Parameter (Assoc);
12389
12390             --  Within a nested instantiation, a defaulted actual is an empty
12391             --  association, so nothing to analyze. If the subprogram actual
12392             --  is an attribute, analyze prefix only, because actual is not a
12393             --  complete attribute reference.
12394
12395             --  If actual is an allocator, analyze expression only. The full
12396             --  analysis can generate code, and if instance is a compilation
12397             --  unit we have to wait until the package instance is installed
12398             --  to have a proper place to insert this code.
12399
12400             --  String literals may be operators, but at this point we do not
12401             --  know whether the actual is a formal subprogram or a string.
12402
12403             if No (Act) then
12404                null;
12405
12406             elsif Nkind (Act) = N_Attribute_Reference then
12407                Analyze (Prefix (Act));
12408
12409             elsif Nkind (Act) = N_Explicit_Dereference then
12410                Analyze (Prefix (Act));
12411
12412             elsif Nkind (Act) = N_Allocator then
12413                declare
12414                   Expr : constant Node_Id := Expression (Act);
12415
12416                begin
12417                   if Nkind (Expr) = N_Subtype_Indication then
12418                      Analyze (Subtype_Mark (Expr));
12419
12420                      --  Analyze separately each discriminant constraint, when
12421                      --  given with a named association.
12422
12423                      declare
12424                         Constr : Node_Id;
12425
12426                      begin
12427                         Constr := First (Constraints (Constraint (Expr)));
12428                         while Present (Constr) loop
12429                            if Nkind (Constr) = N_Discriminant_Association then
12430                               Analyze (Expression (Constr));
12431                            else
12432                               Analyze (Constr);
12433                            end if;
12434
12435                            Next (Constr);
12436                         end loop;
12437                      end;
12438
12439                   else
12440                      Analyze (Expr);
12441                   end if;
12442                end;
12443
12444             elsif Nkind (Act) /= N_Operator_Symbol then
12445                Analyze (Act);
12446             end if;
12447
12448             --  Ensure that a ghost subprogram does not act as generic actual
12449
12450             if Is_Entity_Name (Act)
12451               and then Is_Ghost_Subprogram (Entity (Act))
12452             then
12453                Error_Msg_N
12454                  ("ghost subprogram & cannot act as generic actual", Act);
12455                Abandon_Instantiation (Act);
12456
12457             elsif Errs /= Serious_Errors_Detected then
12458
12459                --  Do a minimal analysis of the generic, to prevent spurious
12460                --  warnings complaining about the generic being unreferenced,
12461                --  before abandoning the instantiation.
12462
12463                Analyze (Name (N));
12464
12465                if Is_Entity_Name (Name (N))
12466                  and then Etype (Name (N)) /= Any_Type
12467                then
12468                   Generate_Reference  (Entity (Name (N)), Name (N));
12469                   Set_Is_Instantiated (Entity (Name (N)));
12470                end if;
12471
12472                if Present (Cur) then
12473
12474                   --  For the case of a child instance hiding an outer homonym,
12475                   --  provide additional warning which might explain the error.
12476
12477                   Set_Is_Immediately_Visible (Cur, Vis);
12478                   Error_Msg_NE ("& hides outer unit with the same name??",
12479                     N, Defining_Unit_Name (N));
12480                end if;
12481
12482                Abandon_Instantiation (Act);
12483             end if;
12484          end if;
12485
12486          Next (Assoc);
12487       end loop;
12488
12489       if Present (Cur) then
12490          Set_Is_Immediately_Visible (Cur, Vis);
12491       end if;
12492    end Preanalyze_Actuals;
12493
12494    -------------------
12495    -- Remove_Parent --
12496    -------------------
12497
12498    procedure Remove_Parent (In_Body : Boolean := False) is
12499       S : Entity_Id := Current_Scope;
12500       --  S is the scope containing the instantiation just completed. The scope
12501       --  stack contains the parent instances of the instantiation, followed by
12502       --  the original S.
12503
12504       Cur_P  : Entity_Id;
12505       E      : Entity_Id;
12506       P      : Entity_Id;
12507       Hidden : Elmt_Id;
12508
12509    begin
12510       --  After child instantiation is complete, remove from scope stack the
12511       --  extra copy of the current scope, and then remove parent instances.
12512
12513       if not In_Body then
12514          Pop_Scope;
12515
12516          while Current_Scope /= S loop
12517             P := Current_Scope;
12518             End_Package_Scope (Current_Scope);
12519
12520             if In_Open_Scopes (P) then
12521                E := First_Entity (P);
12522                while Present (E) loop
12523                   Set_Is_Immediately_Visible (E, True);
12524                   Next_Entity (E);
12525                end loop;
12526
12527                --  If instantiation is declared in a block, it is the enclosing
12528                --  scope that might be a parent instance. Note that only one
12529                --  block can be involved, because the parent instances have
12530                --  been installed within it.
12531
12532                if Ekind (P) = E_Block then
12533                   Cur_P := Scope (P);
12534                else
12535                   Cur_P := P;
12536                end if;
12537
12538                if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12539                   --  We are within an instance of some sibling. Retain
12540                   --  visibility of parent, for proper subsequent cleanup, and
12541                   --  reinstall private declarations as well.
12542
12543                   Set_In_Private_Part (P);
12544                   Install_Private_Declarations (P);
12545                end if;
12546
12547             --  If the ultimate parent is a top-level unit recorded in
12548             --  Instance_Parent_Unit, then reset its visibility to what it was
12549             --  before instantiation. (It's not clear what the purpose is of
12550             --  testing whether Scope (P) is In_Open_Scopes, but that test was
12551             --  present before the ultimate parent test was added.???)
12552
12553             elsif not In_Open_Scopes (Scope (P))
12554               or else (P = Instance_Parent_Unit
12555                         and then not Parent_Unit_Visible)
12556             then
12557                Set_Is_Immediately_Visible (P, False);
12558
12559             --  If the current scope is itself an instantiation of a generic
12560             --  nested within P, and we are in the private part of body of this
12561             --  instantiation, restore the full views of P, that were removed
12562             --  in End_Package_Scope above. This obscure case can occur when a
12563             --  subunit of a generic contains an instance of a child unit of
12564             --  its generic parent unit.
12565
12566             elsif S = Current_Scope and then Is_Generic_Instance (S) then
12567                declare
12568                   Par : constant Entity_Id :=
12569                           Generic_Parent (Package_Specification (S));
12570                begin
12571                   if Present (Par)
12572                     and then P = Scope (Par)
12573                     and then (In_Package_Body (S) or else In_Private_Part (S))
12574                   then
12575                      Set_In_Private_Part (P);
12576                      Install_Private_Declarations (P);
12577                   end if;
12578                end;
12579             end if;
12580          end loop;
12581
12582          --  Reset visibility of entities in the enclosing scope
12583
12584          Set_Is_Hidden_Open_Scope (Current_Scope, False);
12585
12586          Hidden := First_Elmt (Hidden_Entities);
12587          while Present (Hidden) loop
12588             Set_Is_Immediately_Visible (Node (Hidden), True);
12589             Next_Elmt (Hidden);
12590          end loop;
12591
12592       else
12593          --  Each body is analyzed separately, and there is no context that
12594          --  needs preserving from one body instance to the next, so remove all
12595          --  parent scopes that have been installed.
12596
12597          while Present (S) loop
12598             End_Package_Scope (S);
12599             Set_Is_Immediately_Visible (S, False);
12600             S := Current_Scope;
12601             exit when S = Standard_Standard;
12602          end loop;
12603       end if;
12604    end Remove_Parent;
12605
12606    -----------------
12607    -- Restore_Env --
12608    -----------------
12609
12610    procedure Restore_Env is
12611       Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12612
12613    begin
12614       if No (Current_Instantiated_Parent.Act_Id) then
12615          --  Restore environment after subprogram inlining
12616
12617          Restore_Private_Views (Empty);
12618       end if;
12619
12620       Current_Instantiated_Parent := Saved.Instantiated_Parent;
12621       Exchanged_Views             := Saved.Exchanged_Views;
12622       Hidden_Entities             := Saved.Hidden_Entities;
12623       Current_Sem_Unit            := Saved.Current_Sem_Unit;
12624       Parent_Unit_Visible         := Saved.Parent_Unit_Visible;
12625       Instance_Parent_Unit        := Saved.Instance_Parent_Unit;
12626
12627       Restore_Opt_Config_Switches (Saved.Switches);
12628
12629       Instance_Envs.Decrement_Last;
12630    end Restore_Env;
12631
12632    ---------------------------
12633    -- Restore_Private_Views --
12634    ---------------------------
12635
12636    procedure Restore_Private_Views
12637      (Pack_Id    : Entity_Id;
12638       Is_Package : Boolean := True)
12639    is
12640       M        : Elmt_Id;
12641       E        : Entity_Id;
12642       Typ      : Entity_Id;
12643       Dep_Elmt : Elmt_Id;
12644       Dep_Typ  : Node_Id;
12645
12646       procedure Restore_Nested_Formal (Formal : Entity_Id);
12647       --  Hide the generic formals of formal packages declared with box which
12648       --  were reachable in the current instantiation.
12649
12650       ---------------------------
12651       -- Restore_Nested_Formal --
12652       ---------------------------
12653
12654       procedure Restore_Nested_Formal (Formal : Entity_Id) is
12655          Ent : Entity_Id;
12656
12657       begin
12658          if Present (Renamed_Object (Formal))
12659            and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12660          then
12661             return;
12662
12663          elsif Present (Associated_Formal_Package (Formal)) then
12664             Ent := First_Entity (Formal);
12665             while Present (Ent) loop
12666                exit when Ekind (Ent) = E_Package
12667                  and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12668
12669                Set_Is_Hidden (Ent);
12670                Set_Is_Potentially_Use_Visible (Ent, False);
12671
12672                --  If package, then recurse
12673
12674                if Ekind (Ent) = E_Package then
12675                   Restore_Nested_Formal (Ent);
12676                end if;
12677
12678                Next_Entity (Ent);
12679             end loop;
12680          end if;
12681       end Restore_Nested_Formal;
12682
12683    --  Start of processing for Restore_Private_Views
12684
12685    begin
12686       M := First_Elmt (Exchanged_Views);
12687       while Present (M) loop
12688          Typ := Node (M);
12689
12690          --  Subtypes of types whose views have been exchanged, and that are
12691          --  defined within the instance, were not on the Private_Dependents
12692          --  list on entry to the instance, so they have to be exchanged
12693          --  explicitly now, in order to remain consistent with the view of the
12694          --  parent type.
12695
12696          if Ekind_In (Typ, E_Private_Type,
12697                            E_Limited_Private_Type,
12698                            E_Record_Type_With_Private)
12699          then
12700             Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12701             while Present (Dep_Elmt) loop
12702                Dep_Typ := Node (Dep_Elmt);
12703
12704                if Scope (Dep_Typ) = Pack_Id
12705                  and then Present (Full_View (Dep_Typ))
12706                then
12707                   Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12708                   Exchange_Declarations (Dep_Typ);
12709                end if;
12710
12711                Next_Elmt (Dep_Elmt);
12712             end loop;
12713          end if;
12714
12715          Exchange_Declarations (Node (M));
12716          Next_Elmt (M);
12717       end loop;
12718
12719       if No (Pack_Id) then
12720          return;
12721       end if;
12722
12723       --  Make the generic formal parameters private, and make the formal types
12724       --  into subtypes of the actuals again.
12725
12726       E := First_Entity (Pack_Id);
12727       while Present (E) loop
12728          Set_Is_Hidden (E, True);
12729
12730          if Is_Type (E)
12731            and then Nkind (Parent (E)) = N_Subtype_Declaration
12732          then
12733             --  If the actual for E is itself a generic actual type from
12734             --  an enclosing instance, E is still a generic actual type
12735             --  outside of the current instance. This matter when resolving
12736             --  an overloaded call that may be ambiguous in the enclosing
12737             --  instance, when two of its actuals coincide.
12738
12739             if Is_Entity_Name (Subtype_Indication (Parent (E)))
12740               and then Is_Generic_Actual_Type
12741                          (Entity (Subtype_Indication (Parent (E))))
12742             then
12743                null;
12744             else
12745                Set_Is_Generic_Actual_Type (E, False);
12746             end if;
12747
12748             --  An unusual case of aliasing: the actual may also be directly
12749             --  visible in the generic, and be private there, while it is fully
12750             --  visible in the context of the instance. The internal subtype
12751             --  is private in the instance but has full visibility like its
12752             --  parent in the enclosing scope. This enforces the invariant that
12753             --  the privacy status of all private dependents of a type coincide
12754             --  with that of the parent type. This can only happen when a
12755             --  generic child unit is instantiated within a sibling.
12756
12757             if Is_Private_Type (E)
12758               and then not Is_Private_Type (Etype (E))
12759             then
12760                Exchange_Declarations (E);
12761             end if;
12762
12763          elsif Ekind (E) = E_Package then
12764
12765             --  The end of the renaming list is the renaming of the generic
12766             --  package itself. If the instance is a subprogram, all entities
12767             --  in the corresponding package are renamings. If this entity is
12768             --  a formal package, make its own formals private as well. The
12769             --  actual in this case is itself the renaming of an instantiation.
12770             --  If the entity is not a package renaming, it is the entity
12771             --  created to validate formal package actuals: ignore it.
12772
12773             --  If the actual is itself a formal package for the enclosing
12774             --  generic, or the actual for such a formal package, it remains
12775             --  visible on exit from the instance, and therefore nothing needs
12776             --  to be done either, except to keep it accessible.
12777
12778             if Is_Package and then Renamed_Object (E) = Pack_Id then
12779                exit;
12780
12781             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12782                null;
12783
12784             elsif
12785               Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12786             then
12787                Set_Is_Hidden (E, False);
12788
12789             else
12790                declare
12791                   Act_P : constant Entity_Id := Renamed_Object (E);
12792                   Id    : Entity_Id;
12793
12794                begin
12795                   Id := First_Entity (Act_P);
12796                   while Present (Id)
12797                     and then Id /= First_Private_Entity (Act_P)
12798                   loop
12799                      exit when Ekind (Id) = E_Package
12800                                  and then Renamed_Object (Id) = Act_P;
12801
12802                      Set_Is_Hidden (Id, True);
12803                      Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12804
12805                      if Ekind (Id) = E_Package then
12806                         Restore_Nested_Formal (Id);
12807                      end if;
12808
12809                      Next_Entity (Id);
12810                   end loop;
12811                end;
12812             end if;
12813          end if;
12814
12815          Next_Entity (E);
12816       end loop;
12817    end Restore_Private_Views;
12818
12819    --------------
12820    -- Save_Env --
12821    --------------
12822
12823    procedure Save_Env
12824      (Gen_Unit : Entity_Id;
12825       Act_Unit : Entity_Id)
12826    is
12827    begin
12828       Init_Env;
12829       Set_Instance_Env (Gen_Unit, Act_Unit);
12830    end Save_Env;
12831
12832    ----------------------------
12833    -- Save_Global_References --
12834    ----------------------------
12835
12836    procedure Save_Global_References (N : Node_Id) is
12837       Gen_Scope : Entity_Id;
12838       E         : Entity_Id;
12839       N2        : Node_Id;
12840
12841       function Is_Global (E : Entity_Id) return Boolean;
12842       --  Check whether entity is defined outside of generic unit. Examine the
12843       --  scope of an entity, and the scope of the scope, etc, until we find
12844       --  either Standard, in which case the entity is global, or the generic
12845       --  unit itself, which indicates that the entity is local. If the entity
12846       --  is the generic unit itself, as in the case of a recursive call, or
12847       --  the enclosing generic unit, if different from the current scope, then
12848       --  it is local as well, because it will be replaced at the point of
12849       --  instantiation. On the other hand, if it is a reference to a child
12850       --  unit of a common ancestor, which appears in an instantiation, it is
12851       --  global because it is used to denote a specific compilation unit at
12852       --  the time the instantiations will be analyzed.
12853
12854       procedure Reset_Entity (N : Node_Id);
12855       --  Save semantic information on global entity so that it is not resolved
12856       --  again at instantiation time.
12857
12858       procedure Save_Entity_Descendants (N : Node_Id);
12859       --  Apply Save_Global_References to the two syntactic descendants of
12860       --  non-terminal nodes that carry an Associated_Node and are processed
12861       --  through Reset_Entity. Once the global entity (if any) has been
12862       --  captured together with its type, only two syntactic descendants need
12863       --  to be traversed to complete the processing of the tree rooted at N.
12864       --  This applies to Selected_Components, Expanded_Names, and to Operator
12865       --  nodes. N can also be a character literal, identifier, or operator
12866       --  symbol node, but the call has no effect in these cases.
12867
12868       procedure Save_Global_Defaults (N1, N2 : Node_Id);
12869       --  Default actuals in nested instances must be handled specially
12870       --  because there is no link to them from the original tree. When an
12871       --  actual subprogram is given by a default, we add an explicit generic
12872       --  association for it in the instantiation node. When we save the
12873       --  global references on the name of the instance, we recover the list
12874       --  of generic associations, and add an explicit one to the original
12875       --  generic tree, through which a global actual can be preserved.
12876       --  Similarly, if a child unit is instantiated within a sibling, in the
12877       --  context of the parent, we must preserve the identifier of the parent
12878       --  so that it can be properly resolved in a subsequent instantiation.
12879
12880       procedure Save_Global_Descendant (D : Union_Id);
12881       --  Apply Save_Global_References recursively to the descendents of the
12882       --  current node.
12883
12884       procedure Save_References (N : Node_Id);
12885       --  This is the recursive procedure that does the work, once the
12886       --  enclosing generic scope has been established.
12887
12888       ---------------
12889       -- Is_Global --
12890       ---------------
12891
12892       function Is_Global (E : Entity_Id) return Boolean is
12893          Se : Entity_Id;
12894
12895          function Is_Instance_Node (Decl : Node_Id) return Boolean;
12896          --  Determine whether the parent node of a reference to a child unit
12897          --  denotes an instantiation or a formal package, in which case the
12898          --  reference to the child unit is global, even if it appears within
12899          --  the current scope (e.g. when the instance appears within the body
12900          --  of an ancestor).
12901
12902          ----------------------
12903          -- Is_Instance_Node --
12904          ----------------------
12905
12906          function Is_Instance_Node (Decl : Node_Id) return Boolean is
12907          begin
12908             return Nkind (Decl) in N_Generic_Instantiation
12909                      or else
12910                    Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12911          end Is_Instance_Node;
12912
12913       --  Start of processing for Is_Global
12914
12915       begin
12916          if E = Gen_Scope then
12917             return False;
12918
12919          elsif E = Standard_Standard then
12920             return True;
12921
12922          elsif Is_Child_Unit (E)
12923            and then (Is_Instance_Node (Parent (N2))
12924                       or else (Nkind (Parent (N2)) = N_Expanded_Name
12925                                 and then N2 = Selector_Name (Parent (N2))
12926                                 and then
12927                                   Is_Instance_Node (Parent (Parent (N2)))))
12928          then
12929             return True;
12930
12931          else
12932             Se := Scope (E);
12933             while Se /= Gen_Scope loop
12934                if Se = Standard_Standard then
12935                   return True;
12936                else
12937                   Se := Scope (Se);
12938                end if;
12939             end loop;
12940
12941             return False;
12942          end if;
12943       end Is_Global;
12944
12945       ------------------
12946       -- Reset_Entity --
12947       ------------------
12948
12949       procedure Reset_Entity (N : Node_Id) is
12950
12951          procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12952          --  If the type of N2 is global to the generic unit, save the type in
12953          --  the generic node. Just as we perform name capture for explicit
12954          --  references within the generic, we must capture the global types
12955          --  of local entities because they may participate in resolution in
12956          --  the instance.
12957
12958          function Top_Ancestor (E : Entity_Id) return Entity_Id;
12959          --  Find the ultimate ancestor of the current unit. If it is not a
12960          --  generic unit, then the name of the current unit in the prefix of
12961          --  an expanded name must be replaced with its generic homonym to
12962          --  ensure that it will be properly resolved in an instance.
12963
12964          ---------------------
12965          -- Set_Global_Type --
12966          ---------------------
12967
12968          procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12969             Typ : constant Entity_Id := Etype (N2);
12970
12971          begin
12972             Set_Etype (N, Typ);
12973
12974             if Entity (N) /= N2
12975               and then Has_Private_View (Entity (N))
12976             then
12977                --  If the entity of N is not the associated node, this is a
12978                --  nested generic and it has an associated node as well, whose
12979                --  type is already the full view (see below). Indicate that the
12980                --  original node has a private view.
12981
12982                Set_Has_Private_View (N);
12983             end if;
12984
12985             --  If not a private type, nothing else to do
12986
12987             if not Is_Private_Type (Typ) then
12988                if Is_Array_Type (Typ)
12989                  and then Is_Private_Type (Component_Type (Typ))
12990                then
12991                   Set_Has_Private_View (N);
12992                end if;
12993
12994             --  If it is a derivation of a private type in a context where no
12995             --  full view is needed, nothing to do either.
12996
12997             elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
12998                null;
12999
13000             --  Otherwise mark the type for flipping and use the full view when
13001             --  available.
13002
13003             else
13004                Set_Has_Private_View (N);
13005
13006                if Present (Full_View (Typ)) then
13007                   Set_Etype (N2, Full_View (Typ));
13008                end if;
13009             end if;
13010          end Set_Global_Type;
13011
13012          ------------------
13013          -- Top_Ancestor --
13014          ------------------
13015
13016          function Top_Ancestor (E : Entity_Id) return Entity_Id is
13017             Par : Entity_Id;
13018
13019          begin
13020             Par := E;
13021             while Is_Child_Unit (Par) loop
13022                Par := Scope (Par);
13023             end loop;
13024
13025             return Par;
13026          end Top_Ancestor;
13027
13028       --  Start of processing for Reset_Entity
13029
13030       begin
13031          N2 := Get_Associated_Node (N);
13032          E := Entity (N2);
13033
13034          if Present (E) then
13035
13036             --  If the node is an entry call to an entry in an enclosing task,
13037             --  it is rewritten as a selected component. No global entity to
13038             --  preserve in this case, since the expansion will be redone in
13039             --  the instance.
13040
13041             if not Nkind_In (E, N_Defining_Identifier,
13042                                 N_Defining_Character_Literal,
13043                                 N_Defining_Operator_Symbol)
13044             then
13045                Set_Associated_Node (N, Empty);
13046                Set_Etype  (N, Empty);
13047                return;
13048             end if;
13049
13050             --  If the entity is an itype created as a subtype of an access
13051             --  type with a null exclusion restore source entity for proper
13052             --  visibility. The itype will be created anew in the instance.
13053
13054             if Is_Itype (E)
13055               and then Ekind (E) = E_Access_Subtype
13056               and then Is_Entity_Name (N)
13057               and then Chars (Etype (E)) = Chars (N)
13058             then
13059                E := Etype (E);
13060                Set_Entity (N2, E);
13061                Set_Etype  (N2, E);
13062             end if;
13063
13064             if Is_Global (E) then
13065
13066                --  If the entity is a package renaming that is the prefix of
13067                --  an expanded name, it has been rewritten as the renamed
13068                --  package, which is necessary semantically but complicates
13069                --  ASIS tree traversal, so we recover the original entity to
13070                --  expose the renaming. Take into account that the context may
13071                --  be a nested generic and that the original node may itself
13072                --  have an associated node.
13073
13074                if Ekind (E) = E_Package
13075                  and then Nkind (Parent (N)) = N_Expanded_Name
13076                  and then Present (Original_Node (N2))
13077                  and then Present (Entity (Original_Node (N2)))
13078                  and then Is_Entity_Name (Entity (Original_Node (N2)))
13079                then
13080                   if Is_Global (Entity (Original_Node (N2))) then
13081                      N2 := Original_Node (N2);
13082                      Set_Associated_Node (N, N2);
13083                      Set_Global_Type (N, N2);
13084
13085                   else
13086                      --  Renaming is local, and will be resolved in instance
13087
13088                      Set_Associated_Node (N, Empty);
13089                      Set_Etype  (N, Empty);
13090                   end if;
13091
13092                else
13093                   Set_Global_Type (N, N2);
13094                end if;
13095
13096             elsif Nkind (N) = N_Op_Concat
13097               and then Is_Generic_Type (Etype (N2))
13098               and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13099                          or else
13100                         Base_Type (Etype (Left_Opnd (N2)))  = Etype (N2))
13101               and then Is_Intrinsic_Subprogram (E)
13102             then
13103                null;
13104
13105             else
13106                --  Entity is local. Mark generic node as unresolved.
13107                --  Note that now it does not have an entity.
13108
13109                Set_Associated_Node (N, Empty);
13110                Set_Etype  (N, Empty);
13111             end if;
13112
13113             if Nkind (Parent (N)) in N_Generic_Instantiation
13114               and then N = Name (Parent (N))
13115             then
13116                Save_Global_Defaults (Parent (N), Parent (N2));
13117             end if;
13118
13119          elsif Nkind (Parent (N)) = N_Selected_Component
13120            and then Nkind (Parent (N2)) = N_Expanded_Name
13121          then
13122             if Is_Global (Entity (Parent (N2))) then
13123                Change_Selected_Component_To_Expanded_Name (Parent (N));
13124                Set_Associated_Node (Parent (N), Parent (N2));
13125                Set_Global_Type (Parent (N), Parent (N2));
13126                Save_Entity_Descendants (N);
13127
13128             --  If this is a reference to the current generic entity, replace
13129             --  by the name of the generic homonym of the current package. This
13130             --  is because in an instantiation Par.P.Q will not resolve to the
13131             --  name of the instance, whose enclosing scope is not necessarily
13132             --  Par. We use the generic homonym rather that the name of the
13133             --  generic itself because it may be hidden by a local declaration.
13134
13135             elsif In_Open_Scopes (Entity (Parent (N2)))
13136               and then not
13137                 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13138             then
13139                if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13140                   Rewrite (Parent (N),
13141                     Make_Identifier (Sloc (N),
13142                       Chars =>
13143                         Chars (Generic_Homonym (Entity (Parent (N2))))));
13144                else
13145                   Rewrite (Parent (N),
13146                     Make_Identifier (Sloc (N),
13147                       Chars => Chars (Selector_Name (Parent (N2)))));
13148                end if;
13149             end if;
13150
13151             if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13152               and then Parent (N) = Name (Parent (Parent (N)))
13153             then
13154                Save_Global_Defaults
13155                  (Parent (Parent (N)), Parent (Parent ((N2))));
13156             end if;
13157
13158          --  A selected component may denote a static constant that has been
13159          --  folded. If the static constant is global to the generic, capture
13160          --  its value. Otherwise the folding will happen in any instantiation.
13161
13162          elsif Nkind (Parent (N)) = N_Selected_Component
13163            and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13164          then
13165             if Present (Entity (Original_Node (Parent (N2))))
13166               and then Is_Global (Entity (Original_Node (Parent (N2))))
13167             then
13168                Rewrite (Parent (N), New_Copy (Parent (N2)));
13169                Set_Analyzed (Parent (N), False);
13170
13171             else
13172                null;
13173             end if;
13174
13175          --  A selected component may be transformed into a parameterless
13176          --  function call. If the called entity is global, rewrite the node
13177          --  appropriately, i.e. as an extended name for the global entity.
13178
13179          elsif Nkind (Parent (N)) = N_Selected_Component
13180            and then Nkind (Parent (N2)) = N_Function_Call
13181            and then N = Selector_Name (Parent (N))
13182          then
13183             if No (Parameter_Associations (Parent (N2))) then
13184                if Is_Global (Entity (Name (Parent (N2)))) then
13185                   Change_Selected_Component_To_Expanded_Name (Parent (N));
13186                   Set_Associated_Node (Parent (N), Name (Parent (N2)));
13187                   Set_Global_Type (Parent (N), Name (Parent (N2)));
13188                   Save_Entity_Descendants (N);
13189
13190                else
13191                   Set_Is_Prefixed_Call (Parent (N));
13192                   Set_Associated_Node (N, Empty);
13193                   Set_Etype (N, Empty);
13194                end if;
13195
13196             --  In Ada 2005, X.F may be a call to a primitive operation,
13197             --  rewritten as F (X). This rewriting will be done again in an
13198             --  instance, so keep the original node. Global entities will be
13199             --  captured as for other constructs. Indicate that this must
13200             --  resolve as a call, to prevent accidental overloading in the
13201             --  instance, if both a component and a primitive operation appear
13202             --  as candidates.
13203
13204             else
13205                Set_Is_Prefixed_Call (Parent (N));
13206             end if;
13207
13208          --  Entity is local. Reset in generic unit, so that node is resolved
13209          --  anew at the point of instantiation.
13210
13211          else
13212             Set_Associated_Node (N, Empty);
13213             Set_Etype (N, Empty);
13214          end if;
13215       end Reset_Entity;
13216
13217       -----------------------------
13218       -- Save_Entity_Descendants --
13219       -----------------------------
13220
13221       procedure Save_Entity_Descendants (N : Node_Id) is
13222       begin
13223          case Nkind (N) is
13224             when N_Binary_Op =>
13225                Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13226                Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13227
13228             when N_Unary_Op =>
13229                Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13230
13231             when N_Expanded_Name | N_Selected_Component =>
13232                Save_Global_Descendant (Union_Id (Prefix (N)));
13233                Save_Global_Descendant (Union_Id (Selector_Name (N)));
13234
13235             when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13236                null;
13237
13238             when others =>
13239                raise Program_Error;
13240          end case;
13241       end Save_Entity_Descendants;
13242
13243       --------------------------
13244       -- Save_Global_Defaults --
13245       --------------------------
13246
13247       procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13248          Loc    : constant Source_Ptr := Sloc (N1);
13249          Assoc2 : constant List_Id    := Generic_Associations (N2);
13250          Gen_Id : constant Entity_Id  := Get_Generic_Entity (N2);
13251          Assoc1 : List_Id;
13252          Act1   : Node_Id;
13253          Act2   : Node_Id;
13254          Def    : Node_Id;
13255          Ndec   : Node_Id;
13256          Subp   : Entity_Id;
13257          Actual : Entity_Id;
13258
13259       begin
13260          Assoc1 := Generic_Associations (N1);
13261
13262          if Present (Assoc1) then
13263             Act1 := First (Assoc1);
13264          else
13265             Act1 := Empty;
13266             Set_Generic_Associations (N1, New_List);
13267             Assoc1 := Generic_Associations (N1);
13268          end if;
13269
13270          if Present (Assoc2) then
13271             Act2 := First (Assoc2);
13272          else
13273             return;
13274          end if;
13275
13276          while Present (Act1) and then Present (Act2) loop
13277             Next (Act1);
13278             Next (Act2);
13279          end loop;
13280
13281          --  Find the associations added for default subprograms
13282
13283          if Present (Act2) then
13284             while Nkind (Act2) /= N_Generic_Association
13285               or else No (Entity (Selector_Name (Act2)))
13286               or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13287             loop
13288                Next (Act2);
13289             end loop;
13290
13291             --  Add a similar association if the default is global. The
13292             --  renaming declaration for the actual has been analyzed, and
13293             --  its alias is the program it renames. Link the actual in the
13294             --  original generic tree with the node in the analyzed tree.
13295
13296             while Present (Act2) loop
13297                Subp := Entity (Selector_Name (Act2));
13298                Def  := Explicit_Generic_Actual_Parameter (Act2);
13299
13300                --  Following test is defence against rubbish errors
13301
13302                if No (Alias (Subp)) then
13303                   return;
13304                end if;
13305
13306                --  Retrieve the resolved actual from the renaming declaration
13307                --  created for the instantiated formal.
13308
13309                Actual := Entity (Name (Parent (Parent (Subp))));
13310                Set_Entity (Def, Actual);
13311                Set_Etype (Def, Etype (Actual));
13312
13313                if Is_Global (Actual) then
13314                   Ndec :=
13315                     Make_Generic_Association (Loc,
13316                       Selector_Name => New_Occurrence_Of (Subp, Loc),
13317                         Explicit_Generic_Actual_Parameter =>
13318                           New_Occurrence_Of (Actual, Loc));
13319
13320                   Set_Associated_Node
13321                     (Explicit_Generic_Actual_Parameter (Ndec), Def);
13322
13323                   Append (Ndec, Assoc1);
13324
13325                --  If there are other defaults, add a dummy association in case
13326                --  there are other defaulted formals with the same name.
13327
13328                elsif Present (Next (Act2)) then
13329                   Ndec :=
13330                     Make_Generic_Association (Loc,
13331                       Selector_Name => New_Occurrence_Of (Subp, Loc),
13332                         Explicit_Generic_Actual_Parameter => Empty);
13333
13334                   Append (Ndec, Assoc1);
13335                end if;
13336
13337                Next (Act2);
13338             end loop;
13339          end if;
13340
13341          if Nkind (Name (N1)) = N_Identifier
13342            and then Is_Child_Unit (Gen_Id)
13343            and then Is_Global (Gen_Id)
13344            and then Is_Generic_Unit (Scope (Gen_Id))
13345            and then In_Open_Scopes (Scope (Gen_Id))
13346          then
13347             --  This is an instantiation of a child unit within a sibling, so
13348             --  that the generic parent is in scope. An eventual instance must
13349             --  occur within the scope of an instance of the parent. Make name
13350             --  in instance into an expanded name, to preserve the identifier
13351             --  of the parent, so it can be resolved subsequently.
13352
13353             Rewrite (Name (N2),
13354               Make_Expanded_Name (Loc,
13355                 Chars         => Chars (Gen_Id),
13356                 Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
13357                 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13358             Set_Entity (Name (N2), Gen_Id);
13359
13360             Rewrite (Name (N1),
13361                Make_Expanded_Name (Loc,
13362                 Chars         => Chars (Gen_Id),
13363                 Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
13364                 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13365
13366             Set_Associated_Node (Name (N1), Name (N2));
13367             Set_Associated_Node (Prefix (Name (N1)), Empty);
13368             Set_Associated_Node
13369               (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13370             Set_Etype (Name (N1), Etype (Gen_Id));
13371          end if;
13372
13373       end Save_Global_Defaults;
13374
13375       ----------------------------
13376       -- Save_Global_Descendant --
13377       ----------------------------
13378
13379       procedure Save_Global_Descendant (D : Union_Id) is
13380          N1 : Node_Id;
13381
13382       begin
13383          if D in Node_Range then
13384             if D = Union_Id (Empty) then
13385                null;
13386
13387             elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13388                Save_References (Node_Id (D));
13389             end if;
13390
13391          elsif D in List_Range then
13392             if D = Union_Id (No_List)
13393               or else Is_Empty_List (List_Id (D))
13394             then
13395                null;
13396
13397             else
13398                N1 := First (List_Id (D));
13399                while Present (N1) loop
13400                   Save_References (N1);
13401                   Next (N1);
13402                end loop;
13403             end if;
13404
13405          --  Element list or other non-node field, nothing to do
13406
13407          else
13408             null;
13409          end if;
13410       end Save_Global_Descendant;
13411
13412       ---------------------
13413       -- Save_References --
13414       ---------------------
13415
13416       --  This is the recursive procedure that does the work once the enclosing
13417       --  generic scope has been established. We have to treat specially a
13418       --  number of node rewritings that are required by semantic processing
13419       --  and which change the kind of nodes in the generic copy: typically
13420       --  constant-folding, replacing an operator node by a string literal, or
13421       --  a selected component by an expanded name. In each of those cases, the
13422       --  transformation is propagated to the generic unit.
13423
13424       procedure Save_References (N : Node_Id) is
13425          Loc : constant Source_Ptr := Sloc (N);
13426
13427       begin
13428          if N = Empty then
13429             null;
13430
13431          elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13432             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13433                Reset_Entity (N);
13434
13435             elsif Nkind (N) = N_Operator_Symbol
13436               and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13437             then
13438                Change_Operator_Symbol_To_String_Literal (N);
13439             end if;
13440
13441          elsif Nkind (N) in N_Op then
13442             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13443                if Nkind (N) = N_Op_Concat then
13444                   Set_Is_Component_Left_Opnd (N,
13445                     Is_Component_Left_Opnd (Get_Associated_Node (N)));
13446
13447                   Set_Is_Component_Right_Opnd (N,
13448                     Is_Component_Right_Opnd (Get_Associated_Node (N)));
13449                end if;
13450
13451                Reset_Entity (N);
13452
13453             else
13454                --  Node may be transformed into call to a user-defined operator
13455
13456                N2 := Get_Associated_Node (N);
13457
13458                if Nkind (N2) = N_Function_Call then
13459                   E := Entity (Name (N2));
13460
13461                   if Present (E)
13462                     and then Is_Global (E)
13463                   then
13464                      Set_Etype (N, Etype (N2));
13465                   else
13466                      Set_Associated_Node (N, Empty);
13467                      Set_Etype (N, Empty);
13468                   end if;
13469
13470                elsif Nkind_In (N2, N_Integer_Literal,
13471                                    N_Real_Literal,
13472                                    N_String_Literal)
13473                then
13474                   if Present (Original_Node (N2))
13475                     and then Nkind (Original_Node (N2)) = Nkind (N)
13476                   then
13477
13478                      --  Operation was constant-folded. Whenever possible,
13479                      --  recover semantic information from unfolded node,
13480                      --  for ASIS use.
13481
13482                      Set_Associated_Node (N, Original_Node (N2));
13483
13484                      if Nkind (N) = N_Op_Concat then
13485                         Set_Is_Component_Left_Opnd (N,
13486                           Is_Component_Left_Opnd  (Get_Associated_Node (N)));
13487                         Set_Is_Component_Right_Opnd (N,
13488                           Is_Component_Right_Opnd (Get_Associated_Node (N)));
13489                      end if;
13490
13491                      Reset_Entity (N);
13492
13493                   else
13494                      --  If original node is already modified, propagate
13495                      --  constant-folding to template.
13496
13497                      Rewrite (N, New_Copy (N2));
13498                      Set_Analyzed (N, False);
13499                   end if;
13500
13501                elsif Nkind (N2) = N_Identifier
13502                  and then Ekind (Entity (N2)) = E_Enumeration_Literal
13503                then
13504                   --  Same if call was folded into a literal, but in this case
13505                   --  retain the entity to avoid spurious ambiguities if it is
13506                   --  overloaded at the point of instantiation or inlining.
13507
13508                   Rewrite (N, New_Copy (N2));
13509                   Set_Analyzed (N, False);
13510                end if;
13511             end if;
13512
13513             --  Complete operands check if node has not been constant-folded
13514
13515             if Nkind (N) in N_Op then
13516                Save_Entity_Descendants (N);
13517             end if;
13518
13519          elsif Nkind (N) = N_Identifier then
13520             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13521
13522                --  If this is a discriminant reference, always save it. It is
13523                --  used in the instance to find the corresponding discriminant
13524                --  positionally rather than by name.
13525
13526                Set_Original_Discriminant
13527                  (N, Original_Discriminant (Get_Associated_Node (N)));
13528                Reset_Entity (N);
13529
13530             else
13531                N2 := Get_Associated_Node (N);
13532
13533                if Nkind (N2) = N_Function_Call then
13534                   E := Entity (Name (N2));
13535
13536                   --  Name resolves to a call to parameterless function. If
13537                   --  original entity is global, mark node as resolved.
13538
13539                   if Present (E)
13540                     and then Is_Global (E)
13541                   then
13542                      Set_Etype (N, Etype (N2));
13543                   else
13544                      Set_Associated_Node (N, Empty);
13545                      Set_Etype (N, Empty);
13546                   end if;
13547
13548                elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13549                  and then Is_Entity_Name (Original_Node (N2))
13550                then
13551                   --  Name resolves to named number that is constant-folded,
13552                   --  We must preserve the original name for ASIS use, and
13553                   --  undo the constant-folding, which will be repeated in
13554                   --  each instance.
13555
13556                   Set_Associated_Node (N, Original_Node (N2));
13557                   Reset_Entity (N);
13558
13559                elsif Nkind (N2) = N_String_Literal then
13560
13561                   --  Name resolves to string literal. Perform the same
13562                   --  replacement in generic.
13563
13564                   Rewrite (N, New_Copy (N2));
13565
13566                elsif Nkind (N2) = N_Explicit_Dereference then
13567
13568                   --  An identifier is rewritten as a dereference if it is the
13569                   --  prefix in an implicit dereference (call or attribute).
13570                   --  The analysis of an instantiation will expand the node
13571                   --  again, so we preserve the original tree but link it to
13572                   --  the resolved entity in case it is global.
13573
13574                   if Is_Entity_Name (Prefix (N2))
13575                     and then Present (Entity (Prefix (N2)))
13576                     and then Is_Global (Entity (Prefix (N2)))
13577                   then
13578                      Set_Associated_Node (N, Prefix (N2));
13579
13580                   elsif Nkind (Prefix (N2)) = N_Function_Call
13581                     and then Is_Global (Entity (Name (Prefix (N2))))
13582                   then
13583                      Rewrite (N,
13584                        Make_Explicit_Dereference (Loc,
13585                           Prefix => Make_Function_Call (Loc,
13586                             Name =>
13587                               New_Occurrence_Of (Entity (Name (Prefix (N2))),
13588                                                  Loc))));
13589
13590                   else
13591                      Set_Associated_Node (N, Empty);
13592                      Set_Etype (N, Empty);
13593                   end if;
13594
13595                --  The subtype mark of a nominally unconstrained object is
13596                --  rewritten as a subtype indication using the bounds of the
13597                --  expression. Recover the original subtype mark.
13598
13599                elsif Nkind (N2) = N_Subtype_Indication
13600                  and then Is_Entity_Name (Original_Node (N2))
13601                then
13602                   Set_Associated_Node (N, Original_Node (N2));
13603                   Reset_Entity (N);
13604
13605                else
13606                   null;
13607                end if;
13608             end if;
13609
13610          elsif Nkind (N) in N_Entity then
13611             null;
13612
13613          else
13614             declare
13615                Qual : Node_Id := Empty;
13616                Typ  : Entity_Id := Empty;
13617                Nam  : Node_Id;
13618
13619                use Atree.Unchecked_Access;
13620                --  This code section is part of implementing an untyped tree
13621                --  traversal, so it needs direct access to node fields.
13622
13623             begin
13624                if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13625                   N2 := Get_Associated_Node (N);
13626
13627                   if No (N2) then
13628                      Typ := Empty;
13629                   else
13630                      Typ := Etype (N2);
13631
13632                      --  In an instance within a generic, use the name of the
13633                      --  actual and not the original generic parameter. If the
13634                      --  actual is global in the current generic it must be
13635                      --  preserved for its instantiation.
13636
13637                      if Nkind (Parent (Typ)) = N_Subtype_Declaration
13638                        and then
13639                          Present (Generic_Parent_Type (Parent (Typ)))
13640                      then
13641                         Typ := Base_Type (Typ);
13642                         Set_Etype (N2, Typ);
13643                      end if;
13644                   end if;
13645
13646                   if No (N2)
13647                     or else No (Typ)
13648                     or else not Is_Global (Typ)
13649                   then
13650                      Set_Associated_Node (N, Empty);
13651
13652                      --  If the aggregate is an actual in a call, it has been
13653                      --  resolved in the current context, to some local type.
13654                      --  The enclosing call may have been disambiguated by the
13655                      --  aggregate, and this disambiguation might fail at
13656                      --  instantiation time because the type to which the
13657                      --  aggregate did resolve is not preserved. In order to
13658                      --  preserve some of this information, we wrap the
13659                      --  aggregate in a qualified expression, using the id of
13660                      --  its type. For further disambiguation we qualify the
13661                      --  type name with its scope (if visible) because both
13662                      --  id's will have corresponding entities in an instance.
13663                      --  This resolves most of the problems with missing type
13664                      --  information on aggregates in instances.
13665
13666                      if Nkind (N2) = Nkind (N)
13667                        and then Nkind (Parent (N2)) in N_Subprogram_Call
13668                        and then Comes_From_Source (Typ)
13669                      then
13670                         if Is_Immediately_Visible (Scope (Typ)) then
13671                            Nam := Make_Selected_Component (Loc,
13672                              Prefix =>
13673                                Make_Identifier (Loc, Chars (Scope (Typ))),
13674                              Selector_Name =>
13675                                Make_Identifier (Loc, Chars (Typ)));
13676                         else
13677                            Nam := Make_Identifier (Loc, Chars (Typ));
13678                         end if;
13679
13680                         Qual :=
13681                           Make_Qualified_Expression (Loc,
13682                             Subtype_Mark => Nam,
13683                             Expression => Relocate_Node (N));
13684                      end if;
13685                   end if;
13686
13687                   Save_Global_Descendant (Field1 (N));
13688                   Save_Global_Descendant (Field2 (N));
13689                   Save_Global_Descendant (Field3 (N));
13690                   Save_Global_Descendant (Field5 (N));
13691
13692                   if Present (Qual) then
13693                      Rewrite (N, Qual);
13694                   end if;
13695
13696                --  All other cases than aggregates
13697
13698                else
13699                   Save_Global_Descendant (Field1 (N));
13700                   Save_Global_Descendant (Field2 (N));
13701                   Save_Global_Descendant (Field3 (N));
13702                   Save_Global_Descendant (Field4 (N));
13703                   Save_Global_Descendant (Field5 (N));
13704                end if;
13705             end;
13706          end if;
13707
13708          --  If a node has aspects, references within their expressions must
13709          --  be saved separately, given that they are not directly in the
13710          --  tree.
13711
13712          if Has_Aspects (N) then
13713             declare
13714                Aspect : Node_Id;
13715             begin
13716                Aspect := First (Aspect_Specifications (N));
13717                while Present (Aspect) loop
13718                   Save_Global_References (Expression (Aspect));
13719                   Next (Aspect);
13720                end loop;
13721             end;
13722          end if;
13723       end Save_References;
13724
13725    --  Start of processing for Save_Global_References
13726
13727    begin
13728       Gen_Scope := Current_Scope;
13729
13730       --  If the generic unit is a child unit, references to entities in the
13731       --  parent are treated as local, because they will be resolved anew in
13732       --  the context of the instance of the parent.
13733
13734       while Is_Child_Unit (Gen_Scope)
13735         and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13736       loop
13737          Gen_Scope := Scope (Gen_Scope);
13738       end loop;
13739
13740       Save_References (N);
13741    end Save_Global_References;
13742
13743    --------------------------------------
13744    -- Set_Copied_Sloc_For_Inlined_Body --
13745    --------------------------------------
13746
13747    procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13748    begin
13749       Create_Instantiation_Source (N, E, True, S_Adjustment);
13750    end Set_Copied_Sloc_For_Inlined_Body;
13751
13752    ---------------------
13753    -- Set_Instance_Of --
13754    ---------------------
13755
13756    procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13757    begin
13758       Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13759       Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13760       Generic_Renamings.Increment_Last;
13761    end Set_Instance_Of;
13762
13763    --------------------
13764    -- Set_Next_Assoc --
13765    --------------------
13766
13767    procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13768    begin
13769       Generic_Renamings.Table (E).Next_In_HTable := Next;
13770    end Set_Next_Assoc;
13771
13772    -------------------
13773    -- Start_Generic --
13774    -------------------
13775
13776    procedure Start_Generic is
13777    begin
13778       --  ??? More things could be factored out in this routine.
13779       --  Should probably be done at a later stage.
13780
13781       Generic_Flags.Append (Inside_A_Generic);
13782       Inside_A_Generic := True;
13783
13784       Expander_Mode_Save_And_Set (False);
13785    end Start_Generic;
13786
13787    ----------------------
13788    -- Set_Instance_Env --
13789    ----------------------
13790
13791    procedure Set_Instance_Env
13792      (Gen_Unit : Entity_Id;
13793       Act_Unit : Entity_Id)
13794    is
13795    begin
13796       --  Regardless of the current mode, predefined units are analyzed in the
13797       --  most current Ada mode, and earlier version Ada checks do not apply
13798       --  to predefined units. Nothing needs to be done for non-internal units.
13799       --  These are always analyzed in the current mode.
13800
13801       if Is_Internal_File_Name
13802            (Fname              => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13803             Renamings_Included => True)
13804       then
13805          Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13806       end if;
13807
13808       Current_Instantiated_Parent :=
13809         (Gen_Id         => Gen_Unit,
13810          Act_Id         => Act_Unit,
13811          Next_In_HTable => Assoc_Null);
13812    end Set_Instance_Env;
13813
13814    -----------------
13815    -- Switch_View --
13816    -----------------
13817
13818    procedure Switch_View (T : Entity_Id) is
13819       BT        : constant Entity_Id := Base_Type (T);
13820       Priv_Elmt : Elmt_Id := No_Elmt;
13821       Priv_Sub  : Entity_Id;
13822
13823    begin
13824       --  T may be private but its base type may have been exchanged through
13825       --  some other occurrence, in which case there is nothing to switch
13826       --  besides T itself. Note that a private dependent subtype of a private
13827       --  type might not have been switched even if the base type has been,
13828       --  because of the last branch of Check_Private_View (see comment there).
13829
13830       if not Is_Private_Type (BT) then
13831          Prepend_Elmt (Full_View (T), Exchanged_Views);
13832          Exchange_Declarations (T);
13833          return;
13834       end if;
13835
13836       Priv_Elmt := First_Elmt (Private_Dependents (BT));
13837
13838       if Present (Full_View (BT)) then
13839          Prepend_Elmt (Full_View (BT), Exchanged_Views);
13840          Exchange_Declarations (BT);
13841       end if;
13842
13843       while Present (Priv_Elmt) loop
13844          Priv_Sub := (Node (Priv_Elmt));
13845
13846          --  We avoid flipping the subtype if the Etype of its full view is
13847          --  private because this would result in a malformed subtype. This
13848          --  occurs when the Etype of the subtype full view is the full view of
13849          --  the base type (and since the base types were just switched, the
13850          --  subtype is pointing to the wrong view). This is currently the case
13851          --  for tagged record types, access types (maybe more?) and needs to
13852          --  be resolved. ???
13853
13854          if Present (Full_View (Priv_Sub))
13855            and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
13856          then
13857             Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
13858             Exchange_Declarations (Priv_Sub);
13859          end if;
13860
13861          Next_Elmt (Priv_Elmt);
13862       end loop;
13863    end Switch_View;
13864
13865    -----------------
13866    -- True_Parent --
13867    -----------------
13868
13869    function True_Parent (N : Node_Id) return Node_Id is
13870    begin
13871       if Nkind (Parent (N)) = N_Subunit then
13872          return Parent (Corresponding_Stub (Parent (N)));
13873       else
13874          return Parent (N);
13875       end if;
13876    end True_Parent;
13877
13878    -----------------------------
13879    -- Valid_Default_Attribute --
13880    -----------------------------
13881
13882    procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
13883       Attr_Id : constant Attribute_Id :=
13884                   Get_Attribute_Id (Attribute_Name (Def));
13885       T       : constant Entity_Id := Entity (Prefix (Def));
13886       Is_Fun  : constant Boolean := (Ekind (Nam) = E_Function);
13887       F       : Entity_Id;
13888       Num_F   : Int;
13889       OK      : Boolean;
13890
13891    begin
13892       if No (T)
13893         or else T = Any_Id
13894       then
13895          return;
13896       end if;
13897
13898       Num_F := 0;
13899       F := First_Formal (Nam);
13900       while Present (F) loop
13901          Num_F := Num_F + 1;
13902          Next_Formal (F);
13903       end loop;
13904
13905       case Attr_Id is
13906          when Attribute_Adjacent |  Attribute_Ceiling   | Attribute_Copy_Sign |
13907               Attribute_Floor    |  Attribute_Fraction  | Attribute_Machine   |
13908               Attribute_Model    |  Attribute_Remainder | Attribute_Rounding  |
13909               Attribute_Unbiased_Rounding  =>
13910             OK := Is_Fun
13911                     and then Num_F = 1
13912                     and then Is_Floating_Point_Type (T);
13913
13914          when Attribute_Image    | Attribute_Pred       | Attribute_Succ |
13915               Attribute_Value    | Attribute_Wide_Image |
13916               Attribute_Wide_Value  =>
13917             OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
13918
13919          when Attribute_Max      |  Attribute_Min  =>
13920             OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
13921
13922          when Attribute_Input =>
13923             OK := (Is_Fun and then Num_F = 1);
13924
13925          when Attribute_Output | Attribute_Read | Attribute_Write =>
13926             OK := (not Is_Fun and then Num_F = 2);
13927
13928          when others =>
13929             OK := False;
13930       end case;
13931
13932       if not OK then
13933          Error_Msg_N ("attribute reference has wrong profile for subprogram",
13934            Def);
13935       end if;
13936    end Valid_Default_Attribute;
13937
13938 end Sem_Ch12;