OSDN Git Service

2004-06-07 Robert Dewar <dewar@gnat.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / sem_ch12.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                             S E M _ C H 1 2                              --
6 --                                                                          --
7 --                                 B o d y                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2004, 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 2,  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 COPYING.  If not, write --
19 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
20 -- MA 02111-1307, USA.                                                      --
21 --                                                                          --
22 -- GNAT was originally developed  by the GNAT team at  New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
24 --                                                                          --
25 ------------------------------------------------------------------------------
26
27 with Atree;    use Atree;
28 with Einfo;    use Einfo;
29 with Elists;   use Elists;
30 with Errout;   use Errout;
31 with Expander; use Expander;
32 with Fname;    use Fname;
33 with Fname.UF; use Fname.UF;
34 with Freeze;   use Freeze;
35 with Hostparm;
36 with Inline;   use Inline;
37 with Lib;      use Lib;
38 with Lib.Load; use Lib.Load;
39 with Lib.Xref; use Lib.Xref;
40 with Nlists;   use Nlists;
41 with Nmake;    use Nmake;
42 with Opt;      use Opt;
43 with Rident;   use Rident;
44 with Restrict; use Restrict;
45 with Rtsfind;  use Rtsfind;
46 with Sem;      use Sem;
47 with Sem_Cat;  use Sem_Cat;
48 with Sem_Ch3;  use Sem_Ch3;
49 with Sem_Ch6;  use Sem_Ch6;
50 with Sem_Ch7;  use Sem_Ch7;
51 with Sem_Ch8;  use Sem_Ch8;
52 with Sem_Ch10; use Sem_Ch10;
53 with Sem_Ch13; use Sem_Ch13;
54 with Sem_Elab; use Sem_Elab;
55 with Sem_Elim; use Sem_Elim;
56 with Sem_Eval; use Sem_Eval;
57 with Sem_Res;  use Sem_Res;
58 with Sem_Type; use Sem_Type;
59 with Sem_Util; use Sem_Util;
60 with Sem_Warn; use Sem_Warn;
61 with Stand;    use Stand;
62 with Sinfo;    use Sinfo;
63 with Sinfo.CN; use Sinfo.CN;
64 with Sinput;   use Sinput;
65 with Sinput.L; use Sinput.L;
66 with Snames;   use Snames;
67 with Stringt;  use Stringt;
68 with Uname;    use Uname;
69 with Table;
70 with Tbuild;   use Tbuild;
71 with Uintp;    use Uintp;
72 with Urealp;   use Urealp;
73
74 with GNAT.HTable;
75
76 package body Sem_Ch12 is
77
78    ----------------------------------------------------------
79    -- Implementation of Generic Analysis and Instantiation --
80    -----------------------------------------------------------
81
82    --  GNAT implements generics by macro expansion. No attempt is made to
83    --  share generic instantiations (for now). Analysis of a generic definition
84    --  does not perform any expansion action, but the expander must be called
85    --  on the tree for each instantiation, because the expansion may of course
86    --  depend on the generic actuals. All of this is best achieved as follows:
87    --
88    --  a) Semantic analysis of a generic unit is performed on a copy of the
89    --  tree for the generic unit. All tree modifications that follow analysis
90    --  do not affect the original tree. Links are kept between the original
91    --  tree and the copy, in order to recognize non-local references within
92    --  the generic, and propagate them to each instance (recall that name
93    --  resolution is done on the generic declaration: generics are not really
94    --  macros!). This is summarized in the following diagram:
95    --
96    --              .-----------.               .----------.
97    --              |  semantic |<--------------|  generic |
98    --              |    copy   |               |    unit  |
99    --              |           |==============>|          |
100    --              |___________|    global     |__________|
101    --                             references     |   |  |
102    --                                            |   |  |
103    --                                          .-----|--|.
104    --                                          |  .-----|---.
105    --                                          |  |  .----------.
106    --                                          |  |  |  generic |
107    --                                          |__|  |          |
108    --                                             |__| instance |
109    --                                                |__________|
110    --
111    --  b) Each instantiation copies the original tree, and inserts into it a
112    --  series of declarations that describe the mapping between generic formals
113    --  and actuals. For example, a generic In OUT parameter is an object
114    --  renaming of the corresponing actual, etc. Generic IN parameters are
115    --  constant declarations.
116    --
117    --  c) In order to give the right visibility for these renamings, we use
118    --  a different scheme for package and subprogram instantiations. For
119    --  packages, the list of renamings is inserted into the package
120    --  specification, before the visible declarations of the package. The
121    --  renamings are analyzed before any of the text of the instance, and are
122    --  thus visible at the right place. Furthermore, outside of the instance,
123    --  the generic parameters are visible and denote their corresponding
124    --  actuals.
125
126    --  For subprograms, we create a container package to hold the renamings
127    --  and the subprogram instance itself. Analysis of the package makes the
128    --  renaming declarations visible to the subprogram. After analyzing the
129    --  package, the defining entity for the subprogram is touched-up so that
130    --  it appears declared in the current scope, and not inside the container
131    --  package.
132
133    --  If the instantiation is a compilation unit, the container package is
134    --  given the same name as the subprogram instance. This ensures that
135    --  the elaboration procedure called by the binder, using the compilation
136    --  unit name, calls in fact the elaboration procedure for the package.
137
138    --  Not surprisingly, private types complicate this approach. By saving in
139    --  the original generic object the non-local references, we guarantee that
140    --  the proper entities are referenced at the point of instantiation.
141    --  However, for private types, this by itself does not insure that the
142    --  proper VIEW of the entity is used (the full type may be visible at the
143    --  point of generic definition, but not at instantiation, or vice-versa).
144    --  In  order to reference the proper view, we special-case any reference
145    --  to private types in the generic object, by saving both views, one in
146    --  the generic and one in the semantic copy. At time of instantiation, we
147    --  check whether the two views are consistent, and exchange declarations if
148    --  necessary, in order to restore the correct visibility. Similarly, if
149    --  the instance view is private when the generic view was not, we perform
150    --  the exchange. After completing the instantiation, we restore the
151    --  current visibility. The flag Has_Private_View marks identifiers in the
152    --  the generic unit that require checking.
153
154    --  Visibility within nested generic units requires special handling.
155    --  Consider the following scheme:
156    --
157    --  type Global is ...         --  outside of generic unit.
158    --  generic ...
159    --  package Outer is
160    --     ...
161    --     type Semi_Global is ... --  global to inner.
162    --
163    --     generic ...                                         -- 1
164    --     procedure inner (X1 : Global;  X2 : Semi_Global);
165    --
166    --     procedure in2 is new inner (...);                   -- 4
167    --  end Outer;
168
169    --  package New_Outer is new Outer (...);                  -- 2
170    --  procedure New_Inner is new New_Outer.Inner (...);      -- 3
171
172    --  The semantic analysis of Outer captures all occurrences of Global.
173    --  The semantic analysis of Inner (at 1) captures both occurrences of
174    --  Global and Semi_Global.
175
176    --  At point 2 (instantiation of Outer), we also produce a generic copy
177    --  of Inner, even though Inner is, at that point, not being instantiated.
178    --  (This is just part of the semantic analysis of New_Outer).
179
180    --  Critically, references to Global within Inner must be preserved, while
181    --  references to Semi_Global should not preserved, because they must now
182    --  resolve to an entity within New_Outer. To distinguish between these, we
183    --  use a global variable, Current_Instantiated_Parent, which is set when
184    --  performing a generic copy during instantiation (at 2). This variable is
185    --  used when performing a generic copy that is not an instantiation, but
186    --  that is nested within one, as the occurrence of 1 within 2. The analysis
187    --  of a nested generic only preserves references that are global to the
188    --  enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
189    --  determine whether a reference is external to the given parent.
190
191    --  The instantiation at point 3 requires no special treatment. The method
192    --  works as well for further nestings of generic units, but of course the
193    --  variable Current_Instantiated_Parent must be stacked because nested
194    --  instantiations can occur, e.g. the occurrence of 4 within 2.
195
196    --  The instantiation of package and subprogram bodies is handled in a
197    --  similar manner, except that it is delayed until after semantic
198    --  analysis is complete. In this fashion complex cross-dependencies
199    --  between several package declarations and bodies containing generics
200    --  can be compiled which otherwise would diagnose spurious circularities.
201
202    --  For example, it is possible to compile two packages A and B that
203    --  have the following structure:
204
205    --    package A is                         package B is
206    --       generic ...                          generic ...
207    --       package G_A is                       package G_B is
208
209    --    with B;                              with A;
210    --    package body A is                    package body B is
211    --       package N_B is new G_B (..)          package N_A is new G_A (..)
212
213    --  The table Pending_Instantiations in package Inline is used to keep
214    --  track of body instantiations that are delayed in this manner. Inline
215    --  handles the actual calls to do the body instantiations. This activity
216    --  is part of Inline, since the processing occurs at the same point, and
217    --  for essentially the same reason, as the handling of inlined routines.
218
219    ----------------------------------------------
220    -- Detection of Instantiation Circularities --
221    ----------------------------------------------
222
223    --  If we have a chain of instantiations that is circular, this is a
224    --  static error which must be detected at compile time. The detection
225    --  of these circularities is carried out at the point that we insert
226    --  a generic instance spec or body. If there is a circularity, then
227    --  the analysis of the offending spec or body will eventually result
228    --  in trying to load the same unit again, and we detect this problem
229    --  as we analyze the package instantiation for the second time.
230
231    --  At least in some cases after we have detected the circularity, we
232    --  get into trouble if we try to keep going. The following flag is
233    --  set if a circularity is detected, and used to abandon compilation
234    --  after the messages have been posted.
235
236    Circularity_Detected : Boolean := False;
237    --  This should really be reset on encountering a new main unit, but in
238    --  practice we are not using multiple main units so it is not critical.
239
240    -----------------------
241    -- Local subprograms --
242    -----------------------
243
244    procedure Abandon_Instantiation (N : Node_Id);
245    pragma No_Return (Abandon_Instantiation);
246    --  Posts an error message "instantiation abandoned" at the indicated
247    --  node and then raises the exception Instantiation_Error to do it.
248
249    procedure Analyze_Formal_Array_Type
250      (T   : in out Entity_Id;
251       Def : Node_Id);
252    --  A formal array type is treated like an array type declaration, and
253    --  invokes Array_Type_Declaration (sem_ch3) whose first parameter is
254    --  in-out, because in the case of an anonymous type the entity is
255    --  actually created in the procedure.
256
257    --  The following procedures treat other kinds of formal parameters.
258
259    procedure Analyze_Formal_Derived_Type
260      (N   : Node_Id;
261       T   : Entity_Id;
262       Def : Node_Id);
263
264    --  All the following need comments???
265
266    procedure Analyze_Formal_Decimal_Fixed_Point_Type
267                                                 (T : Entity_Id; Def : Node_Id);
268    procedure Analyze_Formal_Discrete_Type       (T : Entity_Id; Def : Node_Id);
269    procedure Analyze_Formal_Floating_Type       (T : Entity_Id; Def : Node_Id);
270    procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
271    procedure Analyze_Formal_Modular_Type        (T : Entity_Id; Def : Node_Id);
272    procedure Analyze_Formal_Ordinary_Fixed_Point_Type
273                                                 (T : Entity_Id; Def : Node_Id);
274
275    procedure Analyze_Formal_Private_Type
276      (N   : Node_Id;
277       T   : Entity_Id;
278       Def : Node_Id);
279    --  This needs comments???
280
281    procedure Analyze_Generic_Formal_Part (N : Node_Id);
282
283    procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
284    --  This needs comments ???
285
286    function Analyze_Associations
287      (I_Node  : Node_Id;
288       Formals : List_Id;
289       F_Copy  : List_Id)
290       return    List_Id;
291    --  At instantiation time, build the list of associations between formals
292    --  and actuals. Each association becomes a renaming declaration for the
293    --  formal entity. F_Copy is the analyzed list of formals in the generic
294    --  copy. It is used to apply legality checks to the actuals. I_Node is the
295    --  instantiation node itself.
296
297    procedure Analyze_Subprogram_Instantiation
298      (N : Node_Id;
299       K : Entity_Kind);
300
301    procedure Build_Instance_Compilation_Unit_Nodes
302      (N        : Node_Id;
303       Act_Body : Node_Id;
304       Act_Decl : Node_Id);
305    --  This procedure is used in the case where the generic instance of a
306    --  subprogram body or package body is a library unit. In this case, the
307    --  original library unit node for the generic instantiation must be
308    --  replaced by the resulting generic body, and a link made to a new
309    --  compilation unit node for the generic declaration. The argument N is
310    --  the original generic instantiation. Act_Body and Act_Decl are the body
311    --  and declaration of the instance (either package body and declaration
312    --  nodes or subprogram body and declaration nodes depending on the case).
313    --  On return, the node N has been rewritten with the actual body.
314
315    procedure Check_Formal_Packages (P_Id : Entity_Id);
316    --  Apply the following to all formal packages in generic associations.
317
318    procedure Check_Formal_Package_Instance
319      (Formal_Pack : Entity_Id;
320       Actual_Pack : Entity_Id);
321    --  Verify that the actuals of the actual instance match the actuals of
322    --  the template for a formal package that is not declared with a box.
323
324    procedure Check_Forward_Instantiation (Decl : Node_Id);
325    --  If the generic is a local entity and the corresponding body has not
326    --  been seen yet, flag enclosing packages to indicate that it will be
327    --  elaborated after the generic body. Subprograms declared in the same
328    --  package cannot be inlined by the front-end because front-end inlining
329    --  requires a strict linear order of elaboration.
330
331    procedure Check_Hidden_Child_Unit
332      (N           : Node_Id;
333       Gen_Unit    : Entity_Id;
334       Act_Decl_Id : Entity_Id);
335    --  If the generic unit is an implicit child instance within a parent
336    --  instance, we need to make an explicit test that it is not hidden by
337    --  a child instance of the same name and parent.
338
339    procedure Check_Private_View (N : Node_Id);
340    --  Check whether the type of a generic entity has a different view between
341    --  the point of generic analysis and the point of instantiation. If the
342    --  view has changed, then at the point of instantiation we restore the
343    --  correct view to perform semantic analysis of the instance, and reset
344    --  the current view after instantiation. The processing is driven by the
345    --  current private status of the type of the node, and Has_Private_View,
346    --  a flag that is set at the point of generic compilation. If view and
347    --  flag are inconsistent then the type is updated appropriately.
348
349    procedure Check_Generic_Actuals
350      (Instance      : Entity_Id;
351       Is_Formal_Box : Boolean);
352    --  Similar to previous one. Check the actuals in the instantiation,
353    --  whose views can change between the point of instantiation and the point
354    --  of instantiation of the body. In addition, mark the generic renamings
355    --  as generic actuals, so that they are not compatible with other actuals.
356    --  Recurse on an actual that is a formal package whose declaration has
357    --  a box.
358
359    function Contains_Instance_Of
360      (Inner : Entity_Id;
361       Outer : Entity_Id;
362       N     : Node_Id)
363       return  Boolean;
364    --  Inner is instantiated within the generic Outer. Check whether Inner
365    --  directly or indirectly contains an instance of Outer or of one of its
366    --  parents, in the case of a subunit. Each generic unit holds a list of
367    --  the entities instantiated within (at any depth). This procedure
368    --  determines whether the set of such lists contains a cycle, i.e. an
369    --  illegal circular instantiation.
370
371    function Denotes_Formal_Package (Pack : Entity_Id) return Boolean;
372    --  Returns True if E is a formal package of an enclosing generic, or
373    --  the actual for such a formal in an enclosing instantiation. Used in
374    --  Restore_Private_Views, to keep the formals of such a package visible
375    --  on exit from an inner instantiation.
376
377    function Find_Actual_Type
378      (Typ       : Entity_Id;
379       Gen_Scope : Entity_Id)
380       return      Entity_Id;
381    --  When validating the actual types of a child instance, check whether
382    --  the formal is a formal type of the parent unit, and retrieve the current
383    --  actual for it. Typ is the entity in the analyzed formal type declaration
384    --  (component or index type of an array type) and Gen_Scope is the scope of
385    --  the analyzed formal array type.
386
387    function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id;
388    --  Given the entity of a unit that is an instantiation, retrieve the
389    --  original instance node. This is used when loading the instantiations
390    --  of the ancestors of a child generic that is being instantiated.
391
392    function In_Same_Declarative_Part
393      (F_Node : Node_Id;
394       Inst   : Node_Id)
395       return   Boolean;
396    --  True if the instantiation Inst and the given freeze_node F_Node appear
397    --  within the same declarative part, ignoring subunits, but with no inter-
398    --  vening suprograms or concurrent units. If true, the freeze node
399    --  of the instance can be placed after the freeze node of the parent,
400    --  which it itself an instance.
401
402    procedure Set_Instance_Env
403      (Gen_Unit : Entity_Id;
404       Act_Unit : Entity_Id);
405    --  Save current instance on saved environment, to be used to determine
406    --  the global status of entities in nested instances. Part of Save_Env.
407    --  called after verifying that the generic unit is legal for the instance.
408
409    procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
410    --  Associate analyzed generic parameter with corresponding
411    --  instance. Used for semantic checks at instantiation time.
412
413    function Has_Been_Exchanged (E : Entity_Id) return Boolean;
414    --  Traverse the Exchanged_Views list to see if a type was private
415    --  and has already been flipped during this phase of instantiation.
416
417    procedure Hide_Current_Scope;
418    --  When compiling a generic child unit, the parent context must be
419    --  present, but the instance and all entities that may be generated
420    --  must be inserted in the current scope. We leave the current scope
421    --  on the stack, but make its entities invisible to avoid visibility
422    --  problems. This is reversed at the end of instantiations. This is
423    --  not done for the instantiation of the bodies, which only require the
424    --  instances of the generic parents to be in scope.
425
426    procedure Install_Body
427      (Act_Body : Node_Id;
428       N        : Node_Id;
429       Gen_Body : Node_Id;
430       Gen_Decl : Node_Id);
431    --  If the instantiation happens textually before the body of the generic,
432    --  the instantiation of the body must be analyzed after the generic body,
433    --  and not at the point of instantiation. Such early instantiations can
434    --  happen if the generic and the instance appear in  a package declaration
435    --  because the generic body can only appear in the corresponding package
436    --  body. Early instantiations can also appear if generic, instance and
437    --  body are all in the declarative part of a subprogram or entry. Entities
438    --  of packages that are early instantiations are delayed, and their freeze
439    --  node appears after the generic body.
440
441    procedure Insert_After_Last_Decl (N : Node_Id; F_Node : Node_Id);
442    --  Insert freeze node at the end of the declarative part that includes the
443    --  instance node N. If N is in the visible part of an enclosing package
444    --  declaration, the freeze node has to be inserted at the end of the
445    --  private declarations, if any.
446
447    procedure Freeze_Subprogram_Body
448      (Inst_Node : Node_Id;
449       Gen_Body  : Node_Id;
450       Pack_Id   : Entity_Id);
451    --  The generic body may appear textually after the instance, including
452    --  in the proper body of a stub, or within a different package instance.
453    --  Given that the instance can only be elaborated after the generic, we
454    --  place freeze_nodes for the instance and/or for packages that may enclose
455    --  the instance and the generic, so that the back-end can establish the
456    --  proper order of elaboration.
457
458    procedure Init_Env;
459    --  Establish environment for subsequent instantiation. Separated from
460    --  Save_Env because data-structures for visibility handling must be
461    --  initialized before call to Check_Generic_Child_Unit.
462
463    procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
464    --  When compiling an instance of a child unit the parent (which is
465    --  itself an instance) is an enclosing scope that must be made
466    --  immediately visible. This procedure is also used to install the non-
467    --  generic parent of a generic child unit when compiling its body, so that
468    --  full views of types in the parent are made visible.
469
470    procedure Remove_Parent (In_Body : Boolean := False);
471    --  Reverse effect after instantiation of child is complete.
472
473    procedure Inline_Instance_Body
474      (N        : Node_Id;
475       Gen_Unit : Entity_Id;
476       Act_Decl : Node_Id);
477    --  If front-end inlining is requested, instantiate the package body,
478    --  and preserve the visibility of its compilation unit, to insure
479    --  that successive instantiations succeed.
480
481    --  The functions Instantiate_XXX perform various legality checks and build
482    --  the declarations for instantiated generic parameters.
483    --  Need to describe what the parameters are ???
484
485    function Instantiate_Object
486      (Formal          : Node_Id;
487       Actual          : Node_Id;
488       Analyzed_Formal : Node_Id)
489       return            List_Id;
490
491    function Instantiate_Type
492      (Formal          : Node_Id;
493       Actual          : Node_Id;
494       Analyzed_Formal : Node_Id;
495       Actual_Decls    : List_Id)
496       return            Node_Id;
497
498    function Instantiate_Formal_Subprogram
499      (Formal          : Node_Id;
500       Actual          : Node_Id;
501       Analyzed_Formal : Node_Id)
502       return            Node_Id;
503
504    function Instantiate_Formal_Package
505      (Formal          : Node_Id;
506       Actual          : Node_Id;
507       Analyzed_Formal : Node_Id)
508       return            List_Id;
509    --  If the formal package is declared with a box, special visibility rules
510    --  apply to its formals: they are in the visible part of the package. This
511    --  is true in the declarative region of the formal package, that is to say
512    --  in the enclosing generic or instantiation. For an instantiation, the
513    --  parameters of the formal package are made visible in an explicit step.
514    --  Furthermore, if the actual is a visible use_clause, these formals must
515    --  be made potentially use_visible as well. On exit from the enclosing
516    --  instantiation, the reverse must be done.
517
518    --  For a formal package declared without a box, there are conformance rules
519    --  that apply to the actuals in the generic declaration and the actuals of
520    --  the actual package in the enclosing instantiation. The simplest way to
521    --  apply these rules is to repeat the instantiation of the formal package
522    --  in the context of the enclosing instance, and compare the generic
523    --  associations of this instantiation with those of the actual package.
524
525    function Is_In_Main_Unit (N : Node_Id) return Boolean;
526    --  Test if given node is in the main unit
527
528    procedure Load_Parent_Of_Generic (N : Node_Id; Spec : Node_Id);
529    --  If the generic appears in a separate non-generic library unit,
530    --  load the corresponding body to retrieve the body of the generic.
531    --  N is the node for the generic instantiation, Spec is the generic
532    --  package declaration.
533
534    procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
535    --  Add the context clause of the unit containing a generic unit to
536    --  an instantiation that is a compilation unit.
537
538    function Get_Associated_Node (N : Node_Id) return Node_Id;
539    --  In order to propagate semantic information back from the analyzed
540    --  copy to the original generic, we maintain links between selected nodes
541    --  in the generic and their corresponding copies. At the end of generic
542    --  analysis, the routine Save_Global_References traverses the generic
543    --  tree, examines the semantic information, and preserves the links to
544    --  those nodes that contain global information. At instantiation, the
545    --  information from the associated node is placed on the new copy, so
546    --  that name resolution is not repeated.
547    --
548    --  Three kinds of source nodes have associated nodes:
549    --
550    --    a) those that can reference (denote) entities, that is identifiers,
551    --       character literals, expanded_names, operator symbols, operators,
552    --       and attribute reference nodes. These nodes have an Entity field
553    --       and are the set of nodes that are in N_Has_Entity.
554    --
555    --    b) aggregates (N_Aggregate and N_Extension_Aggregate)
556    --
557    --    c) selected components (N_Selected_Component)
558    --
559    --  For the first class, the associated node preserves the entity if it is
560    --  global. If the generic contains nested instantiations, the associated
561    --  node itself has been recopied, and a chain of them must be followed.
562    --
563    --  For aggregates, the associated node allows retrieval of the type, which
564    --  may otherwise not appear in the generic. The view of this type may be
565    --  different between generic and instantiation, and the full view can be
566    --  installed before the instantiation is analyzed. For aggregates of
567    --  type extensions, the same view exchange may have to be performed for
568    --  some of the ancestor types, if their view is private at the point of
569    --  instantiation.
570    --
571    --  Nodes that are selected components in the parse tree may be rewritten
572    --  as expanded names after resolution, and must be treated as potential
573    --  entity holders. which is why they also have an Associated_Node.
574    --
575    --  Nodes that do not come from source, such as freeze nodes, do not appear
576    --  in the generic tree, and need not have an associated node.
577    --
578    --  The associated node is stored in the Associated_Node field. Note that
579    --  this field overlaps Entity, which is fine, because the whole point is
580    --  that we don't need or want the normal Entity field in this situation.
581
582    procedure Move_Freeze_Nodes
583      (Out_Of : Entity_Id;
584       After  : Node_Id;
585       L      : List_Id);
586    --  Freeze nodes can be generated in the analysis of a generic unit, but
587    --  will not be seen by the back-end. It is necessary to move those nodes
588    --  to the enclosing scope if they freeze an outer entity. We place them
589    --  at the end of the enclosing generic package, which is semantically
590    --  neutral.
591
592    procedure Pre_Analyze_Actuals (N : Node_Id);
593    --  Analyze actuals to perform name resolution. Full resolution is done
594    --  later, when the expected types are known, but names have to be captured
595    --  before installing parents of generics, that are not visible for the
596    --  actuals themselves.
597
598    procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
599    --  Verify that an attribute that appears as the default for a formal
600    --  subprogram is a function or procedure with the correct profile.
601
602    -------------------------------------------
603    -- Data Structures for Generic Renamings --
604    -------------------------------------------
605
606    --  The map Generic_Renamings associates generic entities with their
607    --  corresponding actuals. Currently used to validate type instances.
608    --  It will eventually be used for all generic parameters to eliminate
609    --  the need for overload resolution in the instance.
610
611    type Assoc_Ptr is new Int;
612
613    Assoc_Null : constant Assoc_Ptr := -1;
614
615    type Assoc is record
616       Gen_Id         : Entity_Id;
617       Act_Id         : Entity_Id;
618       Next_In_HTable : Assoc_Ptr;
619    end record;
620
621    package Generic_Renamings is new Table.Table
622      (Table_Component_Type => Assoc,
623       Table_Index_Type     => Assoc_Ptr,
624       Table_Low_Bound      => 0,
625       Table_Initial        => 10,
626       Table_Increment      => 100,
627       Table_Name           => "Generic_Renamings");
628
629    --  Variable to hold enclosing instantiation. When the environment is
630    --  saved for a subprogram inlining, the corresponding Act_Id is empty.
631
632    Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
633
634    --  Hash table for associations
635
636    HTable_Size : constant := 37;
637    type HTable_Range is range 0 .. HTable_Size - 1;
638
639    procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
640    function  Next_Assoc     (E : Assoc_Ptr) return Assoc_Ptr;
641    function Get_Gen_Id      (E : Assoc_Ptr) return Entity_Id;
642    function Hash            (F : Entity_Id)   return HTable_Range;
643
644    package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
645       Header_Num => HTable_Range,
646       Element    => Assoc,
647       Elmt_Ptr   => Assoc_Ptr,
648       Null_Ptr   => Assoc_Null,
649       Set_Next   => Set_Next_Assoc,
650       Next       => Next_Assoc,
651       Key        => Entity_Id,
652       Get_Key    => Get_Gen_Id,
653       Hash       => Hash,
654       Equal      => "=");
655
656    Exchanged_Views : Elist_Id;
657    --  This list holds the private views that have been exchanged during
658    --  instantiation to restore the visibility of the generic declaration.
659    --  (see comments above). After instantiation, the current visibility is
660    --  reestablished by means of a traversal of this list.
661
662    Hidden_Entities : Elist_Id;
663    --  This list holds the entities of the current scope that are removed
664    --  from immediate visibility when instantiating a child unit. Their
665    --  visibility is restored in Remove_Parent.
666
667    --  Because instantiations can be recursive, the following must be saved
668    --  on entry and restored on exit from an instantiation (spec or body).
669    --  This is done by the two procedures Save_Env and Restore_Env. For
670    --  package and subprogram instantiations (but not for the body instances)
671    --  the action of Save_Env is done in two steps: Init_Env is called before
672    --  Check_Generic_Child_Unit, because setting the parent instances requires
673    --  that the visibility data structures be properly initialized. Once the
674    --  generic is unit is validated, Set_Instance_Env completes Save_Env.
675
676    type Instance_Env is record
677       Ada_Version         : Ada_Version_Type;
678       Instantiated_Parent : Assoc;
679       Exchanged_Views     : Elist_Id;
680       Hidden_Entities     : Elist_Id;
681       Current_Sem_Unit    : Unit_Number_Type;
682    end record;
683
684    package Instance_Envs is new Table.Table (
685      Table_Component_Type => Instance_Env,
686      Table_Index_Type     => Int,
687      Table_Low_Bound      => 0,
688      Table_Initial        => 32,
689      Table_Increment      => 100,
690      Table_Name           => "Instance_Envs");
691
692    procedure Restore_Private_Views
693      (Pack_Id    : Entity_Id;
694       Is_Package : Boolean := True);
695    --  Restore the private views of external types, and unmark the generic
696    --  renamings of actuals, so that they become comptible subtypes again.
697    --  For subprograms, Pack_Id is the package constructed to hold the
698    --  renamings.
699
700    procedure Switch_View (T : Entity_Id);
701    --  Switch the partial and full views of a type and its private
702    --  dependents (i.e. its subtypes and derived types).
703
704    ------------------------------------
705    -- Structures for Error Reporting --
706    ------------------------------------
707
708    Instantiation_Node : Node_Id;
709    --  Used by subprograms that validate instantiation of formal parameters
710    --  where there might be no actual on which to place the error message.
711    --  Also used to locate the instantiation node for generic subunits.
712
713    Instantiation_Error : exception;
714    --  When there is a semantic error in the generic parameter matching,
715    --  there is no point in continuing the instantiation, because the
716    --  number of cascaded errors is unpredictable. This exception aborts
717    --  the instantiation process altogether.
718
719    S_Adjustment : Sloc_Adjustment;
720    --  Offset created for each node in an instantiation, in order to keep
721    --  track of the source position of the instantiation in each of its nodes.
722    --  A subsequent semantic error or warning on a construct of the instance
723    --  points to both places: the original generic node, and the point of
724    --  instantiation. See Sinput and Sinput.L for additional details.
725
726    ------------------------------------------------------------
727    -- Data structure for keeping track when inside a Generic --
728    ------------------------------------------------------------
729
730    --  The following table is used to save values of the Inside_A_Generic
731    --  flag (see spec of Sem) when they are saved by Start_Generic.
732
733    package Generic_Flags is new Table.Table (
734      Table_Component_Type => Boolean,
735      Table_Index_Type     => Int,
736      Table_Low_Bound      => 0,
737      Table_Initial        => 32,
738      Table_Increment      => 200,
739      Table_Name           => "Generic_Flags");
740
741    ---------------------------
742    -- Abandon_Instantiation --
743    ---------------------------
744
745    procedure Abandon_Instantiation (N : Node_Id) is
746    begin
747       Error_Msg_N ("instantiation abandoned!", N);
748       raise Instantiation_Error;
749    end Abandon_Instantiation;
750
751    --------------------------
752    -- Analyze_Associations --
753    --------------------------
754
755    function Analyze_Associations
756      (I_Node  : Node_Id;
757       Formals : List_Id;
758       F_Copy  : List_Id)
759       return    List_Id
760    is
761       Actual_Types    : constant Elist_Id  := New_Elmt_List;
762       Assoc           : constant List_Id   := New_List;
763       Defaults        : constant Elist_Id  := New_Elmt_List;
764       Gen_Unit        : constant Entity_Id := Defining_Entity
765                                                 (Parent (F_Copy));
766       Actuals         : List_Id;
767       Actual          : Node_Id;
768       Formal          : Node_Id;
769       Next_Formal     : Node_Id;
770       Temp_Formal     : Node_Id;
771       Analyzed_Formal : Node_Id;
772       Match           : Node_Id;
773       Named           : Node_Id;
774       First_Named     : Node_Id := Empty;
775       Found_Assoc     : Node_Id;
776       Is_Named_Assoc  : Boolean;
777       Num_Matched     : Int := 0;
778       Num_Actuals     : Int := 0;
779
780       function Matching_Actual
781         (F    : Entity_Id;
782          A_F  : Entity_Id)
783          return Node_Id;
784       --  Find actual that corresponds to a given a formal parameter. If the
785       --  actuals are positional, return the next one, if any. If the actuals
786       --  are named, scan the parameter associations to find the right one.
787       --  A_F is the corresponding entity in the analyzed generic,which is
788       --  placed on the selector name for ASIS use.
789
790       procedure Set_Analyzed_Formal;
791       --  Find the node in the generic copy that corresponds to a given formal.
792       --  The semantic information on this node is used to perform legality
793       --  checks on the actuals. Because semantic analysis can introduce some
794       --  anonymous entities or modify the declaration node itself, the
795       --  correspondence between the two lists is not one-one. In addition to
796       --  anonymous types, the presence a formal equality will introduce an
797       --  implicit declaration for the corresponding inequality.
798
799       ---------------------
800       -- Matching_Actual --
801       ---------------------
802
803       function Matching_Actual
804         (F    : Entity_Id;
805          A_F  : Entity_Id)
806          return Node_Id
807       is
808          Found : Node_Id;
809          Prev  : Node_Id;
810
811       begin
812          Is_Named_Assoc := False;
813
814          --  End of list of purely positional parameters
815
816          if No (Actual) then
817             Found := Empty;
818
819          --  Case of positional parameter corresponding to current formal
820
821          elsif No (Selector_Name (Actual)) then
822             Found := Explicit_Generic_Actual_Parameter (Actual);
823             Found_Assoc := Actual;
824             Num_Matched := Num_Matched + 1;
825             Next (Actual);
826
827          --  Otherwise scan list of named actuals to find the one with the
828          --  desired name. All remaining actuals have explicit names.
829
830          else
831             Is_Named_Assoc := True;
832             Found := Empty;
833             Prev  := Empty;
834
835             while Present (Actual) loop
836                if Chars (Selector_Name (Actual)) = Chars (F) then
837                   Found := Explicit_Generic_Actual_Parameter (Actual);
838                   Set_Entity (Selector_Name (Actual), A_F);
839                   Set_Etype  (Selector_Name (Actual), Etype (A_F));
840                   Generate_Reference (A_F, Selector_Name (Actual));
841                   Found_Assoc := Actual;
842                   Num_Matched := Num_Matched + 1;
843                   exit;
844                end if;
845
846                Prev := Actual;
847                Next (Actual);
848             end loop;
849
850             --  Reset for subsequent searches. In most cases the named
851             --  associations are in order. If they are not, we reorder them
852             --  to avoid scanning twice the same actual. This is not just a
853             --  question of efficiency: there may be multiple defaults with
854             --  boxes that have the same name. In a nested instantiation we
855             --  insert actuals for those defaults, and cannot rely on their
856             --  names to disambiguate them.
857
858             if Actual = First_Named  then
859                Next (First_Named);
860
861             elsif Present (Actual) then
862                Insert_Before (First_Named, Remove_Next (Prev));
863             end if;
864
865             Actual := First_Named;
866          end if;
867
868          return Found;
869       end Matching_Actual;
870
871       -------------------------
872       -- Set_Analyzed_Formal --
873       -------------------------
874
875       procedure Set_Analyzed_Formal is
876          Kind : Node_Kind;
877       begin
878          while Present (Analyzed_Formal) loop
879             Kind := Nkind (Analyzed_Formal);
880
881             case Nkind (Formal) is
882
883                when N_Formal_Subprogram_Declaration =>
884                   exit when Kind = N_Formal_Subprogram_Declaration
885                     and then
886                       Chars
887                         (Defining_Unit_Name (Specification (Formal))) =
888                       Chars
889                         (Defining_Unit_Name (Specification (Analyzed_Formal)));
890
891                when N_Formal_Package_Declaration =>
892                   exit when
893                     Kind = N_Formal_Package_Declaration
894                       or else
895                     Kind = N_Generic_Package_Declaration;
896
897                when N_Use_Package_Clause | N_Use_Type_Clause => exit;
898
899                when others =>
900
901                   --  Skip freeze nodes, and nodes inserted to replace
902                   --  unrecognized pragmas.
903
904                   exit when
905                     Kind /= N_Formal_Subprogram_Declaration
906                       and then Kind /= N_Subprogram_Declaration
907                       and then Kind /= N_Freeze_Entity
908                       and then Kind /= N_Null_Statement
909                       and then Kind /= N_Itype_Reference
910                       and then Chars (Defining_Identifier (Formal)) =
911                                Chars (Defining_Identifier (Analyzed_Formal));
912             end case;
913
914             Next (Analyzed_Formal);
915          end loop;
916
917       end Set_Analyzed_Formal;
918
919    --  Start of processing for Analyze_Associations
920
921    begin
922       --  If named associations are present, save the first named association
923       --  (it may of course be Empty) to facilitate subsequent name search.
924
925       Actuals := Generic_Associations (I_Node);
926
927       if Present (Actuals) then
928          First_Named := First (Actuals);
929
930          while Present (First_Named)
931            and then No (Selector_Name (First_Named))
932          loop
933             Num_Actuals := Num_Actuals + 1;
934             Next (First_Named);
935          end loop;
936       end if;
937
938       Named := First_Named;
939       while Present (Named) loop
940          if No (Selector_Name (Named)) then
941             Error_Msg_N ("invalid positional actual after named one", Named);
942             Abandon_Instantiation (Named);
943          end if;
944
945          --  A named association may lack an actual parameter, if it was
946          --  introduced for a default subprogram that turns out to be local
947          --  to the outer instantiation.
948
949          if Present (Explicit_Generic_Actual_Parameter (Named)) then
950             Num_Actuals := Num_Actuals + 1;
951          end if;
952
953          Next (Named);
954       end loop;
955
956       if Present (Formals) then
957          Formal := First_Non_Pragma (Formals);
958          Analyzed_Formal := First_Non_Pragma (F_Copy);
959
960          if Present (Actuals) then
961             Actual := First (Actuals);
962
963          --  All formals should have default values
964
965          else
966             Actual := Empty;
967          end if;
968
969          while Present (Formal) loop
970             Set_Analyzed_Formal;
971             Next_Formal := Next_Non_Pragma (Formal);
972
973             case Nkind (Formal) is
974                when N_Formal_Object_Declaration =>
975                   Match :=
976                     Matching_Actual (
977                       Defining_Identifier (Formal),
978                       Defining_Identifier (Analyzed_Formal));
979
980                   Append_List
981                     (Instantiate_Object (Formal, Match, Analyzed_Formal),
982                      Assoc);
983
984                when N_Formal_Type_Declaration =>
985                   Match :=
986                     Matching_Actual (
987                       Defining_Identifier (Formal),
988                       Defining_Identifier (Analyzed_Formal));
989
990                   if No (Match) then
991                      Error_Msg_Sloc := Sloc (Gen_Unit);
992                      Error_Msg_NE
993                        ("missing actual&",
994                          Instantiation_Node, Defining_Identifier (Formal));
995                      Error_Msg_NE ("\in instantiation of & declared#",
996                          Instantiation_Node, Gen_Unit);
997                      Abandon_Instantiation (Instantiation_Node);
998
999                   else
1000                      Analyze (Match);
1001                      Append_To (Assoc,
1002                        Instantiate_Type
1003                          (Formal, Match, Analyzed_Formal, Assoc));
1004
1005                      --  an instantiation is a freeze point for the actuals,
1006                      --  unless this is a rewritten formal package.
1007
1008                      if Nkind (I_Node) /= N_Formal_Package_Declaration then
1009                         Append_Elmt (Entity (Match), Actual_Types);
1010                      end if;
1011                   end if;
1012
1013                   --  A remote access-to-class-wide type must not be an
1014                   --  actual parameter for a generic formal of an access
1015                   --  type (E.2.2 (17)).
1016
1017                   if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1018                     and then
1019                       Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1020                                             N_Access_To_Object_Definition
1021                   then
1022                      Validate_Remote_Access_To_Class_Wide_Type (Match);
1023                   end if;
1024
1025                when N_Formal_Subprogram_Declaration =>
1026                   Match :=
1027                     Matching_Actual (
1028                       Defining_Unit_Name (Specification (Formal)),
1029                       Defining_Unit_Name (Specification (Analyzed_Formal)));
1030
1031                   --  If the formal subprogram has the same name as
1032                   --  another formal subprogram of the generic, then
1033                   --  a named association is illegal (12.3(9)). Exclude
1034                   --  named associations that are generated for a nested
1035                   --  instance.
1036
1037                   if Present (Match)
1038                     and then Is_Named_Assoc
1039                     and then Comes_From_Source (Found_Assoc)
1040                   then
1041                      Temp_Formal := First (Formals);
1042                      while Present (Temp_Formal) loop
1043                         if Nkind (Temp_Formal) =
1044                              N_Formal_Subprogram_Declaration
1045                           and then Temp_Formal /= Formal
1046                           and then
1047                             Chars (Selector_Name (Found_Assoc)) =
1048                               Chars (Defining_Unit_Name
1049                                        (Specification (Temp_Formal)))
1050                         then
1051                            Error_Msg_N
1052                              ("name not allowed for overloaded formal",
1053                               Found_Assoc);
1054                            Abandon_Instantiation (Instantiation_Node);
1055                         end if;
1056
1057                         Next (Temp_Formal);
1058                      end loop;
1059                   end if;
1060
1061                   Append_To (Assoc,
1062                     Instantiate_Formal_Subprogram
1063                       (Formal, Match, Analyzed_Formal));
1064
1065                   if No (Match)
1066                     and then Box_Present (Formal)
1067                   then
1068                      Append_Elmt
1069                        (Defining_Unit_Name (Specification (Last (Assoc))),
1070                          Defaults);
1071                   end if;
1072
1073                when N_Formal_Package_Declaration =>
1074                   Match :=
1075                     Matching_Actual (
1076                       Defining_Identifier (Formal),
1077                       Defining_Identifier (Original_Node (Analyzed_Formal)));
1078
1079                   if No (Match) then
1080                      Error_Msg_Sloc := Sloc (Gen_Unit);
1081                      Error_Msg_NE
1082                        ("missing actual&",
1083                          Instantiation_Node, Defining_Identifier (Formal));
1084                      Error_Msg_NE ("\in instantiation of & declared#",
1085                          Instantiation_Node, Gen_Unit);
1086
1087                      Abandon_Instantiation (Instantiation_Node);
1088
1089                   else
1090                      Analyze (Match);
1091                      Append_List
1092                        (Instantiate_Formal_Package
1093                          (Formal, Match, Analyzed_Formal),
1094                         Assoc);
1095                   end if;
1096
1097                --  For use type and use package appearing in the context
1098                --  clause, we have already copied them, so we can just
1099                --  move them where they belong (we mustn't recopy them
1100                --  since this would mess up the Sloc values).
1101
1102                when N_Use_Package_Clause |
1103                     N_Use_Type_Clause    =>
1104                   Remove (Formal);
1105                   Append (Formal, Assoc);
1106
1107                when others =>
1108                   raise Program_Error;
1109
1110             end case;
1111
1112             Formal := Next_Formal;
1113             Next_Non_Pragma (Analyzed_Formal);
1114          end loop;
1115
1116          if Num_Actuals > Num_Matched then
1117             Error_Msg_Sloc := Sloc (Gen_Unit);
1118
1119             if Present (Selector_Name (Actual)) then
1120                Error_Msg_NE
1121                  ("unmatched actual&",
1122                     Actual, Selector_Name (Actual));
1123                Error_Msg_NE ("\in instantiation of& declared#",
1124                     Actual, Gen_Unit);
1125             else
1126                Error_Msg_NE
1127                  ("unmatched actual in instantiation of& declared#",
1128                    Actual, Gen_Unit);
1129             end if;
1130          end if;
1131
1132       elsif Present (Actuals) then
1133          Error_Msg_N
1134            ("too many actuals in generic instantiation", Instantiation_Node);
1135       end if;
1136
1137       declare
1138          Elmt : Elmt_Id := First_Elmt (Actual_Types);
1139
1140       begin
1141          while Present (Elmt) loop
1142             Freeze_Before (I_Node, Node (Elmt));
1143             Next_Elmt (Elmt);
1144          end loop;
1145       end;
1146
1147       --  If there are default subprograms, normalize the tree by adding
1148       --  explicit associations for them. This is required if the instance
1149       --  appears within a generic.
1150
1151       declare
1152          Elmt  : Elmt_Id;
1153          Subp  : Entity_Id;
1154          New_D : Node_Id;
1155
1156       begin
1157          Elmt := First_Elmt (Defaults);
1158          while Present (Elmt) loop
1159             if No (Actuals) then
1160                Actuals := New_List;
1161                Set_Generic_Associations (I_Node, Actuals);
1162             end if;
1163
1164             Subp := Node (Elmt);
1165             New_D :=
1166               Make_Generic_Association (Sloc (Subp),
1167                 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1168                   Explicit_Generic_Actual_Parameter =>
1169                     New_Occurrence_Of (Subp, Sloc (Subp)));
1170             Mark_Rewrite_Insertion (New_D);
1171             Append_To (Actuals, New_D);
1172             Next_Elmt (Elmt);
1173          end loop;
1174       end;
1175
1176       return Assoc;
1177    end Analyze_Associations;
1178
1179    -------------------------------
1180    -- Analyze_Formal_Array_Type --
1181    -------------------------------
1182
1183    procedure Analyze_Formal_Array_Type
1184      (T   : in out Entity_Id;
1185       Def : Node_Id)
1186    is
1187       DSS : Node_Id;
1188
1189    begin
1190       --  Treated like a non-generic array declaration, with
1191       --  additional semantic checks.
1192
1193       Enter_Name (T);
1194
1195       if Nkind (Def) = N_Constrained_Array_Definition then
1196          DSS := First (Discrete_Subtype_Definitions (Def));
1197          while Present (DSS) loop
1198             if Nkind (DSS) = N_Subtype_Indication
1199               or else Nkind (DSS) = N_Range
1200               or else Nkind (DSS) = N_Attribute_Reference
1201             then
1202                Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1203             end if;
1204
1205             Next (DSS);
1206          end loop;
1207       end if;
1208
1209       Array_Type_Declaration (T, Def);
1210       Set_Is_Generic_Type (Base_Type (T));
1211
1212       if Ekind (Component_Type (T)) = E_Incomplete_Type
1213         and then No (Full_View (Component_Type (T)))
1214       then
1215          Error_Msg_N ("premature usage of incomplete type", Def);
1216
1217       elsif Is_Internal (Component_Type (T))
1218         and then Nkind (Original_Node
1219                         (Subtype_Indication (Component_Definition (Def))))
1220           /= N_Attribute_Reference
1221       then
1222          Error_Msg_N
1223            ("only a subtype mark is allowed in a formal",
1224               Subtype_Indication (Component_Definition (Def)));
1225       end if;
1226
1227    end Analyze_Formal_Array_Type;
1228
1229    ---------------------------------------------
1230    -- Analyze_Formal_Decimal_Fixed_Point_Type --
1231    ---------------------------------------------
1232
1233    --  As for other generic types, we create a valid type representation
1234    --  with legal but arbitrary attributes, whose values are never considered
1235    --  static. For all scalar types we introduce an anonymous base type, with
1236    --  the same attributes. We choose the corresponding integer type to be
1237    --  Standard_Integer.
1238
1239    procedure Analyze_Formal_Decimal_Fixed_Point_Type
1240      (T   : Entity_Id;
1241       Def : Node_Id)
1242    is
1243       Loc       : constant Source_Ptr := Sloc (Def);
1244       Base      : constant Entity_Id :=
1245                     New_Internal_Entity
1246                       (E_Decimal_Fixed_Point_Type,
1247                        Current_Scope, Sloc (Def), 'G');
1248       Int_Base  : constant Entity_Id := Standard_Integer;
1249       Delta_Val : constant Ureal := Ureal_1;
1250       Digs_Val  : constant Uint  := Uint_6;
1251
1252    begin
1253       Enter_Name (T);
1254
1255       Set_Etype          (Base, Base);
1256       Set_Size_Info      (Base, Int_Base);
1257       Set_RM_Size        (Base, RM_Size (Int_Base));
1258       Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1259       Set_Digits_Value   (Base, Digs_Val);
1260       Set_Delta_Value    (Base, Delta_Val);
1261       Set_Small_Value    (Base, Delta_Val);
1262       Set_Scalar_Range   (Base,
1263         Make_Range (Loc,
1264           Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
1265           High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1266
1267       Set_Is_Generic_Type (Base);
1268       Set_Parent          (Base, Parent (Def));
1269
1270       Set_Ekind          (T, E_Decimal_Fixed_Point_Subtype);
1271       Set_Etype          (T, Base);
1272       Set_Size_Info      (T, Int_Base);
1273       Set_RM_Size        (T, RM_Size (Int_Base));
1274       Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1275       Set_Digits_Value   (T, Digs_Val);
1276       Set_Delta_Value    (T, Delta_Val);
1277       Set_Small_Value    (T, Delta_Val);
1278       Set_Scalar_Range   (T, Scalar_Range (Base));
1279
1280       Check_Restriction (No_Fixed_Point, Def);
1281    end Analyze_Formal_Decimal_Fixed_Point_Type;
1282
1283    ---------------------------------
1284    -- Analyze_Formal_Derived_Type --
1285    ---------------------------------
1286
1287    procedure Analyze_Formal_Derived_Type
1288      (N   : Node_Id;
1289       T   : Entity_Id;
1290       Def : Node_Id)
1291    is
1292       Loc      : constant Source_Ptr := Sloc (Def);
1293       Unk_Disc : constant Boolean    := Unknown_Discriminants_Present (N);
1294       New_N    : Node_Id;
1295
1296    begin
1297       Set_Is_Generic_Type (T);
1298
1299       if Private_Present (Def) then
1300          New_N :=
1301            Make_Private_Extension_Declaration (Loc,
1302              Defining_Identifier           => T,
1303              Discriminant_Specifications   => Discriminant_Specifications (N),
1304              Unknown_Discriminants_Present => Unk_Disc,
1305              Subtype_Indication            => Subtype_Mark (Def));
1306
1307          Set_Abstract_Present (New_N, Abstract_Present (Def));
1308
1309       else
1310          New_N :=
1311            Make_Full_Type_Declaration (Loc,
1312              Defining_Identifier => T,
1313              Discriminant_Specifications =>
1314                Discriminant_Specifications (Parent (T)),
1315               Type_Definition =>
1316                 Make_Derived_Type_Definition (Loc,
1317                   Subtype_Indication => Subtype_Mark (Def)));
1318
1319          Set_Abstract_Present
1320            (Type_Definition (New_N), Abstract_Present (Def));
1321       end if;
1322
1323       Rewrite (N, New_N);
1324       Analyze (N);
1325
1326       if Unk_Disc then
1327          if not Is_Composite_Type (T) then
1328             Error_Msg_N
1329               ("unknown discriminants not allowed for elementary types", N);
1330          else
1331             Set_Has_Unknown_Discriminants (T);
1332             Set_Is_Constrained (T, False);
1333          end if;
1334       end if;
1335
1336       --  If the parent type has a known size, so does the formal, which
1337       --  makes legal representation clauses that involve the formal.
1338
1339       Set_Size_Known_At_Compile_Time
1340         (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1341
1342    end Analyze_Formal_Derived_Type;
1343
1344    ----------------------------------
1345    -- Analyze_Formal_Discrete_Type --
1346    ----------------------------------
1347
1348    --  The operations defined for a discrete types are those of an
1349    --  enumeration type. The size is set to an arbitrary value, for use
1350    --  in analyzing the generic unit.
1351
1352    procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1353       Loc : constant Source_Ptr := Sloc (Def);
1354       Lo  : Node_Id;
1355       Hi  : Node_Id;
1356
1357    begin
1358       Enter_Name     (T);
1359       Set_Ekind      (T, E_Enumeration_Type);
1360       Set_Etype      (T, T);
1361       Init_Size      (T, 8);
1362       Init_Alignment (T);
1363
1364       --  For semantic analysis, the bounds of the type must be set to some
1365       --  non-static value. The simplest is to create attribute nodes for
1366       --  those bounds, that refer to the type itself. These bounds are never
1367       --  analyzed but serve as place-holders.
1368
1369       Lo :=
1370         Make_Attribute_Reference (Loc,
1371           Attribute_Name => Name_First,
1372           Prefix => New_Reference_To (T, Loc));
1373       Set_Etype (Lo, T);
1374
1375       Hi :=
1376         Make_Attribute_Reference (Loc,
1377           Attribute_Name => Name_Last,
1378           Prefix => New_Reference_To (T, Loc));
1379       Set_Etype (Hi, T);
1380
1381       Set_Scalar_Range (T,
1382         Make_Range (Loc,
1383           Low_Bound => Lo,
1384           High_Bound => Hi));
1385
1386    end Analyze_Formal_Discrete_Type;
1387
1388    ----------------------------------
1389    -- Analyze_Formal_Floating_Type --
1390    ---------------------------------
1391
1392    procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1393       Base : constant Entity_Id :=
1394                New_Internal_Entity
1395                  (E_Floating_Point_Type, Current_Scope, Sloc (Def), 'G');
1396
1397    begin
1398       --  The various semantic attributes are taken from the predefined type
1399       --  Float, just so that all of them are initialized. Their values are
1400       --  never used because no constant folding or expansion takes place in
1401       --  the generic itself.
1402
1403       Enter_Name (T);
1404       Set_Ekind        (T, E_Floating_Point_Subtype);
1405       Set_Etype        (T, Base);
1406       Set_Size_Info    (T,              (Standard_Float));
1407       Set_RM_Size      (T, RM_Size      (Standard_Float));
1408       Set_Digits_Value (T, Digits_Value (Standard_Float));
1409       Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1410
1411       Set_Is_Generic_Type (Base);
1412       Set_Etype           (Base, Base);
1413       Set_Size_Info       (Base,              (Standard_Float));
1414       Set_RM_Size         (Base, RM_Size      (Standard_Float));
1415       Set_Digits_Value    (Base, Digits_Value (Standard_Float));
1416       Set_Scalar_Range    (Base, Scalar_Range (Standard_Float));
1417       Set_Parent          (Base, Parent (Def));
1418
1419       Check_Restriction (No_Floating_Point, Def);
1420    end Analyze_Formal_Floating_Type;
1421
1422    ---------------------------------
1423    -- Analyze_Formal_Modular_Type --
1424    ---------------------------------
1425
1426    procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
1427    begin
1428       --  Apart from their entity kind, generic modular types are treated
1429       --  like signed integer types, and have the same attributes.
1430
1431       Analyze_Formal_Signed_Integer_Type (T, Def);
1432       Set_Ekind (T, E_Modular_Integer_Subtype);
1433       Set_Ekind (Etype (T), E_Modular_Integer_Type);
1434
1435    end Analyze_Formal_Modular_Type;
1436
1437    ---------------------------------------
1438    -- Analyze_Formal_Object_Declaration --
1439    ---------------------------------------
1440
1441    procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
1442       E  : constant Node_Id := Expression (N);
1443       Id : constant Node_Id := Defining_Identifier (N);
1444       K  : Entity_Kind;
1445       T  : Node_Id;
1446
1447    begin
1448       Enter_Name (Id);
1449
1450       --  Determine the mode of the formal object
1451
1452       if Out_Present (N) then
1453          K := E_Generic_In_Out_Parameter;
1454
1455          if not In_Present (N) then
1456             Error_Msg_N ("formal generic objects cannot have mode OUT", N);
1457          end if;
1458
1459       else
1460          K := E_Generic_In_Parameter;
1461       end if;
1462
1463       Find_Type (Subtype_Mark (N));
1464       T  := Entity (Subtype_Mark (N));
1465
1466       if Ekind (T) = E_Incomplete_Type then
1467          Error_Msg_N ("premature usage of incomplete type", Subtype_Mark (N));
1468       end if;
1469
1470       if K = E_Generic_In_Parameter then
1471
1472          --  Ada 2005 (AI-287): Limited aggregates allowed in generic formals
1473
1474          if Ada_Version < Ada_05 and then Is_Limited_Type (T) then
1475             Error_Msg_N
1476               ("generic formal of mode IN must not be of limited type", N);
1477             Explain_Limited_Type (T, N);
1478          end if;
1479
1480          if Is_Abstract (T) then
1481             Error_Msg_N
1482               ("generic formal of mode IN must not be of abstract type", N);
1483          end if;
1484
1485          if Present (E) then
1486             Analyze_Per_Use_Expression (E, T);
1487          end if;
1488
1489          Set_Ekind (Id, K);
1490          Set_Etype (Id, T);
1491
1492       --  Case of generic IN OUT parameter.
1493
1494       else
1495          --  If the formal has an unconstrained type, construct its
1496          --  actual subtype, as is done for subprogram formals. In this
1497          --  fashion, all its uses can refer to specific bounds.
1498
1499          Set_Ekind (Id, K);
1500          Set_Etype (Id, T);
1501
1502          if (Is_Array_Type (T)
1503               and then not Is_Constrained (T))
1504            or else
1505             (Ekind (T) = E_Record_Type
1506               and then Has_Discriminants (T))
1507          then
1508             declare
1509                Non_Freezing_Ref : constant Node_Id :=
1510                                     New_Reference_To (Id, Sloc (Id));
1511                Decl : Node_Id;
1512
1513             begin
1514                --  Make sure that the actual subtype doesn't generate
1515                --  bogus freezing.
1516
1517                Set_Must_Not_Freeze (Non_Freezing_Ref);
1518                Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
1519                Insert_Before_And_Analyze (N, Decl);
1520                Set_Actual_Subtype (Id, Defining_Identifier (Decl));
1521             end;
1522          else
1523             Set_Actual_Subtype (Id, T);
1524          end if;
1525
1526          if Present (E) then
1527             Error_Msg_N
1528               ("initialization not allowed for `IN OUT` formals", N);
1529          end if;
1530       end if;
1531
1532    end Analyze_Formal_Object_Declaration;
1533
1534    ----------------------------------------------
1535    -- Analyze_Formal_Ordinary_Fixed_Point_Type --
1536    ----------------------------------------------
1537
1538    procedure Analyze_Formal_Ordinary_Fixed_Point_Type
1539      (T   : Entity_Id;
1540       Def : Node_Id)
1541    is
1542       Loc  : constant Source_Ptr := Sloc (Def);
1543       Base : constant Entity_Id :=
1544                New_Internal_Entity
1545                  (E_Ordinary_Fixed_Point_Type, Current_Scope, Sloc (Def), 'G');
1546    begin
1547       --  The semantic attributes are set for completeness only, their
1548       --  values will never be used, because all properties of the type
1549       --  are non-static.
1550
1551       Enter_Name (T);
1552       Set_Ekind            (T, E_Ordinary_Fixed_Point_Subtype);
1553       Set_Etype            (T, Base);
1554       Set_Size_Info        (T, Standard_Integer);
1555       Set_RM_Size          (T, RM_Size (Standard_Integer));
1556       Set_Small_Value      (T, Ureal_1);
1557       Set_Delta_Value      (T, Ureal_1);
1558       Set_Scalar_Range     (T,
1559         Make_Range (Loc,
1560           Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
1561           High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1562
1563       Set_Is_Generic_Type (Base);
1564       Set_Etype           (Base, Base);
1565       Set_Size_Info       (Base, Standard_Integer);
1566       Set_RM_Size         (Base, RM_Size (Standard_Integer));
1567       Set_Small_Value     (Base, Ureal_1);
1568       Set_Delta_Value     (Base, Ureal_1);
1569       Set_Scalar_Range    (Base, Scalar_Range (T));
1570       Set_Parent          (Base, Parent (Def));
1571
1572       Check_Restriction (No_Fixed_Point, Def);
1573    end Analyze_Formal_Ordinary_Fixed_Point_Type;
1574
1575    ----------------------------
1576    -- Analyze_Formal_Package --
1577    ----------------------------
1578
1579    procedure Analyze_Formal_Package (N : Node_Id) is
1580       Loc              : constant Source_Ptr := Sloc (N);
1581       Pack_Id          : constant Entity_Id := Defining_Identifier (N);
1582       Formal           : Entity_Id;
1583       Gen_Id           : constant Node_Id    := Name (N);
1584       Gen_Decl         : Node_Id;
1585       Gen_Unit         : Entity_Id;
1586       New_N            : Node_Id;
1587       Parent_Installed : Boolean := False;
1588       Renaming         : Node_Id;
1589       Parent_Instance  : Entity_Id;
1590       Renaming_In_Par  : Entity_Id;
1591
1592    begin
1593       Text_IO_Kludge (Gen_Id);
1594
1595       Init_Env;
1596       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
1597       Gen_Unit := Entity (Gen_Id);
1598
1599       if Ekind (Gen_Unit) /= E_Generic_Package then
1600          Error_Msg_N ("expect generic package name", Gen_Id);
1601          Restore_Env;
1602          return;
1603
1604       elsif  Gen_Unit = Current_Scope then
1605          Error_Msg_N
1606            ("generic package cannot be used as a formal package of itself",
1607              Gen_Id);
1608          Restore_Env;
1609          return;
1610
1611       elsif In_Open_Scopes (Gen_Unit) then
1612          if Is_Compilation_Unit (Gen_Unit)
1613            and then Is_Child_Unit (Current_Scope)
1614          then
1615             --  Special-case the error when the formal is a parent, and
1616             --  continue analysis to minimize cascaded errors.
1617
1618             Error_Msg_N
1619               ("generic parent cannot be used as formal package "
1620                 & "of a child unit",
1621                 Gen_Id);
1622
1623          else
1624             Error_Msg_N
1625               ("generic package cannot be used as a formal package "
1626                 & "within itself",
1627                 Gen_Id);
1628             Restore_Env;
1629             return;
1630          end if;
1631       end if;
1632
1633       --  Check for a formal package that is a package renaming.
1634
1635       if Present (Renamed_Object (Gen_Unit)) then
1636          Gen_Unit := Renamed_Object (Gen_Unit);
1637       end if;
1638
1639       --  The formal package is treated like a regular instance, but only
1640       --  the specification needs to be instantiated, to make entities visible.
1641
1642       if not Box_Present (N) then
1643          Hidden_Entities := New_Elmt_List;
1644          Analyze_Package_Instantiation (N);
1645
1646          if Parent_Installed then
1647             Remove_Parent;
1648          end if;
1649
1650       else
1651          --  If there are no generic associations, the generic parameters
1652          --  appear as local entities and are instantiated like them. We copy
1653          --  the generic package declaration as if it were an instantiation,
1654          --  and analyze it like a regular package, except that we treat the
1655          --  formals as additional visible components.
1656
1657          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
1658
1659          if In_Extended_Main_Source_Unit (N) then
1660             Set_Is_Instantiated (Gen_Unit);
1661             Generate_Reference  (Gen_Unit, N);
1662          end if;
1663
1664          Formal := New_Copy (Pack_Id);
1665          New_N :=
1666            Copy_Generic_Node
1667              (Original_Node (Gen_Decl), Empty, Instantiating => True);
1668          Rewrite (N, New_N);
1669          Set_Defining_Unit_Name (Specification (New_N), Formal);
1670          Set_Instance_Env (Gen_Unit, Formal);
1671
1672          Enter_Name (Formal);
1673          Set_Ekind  (Formal, E_Generic_Package);
1674          Set_Etype  (Formal, Standard_Void_Type);
1675          Set_Inner_Instances (Formal, New_Elmt_List);
1676          New_Scope  (Formal);
1677
1678          --  Within the formal, the name of the generic package is a renaming
1679          --  of the formal (as for a regular instantiation).
1680
1681          Renaming := Make_Package_Renaming_Declaration (Loc,
1682              Defining_Unit_Name =>
1683                Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
1684              Name => New_Reference_To (Formal, Loc));
1685
1686          if Present (Visible_Declarations (Specification (N))) then
1687             Prepend (Renaming, To => Visible_Declarations (Specification (N)));
1688          elsif Present (Private_Declarations (Specification (N))) then
1689             Prepend (Renaming, To => Private_Declarations (Specification (N)));
1690          end if;
1691
1692          if Is_Child_Unit (Gen_Unit)
1693            and then Parent_Installed
1694          then
1695             --  Similarly, we have to make the name of the formal visible in
1696             --  the parent instance, to resolve properly fully qualified names
1697             --  that may appear in the generic unit. The parent instance has
1698             --  been placed on the scope stack ahead of the current scope.
1699
1700             Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
1701
1702             Renaming_In_Par :=
1703               Make_Defining_Identifier (Loc, Chars (Gen_Unit));
1704             Set_Ekind (Renaming_In_Par, E_Package);
1705             Set_Etype (Renaming_In_Par, Standard_Void_Type);
1706             Set_Scope (Renaming_In_Par, Parent_Instance);
1707             Set_Parent (Renaming_In_Par, Parent (Formal));
1708             Set_Renamed_Object (Renaming_In_Par, Formal);
1709             Append_Entity (Renaming_In_Par, Parent_Instance);
1710          end if;
1711
1712          Analyze_Generic_Formal_Part (N);
1713          Analyze (Specification (N));
1714          End_Package_Scope (Formal);
1715
1716          if Parent_Installed then
1717             Remove_Parent;
1718          end if;
1719
1720          Restore_Env;
1721
1722          --  Inside the generic unit, the formal package is a regular
1723          --  package, but no body is needed for it. Note that after
1724          --  instantiation, the defining_unit_name we need is in the
1725          --  new tree and not in the original. (see Package_Instantiation).
1726          --  A generic formal package is an instance, and can be used as
1727          --  an actual for an inner instance. Mark its generic parent.
1728
1729          Set_Ekind (Formal, E_Package);
1730          Set_Generic_Parent (Specification (N), Gen_Unit);
1731          Set_Has_Completion (Formal, True);
1732
1733          Set_Ekind (Pack_Id, E_Package);
1734          Set_Etype (Pack_Id, Standard_Void_Type);
1735          Set_Scope (Pack_Id, Scope (Formal));
1736          Set_Has_Completion (Pack_Id, True);
1737       end if;
1738    end Analyze_Formal_Package;
1739
1740    ---------------------------------
1741    -- Analyze_Formal_Private_Type --
1742    ---------------------------------
1743
1744    procedure Analyze_Formal_Private_Type
1745      (N   : Node_Id;
1746       T   : Entity_Id;
1747       Def : Node_Id)
1748    is
1749    begin
1750       New_Private_Type (N, T, Def);
1751
1752       --  Set the size to an arbitrary but legal value.
1753
1754       Set_Size_Info (T, Standard_Integer);
1755       Set_RM_Size   (T, RM_Size (Standard_Integer));
1756    end Analyze_Formal_Private_Type;
1757
1758    ----------------------------------------
1759    -- Analyze_Formal_Signed_Integer_Type --
1760    ----------------------------------------
1761
1762    procedure Analyze_Formal_Signed_Integer_Type
1763      (T   : Entity_Id;
1764       Def : Node_Id)
1765    is
1766       Base : constant Entity_Id :=
1767                New_Internal_Entity
1768                  (E_Signed_Integer_Type, Current_Scope, Sloc (Def), 'G');
1769
1770    begin
1771       Enter_Name (T);
1772
1773       Set_Ekind        (T, E_Signed_Integer_Subtype);
1774       Set_Etype        (T, Base);
1775       Set_Size_Info    (T, Standard_Integer);
1776       Set_RM_Size      (T, RM_Size (Standard_Integer));
1777       Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
1778
1779       Set_Is_Generic_Type (Base);
1780       Set_Size_Info       (Base, Standard_Integer);
1781       Set_RM_Size         (Base, RM_Size (Standard_Integer));
1782       Set_Etype           (Base, Base);
1783       Set_Scalar_Range    (Base, Scalar_Range (Standard_Integer));
1784       Set_Parent          (Base, Parent (Def));
1785    end Analyze_Formal_Signed_Integer_Type;
1786
1787    -------------------------------
1788    -- Analyze_Formal_Subprogram --
1789    -------------------------------
1790
1791    procedure Analyze_Formal_Subprogram (N : Node_Id) is
1792       Spec : constant Node_Id   := Specification (N);
1793       Def  : constant Node_Id   := Default_Name (N);
1794       Nam  : constant Entity_Id := Defining_Unit_Name (Spec);
1795       Subp : Entity_Id;
1796
1797    begin
1798       if Nam = Error then
1799          return;
1800       end if;
1801
1802       if Nkind (Nam) = N_Defining_Program_Unit_Name then
1803          Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
1804          return;
1805       end if;
1806
1807       Analyze_Subprogram_Declaration (N);
1808       Set_Is_Formal_Subprogram (Nam);
1809       Set_Has_Completion (Nam);
1810
1811       --  Default name is resolved at the point of instantiation
1812
1813       if Box_Present (N) then
1814          null;
1815
1816       --  Else default is bound at the point of generic declaration
1817
1818       elsif Present (Def) then
1819          if Nkind (Def) = N_Operator_Symbol then
1820             Find_Direct_Name (Def);
1821
1822          elsif Nkind (Def) /= N_Attribute_Reference then
1823             Analyze (Def);
1824
1825          else
1826             --  For an attribute reference, analyze the prefix and verify
1827             --  that it has the proper profile for the subprogram.
1828
1829             Analyze (Prefix (Def));
1830             Valid_Default_Attribute (Nam, Def);
1831             return;
1832          end if;
1833
1834          --  Default name may be overloaded, in which case the interpretation
1835          --  with the correct profile must be  selected, as for a renaming.
1836
1837          if Etype (Def) = Any_Type then
1838             return;
1839
1840          elsif Nkind (Def) = N_Selected_Component then
1841             Subp := Entity (Selector_Name (Def));
1842
1843             if Ekind (Subp) /= E_Entry then
1844                Error_Msg_N ("expect valid subprogram name as default", Def);
1845                return;
1846             end if;
1847
1848          elsif Nkind (Def) = N_Indexed_Component then
1849
1850             if  Nkind (Prefix (Def)) /= N_Selected_Component then
1851                Error_Msg_N ("expect valid subprogram name as default", Def);
1852                return;
1853
1854             else
1855                Subp := Entity (Selector_Name (Prefix (Def)));
1856
1857                if Ekind (Subp) /= E_Entry_Family then
1858                   Error_Msg_N ("expect valid subprogram name as default", Def);
1859                   return;
1860                end if;
1861             end if;
1862
1863          elsif Nkind (Def) = N_Character_Literal then
1864
1865             --  Needs some type checks: subprogram should be parameterless???
1866
1867             Resolve (Def, (Etype (Nam)));
1868
1869          elsif not Is_Entity_Name (Def)
1870            or else not Is_Overloadable (Entity (Def))
1871          then
1872             Error_Msg_N ("expect valid subprogram name as default", Def);
1873             return;
1874
1875          elsif not Is_Overloaded (Def) then
1876             Subp := Entity (Def);
1877
1878             if Subp = Nam then
1879                Error_Msg_N ("premature usage of formal subprogram", Def);
1880
1881             elsif not Entity_Matches_Spec (Subp, Nam) then
1882                Error_Msg_N ("no visible entity matches specification", Def);
1883             end if;
1884
1885          else
1886             declare
1887                I   : Interp_Index;
1888                I1  : Interp_Index := 0;
1889                It  : Interp;
1890                It1 : Interp;
1891
1892             begin
1893                Subp := Any_Id;
1894                Get_First_Interp (Def, I, It);
1895                while Present (It.Nam) loop
1896
1897                   if Entity_Matches_Spec (It.Nam, Nam) then
1898                      if Subp /= Any_Id then
1899                         It1 := Disambiguate (Def, I1, I, Etype (Subp));
1900
1901                         if It1 = No_Interp then
1902                            Error_Msg_N ("ambiguous default subprogram", Def);
1903                         else
1904                            Subp := It1.Nam;
1905                         end if;
1906
1907                         exit;
1908
1909                      else
1910                         I1  := I;
1911                         Subp := It.Nam;
1912                      end if;
1913                   end if;
1914
1915                   Get_Next_Interp (I, It);
1916                end loop;
1917             end;
1918
1919             if Subp /= Any_Id then
1920                Set_Entity (Def, Subp);
1921
1922                if Subp = Nam then
1923                   Error_Msg_N ("premature usage of formal subprogram", Def);
1924
1925                elsif Ekind (Subp) /= E_Operator then
1926                   Check_Mode_Conformant (Subp, Nam);
1927                end if;
1928
1929             else
1930                Error_Msg_N ("no visible subprogram matches specification", N);
1931             end if;
1932          end if;
1933       end if;
1934    end Analyze_Formal_Subprogram;
1935
1936    -------------------------------------
1937    -- Analyze_Formal_Type_Declaration --
1938    -------------------------------------
1939
1940    procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
1941       Def : constant Node_Id := Formal_Type_Definition (N);
1942       T   : Entity_Id;
1943
1944    begin
1945       T := Defining_Identifier (N);
1946
1947       if Present (Discriminant_Specifications (N))
1948         and then Nkind (Def) /= N_Formal_Private_Type_Definition
1949       then
1950          Error_Msg_N
1951            ("discriminants not allowed for this formal type",
1952             Defining_Identifier (First (Discriminant_Specifications (N))));
1953       end if;
1954
1955       --  Enter the new name, and branch to specific routine.
1956
1957       case Nkind (Def) is
1958          when N_Formal_Private_Type_Definition         =>
1959             Analyze_Formal_Private_Type (N, T, Def);
1960
1961          when N_Formal_Derived_Type_Definition         =>
1962             Analyze_Formal_Derived_Type (N, T, Def);
1963
1964          when N_Formal_Discrete_Type_Definition        =>
1965             Analyze_Formal_Discrete_Type (T, Def);
1966
1967          when N_Formal_Signed_Integer_Type_Definition  =>
1968             Analyze_Formal_Signed_Integer_Type (T, Def);
1969
1970          when N_Formal_Modular_Type_Definition         =>
1971             Analyze_Formal_Modular_Type (T, Def);
1972
1973          when N_Formal_Floating_Point_Definition       =>
1974             Analyze_Formal_Floating_Type (T, Def);
1975
1976          when N_Formal_Ordinary_Fixed_Point_Definition =>
1977             Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
1978
1979          when N_Formal_Decimal_Fixed_Point_Definition  =>
1980             Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
1981
1982          when N_Array_Type_Definition =>
1983             Analyze_Formal_Array_Type (T, Def);
1984
1985          when N_Access_To_Object_Definition            |
1986               N_Access_Function_Definition             |
1987               N_Access_Procedure_Definition            =>
1988             Analyze_Generic_Access_Type (T, Def);
1989
1990          when N_Error                                  =>
1991             null;
1992
1993          when others                                   =>
1994             raise Program_Error;
1995
1996       end case;
1997
1998       Set_Is_Generic_Type (T);
1999    end Analyze_Formal_Type_Declaration;
2000
2001    ------------------------------------
2002    -- Analyze_Function_Instantiation --
2003    ------------------------------------
2004
2005    procedure Analyze_Function_Instantiation (N : Node_Id) is
2006    begin
2007       Analyze_Subprogram_Instantiation (N, E_Function);
2008    end Analyze_Function_Instantiation;
2009
2010    ---------------------------------
2011    -- Analyze_Generic_Access_Type --
2012    ---------------------------------
2013
2014    procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2015    begin
2016       Enter_Name (T);
2017
2018       if Nkind (Def) = N_Access_To_Object_Definition then
2019          Access_Type_Declaration (T, Def);
2020
2021          if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2022            and then No (Full_View (Designated_Type (T)))
2023            and then not Is_Generic_Type (Designated_Type (T))
2024          then
2025             Error_Msg_N ("premature usage of incomplete type", Def);
2026
2027          elsif Is_Internal (Designated_Type (T)) then
2028             Error_Msg_N
2029               ("only a subtype mark is allowed in a formal", Def);
2030          end if;
2031
2032       else
2033          Access_Subprogram_Declaration (T, Def);
2034       end if;
2035    end Analyze_Generic_Access_Type;
2036
2037    ---------------------------------
2038    -- Analyze_Generic_Formal_Part --
2039    ---------------------------------
2040
2041    procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2042       Gen_Parm_Decl : Node_Id;
2043
2044    begin
2045       --  The generic formals are processed in the scope of the generic
2046       --  unit, where they are immediately visible. The scope is installed
2047       --  by the caller.
2048
2049       Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2050
2051       while Present (Gen_Parm_Decl) loop
2052          Analyze (Gen_Parm_Decl);
2053          Next (Gen_Parm_Decl);
2054       end loop;
2055
2056       Generate_Reference_To_Generic_Formals (Current_Scope);
2057    end Analyze_Generic_Formal_Part;
2058
2059    ------------------------------------------
2060    -- Analyze_Generic_Package_Declaration  --
2061    ------------------------------------------
2062
2063    procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2064       Loc         : constant Source_Ptr := Sloc (N);
2065       Id          : Entity_Id;
2066       New_N       : Node_Id;
2067       Save_Parent : Node_Id;
2068       Renaming    : Node_Id;
2069       Decls       : constant List_Id :=
2070                       Visible_Declarations (Specification (N));
2071       Decl        : Node_Id;
2072
2073    begin
2074       --  We introduce a renaming of the enclosing package, to have a usable
2075       --  entity as the prefix of an expanded name for a local entity of the
2076       --  form Par.P.Q, where P is the generic package. This is because a local
2077       --  entity named P may hide it, so that the usual visibility rules in
2078       --  the instance will not resolve properly.
2079
2080       Renaming :=
2081         Make_Package_Renaming_Declaration (Loc,
2082           Defining_Unit_Name =>
2083             Make_Defining_Identifier (Loc,
2084              Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2085           Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2086
2087       if Present (Decls) then
2088          Decl := First (Decls);
2089          while Present (Decl)
2090            and then Nkind (Decl) = N_Pragma
2091          loop
2092             Next (Decl);
2093          end loop;
2094
2095          if Present (Decl) then
2096             Insert_Before (Decl, Renaming);
2097          else
2098             Append (Renaming, Visible_Declarations (Specification (N)));
2099          end if;
2100
2101       else
2102          Set_Visible_Declarations (Specification (N), New_List (Renaming));
2103       end if;
2104
2105       --  Create copy of generic unit, and save for instantiation.
2106       --  If the unit is a child unit, do not copy the specifications
2107       --  for the parent, which are not part of the generic tree.
2108
2109       Save_Parent := Parent_Spec (N);
2110       Set_Parent_Spec (N, Empty);
2111
2112       New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2113       Set_Parent_Spec (New_N, Save_Parent);
2114       Rewrite (N, New_N);
2115       Id := Defining_Entity (N);
2116       Generate_Definition (Id);
2117
2118       --  Expansion is not applied to generic units.
2119
2120       Start_Generic;
2121
2122       Enter_Name (Id);
2123       Set_Ekind (Id, E_Generic_Package);
2124       Set_Etype (Id, Standard_Void_Type);
2125       New_Scope (Id);
2126       Enter_Generic_Scope (Id);
2127       Set_Inner_Instances (Id, New_Elmt_List);
2128
2129       Set_Categorization_From_Pragmas (N);
2130       Set_Is_Pure (Id, Is_Pure (Current_Scope));
2131
2132       --  Link the declaration of the generic homonym in the generic copy
2133       --  to the package it renames, so that it is always resolved properly.
2134
2135       Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
2136       Set_Entity (Associated_Node (Name (Renaming)), Id);
2137
2138       --  For a library unit, we have reconstructed the entity for the
2139       --  unit, and must reset it in the library tables.
2140
2141       if Nkind (Parent (N)) = N_Compilation_Unit then
2142          Set_Cunit_Entity (Current_Sem_Unit, Id);
2143       end if;
2144
2145       Analyze_Generic_Formal_Part (N);
2146
2147       --  After processing the generic formals, analysis proceeds
2148       --  as for a non-generic package.
2149
2150       Analyze (Specification (N));
2151
2152       Validate_Categorization_Dependency (N, Id);
2153
2154       End_Generic;
2155
2156       End_Package_Scope (Id);
2157       Exit_Generic_Scope (Id);
2158
2159       if Nkind (Parent (N)) /= N_Compilation_Unit then
2160          Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
2161          Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
2162          Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
2163
2164       else
2165          Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
2166          Validate_RT_RAT_Component (N);
2167
2168          --  If this is a spec without a body, check that generic parameters
2169          --  are referenced.
2170
2171          if not Body_Required (Parent (N)) then
2172             Check_References (Id);
2173          end if;
2174       end if;
2175    end Analyze_Generic_Package_Declaration;
2176
2177    --------------------------------------------
2178    -- Analyze_Generic_Subprogram_Declaration --
2179    --------------------------------------------
2180
2181    procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
2182       Spec        : Node_Id;
2183       Id          : Entity_Id;
2184       Formals     : List_Id;
2185       New_N       : Node_Id;
2186       Save_Parent : Node_Id;
2187
2188    begin
2189       --  Create copy of generic unit,and save for instantiation.
2190       --  If the unit is a child unit, do not copy the specifications
2191       --  for the parent, which are not part of the generic tree.
2192
2193       Save_Parent := Parent_Spec (N);
2194       Set_Parent_Spec (N, Empty);
2195
2196       New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2197       Set_Parent_Spec (New_N, Save_Parent);
2198       Rewrite (N, New_N);
2199
2200       Spec := Specification (N);
2201       Id := Defining_Entity (Spec);
2202       Generate_Definition (Id);
2203
2204       if Nkind (Id) = N_Defining_Operator_Symbol then
2205          Error_Msg_N
2206            ("operator symbol not allowed for generic subprogram", Id);
2207       end if;
2208
2209       Start_Generic;
2210
2211       Enter_Name (Id);
2212
2213       Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
2214       New_Scope (Id);
2215       Enter_Generic_Scope (Id);
2216       Set_Inner_Instances (Id, New_Elmt_List);
2217       Set_Is_Pure (Id, Is_Pure (Current_Scope));
2218
2219       Analyze_Generic_Formal_Part (N);
2220
2221       Formals := Parameter_Specifications (Spec);
2222
2223       if Present (Formals) then
2224          Process_Formals (Formals, Spec);
2225       end if;
2226
2227       if Nkind (Spec) = N_Function_Specification then
2228          Set_Ekind (Id, E_Generic_Function);
2229          Find_Type (Subtype_Mark (Spec));
2230          Set_Etype (Id, Entity (Subtype_Mark (Spec)));
2231       else
2232          Set_Ekind (Id, E_Generic_Procedure);
2233          Set_Etype (Id, Standard_Void_Type);
2234       end if;
2235
2236       --  For a library unit, we have reconstructed the entity for the
2237       --  unit, and must reset it in the library tables. We also need
2238       --  to make sure that Body_Required is set properly in the original
2239       --  compilation unit node.
2240
2241       if Nkind (Parent (N)) = N_Compilation_Unit then
2242          Set_Cunit_Entity (Current_Sem_Unit, Id);
2243          Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
2244       end if;
2245
2246       Set_Categorization_From_Pragmas (N);
2247       Validate_Categorization_Dependency (N, Id);
2248
2249       Save_Global_References (Original_Node (N));
2250
2251       End_Generic;
2252       End_Scope;
2253       Exit_Generic_Scope (Id);
2254       Generate_Reference_To_Formals (Id);
2255    end Analyze_Generic_Subprogram_Declaration;
2256
2257    -----------------------------------
2258    -- Analyze_Package_Instantiation --
2259    -----------------------------------
2260
2261    --  Note: this procedure is also used for formal package declarations,
2262    --  in which case the argument N is an N_Formal_Package_Declaration
2263    --  node. This should really be noted in the spec! ???
2264
2265    procedure Analyze_Package_Instantiation (N : Node_Id) is
2266       Loc    : constant Source_Ptr := Sloc (N);
2267       Gen_Id : constant Node_Id    := Name (N);
2268
2269       Act_Decl      : Node_Id;
2270       Act_Decl_Name : Node_Id;
2271       Act_Decl_Id   : Entity_Id;
2272       Act_Spec      : Node_Id;
2273       Act_Tree      : Node_Id;
2274
2275       Gen_Decl : Node_Id;
2276       Gen_Unit : Entity_Id;
2277
2278       Is_Actual_Pack : constant Boolean :=
2279                          Is_Internal (Defining_Entity (N));
2280
2281       Parent_Installed : Boolean := False;
2282       Renaming_List    : List_Id;
2283       Unit_Renaming    : Node_Id;
2284       Needs_Body       : Boolean;
2285       Inline_Now       : Boolean := False;
2286
2287       procedure Delay_Descriptors (E : Entity_Id);
2288       --  Delay generation of subprogram descriptors for given entity
2289
2290       function Might_Inline_Subp return Boolean;
2291       --  If inlining is active and the generic contains inlined subprograms,
2292       --  we instantiate the body. This may cause superfluous instantiations,
2293       --  but it is simpler than detecting the need for the body at the point
2294       --  of inlining, when the context of the instance is not available.
2295
2296       -----------------------
2297       -- Delay_Descriptors --
2298       -----------------------
2299
2300       procedure Delay_Descriptors (E : Entity_Id) is
2301       begin
2302          if not Delay_Subprogram_Descriptors (E) then
2303             Set_Delay_Subprogram_Descriptors (E);
2304             Pending_Descriptor.Increment_Last;
2305             Pending_Descriptor.Table (Pending_Descriptor.Last) := E;
2306          end if;
2307       end Delay_Descriptors;
2308
2309       -----------------------
2310       -- Might_Inline_Subp --
2311       -----------------------
2312
2313       function Might_Inline_Subp return Boolean is
2314          E : Entity_Id;
2315
2316       begin
2317          if not Inline_Processing_Required then
2318             return False;
2319
2320          else
2321             E := First_Entity (Gen_Unit);
2322
2323             while Present (E) loop
2324
2325                if Is_Subprogram (E)
2326                  and then Is_Inlined (E)
2327                then
2328                   return True;
2329                end if;
2330
2331                Next_Entity (E);
2332             end loop;
2333          end if;
2334
2335          return False;
2336       end Might_Inline_Subp;
2337
2338    --  Start of processing for Analyze_Package_Instantiation
2339
2340    begin
2341       --  Very first thing: apply the special kludge for Text_IO processing
2342       --  in case we are instantiating one of the children of [Wide_]Text_IO.
2343
2344       Text_IO_Kludge (Name (N));
2345
2346       --  Make node global for error reporting.
2347
2348       Instantiation_Node := N;
2349
2350       --  Case of instantiation of a generic package
2351
2352       if Nkind (N) = N_Package_Instantiation then
2353          Act_Decl_Id := New_Copy (Defining_Entity (N));
2354          Set_Comes_From_Source (Act_Decl_Id, True);
2355
2356          if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
2357             Act_Decl_Name :=
2358               Make_Defining_Program_Unit_Name (Loc,
2359                 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
2360                 Defining_Identifier => Act_Decl_Id);
2361          else
2362             Act_Decl_Name :=  Act_Decl_Id;
2363          end if;
2364
2365       --  Case of instantiation of a formal package
2366
2367       else
2368          Act_Decl_Id   := Defining_Identifier (N);
2369          Act_Decl_Name := Act_Decl_Id;
2370       end if;
2371
2372       Generate_Definition (Act_Decl_Id);
2373       Pre_Analyze_Actuals (N);
2374
2375       Init_Env;
2376       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2377       Gen_Unit := Entity (Gen_Id);
2378
2379       --  Verify that it is the name of a generic package
2380
2381       if Etype (Gen_Unit) = Any_Type then
2382          Restore_Env;
2383          return;
2384
2385       elsif Ekind (Gen_Unit) /= E_Generic_Package then
2386
2387          --  Ada 2005 (AI-50217): Cannot use instance in limited with_clause
2388
2389          if From_With_Type (Gen_Unit) then
2390             Error_Msg_N
2391               ("cannot instantiate a limited withed package", Gen_Id);
2392          else
2393             Error_Msg_N
2394               ("expect name of generic package in instantiation", Gen_Id);
2395          end if;
2396
2397          Restore_Env;
2398          return;
2399       end if;
2400
2401       if In_Extended_Main_Source_Unit (N) then
2402          Set_Is_Instantiated (Gen_Unit);
2403          Generate_Reference  (Gen_Unit, N);
2404
2405          if Present (Renamed_Object (Gen_Unit)) then
2406             Set_Is_Instantiated (Renamed_Object (Gen_Unit));
2407             Generate_Reference  (Renamed_Object (Gen_Unit), N);
2408          end if;
2409       end if;
2410
2411       if Nkind (Gen_Id) = N_Identifier
2412         and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
2413       then
2414          Error_Msg_NE
2415            ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2416
2417       elsif Nkind (Gen_Id) = N_Expanded_Name
2418         and then Is_Child_Unit (Gen_Unit)
2419         and then Nkind (Prefix (Gen_Id)) = N_Identifier
2420         and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
2421       then
2422          Error_Msg_N
2423            ("& is hidden within declaration of instance ", Prefix (Gen_Id));
2424       end if;
2425
2426       Set_Entity (Gen_Id, Gen_Unit);
2427
2428       --  If generic is a renaming, get original generic unit.
2429
2430       if Present (Renamed_Object (Gen_Unit))
2431         and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
2432       then
2433          Gen_Unit := Renamed_Object (Gen_Unit);
2434       end if;
2435
2436       --  Verify that there are no circular instantiations.
2437
2438       if In_Open_Scopes (Gen_Unit) then
2439          Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
2440          Restore_Env;
2441          return;
2442
2443       elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
2444          Error_Msg_Node_2 := Current_Scope;
2445          Error_Msg_NE
2446            ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
2447          Circularity_Detected := True;
2448          Restore_Env;
2449          return;
2450
2451       else
2452          Set_Instance_Env (Gen_Unit, Act_Decl_Id);
2453          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2454
2455          --  Initialize renamings map, for error checking, and the list
2456          --  that holds private entities whose views have changed between
2457          --  generic definition and instantiation. If this is the instance
2458          --  created to validate an actual package, the instantiation
2459          --  environment is that of the enclosing instance.
2460
2461          Generic_Renamings.Set_Last (0);
2462          Generic_Renamings_HTable.Reset;
2463
2464          Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2465
2466          --  Copy original generic tree, to produce text for instantiation.
2467
2468          Act_Tree :=
2469            Copy_Generic_Node
2470              (Original_Node (Gen_Decl), Empty, Instantiating => True);
2471
2472          Act_Spec := Specification (Act_Tree);
2473
2474          --  If this is the instance created to validate an actual package,
2475          --  only the formals matter, do not examine the package spec itself.
2476
2477          if Is_Actual_Pack then
2478             Set_Visible_Declarations (Act_Spec, New_List);
2479             Set_Private_Declarations (Act_Spec, New_List);
2480          end if;
2481
2482          Renaming_List :=
2483            Analyze_Associations
2484              (N,
2485               Generic_Formal_Declarations (Act_Tree),
2486               Generic_Formal_Declarations (Gen_Decl));
2487
2488          Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
2489          Set_Is_Generic_Instance (Act_Decl_Id);
2490
2491          Set_Generic_Parent (Act_Spec, Gen_Unit);
2492
2493          --  References to the generic in its own declaration or its body
2494          --  are references to the instance. Add a renaming declaration for
2495          --  the generic unit itself. This declaration, as well as the renaming
2496          --  declarations for the generic formals, must remain private to the
2497          --  unit: the formals, because this is the language semantics, and
2498          --  the unit because its use is an artifact of the implementation.
2499
2500          Unit_Renaming :=
2501            Make_Package_Renaming_Declaration (Loc,
2502              Defining_Unit_Name =>
2503                Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2504              Name => New_Reference_To (Act_Decl_Id, Loc));
2505
2506          Append (Unit_Renaming, Renaming_List);
2507
2508          --  The renaming declarations are the first local declarations of
2509          --  the new unit.
2510
2511          if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
2512             Insert_List_Before
2513               (First (Visible_Declarations (Act_Spec)), Renaming_List);
2514          else
2515             Set_Visible_Declarations (Act_Spec, Renaming_List);
2516          end if;
2517
2518          Act_Decl :=
2519            Make_Package_Declaration (Loc,
2520              Specification => Act_Spec);
2521
2522          --  Save the instantiation node, for subsequent instantiation
2523          --  of the body, if there is one and we are generating code for
2524          --  the current unit. Mark the unit as having a body, to avoid
2525          --  a premature error message.
2526
2527          --  We instantiate the body if we are generating code, if we are
2528          --  generating cross-reference information, or if we are building
2529          --  trees for ASIS use.
2530
2531          declare
2532             Enclosing_Body_Present : Boolean := False;
2533             --  If the generic unit is not a compilation unit, then a body
2534             --  may be present in its parent even if none is required. We
2535             --  create a tentative pending instantiation for the body, which
2536             --  will be discarded if none is actually present.
2537
2538             Scop : Entity_Id;
2539
2540          begin
2541             if Scope (Gen_Unit) /= Standard_Standard
2542               and then not Is_Child_Unit (Gen_Unit)
2543             then
2544                Scop := Scope (Gen_Unit);
2545
2546                while Present (Scop)
2547                  and then Scop /= Standard_Standard
2548                loop
2549                   if Unit_Requires_Body (Scop) then
2550                      Enclosing_Body_Present := True;
2551                      exit;
2552                   end if;
2553
2554                   exit when Is_Compilation_Unit (Scop);
2555                   Scop := Scope (Scop);
2556                end loop;
2557             end if;
2558
2559             --  If front-end inlining is enabled, and this is a unit for which
2560             --  code will be generated, we instantiate the body at once.
2561             --  This is done if the instance is not the main unit, and if the
2562             --  generic is not a child unit of another generic, to avoid scope
2563             --  problems and the reinstallation of parent instances.
2564
2565             if Front_End_Inlining
2566               and then Expander_Active
2567               and then (not Is_Child_Unit (Gen_Unit)
2568                          or else not Is_Generic_Unit (Scope (Gen_Unit)))
2569               and then Is_In_Main_Unit (N)
2570               and then Nkind (Parent (N)) /= N_Compilation_Unit
2571               and then Might_Inline_Subp
2572               and then not Is_Actual_Pack
2573             then
2574                Inline_Now := True;
2575             end if;
2576
2577             Needs_Body :=
2578               (Unit_Requires_Body (Gen_Unit)
2579                   or else Enclosing_Body_Present
2580                   or else Present (Corresponding_Body (Gen_Decl)))
2581                 and then (Is_In_Main_Unit (N)
2582                            or else Might_Inline_Subp)
2583                 and then not Is_Actual_Pack
2584                 and then not Inline_Now
2585
2586                 and then (Operating_Mode = Generate_Code
2587                             or else (Operating_Mode = Check_Semantics
2588                                       and then ASIS_Mode));
2589
2590             --  If front_end_inlining is enabled, do not instantiate a
2591             --  body if within a generic context.
2592
2593             if Front_End_Inlining
2594               and then not Expander_Active
2595             then
2596                Needs_Body := False;
2597             end if;
2598
2599             --  If the current context is generic, and the package being
2600             --  instantiated is declared within a formal package, there
2601             --  is no body to instantiate until the enclosing generic is
2602             --  instantiated, and there is an actual for the formal
2603             --  package. If the formal package has parameters, we build a
2604             --  regular package instance for it, that preceeds the original
2605             --  formal package declaration.
2606
2607             if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
2608                declare
2609                   Decl : constant Node_Id :=
2610                            Original_Node
2611                              (Unit_Declaration_Node (Scope (Gen_Unit)));
2612                begin
2613                   if Nkind (Decl) = N_Formal_Package_Declaration
2614                     or else (Nkind (Decl) = N_Package_Declaration
2615                       and then Is_List_Member (Decl)
2616                       and then Present (Next (Decl))
2617                       and then
2618                         Nkind (Next (Decl)) = N_Formal_Package_Declaration)
2619                   then
2620                      Needs_Body := False;
2621                   end if;
2622                end;
2623             end if;
2624          end;
2625
2626          --  If we are generating the calling stubs from the instantiation
2627          --  of a generic RCI package, we will not use the body of the
2628          --  generic package.
2629
2630          if Distribution_Stub_Mode = Generate_Caller_Stub_Body
2631            and then Is_Compilation_Unit (Defining_Entity (N))
2632          then
2633             Needs_Body := False;
2634          end if;
2635
2636          if Needs_Body then
2637
2638             --  Here is a defence against a ludicrous number of instantiations
2639             --  caused by a circular set of instantiation attempts.
2640
2641             if Pending_Instantiations.Last >
2642                  Hostparm.Max_Instantiations
2643             then
2644                Error_Msg_N ("too many instantiations", N);
2645                raise Unrecoverable_Error;
2646             end if;
2647
2648             --  Indicate that the enclosing scopes contain an instantiation,
2649             --  and that cleanup actions should be delayed until after the
2650             --  instance body is expanded.
2651
2652             Check_Forward_Instantiation (Gen_Decl);
2653             if Nkind (N) = N_Package_Instantiation then
2654                declare
2655                   Enclosing_Master : Entity_Id := Current_Scope;
2656
2657                begin
2658                   while Enclosing_Master /= Standard_Standard loop
2659
2660                      if Ekind (Enclosing_Master) = E_Package then
2661                         if Is_Compilation_Unit (Enclosing_Master) then
2662                            if In_Package_Body (Enclosing_Master) then
2663                               Delay_Descriptors
2664                                 (Body_Entity (Enclosing_Master));
2665                            else
2666                               Delay_Descriptors
2667                                 (Enclosing_Master);
2668                            end if;
2669
2670                            exit;
2671
2672                         else
2673                            Enclosing_Master := Scope (Enclosing_Master);
2674                         end if;
2675
2676                      elsif Ekind (Enclosing_Master) = E_Generic_Package then
2677                         Enclosing_Master := Scope (Enclosing_Master);
2678
2679                      elsif Is_Generic_Subprogram (Enclosing_Master)
2680                        or else Ekind (Enclosing_Master) = E_Void
2681                      then
2682                         --  Cleanup actions will eventually be performed on
2683                         --  the enclosing instance, if any. enclosing scope
2684                         --  is void in the formal part of a generic subp.
2685
2686                         exit;
2687
2688                      else
2689                         if Ekind (Enclosing_Master) = E_Entry
2690                           and then
2691                             Ekind (Scope (Enclosing_Master)) = E_Protected_Type
2692                         then
2693                            Enclosing_Master :=
2694                              Protected_Body_Subprogram (Enclosing_Master);
2695                         end if;
2696
2697                         Set_Delay_Cleanups (Enclosing_Master);
2698
2699                         while Ekind (Enclosing_Master) = E_Block loop
2700                            Enclosing_Master := Scope (Enclosing_Master);
2701                         end loop;
2702
2703                         if Is_Subprogram (Enclosing_Master) then
2704                            Delay_Descriptors (Enclosing_Master);
2705
2706                         elsif Is_Task_Type (Enclosing_Master) then
2707                            declare
2708                               TBP : constant Node_Id :=
2709                                       Get_Task_Body_Procedure
2710                                         (Enclosing_Master);
2711
2712                            begin
2713                               if Present (TBP) then
2714                                  Delay_Descriptors  (TBP);
2715                                  Set_Delay_Cleanups (TBP);
2716                               end if;
2717                            end;
2718                         end if;
2719
2720                         exit;
2721                      end if;
2722                   end loop;
2723                end;
2724
2725                --  Make entry in table
2726
2727                Pending_Instantiations.Increment_Last;
2728                Pending_Instantiations.Table (Pending_Instantiations.Last) :=
2729                  (N, Act_Decl, Expander_Active, Current_Sem_Unit);
2730             end if;
2731          end if;
2732
2733          Set_Categorization_From_Pragmas (Act_Decl);
2734
2735          if Parent_Installed then
2736             Hide_Current_Scope;
2737          end if;
2738
2739          Set_Instance_Spec (N, Act_Decl);
2740
2741          --  If not a compilation unit, insert the package declaration
2742          --  before the original instantiation node.
2743
2744          if Nkind (Parent (N)) /= N_Compilation_Unit then
2745             Mark_Rewrite_Insertion (Act_Decl);
2746             Insert_Before (N, Act_Decl);
2747             Analyze (Act_Decl);
2748
2749          --  For an instantiation that is a compilation unit, place
2750          --  declaration on current node so context is complete
2751          --  for analysis (including nested instantiations). It this
2752          --  is the main unit, the declaration eventually replaces the
2753          --  instantiation node. If the instance body is later created, it
2754          --  replaces the instance node, and the declation is attached to
2755          --  it (see Build_Instance_Compilation_Unit_Nodes).
2756
2757          else
2758             if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
2759
2760                --  The entity for the current unit is the newly created one,
2761                --  and all semantic information is attached to it.
2762
2763                Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
2764
2765                --  If this is the main unit, replace the main entity as well.
2766
2767                if Current_Sem_Unit = Main_Unit then
2768                   Main_Unit_Entity := Act_Decl_Id;
2769                end if;
2770             end if;
2771
2772             Set_Unit (Parent (N), Act_Decl);
2773             Set_Parent_Spec (Act_Decl, Parent_Spec (N));
2774             Analyze (Act_Decl);
2775             Set_Unit (Parent (N), N);
2776             Set_Body_Required (Parent (N), False);
2777
2778             --  We never need elaboration checks on instantiations, since
2779             --  by definition, the body instantiation is elaborated at the
2780             --  same time as the spec instantiation.
2781
2782             Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
2783             Set_Kill_Elaboration_Checks       (Act_Decl_Id);
2784          end if;
2785
2786          Check_Elab_Instantiation (N);
2787
2788          if ABE_Is_Certain (N) and then Needs_Body then
2789             Pending_Instantiations.Decrement_Last;
2790          end if;
2791          Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
2792
2793          Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
2794            First_Private_Entity (Act_Decl_Id));
2795
2796          --  If the instantiation will receive a body, the unit will
2797          --  be transformed into a package body, and receive its own
2798          --  elaboration entity. Otherwise, the nature of the unit is
2799          --  now a package declaration.
2800
2801          if Nkind (Parent (N)) = N_Compilation_Unit
2802            and then not Needs_Body
2803          then
2804             Rewrite (N, Act_Decl);
2805          end if;
2806
2807          if Present (Corresponding_Body (Gen_Decl))
2808            or else Unit_Requires_Body (Gen_Unit)
2809          then
2810             Set_Has_Completion (Act_Decl_Id);
2811          end if;
2812
2813          Check_Formal_Packages (Act_Decl_Id);
2814
2815          Restore_Private_Views (Act_Decl_Id);
2816
2817          if not Generic_Separately_Compiled (Gen_Unit) then
2818             Inherit_Context (Gen_Decl, N);
2819          end if;
2820
2821          if Parent_Installed then
2822             Remove_Parent;
2823          end if;
2824
2825          Restore_Env;
2826       end if;
2827
2828       Validate_Categorization_Dependency (N, Act_Decl_Id);
2829
2830       --  Check restriction, but skip this if something went wrong in
2831       --  the above analysis, indicated by Act_Decl_Id being void.
2832
2833       if Ekind (Act_Decl_Id) /= E_Void
2834         and then not Is_Library_Level_Entity (Act_Decl_Id)
2835       then
2836          Check_Restriction (No_Local_Allocators, N);
2837       end if;
2838
2839       if Inline_Now then
2840          Inline_Instance_Body (N, Gen_Unit, Act_Decl);
2841       end if;
2842
2843    exception
2844       when Instantiation_Error =>
2845          if Parent_Installed then
2846             Remove_Parent;
2847          end if;
2848    end Analyze_Package_Instantiation;
2849
2850    ---------------------------
2851    --  Inline_Instance_Body --
2852    ---------------------------
2853
2854    procedure Inline_Instance_Body
2855      (N        : Node_Id;
2856       Gen_Unit : Entity_Id;
2857       Act_Decl : Node_Id)
2858    is
2859       Vis          : Boolean;
2860       Gen_Comp     : constant Entity_Id :=
2861                       Cunit_Entity (Get_Source_Unit (Gen_Unit));
2862       Curr_Comp    : constant Node_Id := Cunit (Current_Sem_Unit);
2863       Curr_Scope   : Entity_Id := Empty;
2864       Curr_Unit    : constant Entity_Id :=
2865                        Cunit_Entity (Current_Sem_Unit);
2866       Removed      : Boolean := False;
2867       Num_Scopes   : Int := 0;
2868       Use_Clauses  : array (1 .. Scope_Stack.Last) of Node_Id;
2869       Instances    : array (1 .. Scope_Stack.Last) of Entity_Id;
2870       Inner_Scopes : array (1 .. Scope_Stack.Last) of Entity_Id;
2871       Num_Inner    : Int := 0;
2872       N_Instances  : Int := 0;
2873       S            : Entity_Id;
2874
2875    begin
2876       --  Case of generic unit defined in another unit. We must remove
2877       --  the complete context of the current unit to install that of
2878       --  the generic.
2879
2880       if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
2881          S := Current_Scope;
2882
2883          while Present (S)
2884            and then S /= Standard_Standard
2885          loop
2886             Num_Scopes := Num_Scopes + 1;
2887
2888             Use_Clauses (Num_Scopes) :=
2889               (Scope_Stack.Table
2890                  (Scope_Stack.Last - Num_Scopes + 1).
2891                     First_Use_Clause);
2892             End_Use_Clauses (Use_Clauses (Num_Scopes));
2893
2894             exit when Is_Generic_Instance (S)
2895               and then (In_Package_Body (S)
2896                           or else Ekind (S) = E_Procedure
2897                           or else Ekind (S) = E_Function);
2898             S := Scope (S);
2899          end loop;
2900
2901          Vis := Is_Immediately_Visible (Gen_Comp);
2902
2903          --  Find and save all enclosing instances
2904
2905          S := Current_Scope;
2906
2907          while Present (S)
2908            and then S /= Standard_Standard
2909          loop
2910             if Is_Generic_Instance (S) then
2911                N_Instances := N_Instances + 1;
2912                Instances (N_Instances) := S;
2913
2914                exit when In_Package_Body (S);
2915             end if;
2916
2917             S := Scope (S);
2918          end loop;
2919
2920          --  Remove context of current compilation unit, unless we
2921          --  are within a nested package instantiation, in which case
2922          --  the context has been removed previously.
2923
2924          --  If current scope is the body of a child unit, remove context
2925          --  of spec as well.
2926
2927          S := Current_Scope;
2928
2929          while Present (S)
2930            and then S /= Standard_Standard
2931          loop
2932             exit when Is_Generic_Instance (S)
2933                  and then (In_Package_Body (S)
2934                             or else Ekind (S) = E_Procedure
2935                             or else Ekind (S) = E_Function);
2936
2937             if S = Curr_Unit
2938               or else (Ekind (Curr_Unit) = E_Package_Body
2939                         and then S = Spec_Entity (Curr_Unit))
2940               or else (Ekind (Curr_Unit) = E_Subprogram_Body
2941                         and then S =
2942                           Corresponding_Spec
2943                             (Unit_Declaration_Node (Curr_Unit)))
2944             then
2945                Removed := True;
2946
2947                --  Remove entities in current scopes from visibility, so
2948                --  than instance body is compiled in a clean environment.
2949
2950                Save_Scope_Stack (Handle_Use => False);
2951
2952                if Is_Child_Unit (S) then
2953
2954                   --  Remove child unit from stack, as well as inner scopes.
2955                   --  Removing the context of a child unit removes parent
2956                   --  units as well.
2957
2958                   while Current_Scope /= S loop
2959                      Num_Inner := Num_Inner + 1;
2960                      Inner_Scopes (Num_Inner) := Current_Scope;
2961                      Pop_Scope;
2962                   end loop;
2963
2964                   Pop_Scope;
2965                   Remove_Context (Curr_Comp);
2966                   Curr_Scope := S;
2967
2968                else
2969                   Remove_Context (Curr_Comp);
2970                end if;
2971
2972                if Ekind (Curr_Unit) = E_Package_Body then
2973                   Remove_Context (Library_Unit (Curr_Comp));
2974                end if;
2975             end if;
2976
2977             S := Scope (S);
2978          end loop;
2979
2980          New_Scope (Standard_Standard);
2981          Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
2982          Instantiate_Package_Body
2983            ((N, Act_Decl, Expander_Active, Current_Sem_Unit), True);
2984          Pop_Scope;
2985
2986          --  Restore context
2987
2988          Set_Is_Immediately_Visible (Gen_Comp, Vis);
2989
2990          --  Reset Generic_Instance flag so that use clauses can be installed
2991          --  in the proper order. (See Use_One_Package for effect of enclosing
2992          --  instances on processing of use clauses).
2993
2994          for J in 1 .. N_Instances loop
2995             Set_Is_Generic_Instance (Instances (J), False);
2996          end loop;
2997
2998          if Removed then
2999             Install_Context (Curr_Comp);
3000
3001             if Present (Curr_Scope)
3002               and then Is_Child_Unit (Curr_Scope)
3003             then
3004                New_Scope (Curr_Scope);
3005                Set_Is_Immediately_Visible (Curr_Scope);
3006
3007                --  Finally, restore inner scopes as well.
3008
3009                for J in reverse 1 .. Num_Inner loop
3010                   New_Scope (Inner_Scopes (J));
3011                end loop;
3012             end if;
3013
3014             Restore_Scope_Stack (Handle_Use => False);
3015          end if;
3016
3017          --  Restore use clauses. For a child unit, use clauses in the
3018          --  parents are restored when installing the context, so only
3019          --  those in inner scopes (and those local to the child unit itself)
3020          --  need to be installed explicitly.
3021
3022          if Is_Child_Unit (Curr_Unit)
3023            and then Removed
3024          then
3025             for J in reverse 1 .. Num_Inner + 1 loop
3026                Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
3027                  Use_Clauses (J);
3028                Install_Use_Clauses (Use_Clauses (J));
3029             end  loop;
3030
3031          else
3032             for J in reverse 1 .. Num_Scopes loop
3033                Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
3034                  Use_Clauses (J);
3035                Install_Use_Clauses (Use_Clauses (J));
3036             end  loop;
3037          end if;
3038
3039          for J in 1 .. N_Instances loop
3040             Set_Is_Generic_Instance (Instances (J), True);
3041          end loop;
3042
3043       --  If generic unit is in current unit, current context is correct.
3044
3045       else
3046          Instantiate_Package_Body
3047            ((N, Act_Decl, Expander_Active, Current_Sem_Unit), True);
3048       end if;
3049    end Inline_Instance_Body;
3050
3051    -------------------------------------
3052    -- Analyze_Procedure_Instantiation --
3053    -------------------------------------
3054
3055    procedure Analyze_Procedure_Instantiation (N : Node_Id) is
3056    begin
3057       Analyze_Subprogram_Instantiation (N, E_Procedure);
3058    end Analyze_Procedure_Instantiation;
3059
3060    --------------------------------------
3061    -- Analyze_Subprogram_Instantiation --
3062    --------------------------------------
3063
3064    procedure Analyze_Subprogram_Instantiation
3065      (N : Node_Id;
3066       K : Entity_Kind)
3067    is
3068       Loc    : constant Source_Ptr := Sloc (N);
3069       Gen_Id : constant Node_Id    := Name (N);
3070
3071       Anon_Id : constant Entity_Id :=
3072                   Make_Defining_Identifier (Sloc (Defining_Entity (N)),
3073                     Chars => New_External_Name
3074                                (Chars (Defining_Entity (N)), 'R'));
3075
3076       Act_Decl_Id : Entity_Id;
3077       Act_Decl    : Node_Id;
3078       Act_Spec    : Node_Id;
3079       Act_Tree    : Node_Id;
3080
3081       Gen_Unit         : Entity_Id;
3082       Gen_Decl         : Node_Id;
3083       Pack_Id          : Entity_Id;
3084       Parent_Installed : Boolean := False;
3085       Renaming_List    : List_Id;
3086
3087       procedure Analyze_Instance_And_Renamings;
3088       --  The instance must be analyzed in a context that includes the
3089       --  mappings of generic parameters into actuals. We create a package
3090       --  declaration for this purpose, and a subprogram with an internal
3091       --  name within the package. The subprogram instance is simply an
3092       --  alias for the internal subprogram, declared in the current scope.
3093
3094       ------------------------------------
3095       -- Analyze_Instance_And_Renamings --
3096       ------------------------------------
3097
3098       procedure Analyze_Instance_And_Renamings is
3099          Def_Ent   : constant Entity_Id := Defining_Entity (N);
3100          Pack_Decl : Node_Id;
3101
3102       begin
3103          if Nkind (Parent (N)) = N_Compilation_Unit then
3104
3105             --  For the case of a compilation unit, the container package
3106             --  has the same name as the instantiation, to insure that the
3107             --  binder calls the elaboration procedure with the right name.
3108             --  Copy the entity of the instance, which may have compilation
3109             --  level flags (e.g. Is_Child_Unit) set.
3110
3111             Pack_Id := New_Copy (Def_Ent);
3112
3113          else
3114             --  Otherwise we use the name of the instantiation concatenated
3115             --  with its source position to ensure uniqueness if there are
3116             --  several instantiations with the same name.
3117
3118             Pack_Id :=
3119               Make_Defining_Identifier (Loc,
3120                 Chars => New_External_Name
3121                            (Related_Id   => Chars (Def_Ent),
3122                             Suffix       => "GP",
3123                             Suffix_Index => Source_Offset (Sloc (Def_Ent))));
3124          end if;
3125
3126          Pack_Decl := Make_Package_Declaration (Loc,
3127            Specification => Make_Package_Specification (Loc,
3128              Defining_Unit_Name   => Pack_Id,
3129              Visible_Declarations => Renaming_List,
3130              End_Label            => Empty));
3131
3132          Set_Instance_Spec (N, Pack_Decl);
3133          Set_Is_Generic_Instance (Pack_Id);
3134          Set_Needs_Debug_Info (Pack_Id);
3135
3136          --  Case of not a compilation unit
3137
3138          if Nkind (Parent (N)) /= N_Compilation_Unit then
3139             Mark_Rewrite_Insertion (Pack_Decl);
3140             Insert_Before (N, Pack_Decl);
3141             Set_Has_Completion (Pack_Id);
3142
3143          --  Case of an instantiation that is a compilation unit
3144
3145          --  Place declaration on current node so context is complete
3146          --  for analysis (including nested instantiations), and for
3147          --  use in a context_clause (see Analyze_With_Clause).
3148
3149          else
3150             Set_Unit (Parent (N), Pack_Decl);
3151             Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
3152          end if;
3153
3154          Analyze (Pack_Decl);
3155          Check_Formal_Packages (Pack_Id);
3156          Set_Is_Generic_Instance (Pack_Id, False);
3157
3158          --  Body of the enclosing package is supplied when instantiating
3159          --  the subprogram body, after semantic  analysis is completed.
3160
3161          if Nkind (Parent (N)) = N_Compilation_Unit then
3162
3163             --  Remove package itself from visibility, so it does not
3164             --  conflict with subprogram.
3165
3166             Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
3167
3168             --  Set name and scope of internal subprogram so that the
3169             --  proper external name will be generated. The proper scope
3170             --  is the scope of the wrapper package. We need to generate
3171             --  debugging information for the internal subprogram, so set
3172             --  flag accordingly.
3173
3174             Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
3175             Set_Scope (Anon_Id, Scope (Pack_Id));
3176
3177             --  Mark wrapper package as referenced, to avoid spurious
3178             --  warnings if the instantiation appears in various with_
3179             --  clauses of subunits of the main unit.
3180
3181             Set_Referenced (Pack_Id);
3182          end if;
3183
3184          Set_Is_Generic_Instance (Anon_Id);
3185          Set_Needs_Debug_Info    (Anon_Id);
3186          Act_Decl_Id := New_Copy (Anon_Id);
3187
3188          Set_Parent            (Act_Decl_Id, Parent (Anon_Id));
3189          Set_Chars             (Act_Decl_Id, Chars (Defining_Entity (N)));
3190          Set_Sloc              (Act_Decl_Id, Sloc (Defining_Entity (N)));
3191          Set_Comes_From_Source (Act_Decl_Id, True);
3192
3193          --  The signature may involve types that are not frozen yet, but
3194          --  the subprogram will be frozen at the point the wrapper package
3195          --  is frozen, so it does not need its own freeze node. In fact, if
3196          --  one is created, it might conflict with the freezing actions from
3197          --  the wrapper package (see 7206-013).
3198
3199          Set_Has_Delayed_Freeze (Anon_Id, False);
3200
3201          --  If the instance is a child unit, mark the Id accordingly. Mark
3202          --  the anonymous entity as well, which is the real subprogram and
3203          --  which is used when the instance appears in a context clause.
3204
3205          Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
3206          Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
3207          New_Overloaded_Entity (Act_Decl_Id);
3208          Check_Eliminated  (Act_Decl_Id);
3209
3210          --  In compilation unit case, kill elaboration checks on the
3211          --  instantiation, since they are never needed -- the body is
3212          --  instantiated at the same point as the spec.
3213
3214          if Nkind (Parent (N)) = N_Compilation_Unit then
3215             Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3216             Set_Kill_Elaboration_Checks       (Act_Decl_Id);
3217             Set_Is_Compilation_Unit (Anon_Id);
3218
3219             Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
3220          end if;
3221
3222          --  The instance is not a freezing point for the new subprogram.
3223
3224          Set_Is_Frozen (Act_Decl_Id, False);
3225
3226          if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
3227             Valid_Operator_Definition (Act_Decl_Id);
3228          end if;
3229
3230          Set_Alias  (Act_Decl_Id, Anon_Id);
3231          Set_Parent (Act_Decl_Id, Parent (Anon_Id));
3232          Set_Has_Completion (Act_Decl_Id);
3233          Set_Related_Instance (Pack_Id, Act_Decl_Id);
3234
3235          if Nkind (Parent (N)) = N_Compilation_Unit then
3236             Set_Body_Required (Parent (N), False);
3237          end if;
3238
3239       end Analyze_Instance_And_Renamings;
3240
3241    --  Start of processing for Analyze_Subprogram_Instantiation
3242
3243    begin
3244       --  Very first thing: apply the special kludge for Text_IO processing
3245       --  in case we are instantiating one of the children of [Wide_]Text_IO.
3246       --  Of course such an instantiation is bogus (these are packages, not
3247       --  subprograms), but we get a better error message if we do this.
3248
3249       Text_IO_Kludge (Gen_Id);
3250
3251       --  Make node global for error reporting.
3252
3253       Instantiation_Node := N;
3254       Pre_Analyze_Actuals (N);
3255
3256       Init_Env;
3257       Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3258       Gen_Unit := Entity (Gen_Id);
3259
3260       Generate_Reference (Gen_Unit, Gen_Id);
3261
3262       if Nkind (Gen_Id) = N_Identifier
3263         and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3264       then
3265          Error_Msg_NE
3266            ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3267       end if;
3268
3269       if Etype (Gen_Unit) = Any_Type then
3270          Restore_Env;
3271          return;
3272       end if;
3273
3274       --  Verify that it is a generic subprogram of the right kind, and that
3275       --  it does not lead to a circular instantiation.
3276
3277       if Ekind (Gen_Unit) /= E_Generic_Procedure
3278         and then Ekind (Gen_Unit) /= E_Generic_Function
3279       then
3280          Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
3281
3282       elsif In_Open_Scopes (Gen_Unit) then
3283          Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3284
3285       elsif K = E_Procedure
3286         and then Ekind (Gen_Unit) /= E_Generic_Procedure
3287       then
3288          if Ekind (Gen_Unit) = E_Generic_Function then
3289             Error_Msg_N
3290               ("cannot instantiate generic function as procedure", Gen_Id);
3291          else
3292             Error_Msg_N
3293               ("expect name of generic procedure in instantiation", Gen_Id);
3294          end if;
3295
3296       elsif K = E_Function
3297         and then Ekind (Gen_Unit) /= E_Generic_Function
3298       then
3299          if Ekind (Gen_Unit) = E_Generic_Procedure then
3300             Error_Msg_N
3301               ("cannot instantiate generic procedure as function", Gen_Id);
3302          else
3303             Error_Msg_N
3304               ("expect name of generic function in instantiation", Gen_Id);
3305          end if;
3306
3307       else
3308          Set_Entity (Gen_Id, Gen_Unit);
3309          Set_Is_Instantiated (Gen_Unit);
3310
3311          if In_Extended_Main_Source_Unit (N) then
3312             Generate_Reference (Gen_Unit, N);
3313          end if;
3314
3315          --  If renaming, get original unit
3316
3317          if Present (Renamed_Object (Gen_Unit))
3318            and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
3319                        or else
3320                      Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
3321          then
3322             Gen_Unit := Renamed_Object (Gen_Unit);
3323             Set_Is_Instantiated (Gen_Unit);
3324             Generate_Reference  (Gen_Unit, N);
3325          end if;
3326
3327          if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3328             Error_Msg_Node_2 := Current_Scope;
3329             Error_Msg_NE
3330               ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3331             Circularity_Detected := True;
3332             return;
3333          end if;
3334
3335          Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3336
3337          --  The subprogram itself cannot contain a nested instance, so
3338          --  the current parent is left empty.
3339
3340          Set_Instance_Env (Gen_Unit, Empty);
3341
3342          --  Initialize renamings map, for error checking.
3343
3344          Generic_Renamings.Set_Last (0);
3345          Generic_Renamings_HTable.Reset;
3346
3347          Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3348
3349          --  Copy original generic tree, to produce text for instantiation.
3350
3351          Act_Tree :=
3352            Copy_Generic_Node
3353              (Original_Node (Gen_Decl), Empty, Instantiating => True);
3354
3355          Act_Spec := Specification (Act_Tree);
3356          Renaming_List :=
3357            Analyze_Associations
3358              (N,
3359               Generic_Formal_Declarations (Act_Tree),
3360               Generic_Formal_Declarations (Gen_Decl));
3361
3362          --  Build the subprogram declaration, which does not appear
3363          --  in the generic template, and give it a sloc consistent
3364          --  with that of the template.
3365
3366          Set_Defining_Unit_Name (Act_Spec, Anon_Id);
3367          Set_Generic_Parent (Act_Spec, Gen_Unit);
3368          Act_Decl :=
3369            Make_Subprogram_Declaration (Sloc (Act_Spec),
3370              Specification => Act_Spec);
3371
3372          Set_Categorization_From_Pragmas (Act_Decl);
3373
3374          if Parent_Installed then
3375             Hide_Current_Scope;
3376          end if;
3377
3378          Append (Act_Decl, Renaming_List);
3379          Analyze_Instance_And_Renamings;
3380
3381          --  If the generic is marked Import (Intrinsic), then so is the
3382          --  instance. This indicates that there is no body to instantiate.
3383          --  If generic is marked inline, so it the instance, and the
3384          --  anonymous subprogram it renames. If inlined, or else if inlining
3385          --  is enabled for the compilation, we generate the instance body
3386          --  even if it is not within the main unit.
3387
3388          --  Any other  pragmas might also be inherited ???
3389
3390          if Is_Intrinsic_Subprogram (Gen_Unit) then
3391             Set_Is_Intrinsic_Subprogram (Anon_Id);
3392             Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
3393
3394             if Chars (Gen_Unit) = Name_Unchecked_Conversion then
3395                Validate_Unchecked_Conversion (N, Act_Decl_Id);
3396             end if;
3397          end if;
3398
3399          Generate_Definition (Act_Decl_Id);
3400
3401          Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
3402          Set_Is_Inlined (Anon_Id,     Is_Inlined (Gen_Unit));
3403
3404          if not Is_Intrinsic_Subprogram (Gen_Unit) then
3405             Check_Elab_Instantiation (N);
3406          end if;
3407
3408          Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3409
3410          --  Subject to change, pending on if other pragmas are inherited ???
3411
3412          Validate_Categorization_Dependency (N, Act_Decl_Id);
3413
3414          if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
3415
3416             if not Generic_Separately_Compiled (Gen_Unit) then
3417                Inherit_Context (Gen_Decl, N);
3418             end if;
3419
3420             Restore_Private_Views (Pack_Id, False);
3421
3422             --  If the context requires a full instantiation, mark node for
3423             --  subsequent construction of the body.
3424
3425             if (Is_In_Main_Unit (N)
3426                   or else Is_Inlined (Act_Decl_Id))
3427               and then (Operating_Mode = Generate_Code
3428                           or else (Operating_Mode = Check_Semantics
3429                                     and then ASIS_Mode))
3430               and then (Expander_Active or else ASIS_Mode)
3431               and then not ABE_Is_Certain (N)
3432               and then not Is_Eliminated (Act_Decl_Id)
3433             then
3434                Pending_Instantiations.Increment_Last;
3435                Pending_Instantiations.Table (Pending_Instantiations.Last) :=
3436                  (N, Act_Decl, Expander_Active, Current_Sem_Unit);
3437                Check_Forward_Instantiation (Gen_Decl);
3438
3439                --  The wrapper package is always delayed, because it does
3440                --  not constitute a freeze point, but to insure that the
3441                --  freeze node is placed properly, it is created directly
3442                --  when instantiating the body (otherwise the freeze node
3443                --  might appear to early for nested instantiations).
3444
3445             elsif Nkind (Parent (N)) = N_Compilation_Unit then
3446
3447                --  For ASIS purposes, indicate that the wrapper package has
3448                --  replaced the instantiation node.
3449
3450                Rewrite (N, Unit (Parent (N)));
3451                Set_Unit (Parent (N), N);
3452             end if;
3453
3454          elsif Nkind (Parent (N)) = N_Compilation_Unit then
3455
3456                --  Replace instance node for library-level instantiations
3457                --  of intrinsic subprograms, for ASIS use.
3458
3459                Rewrite (N, Unit (Parent (N)));
3460                Set_Unit (Parent (N), N);
3461          end if;
3462
3463          if Parent_Installed then
3464             Remove_Parent;
3465          end if;
3466
3467          Restore_Env;
3468          Generic_Renamings.Set_Last (0);
3469          Generic_Renamings_HTable.Reset;
3470       end if;
3471
3472    exception
3473       when Instantiation_Error =>
3474          if Parent_Installed then
3475             Remove_Parent;
3476          end if;
3477    end Analyze_Subprogram_Instantiation;
3478
3479    -------------------------
3480    -- Get_Associated_Node --
3481    -------------------------
3482
3483    function Get_Associated_Node (N : Node_Id) return Node_Id is
3484       Assoc : Node_Id := Associated_Node (N);
3485
3486    begin
3487       if Nkind (Assoc) /= Nkind (N) then
3488          return Assoc;
3489
3490       elsif Nkind (Assoc) = N_Aggregate
3491         or else Nkind (Assoc) = N_Extension_Aggregate
3492       then
3493          return Assoc;
3494       else
3495          --  If the node is part of an inner generic, it may itself have been
3496          --  remapped into a further generic copy. Associated_Node is otherwise
3497          --  used for the entity of the node, and will be of a different node
3498          --  kind, or else N has been rewritten as a literal or function call.
3499
3500          while Present (Associated_Node (Assoc))
3501            and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
3502          loop
3503             Assoc := Associated_Node (Assoc);
3504          end loop;
3505
3506          --  Follow and additional link in case the final node was rewritten.
3507          --  This can only happen with nested generic units.
3508
3509          if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
3510            and then Present (Associated_Node (Assoc))
3511            and then (Nkind (Associated_Node (Assoc)) = N_Function_Call
3512                        or else
3513                      Nkind (Associated_Node (Assoc)) = N_Explicit_Dereference
3514                        or else
3515                      Nkind (Associated_Node (Assoc)) = N_Integer_Literal
3516                        or else
3517                      Nkind (Associated_Node (Assoc)) = N_Real_Literal
3518                        or else
3519                      Nkind (Associated_Node (Assoc)) = N_String_Literal)
3520          then
3521             Assoc := Associated_Node (Assoc);
3522          end if;
3523
3524          return Assoc;
3525       end if;
3526    end Get_Associated_Node;
3527
3528    -------------------------------------------
3529    -- Build_Instance_Compilation_Unit_Nodes --
3530    -------------------------------------------
3531
3532    procedure Build_Instance_Compilation_Unit_Nodes
3533      (N        : Node_Id;
3534       Act_Body : Node_Id;
3535       Act_Decl : Node_Id)
3536    is
3537       Decl_Cunit : Node_Id;
3538       Body_Cunit : Node_Id;
3539       Citem      : Node_Id;
3540       New_Main   : constant Entity_Id := Defining_Entity (Act_Decl);
3541       Old_Main   : constant Entity_Id := Cunit_Entity (Main_Unit);
3542
3543    begin
3544       --  A new compilation unit node is built for the instance declaration
3545
3546       Decl_Cunit :=
3547         Make_Compilation_Unit (Sloc (N),
3548           Context_Items  => Empty_List,
3549           Unit           => Act_Decl,
3550           Aux_Decls_Node =>
3551             Make_Compilation_Unit_Aux (Sloc (N)));
3552
3553       Set_Parent_Spec   (Act_Decl, Parent_Spec (N));
3554       Set_Body_Required (Decl_Cunit, True);
3555
3556       --  We use the original instantiation compilation unit as the resulting
3557       --  compilation unit of the instance, since this is the main unit.
3558
3559       Rewrite (N, Act_Body);
3560       Body_Cunit := Parent (N);
3561
3562       --  The two compilation unit nodes are linked by the Library_Unit field
3563
3564       Set_Library_Unit  (Decl_Cunit, Body_Cunit);
3565       Set_Library_Unit  (Body_Cunit, Decl_Cunit);
3566
3567       --  Preserve the private nature of the package if needed.
3568
3569       Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
3570
3571       --  If the instance is not the main unit, its context, categorization,
3572       --  and elaboration entity are not relevant to the compilation.
3573
3574       if Parent (N) /= Cunit (Main_Unit) then
3575          return;
3576       end if;
3577
3578       --  The context clause items on the instantiation, which are now
3579       --  attached to the body compilation unit (since the body overwrote
3580       --  the original instantiation node), semantically belong on the spec,
3581       --  so copy them there. It's harmless to leave them on the body as well.
3582       --  In fact one could argue that they belong in both places.
3583
3584       Citem := First (Context_Items (Body_Cunit));
3585       while Present (Citem) loop
3586          Append (New_Copy (Citem), Context_Items (Decl_Cunit));
3587          Next (Citem);
3588       end loop;
3589
3590       --  Propagate categorization flags on packages, so that they appear
3591       --  in ali file for the spec of the unit.
3592
3593       if Ekind (New_Main) = E_Package then
3594          Set_Is_Pure           (Old_Main, Is_Pure (New_Main));
3595          Set_Is_Preelaborated  (Old_Main, Is_Preelaborated (New_Main));
3596          Set_Is_Remote_Types   (Old_Main, Is_Remote_Types (New_Main));
3597          Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
3598          Set_Is_Remote_Call_Interface
3599            (Old_Main, Is_Remote_Call_Interface (New_Main));
3600       end if;
3601
3602       --  Make entry in Units table, so that binder can generate call to
3603       --  elaboration procedure for body, if any.
3604
3605       Make_Instance_Unit (Body_Cunit);
3606       Main_Unit_Entity := New_Main;
3607       Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
3608
3609       --  Build elaboration entity, since the instance may certainly
3610       --  generate elaboration code requiring a flag for protection.
3611
3612       Build_Elaboration_Entity (Decl_Cunit, New_Main);
3613    end Build_Instance_Compilation_Unit_Nodes;
3614
3615    -----------------------------------
3616    -- Check_Formal_Package_Instance --
3617    -----------------------------------
3618
3619    --  If the formal has specific parameters, they must match those of the
3620    --  actual. Both of them are instances, and the renaming declarations
3621    --  for their formal parameters appear in the same order in both. The
3622    --  analyzed formal has been analyzed in the context of the current
3623    --  instance.
3624
3625    procedure Check_Formal_Package_Instance
3626      (Formal_Pack : Entity_Id;
3627       Actual_Pack : Entity_Id)
3628    is
3629       E1 : Entity_Id := First_Entity (Actual_Pack);
3630       E2 : Entity_Id := First_Entity (Formal_Pack);
3631
3632       Expr1 : Node_Id;
3633       Expr2 : Node_Id;
3634
3635       procedure Check_Mismatch (B : Boolean);
3636       --  Common error routine for mismatch between the parameters of
3637       --  the actual instance and those of the formal package.
3638
3639       function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
3640       --  The formal may come from a nested formal package, and the actual
3641       --  may have been constant-folded. To determine whether the two denote
3642       --  the same entity we may have to traverse several definitions to
3643       --  recover the ultimate entity that they refer to.
3644
3645       function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
3646       --  Similarly, if the formal comes from a nested formal package, the
3647       --  actual may designate the formal through multiple renamings, which
3648       --  have to be followed to determine the original variable in question.
3649
3650       --------------------
3651       -- Check_Mismatch --
3652       --------------------
3653
3654       procedure Check_Mismatch (B : Boolean) is
3655       begin
3656          if B then
3657             Error_Msg_NE
3658               ("actual for & in actual instance does not match formal",
3659                Parent (Actual_Pack), E1);
3660          end if;
3661       end Check_Mismatch;
3662
3663       --------------------------------
3664       -- Same_Instantiated_Constant --
3665       --------------------------------
3666
3667       function Same_Instantiated_Constant
3668         (E1, E2 : Entity_Id) return Boolean
3669       is
3670          Ent : Entity_Id;
3671       begin
3672          Ent := E2;
3673          while Present (Ent) loop
3674             if E1 = Ent then
3675                return True;
3676
3677             elsif Ekind (Ent) /= E_Constant then
3678                return False;
3679
3680             elsif Is_Entity_Name (Constant_Value (Ent)) then
3681                if  Entity (Constant_Value (Ent)) = E1 then
3682                   return True;
3683                else
3684                   Ent := Entity (Constant_Value (Ent));
3685                end if;
3686
3687             --  The actual may be a constant that has been folded. Recover
3688             --  original name.
3689
3690             elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
3691                   Ent := Entity (Original_Node (Constant_Value (Ent)));
3692             else
3693                return False;
3694             end if;
3695          end loop;
3696
3697          return False;
3698       end Same_Instantiated_Constant;
3699
3700       --------------------------------
3701       -- Same_Instantiated_Variable --
3702       --------------------------------
3703
3704       function Same_Instantiated_Variable
3705         (E1, E2 : Entity_Id) return Boolean
3706       is
3707          function Original_Entity (E : Entity_Id) return Entity_Id;
3708          --  Follow chain of renamings to the ultimate ancestor.
3709
3710          ---------------------
3711          -- Original_Entity --
3712          ---------------------
3713
3714          function Original_Entity (E : Entity_Id) return Entity_Id is
3715             Orig : Entity_Id;
3716
3717          begin
3718             Orig := E;
3719             while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
3720               and then Present (Renamed_Object (Orig))
3721               and then Is_Entity_Name (Renamed_Object (Orig))
3722             loop
3723                Orig := Entity (Renamed_Object (Orig));
3724             end loop;
3725
3726             return Orig;
3727          end Original_Entity;
3728
3729       --  Start of processing for Same_Instantiated_Variable
3730
3731       begin
3732          return Ekind (E1) = Ekind (E2)
3733            and then Original_Entity (E1) = Original_Entity (E2);
3734       end Same_Instantiated_Variable;
3735
3736    --  Start of processing for Check_Formal_Package_Instance
3737
3738    begin
3739       while Present (E1)
3740         and then Present (E2)
3741       loop
3742          exit when Ekind (E1) = E_Package
3743            and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
3744
3745          if Is_Type (E1) then
3746
3747             --  Subtypes must statically match. E1 and E2 are the
3748             --  local entities that are subtypes of the actuals.
3749             --  Itypes generated for other parameters need not be checked,
3750             --  the check will be performed on the parameters themselves.
3751
3752             if not Is_Itype (E1)
3753               and then not Is_Itype (E2)
3754             then
3755                Check_Mismatch
3756                  (not Is_Type (E2)
3757                    or else Etype (E1) /= Etype (E2)
3758                    or else not Subtypes_Statically_Match (E1, E2));
3759             end if;
3760
3761          elsif Ekind (E1) = E_Constant then
3762
3763             --  IN parameters must denote the same static value, or
3764             --  the same constant, or the literal null.
3765
3766             Expr1 := Expression (Parent (E1));
3767
3768             if Ekind (E2) /= E_Constant then
3769                Check_Mismatch (True);
3770                goto Next_E;
3771             else
3772                Expr2 := Expression (Parent (E2));
3773             end if;
3774
3775             if Is_Static_Expression (Expr1) then
3776
3777                if not Is_Static_Expression (Expr2) then
3778                   Check_Mismatch (True);
3779
3780                elsif Is_Integer_Type (Etype (E1)) then
3781
3782                   declare
3783                      V1 : constant Uint := Expr_Value (Expr1);
3784                      V2 : constant Uint := Expr_Value (Expr2);
3785                   begin
3786                      Check_Mismatch (V1 /= V2);
3787                   end;
3788
3789                elsif Is_Real_Type (Etype (E1)) then
3790                   declare
3791                      V1 : constant Ureal := Expr_Value_R (Expr1);
3792                      V2 : constant Ureal := Expr_Value_R (Expr2);
3793                   begin
3794                      Check_Mismatch (V1 /= V2);
3795                   end;
3796
3797                elsif Is_String_Type (Etype (E1))
3798                  and then Nkind (Expr1) = N_String_Literal
3799                then
3800
3801                   if Nkind (Expr2) /= N_String_Literal then
3802                      Check_Mismatch (True);
3803                   else
3804                      Check_Mismatch
3805                        (not String_Equal (Strval (Expr1), Strval (Expr2)));
3806                   end if;
3807                end if;
3808
3809             elsif Is_Entity_Name (Expr1) then
3810                if Is_Entity_Name (Expr2) then
3811                   if Entity (Expr1) = Entity (Expr2) then
3812                      null;
3813                   else
3814                      Check_Mismatch
3815                        (not Same_Instantiated_Constant
3816                          (Entity (Expr1), Entity (Expr2)));
3817                   end if;
3818                else
3819                   Check_Mismatch (True);
3820                end if;
3821
3822             elsif Is_Entity_Name (Original_Node (Expr1))
3823               and then Is_Entity_Name (Expr2)
3824             and then
3825               Same_Instantiated_Constant
3826                 (Entity (Original_Node (Expr1)), Entity (Expr2))
3827             then
3828                null;
3829
3830             elsif Nkind (Expr1) = N_Null then
3831                Check_Mismatch (Nkind (Expr1) /= N_Null);
3832
3833             else
3834                Check_Mismatch (True);
3835             end if;
3836
3837          elsif Ekind (E1) = E_Variable then
3838             Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
3839
3840          elsif Ekind (E1) = E_Package then
3841             Check_Mismatch
3842               (Ekind (E1) /= Ekind (E2)
3843                 or else Renamed_Object (E1) /= Renamed_Object (E2));
3844
3845          elsif Is_Overloadable (E1) then
3846
3847             --  Verify that the names of the  entities match.
3848             --  What if actual is an attribute ???
3849
3850             Check_Mismatch
3851               (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
3852
3853          else
3854             raise Program_Error;
3855          end if;
3856
3857          <<Next_E>>
3858             Next_Entity (E1);
3859             Next_Entity (E2);
3860       end loop;
3861    end Check_Formal_Package_Instance;
3862
3863    ---------------------------
3864    -- Check_Formal_Packages --
3865    ---------------------------
3866
3867    procedure Check_Formal_Packages (P_Id : Entity_Id) is
3868       E        : Entity_Id;
3869       Formal_P : Entity_Id;
3870
3871    begin
3872       --  Iterate through the declarations in the instance, looking for
3873       --  package renaming declarations that denote instances of formal
3874       --  packages. Stop when we find the renaming of the current package
3875       --  itself. The declaration for a formal package without a box is
3876       --  followed by an internal entity that repeats the instantiation.
3877
3878       E := First_Entity (P_Id);
3879       while Present (E) loop
3880          if Ekind (E) = E_Package then
3881             if Renamed_Object (E) = P_Id then
3882                exit;
3883
3884             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
3885                null;
3886
3887             elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
3888                Formal_P := Next_Entity (E);
3889                Check_Formal_Package_Instance (Formal_P, E);
3890             end if;
3891          end if;
3892
3893          Next_Entity (E);
3894       end loop;
3895    end Check_Formal_Packages;
3896
3897    ---------------------------------
3898    -- Check_Forward_Instantiation --
3899    ---------------------------------
3900
3901    procedure Check_Forward_Instantiation (Decl : Node_Id) is
3902       S        : Entity_Id;
3903       Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
3904
3905    begin
3906       --  The instantiation appears before the generic body if we are in the
3907       --  scope of the unit containing the generic, either in its spec or in
3908       --  the package body. and before the generic body.
3909
3910       if Ekind (Gen_Comp) = E_Package_Body then
3911          Gen_Comp := Spec_Entity (Gen_Comp);
3912       end if;
3913
3914       if In_Open_Scopes (Gen_Comp)
3915         and then No (Corresponding_Body (Decl))
3916       then
3917          S := Current_Scope;
3918
3919          while Present (S)
3920            and then not Is_Compilation_Unit (S)
3921            and then not Is_Child_Unit (S)
3922          loop
3923             if Ekind (S) = E_Package then
3924                Set_Has_Forward_Instantiation (S);
3925             end if;
3926
3927             S := Scope (S);
3928          end loop;
3929       end if;
3930    end Check_Forward_Instantiation;
3931
3932    ---------------------------
3933    -- Check_Generic_Actuals --
3934    ---------------------------
3935
3936    --  The visibility of the actuals may be different between the
3937    --  point of generic instantiation and the instantiation of the body.
3938
3939    procedure Check_Generic_Actuals
3940      (Instance      : Entity_Id;
3941       Is_Formal_Box : Boolean)
3942    is
3943       E      : Entity_Id;
3944       Astype : Entity_Id;
3945
3946    begin
3947       E := First_Entity (Instance);
3948       while Present (E) loop
3949          if Is_Type (E)
3950            and then Nkind (Parent (E)) = N_Subtype_Declaration
3951            and then Scope (Etype (E)) /= Instance
3952            and then Is_Entity_Name (Subtype_Indication (Parent (E)))
3953          then
3954             Check_Private_View (Subtype_Indication (Parent (E)));
3955             Set_Is_Generic_Actual_Type (E, True);
3956             Set_Is_Hidden (E, False);
3957
3958             --  We constructed the generic actual type as a subtype of
3959             --  the supplied type. This means that it normally would not
3960             --  inherit subtype specific attributes of the actual, which
3961             --  is wrong for the generic case.
3962
3963             Astype := Ancestor_Subtype (E);
3964
3965             if No (Astype) then
3966
3967                --  can happen when E is an itype that is the full view of
3968                --  a private type completed, e.g. with a constrained array.
3969
3970                Astype := Base_Type (E);
3971             end if;
3972
3973             Set_Size_Info      (E,                (Astype));
3974             Set_RM_Size        (E, RM_Size        (Astype));
3975             Set_First_Rep_Item (E, First_Rep_Item (Astype));
3976
3977             if Is_Discrete_Or_Fixed_Point_Type (E) then
3978                Set_RM_Size (E, RM_Size (Astype));
3979
3980             --  In  nested instances, the base type of an access actual
3981             --  may itself be private, and need to be exchanged.
3982
3983             elsif Is_Access_Type (E)
3984               and then Is_Private_Type (Etype (E))
3985             then
3986                Check_Private_View
3987                  (New_Occurrence_Of (Etype (E), Sloc (Instance)));
3988             end if;
3989
3990          elsif Ekind (E) = E_Package then
3991
3992             --  If this is the renaming for the current instance, we're done.
3993             --  Otherwise it is a formal package. If the corresponding formal
3994             --  was declared with a box, the (instantiations of the) generic
3995             --  formal part are also visible. Otherwise, ignore the entity
3996             --  created to validate the actuals.
3997
3998             if Renamed_Object (E) = Instance then
3999                exit;
4000
4001             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
4002                null;
4003
4004             --  The visibility of a formal of an enclosing generic is already
4005             --  correct.
4006
4007             elsif Denotes_Formal_Package (E) then
4008                null;
4009
4010             elsif Present (Associated_Formal_Package (E))
4011               and then Box_Present (Parent (Associated_Formal_Package (E)))
4012             then
4013                Check_Generic_Actuals (Renamed_Object (E), True);
4014                Set_Is_Hidden (E, False);
4015             end if;
4016
4017          --  If this is a subprogram instance (in a wrapper package) the
4018          --  actual is fully visible.
4019
4020          elsif Is_Wrapper_Package (Instance) then
4021             Set_Is_Hidden (E, False);
4022
4023          else
4024             Set_Is_Hidden (E, not Is_Formal_Box);
4025          end if;
4026
4027          Next_Entity (E);
4028       end loop;
4029    end Check_Generic_Actuals;
4030
4031    ------------------------------
4032    -- Check_Generic_Child_Unit --
4033    ------------------------------
4034
4035    procedure Check_Generic_Child_Unit
4036      (Gen_Id           : Node_Id;
4037       Parent_Installed : in out Boolean)
4038    is
4039       Loc      : constant Source_Ptr := Sloc (Gen_Id);
4040       Gen_Par  : Entity_Id := Empty;
4041       Inst_Par : Entity_Id;
4042       E        : Entity_Id;
4043       S        : Node_Id;
4044
4045       function Find_Generic_Child
4046         (Scop : Entity_Id;
4047          Id   : Node_Id)
4048          return Entity_Id;
4049       --  Search generic parent for possible child unit with the given name.
4050
4051       function In_Enclosing_Instance return Boolean;
4052       --  Within an instance of the parent, the child unit may be denoted
4053       --  by a simple name, or an abbreviated expanded name. Examine enclosing
4054       --  scopes to locate a possible parent instantiation.
4055
4056       ------------------------
4057       -- Find_Generic_Child --
4058       ------------------------
4059
4060       function Find_Generic_Child
4061         (Scop : Entity_Id;
4062          Id   : Node_Id)
4063          return Entity_Id
4064       is
4065          E : Entity_Id;
4066
4067       begin
4068          --  If entity of name is already set, instance has already been
4069          --  resolved, e.g. in an enclosing instantiation.
4070
4071          if Present (Entity (Id)) then
4072             if Scope (Entity (Id)) = Scop then
4073                return Entity (Id);
4074             else
4075                return Empty;
4076             end if;
4077
4078          else
4079             E := First_Entity (Scop);
4080             while Present (E) loop
4081                if Chars (E) = Chars (Id)
4082                  and then Is_Child_Unit (E)
4083                then
4084                   if Is_Child_Unit (E)
4085                     and then not Is_Visible_Child_Unit (E)
4086                   then
4087                      Error_Msg_NE
4088                        ("generic child unit& is not visible", Gen_Id, E);
4089                   end if;
4090
4091                   Set_Entity (Id, E);
4092                   return E;
4093                end if;
4094
4095                Next_Entity (E);
4096             end loop;
4097
4098             return Empty;
4099          end if;
4100       end Find_Generic_Child;
4101
4102       ---------------------------
4103       -- In_Enclosing_Instance --
4104       ---------------------------
4105
4106       function In_Enclosing_Instance return Boolean is
4107          Enclosing_Instance : Node_Id;
4108          Instance_Decl      : Node_Id;
4109
4110       begin
4111          Enclosing_Instance := Current_Scope;
4112
4113          while Present (Enclosing_Instance) loop
4114             Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
4115
4116             if Ekind (Enclosing_Instance) = E_Package
4117               and then Is_Generic_Instance (Enclosing_Instance)
4118               and then Present
4119                 (Generic_Parent (Specification (Instance_Decl)))
4120             then
4121                --  Check whether the generic we are looking for is a child
4122                --  of this instance.
4123
4124                E := Find_Generic_Child
4125                       (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
4126                exit when Present (E);
4127
4128             else
4129                E := Empty;
4130             end if;
4131
4132             Enclosing_Instance := Scope (Enclosing_Instance);
4133          end loop;
4134
4135          if No (E) then
4136
4137             --  Not a child unit
4138
4139             Analyze (Gen_Id);
4140             return False;
4141
4142          else
4143             Rewrite (Gen_Id,
4144               Make_Expanded_Name (Loc,
4145                 Chars         => Chars (E),
4146                 Prefix        => New_Occurrence_Of (Enclosing_Instance, Loc),
4147                 Selector_Name => New_Occurrence_Of (E, Loc)));
4148
4149             Set_Entity (Gen_Id, E);
4150             Set_Etype  (Gen_Id, Etype (E));
4151             Parent_Installed := False;      -- Already in scope.
4152             return True;
4153          end if;
4154       end In_Enclosing_Instance;
4155
4156    --  Start of processing for Check_Generic_Child_Unit
4157
4158    begin
4159       --  If the name of the generic is given by a selected component, it
4160       --  may be the name of a generic child unit, and the prefix is the name
4161       --  of an instance of the parent, in which case the child unit must be
4162       --  visible. If this instance is not in scope, it must be placed there
4163       --  and removed after instantiation, because what is being instantiated
4164       --  is not the original child, but the corresponding child present in
4165       --  the instance of the parent.
4166
4167       --  If the child is instantiated within the parent, it can be given by
4168       --  a simple name. In this case the instance is already in scope, but
4169       --  the child generic must be recovered from the generic parent as well.
4170
4171       if Nkind (Gen_Id) = N_Selected_Component then
4172          S := Selector_Name (Gen_Id);
4173          Analyze (Prefix (Gen_Id));
4174          Inst_Par := Entity (Prefix (Gen_Id));
4175
4176          if Ekind (Inst_Par) = E_Package
4177            and then Present (Renamed_Object (Inst_Par))
4178          then
4179             Inst_Par := Renamed_Object (Inst_Par);
4180          end if;
4181
4182          if Ekind (Inst_Par) = E_Package then
4183             if Nkind (Parent (Inst_Par)) = N_Package_Specification then
4184                Gen_Par := Generic_Parent (Parent (Inst_Par));
4185
4186             elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
4187               and then
4188                 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
4189             then
4190                Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
4191             end if;
4192
4193          elsif Ekind (Inst_Par) = E_Generic_Package
4194            and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
4195          then
4196             --  A formal package may be a real child package, and not the
4197             --  implicit instance within a parent. In this case the child is
4198             --  not visible and has to be retrieved explicitly as well.
4199
4200             Gen_Par := Inst_Par;
4201          end if;
4202
4203          if Present (Gen_Par) then
4204
4205             --  The prefix denotes an instantiation. The entity itself
4206             --  may be a nested generic, or a child unit.
4207
4208             E := Find_Generic_Child (Gen_Par, S);
4209
4210             if Present (E) then
4211                Change_Selected_Component_To_Expanded_Name (Gen_Id);
4212                Set_Entity (Gen_Id, E);
4213                Set_Etype (Gen_Id, Etype (E));
4214                Set_Entity (S, E);
4215                Set_Etype (S, Etype (E));
4216
4217                --  Indicate that this is a reference to the parent.
4218
4219                if In_Extended_Main_Source_Unit (Gen_Id) then
4220                   Set_Is_Instantiated (Inst_Par);
4221                end if;
4222
4223                --  A common mistake is to replicate the naming scheme of
4224                --  a hierarchy by instantiating a generic child directly,
4225                --  rather than the implicit child in a parent instance:
4226
4227                --  generic .. package Gpar is ..
4228                --  generic .. package Gpar.Child is ..
4229                --  package Par is new Gpar ();
4230
4231                --  with Gpar.Child;
4232                --  package Par.Child is new Gpar.Child ();
4233                --                           rather than Par.Child
4234
4235                --  In this case the instantiation is within Par, which is
4236                --  an instance, but Gpar does not denote Par because we are
4237                --  not IN the instance of Gpar, so this is illegal. The test
4238                --  below recognizes this particular case.
4239
4240                if Is_Child_Unit (E)
4241                  and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
4242                  and then (not In_Instance
4243                              or else Nkind (Parent (Parent (Gen_Id))) =
4244                                                          N_Compilation_Unit)
4245                then
4246                   Error_Msg_N
4247                     ("prefix of generic child unit must be instance of parent",
4248                       Gen_Id);
4249                end if;
4250
4251                if not In_Open_Scopes (Inst_Par)
4252                  and then Nkind (Parent (Gen_Id)) not in
4253                                            N_Generic_Renaming_Declaration
4254                then
4255                   Install_Parent (Inst_Par);
4256                   Parent_Installed := True;
4257                end if;
4258
4259             else
4260                --  If the generic parent does not contain an entity that
4261                --  corresponds to the selector, the instance doesn't either.
4262                --  Analyzing the node will yield the appropriate error message.
4263                --  If the entity is not a child unit, then it is an inner
4264                --  generic in the parent.
4265
4266                Analyze (Gen_Id);
4267             end if;
4268
4269          else
4270             Analyze (Gen_Id);
4271
4272             if Is_Child_Unit (Entity (Gen_Id))
4273               and then
4274                 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
4275               and then not In_Open_Scopes (Inst_Par)
4276             then
4277                Install_Parent (Inst_Par);
4278                Parent_Installed := True;
4279             end if;
4280          end if;
4281
4282       elsif Nkind (Gen_Id) = N_Expanded_Name then
4283
4284          --  Entity already present, analyze prefix, whose meaning may be
4285          --  an instance in the current context. If it is an instance of
4286          --  a relative within another, the proper parent may still have
4287          --  to be installed, if they are not of the same generation.
4288
4289          Analyze (Prefix (Gen_Id));
4290          Inst_Par := Entity (Prefix (Gen_Id));
4291
4292          if In_Enclosing_Instance then
4293             null;
4294
4295          elsif Present (Entity (Gen_Id))
4296            and then Is_Child_Unit (Entity (Gen_Id))
4297            and then not In_Open_Scopes (Inst_Par)
4298          then
4299             Install_Parent (Inst_Par);
4300             Parent_Installed := True;
4301          end if;
4302
4303       elsif In_Enclosing_Instance then
4304
4305          --  The child unit is found in some enclosing scope
4306
4307          null;
4308
4309       else
4310          Analyze (Gen_Id);
4311
4312          --  If this is the renaming of the implicit child in a parent
4313          --  instance, recover the parent name and install it.
4314
4315          if Is_Entity_Name (Gen_Id) then
4316             E := Entity (Gen_Id);
4317
4318             if Is_Generic_Unit (E)
4319               and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
4320               and then Is_Child_Unit (Renamed_Object (E))
4321               and then Is_Generic_Unit (Scope (Renamed_Object (E)))
4322               and then Nkind (Name (Parent (E))) = N_Expanded_Name
4323             then
4324                Rewrite (Gen_Id,
4325                  New_Copy_Tree (Name (Parent (E))));
4326                Inst_Par := Entity (Prefix (Gen_Id));
4327
4328                if not In_Open_Scopes (Inst_Par) then
4329                   Install_Parent (Inst_Par);
4330                   Parent_Installed := True;
4331                end if;
4332
4333             --  If it is a child unit of a non-generic parent, it may be
4334             --  use-visible and given by a direct name. Install parent as
4335             --  for other cases.
4336
4337             elsif Is_Generic_Unit (E)
4338               and then Is_Child_Unit (E)
4339               and then
4340                 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
4341               and then not Is_Generic_Unit (Scope (E))
4342             then
4343                if not In_Open_Scopes (Scope (E)) then
4344                   Install_Parent (Scope (E));
4345                   Parent_Installed := True;
4346                end if;
4347             end if;
4348          end if;
4349       end if;
4350    end Check_Generic_Child_Unit;
4351
4352    -----------------------------
4353    -- Check_Hidden_Child_Unit --
4354    -----------------------------
4355
4356    procedure Check_Hidden_Child_Unit
4357      (N           : Node_Id;
4358       Gen_Unit    : Entity_Id;
4359       Act_Decl_Id : Entity_Id)
4360    is
4361       Gen_Id : constant Node_Id := Name (N);
4362
4363    begin
4364       if Is_Child_Unit (Gen_Unit)
4365         and then Is_Child_Unit (Act_Decl_Id)
4366         and then Nkind (Gen_Id) = N_Expanded_Name
4367         and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
4368         and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
4369       then
4370          Error_Msg_Node_2 := Scope (Act_Decl_Id);
4371          Error_Msg_NE
4372            ("generic unit & is implicitly declared in &",
4373              Defining_Unit_Name (N), Gen_Unit);
4374          Error_Msg_N ("\instance must have different name",
4375            Defining_Unit_Name (N));
4376       end if;
4377    end Check_Hidden_Child_Unit;
4378
4379    ------------------------
4380    -- Check_Private_View --
4381    ------------------------
4382
4383    procedure Check_Private_View (N : Node_Id) is
4384       T : constant Entity_Id := Etype (N);
4385       BT : Entity_Id;
4386
4387    begin
4388       --  Exchange views if the type was not private in the generic but is
4389       --  private at the point of instantiation. Do not exchange views if
4390       --  the scope of the type is in scope. This can happen if both generic
4391       --  and instance are sibling units, or if type is defined in a parent.
4392       --  In this case the visibility of the type will be correct for all
4393       --  semantic checks.
4394
4395       if Present (T) then
4396          BT := Base_Type (T);
4397
4398          if Is_Private_Type (T)
4399            and then not Has_Private_View (N)
4400            and then Present (Full_View (T))
4401            and then not In_Open_Scopes (Scope (T))
4402          then
4403             --  In the generic, the full type was visible. Save the
4404             --  private entity, for subsequent exchange.
4405
4406             Switch_View (T);
4407
4408          elsif Has_Private_View (N)
4409            and then not Is_Private_Type (T)
4410            and then not Has_Been_Exchanged (T)
4411            and then Etype (Get_Associated_Node (N)) /= T
4412          then
4413             --  Only the private declaration was visible in the generic. If
4414             --  the type appears in a subtype declaration, the subtype in the
4415             --  instance must have a view compatible with that of its parent,
4416             --  which must be exchanged (see corresponding code in Restore_
4417             --  Private_Views). Otherwise, if the type is defined in a parent
4418             --  unit, leave full visibility within instance, which is safe.
4419
4420             if In_Open_Scopes (Scope (Base_Type (T)))
4421               and then not Is_Private_Type (Base_Type (T))
4422               and then Comes_From_Source (Base_Type (T))
4423             then
4424                null;
4425
4426             elsif Nkind (Parent (N)) = N_Subtype_Declaration
4427               or else not In_Private_Part (Scope (Base_Type (T)))
4428             then
4429                Append_Elmt (T, Exchanged_Views);
4430                Exchange_Declarations (Etype (Get_Associated_Node (N)));
4431             end if;
4432
4433          --  For composite types with inconsistent representation
4434          --  exchange component types accordingly.
4435
4436          elsif Is_Access_Type (T)
4437            and then Is_Private_Type (Designated_Type (T))
4438            and then not Has_Private_View (N)
4439            and then Present (Full_View (Designated_Type (T)))
4440          then
4441             Switch_View (Designated_Type (T));
4442
4443          elsif Is_Array_Type (T)
4444            and then Is_Private_Type (Component_Type (T))
4445            and then not Has_Private_View (N)
4446            and then Present (Full_View (Component_Type (T)))
4447          then
4448             Switch_View (Component_Type (T));
4449
4450          elsif Is_Private_Type (T)
4451            and then Present (Full_View (T))
4452            and then Is_Array_Type (Full_View (T))
4453            and then Is_Private_Type (Component_Type (Full_View (T)))
4454          then
4455             Switch_View (T);
4456
4457          --  Finally, a non-private subtype may have a private base type,
4458          --  which must be exchanged for consistency. This can happen when
4459          --  instantiating a package body, when the scope stack is empty
4460          --  but in fact the subtype and the base type are declared in an
4461          --  enclosing scope.
4462
4463          elsif not Is_Private_Type (T)
4464            and then not Has_Private_View (N)
4465            and then Is_Private_Type (Base_Type (T))
4466            and then Present (Full_View (BT))
4467            and then not Is_Generic_Type (BT)
4468            and then not In_Open_Scopes (BT)
4469          then
4470             Append_Elmt (Full_View (BT), Exchanged_Views);
4471             Exchange_Declarations (BT);
4472          end if;
4473       end if;
4474    end Check_Private_View;
4475
4476    --------------------------
4477    -- Contains_Instance_Of --
4478    --------------------------
4479
4480    function Contains_Instance_Of
4481      (Inner : Entity_Id;
4482       Outer : Entity_Id;
4483       N     : Node_Id)
4484       return  Boolean
4485    is
4486       Elmt : Elmt_Id;
4487       Scop : Entity_Id;
4488
4489    begin
4490       Scop := Outer;
4491
4492       --  Verify that there are no circular instantiations. We check whether
4493       --  the unit contains an instance of the current scope or some enclosing
4494       --  scope (in case one of the instances appears in a subunit). Longer
4495       --  circularities involving subunits might seem too pathological to
4496       --  consider, but they were not too pathological for the authors of
4497       --  DEC bc30vsq, so we loop over all enclosing scopes, and mark all
4498       --  enclosing generic scopes as containing an instance.
4499
4500       loop
4501          --  Within a generic subprogram body, the scope is not generic, to
4502          --  allow for recursive subprograms. Use the declaration to determine
4503          --  whether this is a generic unit.
4504
4505          if Ekind (Scop) = E_Generic_Package
4506            or else (Is_Subprogram (Scop)
4507                       and then Nkind (Unit_Declaration_Node (Scop)) =
4508                                         N_Generic_Subprogram_Declaration)
4509          then
4510             Elmt := First_Elmt (Inner_Instances (Inner));
4511
4512             while Present (Elmt) loop
4513                if Node (Elmt) = Scop then
4514                   Error_Msg_Node_2 := Inner;
4515                   Error_Msg_NE
4516                     ("circular Instantiation: & instantiated within &!",
4517                        N, Scop);
4518                   return True;
4519
4520                elsif Node (Elmt) = Inner then
4521                   return True;
4522
4523                elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
4524                   Error_Msg_Node_2 := Inner;
4525                   Error_Msg_NE
4526                     ("circular Instantiation: & instantiated within &!",
4527                       N, Node (Elmt));
4528                   return True;
4529                end if;
4530
4531                Next_Elmt (Elmt);
4532             end loop;
4533
4534             --  Indicate that Inner is being instantiated within  Scop.
4535
4536             Append_Elmt (Inner, Inner_Instances (Scop));
4537          end if;
4538
4539          if Scop = Standard_Standard then
4540             exit;
4541          else
4542             Scop := Scope (Scop);
4543          end if;
4544       end loop;
4545
4546       return False;
4547    end Contains_Instance_Of;
4548
4549    -----------------------
4550    -- Copy_Generic_Node --
4551    -----------------------
4552
4553    function Copy_Generic_Node
4554      (N             : Node_Id;
4555       Parent_Id     : Node_Id;
4556       Instantiating : Boolean)
4557       return          Node_Id
4558    is
4559       Ent   : Entity_Id;
4560       New_N : Node_Id;
4561
4562       function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
4563       --  Check the given value of one of the Fields referenced by the
4564       --  current node to determine whether to copy it recursively. The
4565       --  field may hold a Node_Id, a List_Id, or an Elist_Id, or a plain
4566       --  value (Sloc, Uint, Char) in which case it need not be copied.
4567
4568       procedure Copy_Descendants;
4569       --  Common utility for various nodes.
4570
4571       function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
4572       --  Make copy of element list.
4573
4574       function Copy_Generic_List
4575         (L         : List_Id;
4576          Parent_Id : Node_Id)
4577          return      List_Id;
4578       --  Apply Copy_Node recursively to the members of a node list.
4579
4580       function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
4581       --  True if an identifier is part of the defining program unit name
4582       --  of a child unit. The entity of such an identifier must be kept
4583       --  (for ASIS use) even though as the name of an enclosing generic
4584       --   it would otherwise not be preserved in the generic tree.
4585
4586       -----------------------
4587       --  Copy_Descendants --
4588       -----------------------
4589
4590       procedure Copy_Descendants is
4591
4592          use Atree.Unchecked_Access;
4593          --  This code section is part of the implementation of an untyped
4594          --  tree traversal, so it needs direct access to node fields.
4595
4596       begin
4597          Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
4598          Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
4599          Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
4600          Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
4601          Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
4602       end Copy_Descendants;
4603
4604       -----------------------------
4605       -- Copy_Generic_Descendant --
4606       -----------------------------
4607
4608       function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
4609       begin
4610          if D = Union_Id (Empty) then
4611             return D;
4612
4613          elsif D in Node_Range then
4614             return Union_Id
4615               (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
4616
4617          elsif D in List_Range then
4618             return Union_Id (Copy_Generic_List (List_Id (D), New_N));
4619
4620          elsif D in Elist_Range then
4621             return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
4622
4623          --  Nothing else is copyable (e.g. Uint values), return as is
4624
4625          else
4626             return D;
4627          end if;
4628       end Copy_Generic_Descendant;
4629
4630       ------------------------
4631       -- Copy_Generic_Elist --
4632       ------------------------
4633
4634       function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
4635          M : Elmt_Id;
4636          L : Elist_Id;
4637
4638       begin
4639          if Present (E) then
4640             L := New_Elmt_List;
4641             M := First_Elmt (E);
4642             while Present (M) loop
4643                Append_Elmt
4644                  (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
4645                Next_Elmt (M);
4646             end loop;
4647
4648             return L;
4649
4650          else
4651             return No_Elist;
4652          end if;
4653       end Copy_Generic_Elist;
4654
4655       -----------------------
4656       -- Copy_Generic_List --
4657       -----------------------
4658
4659       function Copy_Generic_List
4660         (L         : List_Id;
4661          Parent_Id : Node_Id)
4662          return      List_Id
4663       is
4664          N     : Node_Id;
4665          New_L : List_Id;
4666
4667       begin
4668          if Present (L) then
4669             New_L := New_List;
4670             Set_Parent (New_L, Parent_Id);
4671
4672             N := First (L);
4673             while Present (N) loop
4674                Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
4675                Next (N);
4676             end loop;
4677
4678             return New_L;
4679
4680          else
4681             return No_List;
4682          end if;
4683       end Copy_Generic_List;
4684
4685       ---------------------------
4686       -- In_Defining_Unit_Name --
4687       ---------------------------
4688
4689       function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
4690       begin
4691          return Present (Parent (Nam))
4692            and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
4693                       or else
4694                         (Nkind (Parent (Nam)) = N_Expanded_Name
4695                           and then In_Defining_Unit_Name (Parent (Nam))));
4696       end In_Defining_Unit_Name;
4697
4698    --  Start of processing for Copy_Generic_Node
4699
4700    begin
4701       if N = Empty then
4702          return N;
4703       end if;
4704
4705       New_N := New_Copy (N);
4706
4707       if Instantiating then
4708          Adjust_Instantiation_Sloc (New_N, S_Adjustment);
4709       end if;
4710
4711       if not Is_List_Member (N) then
4712          Set_Parent (New_N, Parent_Id);
4713       end if;
4714
4715       --  If defining identifier, then all fields have been copied already
4716
4717       if Nkind (New_N) in N_Entity then
4718          null;
4719
4720       --  Special casing for identifiers and other entity names and operators
4721
4722       elsif     Nkind (New_N) = N_Identifier
4723         or else Nkind (New_N) = N_Character_Literal
4724         or else Nkind (New_N) = N_Expanded_Name
4725         or else Nkind (New_N) = N_Operator_Symbol
4726         or else Nkind (New_N) in N_Op
4727       then
4728          if not Instantiating then
4729
4730             --  Link both nodes in order to assign subsequently the
4731             --  entity of the copy to the original node, in case this
4732             --  is a global reference.
4733
4734             Set_Associated_Node (N, New_N);
4735
4736             --  If we are within an instantiation, this is a nested generic
4737             --  that has already been analyzed at the point of definition. We
4738             --  must preserve references that were global to the enclosing
4739             --  parent at that point. Other occurrences, whether global or
4740             --  local to the current generic, must be resolved anew, so we
4741             --  reset the entity in the generic copy. A global reference has
4742             --  a smaller depth than the parent, or else the same depth in
4743             --  case both are distinct compilation units.
4744
4745             --  It is also possible for Current_Instantiated_Parent to be
4746             --  defined, and for this not to be a nested generic, namely
4747             --  if the unit is loaded through Rtsfind. In that case, the
4748             --  entity of New_N is only a link to the associated node, and
4749             --  not a defining occurrence.
4750
4751             --  The entities for parent units in the defining_program_unit
4752             --  of a generic child unit are established when the context of
4753             --  the unit is first analyzed, before the generic copy is made.
4754             --  They are preserved in the copy for use in ASIS queries.
4755
4756             Ent := Entity (New_N);
4757
4758             if No (Current_Instantiated_Parent.Gen_Id) then
4759                if No (Ent)
4760                  or else Nkind (Ent) /= N_Defining_Identifier
4761                  or else not In_Defining_Unit_Name (N)
4762                then
4763                   Set_Associated_Node (New_N, Empty);
4764                end if;
4765
4766             elsif No (Ent)
4767               or else
4768                 not (Nkind (Ent) = N_Defining_Identifier
4769                        or else
4770                      Nkind (Ent) = N_Defining_Character_Literal
4771                        or else
4772                      Nkind (Ent) = N_Defining_Operator_Symbol)
4773               or else No (Scope (Ent))
4774               or else Scope (Ent) = Current_Instantiated_Parent.Gen_Id
4775               or else (Scope_Depth (Scope (Ent)) >
4776                              Scope_Depth (Current_Instantiated_Parent.Gen_Id)
4777                          and then
4778                        Get_Source_Unit (Ent) =
4779                        Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
4780             then
4781                Set_Associated_Node (New_N, Empty);
4782             end if;
4783
4784          --  Case of instantiating identifier or some other name or operator
4785
4786          else
4787             --  If the associated node is still defined, the entity in
4788             --  it is global, and must be copied to the instance.
4789             --  If this copy is being made for a body to inline, it is
4790             --  applied to an instantiated tree, and the entity is already
4791             --  present and must be also preserved.
4792
4793             declare
4794                Assoc : constant Node_Id := Get_Associated_Node (N);
4795             begin
4796                if Present (Assoc) then
4797                   if Nkind (Assoc) = Nkind (N) then
4798                      Set_Entity (New_N, Entity (Assoc));
4799                      Check_Private_View (N);
4800
4801                   elsif Nkind (Assoc) = N_Function_Call then
4802                      Set_Entity (New_N, Entity (Name (Assoc)));
4803
4804                   elsif (Nkind (Assoc) = N_Defining_Identifier
4805                           or else Nkind (Assoc) = N_Defining_Character_Literal
4806                           or else Nkind (Assoc) = N_Defining_Operator_Symbol)
4807                     and then Expander_Active
4808                   then
4809                      --  Inlining case: we are copying a tree that contains
4810                      --  global entities, which are preserved in the copy
4811                      --  to be used for subsequent inlining.
4812
4813                      null;
4814
4815                   else
4816                      Set_Entity (New_N, Empty);
4817                   end if;
4818                end if;
4819             end;
4820          end if;
4821
4822          --  For expanded name, we must copy the Prefix and Selector_Name
4823
4824          if Nkind (N) = N_Expanded_Name then
4825             Set_Prefix
4826               (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
4827
4828             Set_Selector_Name (New_N,
4829               Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
4830
4831          --  For operators, we must copy the right operand
4832
4833          elsif Nkind (N) in N_Op then
4834             Set_Right_Opnd (New_N,
4835               Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
4836
4837             --  And for binary operators, the left operand as well
4838
4839             if Nkind (N) in N_Binary_Op then
4840                Set_Left_Opnd (New_N,
4841                  Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
4842             end if;
4843          end if;
4844
4845       --  Special casing for stubs
4846
4847       elsif Nkind (N) in N_Body_Stub then
4848
4849          --  In any case, we must copy the specification or defining
4850          --  identifier as appropriate.
4851
4852          if Nkind (N) = N_Subprogram_Body_Stub then
4853             Set_Specification (New_N,
4854               Copy_Generic_Node (Specification (N), New_N, Instantiating));
4855
4856          else
4857             Set_Defining_Identifier (New_N,
4858               Copy_Generic_Node
4859                 (Defining_Identifier (N), New_N, Instantiating));
4860          end if;
4861
4862          --  If we are not instantiating, then this is where we load and
4863          --  analyze subunits, i.e. at the point where the stub occurs. A
4864          --  more permissivle system might defer this analysis to the point
4865          --  of instantiation, but this seems to complicated for now.
4866
4867          if not Instantiating then
4868             declare
4869                Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
4870                Subunit      : Node_Id;
4871                Unum         : Unit_Number_Type;
4872                New_Body     : Node_Id;
4873
4874             begin
4875                Unum :=
4876                  Load_Unit
4877                    (Load_Name  => Subunit_Name,
4878                     Required   => False,
4879                     Subunit    => True,
4880                     Error_Node => N);
4881
4882                --  If the proper body is not found, a warning message will
4883                --  be emitted when analyzing the stub, or later at the the
4884                --  point of instantiation. Here we just leave the stub as is.
4885
4886                if Unum = No_Unit then
4887                   Subunits_Missing := True;
4888                   goto Subunit_Not_Found;
4889                end if;
4890
4891                Subunit := Cunit (Unum);
4892
4893                if Nkind (Unit (Subunit)) /= N_Subunit then
4894                   Error_Msg_Sloc := Sloc (N);
4895                   Error_Msg_N
4896                     ("expected SEPARATE subunit to complete stub at#,"
4897                        & " found child unit", Subunit);
4898                   goto Subunit_Not_Found;
4899                end if;
4900
4901                --  We must create a generic copy of the subunit, in order
4902                --  to perform semantic analysis on it, and we must replace
4903                --  the stub in the original generic unit with the subunit,
4904                --  in order to preserve non-local references within.
4905
4906                --  Only the proper body needs to be copied. Library_Unit and
4907                --  context clause are simply inherited by the generic copy.
4908                --  Note that the copy (which may be recursive if there are
4909                --  nested subunits) must be done first, before attaching it
4910                --  to the enclosing generic.
4911
4912                New_Body :=
4913                  Copy_Generic_Node
4914                    (Proper_Body (Unit (Subunit)),
4915                     Empty, Instantiating => False);
4916
4917                --  Now place the original proper body in the original
4918                --  generic unit. This is a body, not a compilation unit.
4919
4920                Rewrite (N, Proper_Body (Unit (Subunit)));
4921                Set_Is_Compilation_Unit (Defining_Entity (N), False);
4922                Set_Was_Originally_Stub (N);
4923
4924                --  Finally replace the body of the subunit with its copy,
4925                --  and make this new subunit into the library unit of the
4926                --  generic copy, which does not have stubs any longer.
4927
4928                Set_Proper_Body (Unit (Subunit), New_Body);
4929                Set_Library_Unit (New_N, Subunit);
4930                Inherit_Context (Unit (Subunit), N);
4931             end;
4932
4933          --  If we are instantiating, this must be an error case, since
4934          --  otherwise we would have replaced the stub node by the proper
4935          --  body that corresponds. So just ignore it in the copy (i.e.
4936          --  we have copied it, and that is good enough).
4937
4938          else
4939             null;
4940          end if;
4941
4942          <<Subunit_Not_Found>> null;
4943
4944       --  If the node is a compilation unit, it is the subunit of a stub,
4945       --  which has been loaded already (see code below). In this case,
4946       --  the library unit field of N points to the parent unit (which
4947       --  is a compilation unit) and need not (and cannot!) be copied.
4948
4949       --  When the proper body of the stub is analyzed, thie library_unit
4950       --  link is used to establish the proper context (see sem_ch10).
4951
4952       --  The other fields of a compilation unit are copied as usual
4953
4954       elsif Nkind (N) = N_Compilation_Unit then
4955
4956          --  This code can only be executed when not instantiating, because
4957          --  in the copy made for an instantiation, the compilation unit
4958          --  node has disappeared at the point that a stub is replaced by
4959          --  its proper body.
4960
4961          pragma Assert (not Instantiating);
4962
4963          Set_Context_Items (New_N,
4964            Copy_Generic_List (Context_Items (N), New_N));
4965
4966          Set_Unit (New_N,
4967            Copy_Generic_Node (Unit (N), New_N, False));
4968
4969          Set_First_Inlined_Subprogram (New_N,
4970            Copy_Generic_Node
4971              (First_Inlined_Subprogram (N), New_N, False));
4972
4973          Set_Aux_Decls_Node (New_N,
4974            Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
4975
4976       --  For an assignment node, the assignment is known to be semantically
4977       --  legal if we are instantiating the template. This avoids incorrect
4978       --  diagnostics in generated code.
4979
4980       elsif Nkind (N) = N_Assignment_Statement then
4981
4982          --  Copy name and expression fields in usual manner
4983
4984          Set_Name (New_N,
4985            Copy_Generic_Node (Name (N), New_N, Instantiating));
4986
4987          Set_Expression (New_N,
4988            Copy_Generic_Node (Expression (N), New_N, Instantiating));
4989
4990          if Instantiating then
4991             Set_Assignment_OK (Name (New_N), True);
4992          end if;
4993
4994       elsif Nkind (N) = N_Aggregate
4995               or else Nkind (N) = N_Extension_Aggregate
4996       then
4997
4998          if not Instantiating then
4999             Set_Associated_Node (N, New_N);
5000
5001          else
5002             if Present (Get_Associated_Node (N))
5003               and then Nkind (Get_Associated_Node (N)) = Nkind (N)
5004             then
5005                --  In the generic the aggregate has some composite type. If at
5006                --  the point of instantiation the type has a private view,
5007                --  install the full view (and that of its ancestors, if any).
5008
5009                declare
5010                   T   : Entity_Id := (Etype (Get_Associated_Node (New_N)));
5011                   Rt  : Entity_Id;
5012
5013                begin
5014                   if Present (T)
5015                     and then Is_Private_Type (T)
5016                   then
5017                      Switch_View (T);
5018                   end if;
5019
5020                   if Present (T)
5021                     and then Is_Tagged_Type (T)
5022                     and then Is_Derived_Type (T)
5023                   then
5024                      Rt := Root_Type (T);
5025
5026                      loop
5027                         T := Etype (T);
5028
5029                         if Is_Private_Type (T) then
5030                            Switch_View (T);
5031                         end if;
5032
5033                         exit when T = Rt;
5034                      end loop;
5035                   end if;
5036                end;
5037             end if;
5038          end if;
5039
5040          --  Do not copy the associated node, which points to
5041          --  the generic copy of the aggregate.
5042
5043          declare
5044             use Atree.Unchecked_Access;
5045             --  This code section is part of the implementation of an untyped
5046             --  tree traversal, so it needs direct access to node fields.
5047
5048          begin
5049             Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
5050             Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
5051             Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
5052             Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
5053          end;
5054
5055       --  Allocators do not have an identifier denoting the access type,
5056       --  so we must locate it through the expression to check whether
5057       --  the views are consistent.
5058
5059       elsif Nkind (N) = N_Allocator
5060         and then Nkind (Expression (N)) = N_Qualified_Expression
5061         and then Is_Entity_Name (Subtype_Mark (Expression (N)))
5062         and then Instantiating
5063       then
5064          declare
5065             T     : constant Node_Id :=
5066                       Get_Associated_Node (Subtype_Mark (Expression (N)));
5067             Acc_T : Entity_Id;
5068
5069          begin
5070             if Present (T) then
5071                --  Retrieve the allocator node in the generic copy.
5072
5073                Acc_T := Etype (Parent (Parent (T)));
5074                if Present (Acc_T)
5075                  and then Is_Private_Type (Acc_T)
5076                then
5077                   Switch_View (Acc_T);
5078                end if;
5079             end if;
5080
5081             Copy_Descendants;
5082          end;
5083
5084       --  For a proper body, we must catch the case of a proper body that
5085       --  replaces a stub. This represents the point at which a separate
5086       --  compilation unit, and hence template file, may be referenced, so
5087       --  we must make a new source instantiation entry for the template
5088       --  of the subunit, and ensure that all nodes in the subunit are
5089       --  adjusted using this new source instantiation entry.
5090
5091       elsif Nkind (N) in N_Proper_Body then
5092          declare
5093             Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
5094
5095          begin
5096             if Instantiating and then Was_Originally_Stub (N) then
5097                Create_Instantiation_Source
5098                  (Instantiation_Node,
5099                   Defining_Entity (N),
5100                   False,
5101                   S_Adjustment);
5102             end if;
5103
5104             --  Now copy the fields of the proper body, using the new
5105             --  adjustment factor if one was needed as per test above.
5106
5107             Copy_Descendants;
5108
5109             --  Restore the original adjustment factor in case changed
5110
5111             S_Adjustment := Save_Adjustment;
5112          end;
5113
5114       --  Don't copy Ident or Comment pragmas, since the comment belongs
5115       --  to the generic unit, not to the instantiating unit.
5116
5117       elsif Nkind (N) = N_Pragma
5118         and then Instantiating
5119       then
5120          declare
5121             Prag_Id : constant Pragma_Id := Get_Pragma_Id (Chars (N));
5122
5123          begin
5124             if Prag_Id = Pragma_Ident
5125               or else Prag_Id = Pragma_Comment
5126             then
5127                New_N := Make_Null_Statement (Sloc (N));
5128
5129             else
5130                Copy_Descendants;
5131             end if;
5132          end;
5133
5134       elsif Nkind (N) = N_Integer_Literal
5135         or else Nkind (N) = N_Real_Literal
5136       then
5137          --  No descendant fields need traversing
5138
5139          null;
5140
5141       --  For the remaining nodes, copy recursively their descendants
5142
5143       else
5144          Copy_Descendants;
5145
5146          if Instantiating
5147            and then Nkind (N) = N_Subprogram_Body
5148          then
5149             Set_Generic_Parent (Specification (New_N), N);
5150          end if;
5151       end if;
5152
5153       return New_N;
5154    end Copy_Generic_Node;
5155
5156    ----------------------------
5157    -- Denotes_Formal_Package --
5158    ----------------------------
5159
5160    function Denotes_Formal_Package (Pack : Entity_Id) return Boolean is
5161       Par  : constant Entity_Id := Current_Instantiated_Parent.Act_Id;
5162       Scop : constant Entity_Id := Scope (Pack);
5163       E    : Entity_Id;
5164
5165    begin
5166       if Ekind (Scop) = E_Generic_Package
5167         or else Nkind (Unit_Declaration_Node (Scop)) =
5168                                          N_Generic_Subprogram_Declaration
5169       then
5170          return True;
5171
5172       elsif Nkind (Parent (Pack)) = N_Formal_Package_Declaration then
5173          return True;
5174
5175       elsif No (Par) then
5176          return False;
5177
5178       else
5179          --  Check whether this package is associated with a formal
5180          --  package of the enclosing instantiation. Iterate over the
5181          --  list of renamings.
5182
5183          E := First_Entity (Par);
5184          while Present (E) loop
5185             if Ekind (E) /= E_Package
5186               or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
5187             then
5188                null;
5189             elsif Renamed_Object (E) = Par then
5190                return False;
5191
5192             elsif Renamed_Object (E) = Pack then
5193                return True;
5194             end if;
5195
5196             Next_Entity (E);
5197          end loop;
5198
5199          return False;
5200       end if;
5201    end Denotes_Formal_Package;
5202
5203    -----------------
5204    -- End_Generic --
5205    -----------------
5206
5207    procedure End_Generic is
5208    begin
5209       --  ??? More things could be factored out in this
5210       --  routine. Should probably be done at a later stage.
5211
5212       Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
5213       Generic_Flags.Decrement_Last;
5214
5215       Expander_Mode_Restore;
5216    end End_Generic;
5217
5218    ----------------------
5219    -- Find_Actual_Type --
5220    ----------------------
5221
5222    function Find_Actual_Type
5223      (Typ       : Entity_Id;
5224       Gen_Scope : Entity_Id)
5225       return      Entity_Id
5226    is
5227       T : Entity_Id;
5228
5229    begin
5230       if not Is_Child_Unit (Gen_Scope) then
5231          return Get_Instance_Of (Typ);
5232
5233       elsif not Is_Generic_Type (Typ)
5234         or else Scope (Typ) = Gen_Scope
5235       then
5236          return Get_Instance_Of (Typ);
5237
5238       else
5239          T := Current_Entity (Typ);
5240          while Present (T) loop
5241             if In_Open_Scopes (Scope (T)) then
5242                return T;
5243             end if;
5244
5245             T := Homonym (T);
5246          end loop;
5247
5248          return Typ;
5249       end if;
5250    end Find_Actual_Type;
5251
5252    ----------------------------
5253    -- Freeze_Subprogram_Body --
5254    ----------------------------
5255
5256    procedure Freeze_Subprogram_Body
5257      (Inst_Node : Node_Id;
5258       Gen_Body  : Node_Id;
5259       Pack_Id   : Entity_Id)
5260   is
5261       F_Node   : Node_Id;
5262       Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
5263       Par      : constant Entity_Id := Scope (Gen_Unit);
5264       Enc_G    : Entity_Id;
5265       Enc_I    : Node_Id;
5266       E_G_Id   : Entity_Id;
5267
5268       function Earlier (N1, N2 : Node_Id) return Boolean;
5269       --  Yields True if N1 and N2 appear in the same compilation unit,
5270       --  ignoring subunits, and if N1 is to the left of N2 in a left-to-right
5271       --  traversal of the tree for the unit.
5272
5273       function Enclosing_Body (N : Node_Id) return Node_Id;
5274       --  Find innermost package body that encloses the given node, and which
5275       --  is not a compilation unit. Freeze nodes for the instance, or for its
5276       --  enclosing body, may be inserted after the enclosing_body of the
5277       --  generic unit.
5278
5279       function Package_Freeze_Node (B : Node_Id) return Node_Id;
5280       --  Find entity for given package body, and locate or create a freeze
5281       --  node for it.
5282
5283       function True_Parent (N : Node_Id) return Node_Id;
5284       --  For a subunit, return parent of corresponding stub.
5285
5286       -------------
5287       -- Earlier --
5288       -------------
5289
5290       function Earlier (N1, N2 : Node_Id) return Boolean is
5291          D1 : Integer := 0;
5292          D2 : Integer := 0;
5293          P1 : Node_Id := N1;
5294          P2 : Node_Id := N2;
5295
5296          procedure Find_Depth (P : in out Node_Id; D : in out Integer);
5297          --  Find distance from given node to enclosing compilation unit.
5298
5299          ----------------
5300          -- Find_Depth --
5301          ----------------
5302
5303          procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
5304          begin
5305             while Present (P)
5306               and then Nkind (P) /= N_Compilation_Unit
5307             loop
5308                P := True_Parent (P);
5309                D := D + 1;
5310             end loop;
5311          end Find_Depth;
5312
5313       --  Start of procesing for Earlier
5314
5315       begin
5316          Find_Depth (P1, D1);
5317          Find_Depth (P2, D2);
5318
5319          if P1 /= P2 then
5320             return False;
5321          else
5322             P1 := N1;
5323             P2 := N2;
5324          end if;
5325
5326          while D1 > D2 loop
5327             P1 := True_Parent (P1);
5328             D1 := D1 - 1;
5329          end loop;
5330
5331          while D2 > D1 loop
5332             P2 := True_Parent (P2);
5333             D2 := D2 - 1;
5334          end loop;
5335
5336          --  At this point P1 and P2 are at the same distance from the root.
5337          --  We examine their parents until we find a common declarative
5338          --  list, at which point we can establish their relative placement
5339          --  by comparing their ultimate slocs. If we reach the root,
5340          --  N1 and N2 do not descend from the same declarative list (e.g.
5341          --  one is nested in the declarative part and the other is in a block
5342          --  in the statement part) and the earlier one is already frozen.
5343
5344          while not Is_List_Member (P1)
5345            or else not Is_List_Member (P2)
5346            or else List_Containing (P1) /= List_Containing (P2)
5347          loop
5348             P1 := True_Parent (P1);
5349             P2 := True_Parent (P2);
5350
5351             if Nkind (Parent (P1)) = N_Subunit then
5352                P1 := Corresponding_Stub (Parent (P1));
5353             end if;
5354
5355             if Nkind (Parent (P2)) = N_Subunit then
5356                P2 := Corresponding_Stub (Parent (P2));
5357             end if;
5358
5359             if P1 = P2 then
5360                return False;
5361             end if;
5362          end loop;
5363
5364          return
5365            Top_Level_Location (Sloc (P1)) < Top_Level_Location (Sloc (P2));
5366       end Earlier;
5367
5368       --------------------
5369       -- Enclosing_Body --
5370       --------------------
5371
5372       function Enclosing_Body (N : Node_Id) return Node_Id is
5373          P : Node_Id := Parent (N);
5374
5375       begin
5376          while Present (P)
5377            and then Nkind (Parent (P)) /= N_Compilation_Unit
5378          loop
5379             if Nkind (P) = N_Package_Body then
5380
5381                if Nkind (Parent (P)) = N_Subunit then
5382                   return Corresponding_Stub (Parent (P));
5383                else
5384                   return P;
5385                end if;
5386             end if;
5387
5388             P := True_Parent (P);
5389          end loop;
5390
5391          return Empty;
5392       end Enclosing_Body;
5393
5394       -------------------------
5395       -- Package_Freeze_Node --
5396       -------------------------
5397
5398       function Package_Freeze_Node (B : Node_Id) return Node_Id is
5399          Id : Entity_Id;
5400
5401       begin
5402          if Nkind (B) = N_Package_Body then
5403             Id := Corresponding_Spec (B);
5404
5405          else pragma Assert (Nkind (B) = N_Package_Body_Stub);
5406             Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
5407          end if;
5408
5409          Ensure_Freeze_Node (Id);
5410          return Freeze_Node (Id);
5411       end Package_Freeze_Node;
5412
5413       -----------------
5414       -- True_Parent --
5415       -----------------
5416
5417       function True_Parent (N : Node_Id) return Node_Id is
5418       begin
5419          if Nkind (Parent (N)) = N_Subunit then
5420             return Parent (Corresponding_Stub (Parent (N)));
5421          else
5422             return Parent (N);
5423          end if;
5424       end True_Parent;
5425
5426    --  Start of processing of Freeze_Subprogram_Body
5427
5428    begin
5429       --  If the instance and the generic body appear within the same
5430       --  unit, and the instance preceeds the generic, the freeze node for
5431       --  the instance must appear after that of the generic. If the generic
5432       --  is nested within another instance I2, then current instance must
5433       --  be frozen after I2. In both cases, the freeze nodes are those of
5434       --  enclosing packages. Otherwise, the freeze node is placed at the end
5435       --  of the current declarative part.
5436
5437       Enc_G  := Enclosing_Body (Gen_Body);
5438       Enc_I  := Enclosing_Body (Inst_Node);
5439       Ensure_Freeze_Node (Pack_Id);
5440       F_Node := Freeze_Node (Pack_Id);
5441
5442       if Is_Generic_Instance (Par)
5443         and then Present (Freeze_Node (Par))
5444         and then
5445           In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
5446       then
5447          if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
5448
5449             --  The parent was a premature instantiation. Insert freeze
5450             --  node at the end the current declarative part.
5451
5452             Insert_After_Last_Decl (Inst_Node, F_Node);
5453
5454          else
5455             Insert_After (Freeze_Node (Par), F_Node);
5456          end if;
5457
5458       --  The body enclosing the instance should be frozen after the body
5459       --  that includes the generic, because the body of the instance may
5460       --  make references to entities therein. If the two are not in the
5461       --  same declarative part, or if the one enclosing the instance is
5462       --  frozen already, freeze the instance at the end of the current
5463       --  declarative part.
5464
5465       elsif Is_Generic_Instance (Par)
5466         and then Present (Freeze_Node (Par))
5467         and then Present (Enc_I)
5468       then
5469          if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
5470            or else
5471              (Nkind (Enc_I) = N_Package_Body
5472                and then
5473              In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
5474          then
5475             --  The enclosing package may contain several instances. Rather
5476             --  than computing the earliest point at which to insert its
5477             --  freeze node, we place it at the end of the declarative part
5478             --  of the parent of the generic.
5479
5480             Insert_After_Last_Decl
5481               (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
5482          end if;
5483
5484          Insert_After_Last_Decl (Inst_Node, F_Node);
5485
5486       elsif Present (Enc_G)
5487         and then Present (Enc_I)
5488         and then Enc_G /= Enc_I
5489         and then Earlier (Inst_Node, Gen_Body)
5490       then
5491          if Nkind (Enc_G) = N_Package_Body then
5492             E_G_Id := Corresponding_Spec (Enc_G);
5493          else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
5494             E_G_Id :=
5495               Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
5496          end if;
5497
5498          --  Freeze package that encloses instance, and place node after
5499          --  package that encloses generic. If enclosing package is already
5500          --  frozen we have to assume it is at the proper place. This may
5501          --  be a potential ABE that requires dynamic checking.
5502
5503          Insert_After_Last_Decl (Enc_G, Package_Freeze_Node (Enc_I));
5504
5505          --  Freeze enclosing subunit before instance
5506
5507          Ensure_Freeze_Node (E_G_Id);
5508
5509          if not Is_List_Member (Freeze_Node (E_G_Id)) then
5510             Insert_After (Enc_G, Freeze_Node (E_G_Id));
5511          end if;
5512
5513          Insert_After_Last_Decl (Inst_Node, F_Node);
5514
5515       else
5516          --  If none of the above, insert freeze node at the end of the
5517          --  current declarative part.
5518
5519          Insert_After_Last_Decl (Inst_Node, F_Node);
5520       end if;
5521    end Freeze_Subprogram_Body;
5522
5523    ----------------
5524    -- Get_Gen_Id --
5525    ----------------
5526
5527    function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
5528    begin
5529       return Generic_Renamings.Table (E).Gen_Id;
5530    end Get_Gen_Id;
5531
5532    ---------------------
5533    -- Get_Instance_Of --
5534    ---------------------
5535
5536    function Get_Instance_Of (A : Entity_Id) return Entity_Id is
5537       Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
5538
5539    begin
5540       if Res /= Assoc_Null then
5541          return Generic_Renamings.Table (Res).Act_Id;
5542       else
5543          --  On exit, entity is not instantiated: not a generic parameter,
5544          --  or else parameter of an inner generic unit.
5545
5546          return A;
5547       end if;
5548    end Get_Instance_Of;
5549
5550    ------------------------------------
5551    -- Get_Package_Instantiation_Node --
5552    ------------------------------------
5553
5554    function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
5555       Decl : Node_Id := Unit_Declaration_Node (A);
5556       Inst : Node_Id;
5557
5558    begin
5559       --  If the instantiation is a compilation unit that does not need a
5560       --  body then the instantiation node has been rewritten as a package
5561       --  declaration for the instance, and we return the original node.
5562
5563       --  If it is a compilation unit and the instance node has not been
5564       --  rewritten, then it is still the unit of the compilation. Finally,
5565       --  if a body is present, this is a parent of the main unit whose body
5566       --  has been compiled for inlining purposes, and the instantiation node
5567       --  has been rewritten with the instance body.
5568
5569       --  Otherwise the instantiation node appears after the declaration.
5570       --  If the entity is a formal package, the declaration may have been
5571       --  rewritten as a generic declaration (in the case of a formal with a
5572       --  box) or left as a formal package declaration if it has actuals, and
5573       --  is found with a forward search.
5574
5575       if Nkind (Parent (Decl)) = N_Compilation_Unit then
5576          if Nkind (Decl) = N_Package_Declaration
5577            and then Present (Corresponding_Body (Decl))
5578          then
5579             Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
5580          end if;
5581
5582          if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
5583             return Original_Node (Decl);
5584          else
5585             return Unit (Parent (Decl));
5586          end if;
5587
5588       elsif Nkind (Decl) = N_Generic_Package_Declaration
5589         and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
5590       then
5591          return Original_Node (Decl);
5592
5593       else
5594          Inst := Next (Decl);
5595          while Nkind (Inst) /= N_Package_Instantiation
5596            and then Nkind (Inst) /= N_Formal_Package_Declaration
5597          loop
5598             Next (Inst);
5599          end loop;
5600
5601          return Inst;
5602       end if;
5603    end Get_Package_Instantiation_Node;
5604
5605    ------------------------
5606    -- Has_Been_Exchanged --
5607    ------------------------
5608
5609    function Has_Been_Exchanged (E : Entity_Id) return Boolean is
5610       Next : Elmt_Id := First_Elmt (Exchanged_Views);
5611
5612    begin
5613       while Present (Next) loop
5614          if Full_View (Node (Next)) = E then
5615             return True;
5616          end if;
5617
5618          Next_Elmt (Next);
5619       end loop;
5620
5621       return False;
5622    end Has_Been_Exchanged;
5623
5624    ----------
5625    -- Hash --
5626    ----------
5627
5628    function Hash (F : Entity_Id) return HTable_Range is
5629    begin
5630       return HTable_Range (F mod HTable_Size);
5631    end Hash;
5632
5633    ------------------------
5634    -- Hide_Current_Scope --
5635    ------------------------
5636
5637    procedure Hide_Current_Scope is
5638       C : constant Entity_Id := Current_Scope;
5639       E : Entity_Id;
5640
5641    begin
5642       Set_Is_Hidden_Open_Scope (C);
5643       E := First_Entity (C);
5644
5645       while Present (E) loop
5646          if Is_Immediately_Visible (E) then
5647             Set_Is_Immediately_Visible (E, False);
5648             Append_Elmt (E, Hidden_Entities);
5649          end if;
5650
5651          Next_Entity (E);
5652       end loop;
5653
5654       --  Make the scope name invisible as well. This is necessary, but
5655       --  might conflict with calls to Rtsfind later on, in case the scope
5656       --  is a predefined one. There is no clean solution to this problem, so
5657       --  for now we depend on the user not redefining Standard itself in one
5658       --  of the parent units.
5659
5660       if Is_Immediately_Visible (C)
5661         and then C /= Standard_Standard
5662       then
5663          Set_Is_Immediately_Visible (C, False);
5664          Append_Elmt (C, Hidden_Entities);
5665       end if;
5666
5667    end Hide_Current_Scope;
5668
5669    --------------
5670    -- Init_Env --
5671    --------------
5672
5673    procedure Init_Env is
5674       Saved : Instance_Env;
5675
5676    begin
5677       Saved.Ada_Version         := Ada_Version;
5678       Saved.Instantiated_Parent := Current_Instantiated_Parent;
5679       Saved.Exchanged_Views     := Exchanged_Views;
5680       Saved.Hidden_Entities     := Hidden_Entities;
5681       Saved.Current_Sem_Unit    := Current_Sem_Unit;
5682       Instance_Envs.Increment_Last;
5683       Instance_Envs.Table (Instance_Envs.Last) := Saved;
5684
5685       Exchanged_Views := New_Elmt_List;
5686       Hidden_Entities := New_Elmt_List;
5687
5688       --  Make dummy entry for Instantiated parent. If generic unit is
5689       --  legal, this is set properly in Set_Instance_Env.
5690
5691       Current_Instantiated_Parent :=
5692         (Current_Scope, Current_Scope, Assoc_Null);
5693    end Init_Env;
5694
5695    ------------------------------
5696    -- In_Same_Declarative_Part --
5697    ------------------------------
5698
5699    function In_Same_Declarative_Part
5700      (F_Node : Node_Id;
5701       Inst   : Node_Id)
5702       return   Boolean
5703    is
5704       Decls : constant Node_Id := Parent (F_Node);
5705       Nod   : Node_Id := Parent (Inst);
5706
5707    begin
5708       while Present (Nod) loop
5709          if Nod = Decls then
5710             return True;
5711
5712          elsif Nkind (Nod) = N_Subprogram_Body
5713            or else Nkind (Nod) = N_Package_Body
5714            or else Nkind (Nod) = N_Task_Body
5715            or else Nkind (Nod) = N_Protected_Body
5716            or else Nkind (Nod) = N_Block_Statement
5717          then
5718             return False;
5719
5720          elsif Nkind (Nod) = N_Subunit then
5721             Nod :=  Corresponding_Stub (Nod);
5722
5723          elsif Nkind (Nod) = N_Compilation_Unit then
5724             return False;
5725          else
5726             Nod := Parent (Nod);
5727          end if;
5728       end loop;
5729
5730       return False;
5731    end In_Same_Declarative_Part;
5732
5733    ---------------------
5734    -- Inherit_Context --
5735    ---------------------
5736
5737    procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
5738       Current_Context : List_Id;
5739       Current_Unit    : Node_Id;
5740       Item            : Node_Id;
5741       New_I           : Node_Id;
5742
5743    begin
5744       if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
5745
5746          --  The inherited context is attached to the enclosing compilation
5747          --  unit. This is either the main unit, or the declaration for the
5748          --  main unit (in case the instantation appears within the package
5749          --  declaration and the main unit is its body).
5750
5751          Current_Unit := Parent (Inst);
5752          while Present (Current_Unit)
5753            and then Nkind (Current_Unit) /= N_Compilation_Unit
5754          loop
5755             Current_Unit := Parent (Current_Unit);
5756          end loop;
5757
5758          Current_Context := Context_Items (Current_Unit);
5759
5760          Item := First (Context_Items (Parent (Gen_Decl)));
5761          while Present (Item) loop
5762             if Nkind (Item) = N_With_Clause then
5763                New_I := New_Copy (Item);
5764                Set_Implicit_With (New_I, True);
5765                Append (New_I, Current_Context);
5766             end if;
5767
5768             Next (Item);
5769          end loop;
5770       end if;
5771    end Inherit_Context;
5772
5773    ----------------
5774    -- Initialize --
5775    ----------------
5776
5777    procedure Initialize is
5778    begin
5779       Generic_Renamings.Init;
5780       Instance_Envs.Init;
5781       Generic_Flags.Init;
5782       Generic_Renamings_HTable.Reset;
5783       Circularity_Detected := False;
5784       Exchanged_Views      := No_Elist;
5785       Hidden_Entities      := No_Elist;
5786    end Initialize;
5787
5788    ----------------------------
5789    -- Insert_After_Last_Decl --
5790    ----------------------------
5791
5792    procedure Insert_After_Last_Decl (N : Node_Id; F_Node : Node_Id) is
5793       L : List_Id          := List_Containing (N);
5794       P : constant Node_Id := Parent (L);
5795
5796    begin
5797       if not Is_List_Member (F_Node) then
5798          if Nkind (P) = N_Package_Specification
5799            and then L = Visible_Declarations (P)
5800            and then Present (Private_Declarations (P))
5801            and then not Is_Empty_List (Private_Declarations (P))
5802          then
5803             L := Private_Declarations (P);
5804          end if;
5805
5806          Insert_After (Last (L), F_Node);
5807       end if;
5808    end Insert_After_Last_Decl;
5809
5810    ------------------
5811    -- Install_Body --
5812    ------------------
5813
5814    procedure Install_Body
5815      (Act_Body : Node_Id;
5816       N        : Node_Id;
5817       Gen_Body : Node_Id;
5818       Gen_Decl : Node_Id)
5819    is
5820       Act_Id    : constant Entity_Id := Corresponding_Spec (Act_Body);
5821       Act_Unit  : constant Node_Id   := Unit (Cunit (Get_Source_Unit (N)));
5822       Gen_Id    : constant Entity_Id := Corresponding_Spec (Gen_Body);
5823       Par       : constant Entity_Id := Scope (Gen_Id);
5824       Gen_Unit  : constant Node_Id :=
5825                     Unit (Cunit (Get_Source_Unit (Gen_Decl)));
5826       Orig_Body : Node_Id := Gen_Body;
5827       F_Node    : Node_Id;
5828       Body_Unit : Node_Id;
5829
5830       Must_Delay : Boolean;
5831
5832       function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
5833       --  Find subprogram (if any) that encloses instance and/or generic body.
5834
5835       function True_Sloc (N : Node_Id) return Source_Ptr;
5836       --  If the instance is nested inside a generic unit, the Sloc of the
5837       --  instance indicates the place of the original definition, not the
5838       --  point of the current enclosing instance. Pending a better usage of
5839       --  Slocs to indicate instantiation places, we determine the place of
5840       --  origin of a node by finding the maximum sloc of any ancestor node.
5841       --  Why is this not equivalent fo Top_Level_Location ???
5842
5843       function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
5844          Scop : Entity_Id := Scope (Id);
5845
5846       begin
5847          while Scop /= Standard_Standard
5848            and then not Is_Overloadable (Scop)
5849          loop
5850             Scop := Scope (Scop);
5851          end loop;
5852
5853          return Scop;
5854       end Enclosing_Subp;
5855
5856       function True_Sloc (N : Node_Id) return Source_Ptr is
5857          Res : Source_Ptr;
5858          N1  : Node_Id;
5859
5860       begin
5861          Res := Sloc (N);
5862          N1 := N;
5863          while Present (N1) and then N1 /= Act_Unit loop
5864             if Sloc (N1) > Res then
5865                Res := Sloc (N1);
5866             end if;
5867
5868             N1 := Parent (N1);
5869          end loop;
5870
5871          return Res;
5872       end True_Sloc;
5873
5874    --  Start of processing for Install_Body
5875
5876    begin
5877       --  If the body is a subunit, the freeze point is the corresponding
5878       --  stub in the current compilation, not the subunit itself.
5879
5880       if Nkind (Parent (Gen_Body)) = N_Subunit then
5881          Orig_Body :=  Corresponding_Stub (Parent (Gen_Body));
5882       else
5883          Orig_Body := Gen_Body;
5884       end if;
5885
5886       Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
5887
5888       --  If the instantiation and the generic definition appear in the
5889       --  same package declaration, this is an early instantiation.
5890       --  If they appear in the same declarative part, it is an early
5891       --  instantiation only if the generic body appears textually later,
5892       --  and the generic body is also in the main unit.
5893
5894       --  If instance is nested within a subprogram, and the generic body is
5895       --  not, the instance is delayed because the enclosing body is. If
5896       --  instance and body are within the same scope, or the same sub-
5897       --  program body, indicate explicitly that the instance is delayed.
5898
5899       Must_Delay :=
5900         (Gen_Unit = Act_Unit
5901           and then ((Nkind (Gen_Unit) = N_Package_Declaration)
5902                       or else Nkind (Gen_Unit) = N_Generic_Package_Declaration
5903                       or else (Gen_Unit = Body_Unit
5904                                 and then True_Sloc (N) < Sloc (Orig_Body)))
5905           and then Is_In_Main_Unit (Gen_Unit)
5906           and then (Scope (Act_Id) = Scope (Gen_Id)
5907                       or else
5908                     Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
5909
5910       --  If this is an early instantiation, the freeze node is placed after
5911       --  the generic body. Otherwise, if the generic appears in an instance,
5912       --  we cannot freeze the current instance until the outer one is frozen.
5913       --  This is only relevant if the current instance is nested within some
5914       --  inner scope not itself within the outer instance. If this scope is
5915       --  a package body in the same declarative part as the outer instance,
5916       --  then that body needs to be frozen after the outer instance. Finally,
5917       --  if no delay is needed, we place the freeze node at the end of the
5918       --  current declarative part.
5919
5920       if Expander_Active then
5921          Ensure_Freeze_Node (Act_Id);
5922          F_Node := Freeze_Node (Act_Id);
5923
5924          if Must_Delay then
5925             Insert_After (Orig_Body, F_Node);
5926
5927          elsif Is_Generic_Instance (Par)
5928            and then Present (Freeze_Node (Par))
5929            and then Scope (Act_Id) /= Par
5930          then
5931             --  Freeze instance of inner generic after instance of enclosing
5932             --  generic.
5933
5934             if In_Same_Declarative_Part (Freeze_Node (Par), N) then
5935                Insert_After (Freeze_Node (Par), F_Node);
5936
5937             --  Freeze package enclosing instance of inner generic after
5938             --  instance of enclosing generic.
5939
5940             elsif Nkind (Parent (N)) = N_Package_Body
5941               and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
5942             then
5943
5944                declare
5945                   Enclosing : constant Entity_Id :=
5946                                 Corresponding_Spec (Parent (N));
5947
5948                begin
5949                   Insert_After_Last_Decl (N, F_Node);
5950                   Ensure_Freeze_Node (Enclosing);
5951
5952                   if not Is_List_Member (Freeze_Node (Enclosing)) then
5953                      Insert_After (Freeze_Node (Par), Freeze_Node (Enclosing));
5954                   end if;
5955                end;
5956
5957             else
5958                Insert_After_Last_Decl (N, F_Node);
5959             end if;
5960
5961          else
5962             Insert_After_Last_Decl (N, F_Node);
5963          end if;
5964       end if;
5965
5966       Set_Is_Frozen (Act_Id);
5967       Insert_Before (N, Act_Body);
5968       Mark_Rewrite_Insertion (Act_Body);
5969    end Install_Body;
5970
5971    --------------------
5972    -- Install_Parent --
5973    --------------------
5974
5975    procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
5976       Ancestors : constant Elist_Id  := New_Elmt_List;
5977       S         : constant Entity_Id := Current_Scope;
5978       Inst_Par  : Entity_Id;
5979       First_Par : Entity_Id;
5980       Inst_Node : Node_Id;
5981       Gen_Par   : Entity_Id;
5982       First_Gen : Entity_Id;
5983       Elmt      : Elmt_Id;
5984
5985       procedure Install_Formal_Packages (Par : Entity_Id);
5986       --  If any of the formals of the parent are formal packages with box,
5987       --  their formal parts are visible in the parent and thus in the child
5988       --  unit as well. Analogous to what is done in Check_Generic_Actuals
5989       --  for the unit itself.
5990
5991       procedure Install_Noninstance_Specs (Par : Entity_Id);
5992       --  Install the scopes of noninstance parent units ending with Par.
5993
5994       procedure Install_Spec (Par : Entity_Id);
5995       --  The child unit is within the declarative part of the parent, so
5996       --  the declarations within the parent are immediately visible.
5997
5998       -----------------------------
5999       -- Install_Formal_Packages --
6000       -----------------------------
6001
6002       procedure Install_Formal_Packages (Par : Entity_Id) is
6003          E : Entity_Id;
6004
6005       begin
6006          E := First_Entity (Par);
6007
6008          while Present (E) loop
6009
6010             if Ekind (E) = E_Package
6011               and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
6012             then
6013                --  If this is the renaming for the parent instance, done.
6014
6015                if Renamed_Object (E) = Par then
6016                   exit;
6017
6018                --  The visibility of a formal of an enclosing generic is
6019                --  already correct.
6020
6021                elsif Denotes_Formal_Package (E) then
6022                   null;
6023
6024                elsif Present (Associated_Formal_Package (E))
6025                  and then Box_Present (Parent (Associated_Formal_Package (E)))
6026                then
6027                   Check_Generic_Actuals (Renamed_Object (E), True);
6028                   Set_Is_Hidden (E, False);
6029                end if;
6030             end if;
6031
6032             Next_Entity (E);
6033          end loop;
6034       end Install_Formal_Packages;
6035
6036       -------------------------------
6037       -- Install_Noninstance_Specs --
6038       -------------------------------
6039
6040       procedure Install_Noninstance_Specs (Par : Entity_Id) is
6041       begin
6042          if Present (Par)
6043            and then Par /= Standard_Standard
6044            and then not In_Open_Scopes (Par)
6045          then
6046             Install_Noninstance_Specs (Scope (Par));
6047             Install_Spec (Par);
6048          end if;
6049       end Install_Noninstance_Specs;
6050
6051       ------------------
6052       -- Install_Spec --
6053       ------------------
6054
6055       procedure Install_Spec (Par : Entity_Id) is
6056          Spec : constant Node_Id :=
6057                   Specification (Unit_Declaration_Node (Par));
6058
6059       begin
6060          New_Scope (Par);
6061          Set_Is_Immediately_Visible   (Par);
6062          Install_Visible_Declarations (Par);
6063          Install_Private_Declarations (Par);
6064          Set_Use (Visible_Declarations (Spec));
6065          Set_Use (Private_Declarations (Spec));
6066       end Install_Spec;
6067
6068    --  Start of processing for Install_Parent
6069
6070    begin
6071       --  We need to install the parent instance to compile the instantiation
6072       --  of the child, but the child instance must appear in the current
6073       --  scope. Given that we cannot place the parent above the current
6074       --  scope in the scope stack, we duplicate the current scope and unstack
6075       --  both after the instantiation is complete.
6076
6077       --  If the parent is itself the instantiation of a child unit, we must
6078       --  also stack the instantiation of its parent, and so on. Each such
6079       --  ancestor is the prefix of the name in a prior instantiation.
6080
6081       --  If this is a nested instance, the parent unit itself resolves to
6082       --  a renaming of the parent instance, whose declaration we need.
6083
6084       --  Finally, the parent may be a generic (not an instance) when the
6085       --  child unit appears as a formal package.
6086
6087       Inst_Par := P;
6088
6089       if Present (Renamed_Entity (Inst_Par)) then
6090          Inst_Par := Renamed_Entity (Inst_Par);
6091       end if;
6092
6093       First_Par := Inst_Par;
6094
6095       Gen_Par :=
6096         Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
6097
6098       First_Gen := Gen_Par;
6099
6100       while Present (Gen_Par)
6101         and then Is_Child_Unit (Gen_Par)
6102       loop
6103          --  Load grandparent instance as well
6104
6105          Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
6106
6107          if Nkind (Name (Inst_Node)) = N_Expanded_Name then
6108             Inst_Par := Entity (Prefix (Name (Inst_Node)));
6109
6110             if Present (Renamed_Entity (Inst_Par)) then
6111                Inst_Par := Renamed_Entity (Inst_Par);
6112             end if;
6113
6114             Gen_Par :=
6115               Generic_Parent
6116                 (Specification (Unit_Declaration_Node (Inst_Par)));
6117
6118             if Present (Gen_Par) then
6119                Prepend_Elmt (Inst_Par, Ancestors);
6120
6121             else
6122                --  Parent is not the name of an instantiation
6123
6124                Install_Noninstance_Specs (Inst_Par);
6125
6126                exit;
6127             end if;
6128
6129          else
6130             --  Previous error
6131
6132             exit;
6133          end if;
6134       end loop;
6135
6136       if Present (First_Gen) then
6137          Append_Elmt (First_Par, Ancestors);
6138
6139       else
6140          Install_Noninstance_Specs (First_Par);
6141       end if;
6142
6143       if not Is_Empty_Elmt_List (Ancestors) then
6144          Elmt := First_Elmt (Ancestors);
6145
6146          while Present (Elmt) loop
6147             Install_Spec (Node (Elmt));
6148             Install_Formal_Packages (Node (Elmt));
6149
6150             Next_Elmt (Elmt);
6151          end loop;
6152       end if;
6153
6154       if not In_Body then
6155          New_Scope (S);
6156       end if;
6157    end Install_Parent;
6158
6159    --------------------------------
6160    -- Instantiate_Formal_Package --
6161    --------------------------------
6162
6163    function Instantiate_Formal_Package
6164      (Formal          : Node_Id;
6165       Actual          : Node_Id;
6166       Analyzed_Formal : Node_Id)
6167       return            List_Id
6168    is
6169       Loc         : constant Source_Ptr := Sloc (Actual);
6170       Actual_Pack : Entity_Id;
6171       Formal_Pack : Entity_Id;
6172       Gen_Parent  : Entity_Id;
6173       Decls       : List_Id;
6174       Nod         : Node_Id;
6175       Parent_Spec : Node_Id;
6176
6177       procedure Find_Matching_Actual
6178        (F    : Node_Id;
6179         Act  : in out Entity_Id);
6180       --  We need to associate each formal entity in the formal package
6181       --  with the corresponding entity in the actual package. The actual
6182       --  package has been analyzed and possibly expanded, and as a result
6183       --  there is no one-to-one correspondence between the two lists (for
6184       --  example, the actual may include subtypes, itypes, and inherited
6185       --  primitive operations, interspersed among the renaming declarations
6186       --  for the actuals) . We retrieve the corresponding actual by name
6187       --  because each actual has the same name as the formal, and they do
6188       --  appear in the same order.
6189
6190       function Formal_Entity
6191         (F       : Node_Id;
6192          Act_Ent : Entity_Id)
6193          return    Entity_Id;
6194       --  Returns the entity associated with the given formal F. In the
6195       --  case where F is a formal package, this function will iterate
6196       --  through all of F's formals and enter map associations from the
6197       --  actuals occurring in the formal package's corresponding actual
6198       --  package (obtained via Act_Ent) to the formal package's formal
6199       --  parameters. This function is called recursively for arbitrary
6200       --  levels of formal packages.
6201
6202       function Is_Instance_Of
6203         (Act_Spec : Entity_Id;
6204          Gen_Anc  : Entity_Id)
6205          return     Boolean;
6206       --  The actual can be an instantiation of a generic within another
6207       --  instance, in which case there is no direct link from it to the
6208       --  original generic ancestor. In that case, we recognize that the
6209       --  ultimate ancestor is the same by examining names and scopes.
6210
6211       procedure Map_Entities (Form : Entity_Id; Act : Entity_Id);
6212       --  Within the generic part, entities in the formal package are
6213       --  visible. To validate subsequent type declarations, indicate
6214       --  the correspondence betwen the entities in the analyzed formal,
6215       --  and the entities in  the actual package. There are three packages
6216       --  involved in the instantiation of a formal package: the parent
6217       --  generic P1 which appears in the generic declaration, the fake
6218       --  instantiation P2 which appears in the analyzed generic, and whose
6219       --  visible entities may be used in subsequent formals, and the actual
6220       --  P3 in the instance. To validate subsequent formals, me indicate
6221       --  that the entities in P2 are mapped into those of P3. The mapping of
6222       --  entities has to be done recursively for nested packages.
6223
6224       --------------------------
6225       -- Find_Matching_Actual --
6226       --------------------------
6227
6228       procedure Find_Matching_Actual
6229         (F   : Node_Id;
6230          Act : in out Entity_Id)
6231      is
6232          Formal_Ent : Entity_Id;
6233
6234       begin
6235          case Nkind (Original_Node (F)) is
6236             when N_Formal_Object_Declaration |
6237                  N_Formal_Type_Declaration   =>
6238                Formal_Ent := Defining_Identifier (F);
6239
6240                while Chars (Act) /= Chars (Formal_Ent) loop
6241                   Next_Entity (Act);
6242                end loop;
6243
6244             when N_Formal_Subprogram_Declaration |
6245                  N_Formal_Package_Declaration    |
6246                  N_Package_Declaration           |
6247                  N_Generic_Package_Declaration   =>
6248                Formal_Ent := Defining_Entity (F);
6249
6250                while Chars (Act) /= Chars (Formal_Ent) loop
6251                   Next_Entity (Act);
6252                end loop;
6253
6254             when others =>
6255                raise Program_Error;
6256          end case;
6257       end Find_Matching_Actual;
6258
6259       -------------------
6260       -- Formal_Entity --
6261       -------------------
6262
6263       function Formal_Entity
6264         (F       : Node_Id;
6265          Act_Ent : Entity_Id)
6266          return    Entity_Id
6267       is
6268          Orig_Node : Node_Id := F;
6269          Act_Pkg   : Entity_Id;
6270
6271       begin
6272          case Nkind (Original_Node (F)) is
6273             when N_Formal_Object_Declaration     =>
6274                return Defining_Identifier (F);
6275
6276             when N_Formal_Type_Declaration       =>
6277                return Defining_Identifier (F);
6278
6279             when N_Formal_Subprogram_Declaration =>
6280                return Defining_Unit_Name (Specification (F));
6281
6282             when N_Package_Declaration           =>
6283                return Defining_Unit_Name (Specification (F));
6284
6285             when N_Formal_Package_Declaration |
6286                  N_Generic_Package_Declaration   =>
6287
6288                if Nkind (F) = N_Generic_Package_Declaration then
6289                   Orig_Node := Original_Node (F);
6290                end if;
6291
6292                Act_Pkg := Act_Ent;
6293
6294                --  Find matching actual package, skipping over itypes and
6295                --  other entities generated when analyzing the formal. We
6296                --  know that if the instantiation is legal then there is
6297                --  a matching package for the formal.
6298
6299                while Ekind (Act_Pkg) /= E_Package loop
6300                   Act_Pkg := Next_Entity (Act_Pkg);
6301                end loop;
6302
6303                declare
6304                   Actual_Ent  : Entity_Id := First_Entity (Act_Pkg);
6305                   Formal_Node : Node_Id;
6306                   Formal_Ent  : Entity_Id;
6307
6308                   Gen_Decl : constant Node_Id :=
6309                                Unit_Declaration_Node
6310                                  (Entity (Name (Orig_Node)));
6311
6312                   Formals : constant List_Id :=
6313                               Generic_Formal_Declarations (Gen_Decl);
6314
6315                begin
6316                   if Present (Formals) then
6317                      Formal_Node := First_Non_Pragma (Formals);
6318                   else
6319                      Formal_Node := Empty;
6320                   end if;
6321
6322                   while Present (Actual_Ent)
6323                     and then Present (Formal_Node)
6324                     and then Actual_Ent /= First_Private_Entity (Act_Ent)
6325                   loop
6326                      --  ???  Are the following calls also needed here:
6327                      --
6328                      --  Set_Is_Hidden (Actual_Ent, False);
6329                      --  Set_Is_Potentially_Use_Visible
6330                      --    (Actual_Ent, In_Use (Act_Ent));
6331
6332                      Formal_Ent := Formal_Entity (Formal_Node, Actual_Ent);
6333                      if Present (Formal_Ent) then
6334                         Set_Instance_Of (Formal_Ent, Actual_Ent);
6335                      end if;
6336                      Next_Non_Pragma (Formal_Node);
6337
6338                      Next_Entity (Actual_Ent);
6339                   end loop;
6340                end;
6341
6342                return Defining_Identifier (Orig_Node);
6343
6344             when N_Use_Package_Clause =>
6345                return Empty;
6346
6347             when N_Use_Type_Clause =>
6348                return Empty;
6349
6350             --  We return Empty for all other encountered forms of
6351             --  declarations because there are some cases of nonformal
6352             --  sorts of declaration that can show up (e.g., when array
6353             --  formals are present). Since it's not clear what kinds
6354             --  can appear among the formals, we won't raise failure here.
6355
6356             when others =>
6357                return Empty;
6358
6359          end case;
6360       end Formal_Entity;
6361
6362       --------------------
6363       -- Is_Instance_Of --
6364       --------------------
6365
6366       function Is_Instance_Of
6367         (Act_Spec : Entity_Id;
6368          Gen_Anc  : Entity_Id)
6369          return     Boolean
6370       is
6371          Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
6372
6373       begin
6374          if No (Gen_Par) then
6375             return False;
6376
6377          --  Simplest case: the generic parent of the actual is the formal.
6378
6379          elsif Gen_Par = Gen_Anc then
6380             return True;
6381
6382          elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
6383             return False;
6384
6385          --  The actual may be obtained through several instantiations. Its
6386          --  scope must itself be an instance of a generic declared in the
6387          --  same scope as the formal. Any other case is detected above.
6388
6389          elsif not Is_Generic_Instance (Scope (Gen_Par)) then
6390             return False;
6391
6392          else
6393             return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
6394          end if;
6395       end Is_Instance_Of;
6396
6397       ------------------
6398       -- Map_Entities --
6399       ------------------
6400
6401       procedure Map_Entities (Form : Entity_Id; Act : Entity_Id) is
6402          E1 : Entity_Id;
6403          E2 : Entity_Id;
6404
6405       begin
6406          Set_Instance_Of (Form, Act);
6407
6408          --  Traverse formal and actual package to map the corresponding
6409          --  entities. We skip over internal entities that may be generated
6410          --  during semantic analysis, and find the matching entities by
6411          --  name, given that they must appear in the same order.
6412
6413          E1 := First_Entity (Form);
6414          E2 := First_Entity (Act);
6415          while Present (E1)
6416            and then E1 /= First_Private_Entity (Form)
6417          loop
6418             if not Is_Internal (E1)
6419               and then not Is_Class_Wide_Type (E1)
6420               and then Present (Parent (E1))
6421             then
6422                while Present (E2)
6423                  and then Chars (E2) /= Chars (E1)
6424                loop
6425                   Next_Entity (E2);
6426                end loop;
6427
6428                if No (E2) then
6429                   exit;
6430                else
6431                   Set_Instance_Of (E1, E2);
6432
6433                   if Is_Type (E1)
6434                     and then Is_Tagged_Type (E2)
6435                   then
6436                      Set_Instance_Of
6437                        (Class_Wide_Type (E1), Class_Wide_Type (E2));
6438                   end if;
6439
6440                   if Ekind (E1) = E_Package
6441                     and then No (Renamed_Object (E1))
6442                   then
6443                      Map_Entities (E1, E2);
6444                   end if;
6445                end if;
6446             end if;
6447
6448             Next_Entity (E1);
6449          end loop;
6450       end Map_Entities;
6451
6452    --  Start of processing for Instantiate_Formal_Package
6453
6454    begin
6455       Analyze (Actual);
6456
6457       if not Is_Entity_Name (Actual)
6458         or else  Ekind (Entity (Actual)) /= E_Package
6459       then
6460          Error_Msg_N
6461            ("expect package instance to instantiate formal", Actual);
6462          Abandon_Instantiation (Actual);
6463          raise Program_Error;
6464
6465       else
6466          Actual_Pack := Entity (Actual);
6467          Set_Is_Instantiated (Actual_Pack);
6468
6469          --  The actual may be a renamed package, or an outer generic
6470          --  formal package whose instantiation is converted into a renaming.
6471
6472          if Present (Renamed_Object (Actual_Pack)) then
6473             Actual_Pack := Renamed_Object (Actual_Pack);
6474          end if;
6475
6476          if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
6477             Gen_Parent  := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
6478             Formal_Pack := Defining_Identifier (Analyzed_Formal);
6479          else
6480             Gen_Parent :=
6481               Generic_Parent (Specification (Analyzed_Formal));
6482             Formal_Pack :=
6483               Defining_Unit_Name (Specification (Analyzed_Formal));
6484          end if;
6485
6486          if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
6487             Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
6488          else
6489             Parent_Spec := Parent (Actual_Pack);
6490          end if;
6491
6492          if Gen_Parent = Any_Id then
6493             Error_Msg_N
6494               ("previous error in declaration of formal package", Actual);
6495             Abandon_Instantiation (Actual);
6496
6497          elsif
6498            Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
6499          then
6500             null;
6501
6502          else
6503             Error_Msg_NE
6504               ("actual parameter must be instance of&", Actual, Gen_Parent);
6505             Abandon_Instantiation (Actual);
6506          end if;
6507
6508          Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
6509          Map_Entities (Formal_Pack, Actual_Pack);
6510
6511          Nod :=
6512            Make_Package_Renaming_Declaration (Loc,
6513              Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
6514              Name               => New_Reference_To (Actual_Pack, Loc));
6515
6516          Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
6517            Defining_Identifier (Formal));
6518          Decls := New_List (Nod);
6519
6520          --  If the formal F has a box, then the generic declarations are
6521          --  visible in the generic G. In an instance of G, the corresponding
6522          --  entities in the actual for F (which are the actuals for the
6523          --  instantiation of the generic that F denotes) must also be made
6524          --  visible for analysis of the current instance. On exit from the
6525          --  current instance, those entities are made private again. If the
6526          --  actual is currently in use, these entities are also use-visible.
6527
6528          --  The loop through the actual entities also steps through the
6529          --  formal entities and enters associations from formals to
6530          --  actuals into the renaming map. This is necessary to properly
6531          --  handle checking of actual parameter associations for later
6532          --  formals that depend on actuals declared in the formal package.
6533
6534          if Box_Present (Formal) then
6535             declare
6536                Gen_Decl    : constant Node_Id :=
6537                                Unit_Declaration_Node (Gen_Parent);
6538                Formals     : constant List_Id :=
6539                                Generic_Formal_Declarations (Gen_Decl);
6540                Actual_Ent  : Entity_Id;
6541                Formal_Node : Node_Id;
6542                Formal_Ent  : Entity_Id;
6543
6544             begin
6545                if Present (Formals) then
6546                   Formal_Node := First_Non_Pragma (Formals);
6547                else
6548                   Formal_Node := Empty;
6549                end if;
6550
6551                Actual_Ent := First_Entity (Actual_Pack);
6552
6553                while Present (Actual_Ent)
6554                  and then Actual_Ent /= First_Private_Entity (Actual_Pack)
6555                loop
6556                   Set_Is_Hidden (Actual_Ent, False);
6557                   Set_Is_Potentially_Use_Visible
6558                     (Actual_Ent, In_Use (Actual_Pack));
6559
6560                   if Present (Formal_Node) then
6561                      Formal_Ent := Formal_Entity (Formal_Node, Actual_Ent);
6562
6563                      if Present (Formal_Ent) then
6564                         Find_Matching_Actual (Formal_Node, Actual_Ent);
6565                         Set_Instance_Of (Formal_Ent, Actual_Ent);
6566                      end if;
6567
6568                      Next_Non_Pragma (Formal_Node);
6569
6570                   else
6571                      --  No further formals to match.
6572
6573                      exit;
6574                   end if;
6575
6576                end loop;
6577             end;
6578
6579          --  If the formal is not declared with a box, reanalyze it as
6580          --  an instantiation, to verify the matching rules of 12.7. The
6581          --  actual checks are performed after the generic associations
6582          --  been analyzed.
6583
6584          else
6585             declare
6586                I_Pack : constant Entity_Id :=
6587                           Make_Defining_Identifier (Sloc (Actual),
6588                             Chars => New_Internal_Name  ('P'));
6589
6590             begin
6591                Set_Is_Internal (I_Pack);
6592
6593                Append_To (Decls,
6594                  Make_Package_Instantiation (Sloc (Actual),
6595                    Defining_Unit_Name => I_Pack,
6596                    Name => New_Occurrence_Of (Gen_Parent, Sloc (Actual)),
6597                    Generic_Associations =>
6598                      Generic_Associations (Formal)));
6599             end;
6600          end if;
6601
6602          return Decls;
6603       end if;
6604    end Instantiate_Formal_Package;
6605
6606    -----------------------------------
6607    -- Instantiate_Formal_Subprogram --
6608    -----------------------------------
6609
6610    function Instantiate_Formal_Subprogram
6611      (Formal          : Node_Id;
6612       Actual          : Node_Id;
6613       Analyzed_Formal : Node_Id)
6614       return            Node_Id
6615    is
6616       Loc        : Source_Ptr := Sloc (Instantiation_Node);
6617       Formal_Sub : constant Entity_Id :=
6618                      Defining_Unit_Name (Specification (Formal));
6619       Analyzed_S : constant Entity_Id :=
6620                      Defining_Unit_Name (Specification (Analyzed_Formal));
6621       Decl_Node  : Node_Id;
6622       Nam        : Node_Id;
6623       New_Spec   : Node_Id;
6624
6625       function From_Parent_Scope (Subp : Entity_Id) return Boolean;
6626       --  If the generic is a child unit, the parent has been installed
6627       --  on the scope stack, but a default subprogram cannot resolve to
6628       --  something on the parent because that parent is not really part
6629       --  of the visible context (it is there to resolve explicit local
6630       --  entities). If the default has resolved in this way, we remove
6631       --  the entity from immediate visibility and analyze the node again
6632       --  to emit an error message or find another visible candidate.
6633
6634       procedure Valid_Actual_Subprogram (Act : Node_Id);
6635       --  Perform legality check and raise exception on failure.
6636
6637       -----------------------
6638       -- From_Parent_Scope --
6639       -----------------------
6640
6641       function From_Parent_Scope (Subp : Entity_Id) return Boolean is
6642          Gen_Scope : Node_Id := Scope (Analyzed_S);
6643
6644       begin
6645          while Present (Gen_Scope)
6646            and then  Is_Child_Unit (Gen_Scope)
6647          loop
6648             if Scope (Subp) = Scope (Gen_Scope) then
6649                return True;
6650             end if;
6651
6652             Gen_Scope := Scope (Gen_Scope);
6653          end loop;
6654
6655          return False;
6656       end From_Parent_Scope;
6657
6658       -----------------------------
6659       -- Valid_Actual_Subprogram --
6660       -----------------------------
6661
6662       procedure Valid_Actual_Subprogram (Act : Node_Id) is
6663          Act_E : Entity_Id := Empty;
6664
6665       begin
6666          if Is_Entity_Name (Act) then
6667             Act_E := Entity (Act);
6668          elsif Nkind (Act) = N_Selected_Component
6669            and then Is_Entity_Name (Selector_Name (Act))
6670          then
6671             Act_E := Entity (Selector_Name (Act));
6672          end if;
6673
6674          if (Present (Act_E) and then Is_Overloadable (Act_E))
6675            or else Nkind (Act) = N_Attribute_Reference
6676            or else Nkind (Act) = N_Indexed_Component
6677            or else Nkind (Act) = N_Character_Literal
6678            or else Nkind (Act) = N_Explicit_Dereference
6679          then
6680             return;
6681          end if;
6682
6683          Error_Msg_NE
6684            ("expect subprogram or entry name in instantiation of&",
6685             Instantiation_Node, Formal_Sub);
6686          Abandon_Instantiation (Instantiation_Node);
6687
6688       end Valid_Actual_Subprogram;
6689
6690    --  Start of processing for Instantiate_Formal_Subprogram
6691
6692    begin
6693       New_Spec := New_Copy_Tree (Specification (Formal));
6694
6695       --  Create new entity for the actual (New_Copy_Tree does not).
6696
6697       Set_Defining_Unit_Name
6698         (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
6699
6700       --  Find entity of actual. If the actual is an attribute reference, it
6701       --  cannot be resolved here (its formal is missing) but is handled
6702       --  instead in Attribute_Renaming. If the actual is overloaded, it is
6703       --  fully resolved subsequently, when the renaming declaration for the
6704       --  formal is analyzed. If it is an explicit dereference, resolve the
6705       --  prefix but not the actual itself, to prevent interpretation as a
6706       --  call.
6707
6708       if Present (Actual) then
6709          Loc := Sloc (Actual);
6710          Set_Sloc (New_Spec, Loc);
6711
6712          if Nkind (Actual) = N_Operator_Symbol then
6713             Find_Direct_Name (Actual);
6714
6715          elsif Nkind (Actual) = N_Explicit_Dereference then
6716             Analyze (Prefix (Actual));
6717
6718          elsif Nkind (Actual) /= N_Attribute_Reference then
6719             Analyze (Actual);
6720          end if;
6721
6722          Valid_Actual_Subprogram (Actual);
6723          Nam := Actual;
6724
6725       elsif Present (Default_Name (Formal)) then
6726          if Nkind (Default_Name (Formal)) /= N_Attribute_Reference
6727            and then Nkind (Default_Name (Formal)) /= N_Selected_Component
6728            and then Nkind (Default_Name (Formal)) /= N_Indexed_Component
6729            and then Nkind (Default_Name (Formal)) /= N_Character_Literal
6730            and then Present (Entity (Default_Name (Formal)))
6731          then
6732             Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
6733          else
6734             Nam := New_Copy (Default_Name (Formal));
6735             Set_Sloc (Nam, Loc);
6736          end if;
6737
6738       elsif Box_Present (Formal) then
6739
6740          --  Actual is resolved at the point of instantiation. Create
6741          --  an identifier or operator with the same name as the formal.
6742
6743          if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
6744             Nam := Make_Operator_Symbol (Loc,
6745               Chars =>  Chars (Formal_Sub),
6746               Strval => No_String);
6747          else
6748             Nam := Make_Identifier (Loc, Chars (Formal_Sub));
6749          end if;
6750
6751       else
6752          Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
6753          Error_Msg_NE
6754            ("missing actual&", Instantiation_Node, Formal_Sub);
6755          Error_Msg_NE
6756            ("\in instantiation of & declared#",
6757               Instantiation_Node, Scope (Analyzed_S));
6758          Abandon_Instantiation (Instantiation_Node);
6759       end if;
6760
6761       Decl_Node :=
6762         Make_Subprogram_Renaming_Declaration (Loc,
6763           Specification => New_Spec,
6764           Name          => Nam);
6765
6766       --  If we do not have an actual and the formal specified <> then
6767       --  set to get proper default.
6768
6769       if No (Actual) and then Box_Present (Formal) then
6770          Set_From_Default (Decl_Node);
6771       end if;
6772
6773       --  Gather possible interpretations for the actual before analyzing the
6774       --  instance. If overloaded, it will be resolved when analyzing the
6775       --  renaming declaration.
6776
6777       if Box_Present (Formal)
6778         and then No (Actual)
6779       then
6780          Analyze (Nam);
6781
6782          if Is_Child_Unit (Scope (Analyzed_S))
6783            and then Present (Entity (Nam))
6784          then
6785             if not Is_Overloaded (Nam) then
6786
6787                if From_Parent_Scope (Entity (Nam)) then
6788                   Set_Is_Immediately_Visible (Entity (Nam), False);
6789                   Set_Entity (Nam, Empty);
6790                   Set_Etype (Nam, Empty);
6791
6792                   Analyze (Nam);
6793
6794                   Set_Is_Immediately_Visible (Entity (Nam));
6795                end if;
6796
6797             else
6798                declare
6799                   I  : Interp_Index;
6800                   It : Interp;
6801
6802                begin
6803                   Get_First_Interp (Nam, I, It);
6804
6805                   while Present (It.Nam) loop
6806                      if From_Parent_Scope (It.Nam) then
6807                         Remove_Interp (I);
6808                      end if;
6809
6810                      Get_Next_Interp (I, It);
6811                   end loop;
6812                end;
6813             end if;
6814          end if;
6815       end if;
6816
6817       --  The generic instantiation freezes the actual. This can only be
6818       --  done once the actual is resolved, in the analysis of the renaming
6819       --  declaration. To indicate that must be done, we set the corresponding
6820       --  spec of the node to point to the formal subprogram entity.
6821
6822       Set_Corresponding_Spec (Decl_Node, Analyzed_S);
6823
6824       --  We cannot analyze the renaming declaration, and thus find the
6825       --  actual, until the all the actuals are assembled in the instance.
6826       --  For subsequent checks of other actuals, indicate the node that
6827       --  will hold the instance of this formal.
6828
6829       Set_Instance_Of (Analyzed_S, Nam);
6830
6831       if Nkind (Actual) = N_Selected_Component
6832         and then Is_Task_Type (Etype (Prefix (Actual)))
6833         and then not Is_Frozen (Etype (Prefix (Actual)))
6834       then
6835          --  The renaming declaration will create a body, which must appear
6836          --  outside of the instantiation, We move the renaming declaration
6837          --  out of the instance, and create an additional renaming inside,
6838          --  to prevent freezing anomalies.
6839
6840          declare
6841             Anon_Id : constant Entity_Id :=
6842                         Make_Defining_Identifier
6843                           (Loc, New_Internal_Name ('E'));
6844          begin
6845             Set_Defining_Unit_Name (New_Spec, Anon_Id);
6846             Insert_Before (Instantiation_Node, Decl_Node);
6847             Analyze (Decl_Node);
6848
6849             --  Now create renaming within the instance
6850
6851             Decl_Node :=
6852               Make_Subprogram_Renaming_Declaration (Loc,
6853                 Specification => New_Copy_Tree (New_Spec),
6854                 Name => New_Occurrence_Of (Anon_Id, Loc));
6855
6856             Set_Defining_Unit_Name (Specification (Decl_Node),
6857               Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
6858          end;
6859       end if;
6860
6861       return Decl_Node;
6862    end Instantiate_Formal_Subprogram;
6863
6864    ------------------------
6865    -- Instantiate_Object --
6866    ------------------------
6867
6868    function Instantiate_Object
6869      (Formal          : Node_Id;
6870       Actual          : Node_Id;
6871       Analyzed_Formal : Node_Id)
6872       return            List_Id
6873    is
6874       Formal_Id : constant Entity_Id  := Defining_Identifier (Formal);
6875       Type_Id   : constant Node_Id    := Subtype_Mark (Formal);
6876       Loc       : constant Source_Ptr := Sloc (Actual);
6877       Act_Assoc : constant Node_Id    := Parent (Actual);
6878       Orig_Ftyp : constant Entity_Id  :=
6879                     Etype (Defining_Identifier (Analyzed_Formal));
6880       List      : constant List_Id    := New_List;
6881       Ftyp      : Entity_Id;
6882       Decl_Node : Node_Id;
6883       Subt_Decl : Node_Id := Empty;
6884
6885    begin
6886       --  Sloc for error message on missing actual.
6887       Error_Msg_Sloc := Sloc (Scope (Defining_Identifier (Analyzed_Formal)));
6888
6889       if Get_Instance_Of (Formal_Id) /= Formal_Id then
6890          Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
6891       end if;
6892
6893       Set_Parent (List, Parent (Actual));
6894
6895       --  OUT present
6896
6897       if Out_Present (Formal) then
6898
6899          --  An IN OUT generic actual must be a name. The instantiation is
6900          --  a renaming declaration. The actual is the name being renamed.
6901          --  We use the actual directly, rather than a copy, because it is not
6902          --  used further in the list of actuals, and because a copy or a use
6903          --  of relocate_node is incorrect if the instance is nested within
6904          --  a generic. In order to simplify ASIS searches, the Generic_Parent
6905          --  field links the declaration to the generic association.
6906
6907          if No (Actual) then
6908             Error_Msg_NE
6909               ("missing actual&",
6910                Instantiation_Node, Formal_Id);
6911             Error_Msg_NE
6912               ("\in instantiation of & declared#",
6913                  Instantiation_Node,
6914                    Scope (Defining_Identifier (Analyzed_Formal)));
6915             Abandon_Instantiation (Instantiation_Node);
6916          end if;
6917
6918          Decl_Node :=
6919            Make_Object_Renaming_Declaration (Loc,
6920              Defining_Identifier => New_Copy (Formal_Id),
6921              Subtype_Mark        => New_Copy_Tree (Type_Id),
6922              Name                => Actual);
6923
6924          Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
6925
6926          --  The analysis of the actual may produce insert_action nodes, so
6927          --  the declaration must have a context in which to attach them.
6928
6929          Append (Decl_Node, List);
6930          Analyze (Actual);
6931
6932          --  This check is performed here because Analyze_Object_Renaming
6933          --  will not check it when Comes_From_Source is False. Note
6934          --  though that the check for the actual being the name of an
6935          --  object will be performed in Analyze_Object_Renaming.
6936
6937          if Is_Object_Reference (Actual)
6938            and then Is_Dependent_Component_Of_Mutable_Object (Actual)
6939          then
6940             Error_Msg_N
6941               ("illegal discriminant-dependent component for in out parameter",
6942                Actual);
6943          end if;
6944
6945          --  The actual has to be resolved in order to check that it is
6946          --  a variable (due to cases such as F(1), where F returns
6947          --  access to an array, and for overloaded prefixes).
6948
6949          Ftyp :=
6950            Get_Instance_Of (Etype (Defining_Identifier (Analyzed_Formal)));
6951
6952          if Is_Private_Type (Ftyp)
6953            and then not Is_Private_Type (Etype (Actual))
6954            and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
6955                       or else Base_Type (Etype (Actual)) = Ftyp)
6956          then
6957             --  If the actual has the type of the full view of the formal,
6958             --  or else a non-private subtype of the formal, then
6959             --  the visibility of the formal type has changed. Add to the
6960             --  actuals a subtype declaration that will force the exchange
6961             --  of views in the body of the instance as well.
6962
6963             Subt_Decl :=
6964               Make_Subtype_Declaration (Loc,
6965                  Defining_Identifier =>
6966                    Make_Defining_Identifier (Loc, New_Internal_Name ('P')),
6967                  Subtype_Indication  => New_Occurrence_Of (Ftyp, Loc));
6968
6969             Prepend (Subt_Decl, List);
6970
6971             Append_Elmt (Full_View (Ftyp), Exchanged_Views);
6972             Exchange_Declarations (Ftyp);
6973          end if;
6974
6975          Resolve (Actual, Ftyp);
6976
6977          if not Is_Variable (Actual) or else Paren_Count (Actual) > 0 then
6978             Error_Msg_NE
6979               ("actual for& must be a variable", Actual, Formal_Id);
6980
6981          elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
6982             Error_Msg_NE (
6983               "type of actual does not match type of&", Actual, Formal_Id);
6984
6985          end if;
6986
6987          Note_Possible_Modification (Actual);
6988
6989          --  Check for instantiation of atomic/volatile actual for
6990          --  non-atomic/volatile formal (RM C.6 (12)).
6991
6992          if Is_Atomic_Object (Actual)
6993            and then not Is_Atomic (Orig_Ftyp)
6994          then
6995             Error_Msg_N
6996               ("cannot instantiate non-atomic formal object " &
6997                "with atomic actual", Actual);
6998
6999          elsif Is_Volatile_Object (Actual)
7000            and then not Is_Volatile (Orig_Ftyp)
7001          then
7002             Error_Msg_N
7003               ("cannot instantiate non-volatile formal object " &
7004                "with volatile actual", Actual);
7005          end if;
7006
7007       --  OUT not present
7008
7009       else
7010          --  The instantiation of a generic formal in-parameter
7011          --  is a constant declaration. The actual is the expression for
7012          --  that declaration.
7013
7014          if Present (Actual) then
7015
7016             Decl_Node := Make_Object_Declaration (Loc,
7017               Defining_Identifier => New_Copy (Formal_Id),
7018               Constant_Present => True,
7019               Object_Definition => New_Copy_Tree (Type_Id),
7020               Expression => Actual);
7021
7022             Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
7023
7024             --  A generic formal object of a tagged type is defined
7025             --  to be aliased so the new constant must also be treated
7026             --  as aliased.
7027
7028             if Is_Tagged_Type
7029                  (Etype (Defining_Identifier (Analyzed_Formal)))
7030             then
7031                Set_Aliased_Present (Decl_Node);
7032             end if;
7033
7034             Append (Decl_Node, List);
7035
7036             --  No need to repeat (pre-)analysis of some expression nodes
7037             --  already handled in Pre_Analyze_Actuals.
7038
7039             if Nkind (Actual) /= N_Allocator then
7040                Analyze (Actual);
7041             end if;
7042
7043             declare
7044                Typ : constant Entity_Id :=
7045                        Get_Instance_Of
7046                          (Etype (Defining_Identifier (Analyzed_Formal)));
7047
7048             begin
7049                Freeze_Before (Instantiation_Node, Typ);
7050
7051                --  If the actual is an aggregate, perform name resolution
7052                --  on its components (the analysis of an aggregate does not
7053                --  do it) to capture local names that may be hidden if the
7054                --  generic is a child unit.
7055
7056                if Nkind (Actual) = N_Aggregate then
7057                      Pre_Analyze_And_Resolve (Actual, Typ);
7058                end if;
7059             end;
7060
7061          elsif Present (Expression (Formal)) then
7062
7063             --  Use default to construct declaration.
7064
7065             Decl_Node :=
7066               Make_Object_Declaration (Sloc (Formal),
7067                 Defining_Identifier => New_Copy (Formal_Id),
7068                 Constant_Present    => True,
7069                 Object_Definition   => New_Copy (Type_Id),
7070                 Expression          => New_Copy_Tree (Expression (Formal)));
7071
7072             Append (Decl_Node, List);
7073             Set_Analyzed (Expression (Decl_Node), False);
7074
7075          else
7076             Error_Msg_NE
7077               ("missing actual&",
7078                 Instantiation_Node, Formal_Id);
7079             Error_Msg_NE ("\in instantiation of & declared#",
7080               Instantiation_Node,
7081                 Scope (Defining_Identifier (Analyzed_Formal)));
7082
7083             if Is_Scalar_Type
7084                  (Etype (Defining_Identifier (Analyzed_Formal)))
7085             then
7086                --  Create dummy constant declaration so that instance can
7087                --  be analyzed, to minimize cascaded visibility errors.
7088
7089                Decl_Node :=
7090                  Make_Object_Declaration (Loc,
7091                    Defining_Identifier => New_Copy (Formal_Id),
7092                    Constant_Present    => True,
7093                    Object_Definition   => New_Copy (Type_Id),
7094                    Expression          =>
7095                       Make_Attribute_Reference (Sloc (Formal_Id),
7096                         Attribute_Name => Name_First,
7097                         Prefix         => New_Copy (Type_Id)));
7098
7099                Append (Decl_Node, List);
7100
7101             else
7102                Abandon_Instantiation (Instantiation_Node);
7103             end if;
7104          end if;
7105
7106       end if;
7107
7108       return List;
7109    end Instantiate_Object;
7110
7111    ------------------------------
7112    -- Instantiate_Package_Body --
7113    ------------------------------
7114
7115    procedure Instantiate_Package_Body
7116      (Body_Info    : Pending_Body_Info;
7117       Inlined_Body : Boolean := False)
7118    is
7119       Act_Decl    : constant Node_Id    := Body_Info.Act_Decl;
7120       Inst_Node   : constant Node_Id    := Body_Info.Inst_Node;
7121       Loc         : constant Source_Ptr := Sloc (Inst_Node);
7122
7123       Gen_Id      : constant Node_Id    := Name (Inst_Node);
7124       Gen_Unit    : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
7125       Gen_Decl    : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
7126       Act_Spec    : constant Node_Id    := Specification (Act_Decl);
7127       Act_Decl_Id : constant Entity_Id  := Defining_Entity (Act_Spec);
7128
7129       Act_Body_Name : Node_Id;
7130       Gen_Body      : Node_Id;
7131       Gen_Body_Id   : Node_Id;
7132       Act_Body      : Node_Id;
7133       Act_Body_Id   : Entity_Id;
7134
7135       Parent_Installed : Boolean := False;
7136       Save_Style_Check : constant Boolean := Style_Check;
7137
7138    begin
7139       Gen_Body_Id := Corresponding_Body (Gen_Decl);
7140
7141       --  The instance body may already have been processed, as the parent
7142       --  of another instance that is inlined. (Load_Parent_Of_Generic).
7143
7144       if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
7145          return;
7146       end if;
7147
7148       Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
7149
7150       if No (Gen_Body_Id) then
7151          Load_Parent_Of_Generic (Inst_Node, Specification (Gen_Decl));
7152          Gen_Body_Id := Corresponding_Body (Gen_Decl);
7153       end if;
7154
7155       --  Establish global variable for sloc adjustment and for error
7156       --  recovery.
7157
7158       Instantiation_Node := Inst_Node;
7159
7160       if Present (Gen_Body_Id) then
7161          Save_Env (Gen_Unit, Act_Decl_Id);
7162          Style_Check := False;
7163          Current_Sem_Unit := Body_Info.Current_Sem_Unit;
7164
7165          Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
7166
7167          Create_Instantiation_Source
7168           (Inst_Node, Gen_Body_Id, False, S_Adjustment);
7169
7170          Act_Body :=
7171            Copy_Generic_Node
7172              (Original_Node (Gen_Body), Empty, Instantiating => True);
7173
7174          --  Build new name (possibly qualified) for body declaration
7175
7176          Act_Body_Id := New_Copy (Act_Decl_Id);
7177
7178          --  Some attributes of the spec entity are not inherited by the
7179          --  body entity.
7180
7181          Set_Handler_Records (Act_Body_Id, No_List);
7182
7183          if Nkind (Defining_Unit_Name (Act_Spec)) =
7184                                            N_Defining_Program_Unit_Name
7185          then
7186             Act_Body_Name :=
7187               Make_Defining_Program_Unit_Name (Loc,
7188                 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
7189                 Defining_Identifier => Act_Body_Id);
7190          else
7191             Act_Body_Name :=  Act_Body_Id;
7192          end if;
7193
7194          Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
7195
7196          Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
7197          Check_Generic_Actuals (Act_Decl_Id, False);
7198
7199          --  If it is a child unit, make the parent instance (which is an
7200          --  instance of the parent of the generic) visible. The parent
7201          --  instance is the prefix of the name of the generic unit.
7202
7203          if Ekind (Scope (Gen_Unit)) = E_Generic_Package
7204            and then Nkind (Gen_Id) = N_Expanded_Name
7205          then
7206             Install_Parent (Entity (Prefix (Gen_Id)), In_Body => True);
7207             Parent_Installed := True;
7208
7209          elsif Is_Child_Unit (Gen_Unit) then
7210             Install_Parent (Scope (Gen_Unit), In_Body => True);
7211             Parent_Installed := True;
7212          end if;
7213
7214          --  If the instantiation is a library unit, and this is the main
7215          --  unit, then build the resulting compilation unit nodes for the
7216          --  instance. If this is a compilation unit but it is not the main
7217          --  unit, then it is the body of a unit in the context, that is being
7218          --  compiled because it is encloses some inlined unit or another
7219          --  generic unit being instantiated. In that case, this body is not
7220          --  part of the current compilation, and is not attached to the tree,
7221          --  but its parent must be set for analysis.
7222
7223          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
7224
7225             --  Replace instance node with body of instance, and create
7226             --  new node for corresponding instance declaration.
7227
7228             Build_Instance_Compilation_Unit_Nodes
7229               (Inst_Node, Act_Body, Act_Decl);
7230             Analyze (Inst_Node);
7231
7232             if Parent (Inst_Node) = Cunit (Main_Unit) then
7233
7234                --  If the instance is a child unit itself, then set the
7235                --  scope of the expanded body to be the parent of the
7236                --  instantiation (ensuring that the fully qualified name
7237                --  will be generated for the elaboration subprogram).
7238
7239                if Nkind (Defining_Unit_Name (Act_Spec)) =
7240                                               N_Defining_Program_Unit_Name
7241                then
7242                   Set_Scope
7243                     (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
7244                end if;
7245             end if;
7246
7247          --  Case where instantiation is not a library unit
7248
7249          else
7250             --  If this is an early instantiation, i.e. appears textually
7251             --  before the corresponding body and must be elaborated first,
7252             --  indicate that the body instance is to be delayed.
7253
7254             Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
7255
7256             --  Now analyze the body. We turn off all checks if this is
7257             --  an internal unit, since there is no reason to have checks
7258             --  on for any predefined run-time library code. All such
7259             --  code is designed to be compiled with checks off.
7260
7261             --  Note that we do NOT apply this criterion to children of
7262             --  GNAT (or on VMS, children of DEC). The latter units must
7263             --  suppress checks explicitly if this is needed.
7264
7265             if Is_Predefined_File_Name
7266                  (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
7267             then
7268                Analyze (Act_Body, Suppress => All_Checks);
7269             else
7270                Analyze (Act_Body);
7271             end if;
7272          end if;
7273
7274          if not Generic_Separately_Compiled (Gen_Unit) then
7275             Inherit_Context (Gen_Body, Inst_Node);
7276          end if;
7277
7278          --  Remove the parent instances if they have been placed on the
7279          --  scope stack to compile the body.
7280
7281          if Parent_Installed then
7282             Remove_Parent (In_Body => True);
7283          end if;
7284
7285          Restore_Private_Views (Act_Decl_Id);
7286
7287          --  Remove the current unit from visibility if this is an instance
7288          --  that is not elaborated on the fly for inlining purposes.
7289
7290          if not Inlined_Body then
7291             Set_Is_Immediately_Visible (Act_Decl_Id, False);
7292          end if;
7293
7294          Restore_Env;
7295          Style_Check := Save_Style_Check;
7296
7297       --  If we have no body, and the unit requires a body, then complain.
7298       --  This complaint is suppressed if we have detected other errors
7299       --  (since a common reason for missing the body is that it had errors).
7300
7301       elsif Unit_Requires_Body (Gen_Unit) then
7302          if Serious_Errors_Detected = 0 then
7303             Error_Msg_NE
7304               ("cannot find body of generic package &", Inst_Node, Gen_Unit);
7305
7306          --  Don't attempt to perform any cleanup actions if some other
7307          --  error was aready detected, since this can cause blowups.
7308
7309          else
7310             return;
7311          end if;
7312
7313       --  Case of package that does not need a body
7314
7315       else
7316          --  If the instantiation of the declaration is a library unit,
7317          --  rewrite the original package instantiation as a package
7318          --  declaration in the compilation unit node.
7319
7320          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
7321             Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
7322             Rewrite (Inst_Node, Act_Decl);
7323
7324             --  Generate elaboration entity, in case spec has elaboration
7325             --  code. This cannot be done when the instance is analyzed,
7326             --  because it is not known yet whether the body exists.
7327
7328             Set_Elaboration_Entity_Required (Act_Decl_Id, False);
7329             Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
7330
7331          --  If the instantiation is not a library unit, then append the
7332          --  declaration to the list of implicitly generated entities.
7333          --  unless it is already a list member which means that it was
7334          --  already processed
7335
7336          elsif not Is_List_Member (Act_Decl) then
7337             Mark_Rewrite_Insertion (Act_Decl);
7338             Insert_Before (Inst_Node, Act_Decl);
7339          end if;
7340       end if;
7341
7342       Expander_Mode_Restore;
7343    end Instantiate_Package_Body;
7344
7345    ---------------------------------
7346    -- Instantiate_Subprogram_Body --
7347    ---------------------------------
7348
7349    procedure Instantiate_Subprogram_Body
7350      (Body_Info : Pending_Body_Info)
7351    is
7352       Act_Decl      : constant Node_Id    := Body_Info.Act_Decl;
7353       Inst_Node     : constant Node_Id    := Body_Info.Inst_Node;
7354       Loc           : constant Source_Ptr := Sloc (Inst_Node);
7355       Gen_Id        : constant Node_Id   := Name (Inst_Node);
7356       Gen_Unit      : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7357       Gen_Decl      : constant Node_Id   := Unit_Declaration_Node (Gen_Unit);
7358       Anon_Id       : constant Entity_Id :=
7359                         Defining_Unit_Name (Specification (Act_Decl));
7360       Pack_Id       : constant Entity_Id :=
7361                         Defining_Unit_Name (Parent (Act_Decl));
7362       Decls         : List_Id;
7363       Gen_Body      : Node_Id;
7364       Gen_Body_Id   : Node_Id;
7365       Act_Body      : Node_Id;
7366       Act_Body_Id   : Entity_Id;
7367       Pack_Body     : Node_Id;
7368       Prev_Formal   : Entity_Id;
7369       Ret_Expr      : Node_Id;
7370       Unit_Renaming : Node_Id;
7371
7372       Parent_Installed : Boolean := False;
7373       Save_Style_Check : constant Boolean := Style_Check;
7374
7375    begin
7376       Gen_Body_Id := Corresponding_Body (Gen_Decl);
7377
7378       Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
7379
7380       if No (Gen_Body_Id) then
7381          Load_Parent_Of_Generic (Inst_Node, Specification (Gen_Decl));
7382          Gen_Body_Id := Corresponding_Body (Gen_Decl);
7383       end if;
7384
7385       Instantiation_Node := Inst_Node;
7386
7387       if Present (Gen_Body_Id) then
7388          Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
7389
7390          if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
7391
7392             --  Either body is not present, or context is non-expanding, as
7393             --  when compiling a subunit. Mark the instance as completed, and
7394             --  diagnose a missing body when needed.
7395
7396             if Expander_Active
7397               and then Operating_Mode = Generate_Code
7398             then
7399                Error_Msg_N
7400                  ("missing proper body for instantiation", Gen_Body);
7401             end if;
7402
7403             Set_Has_Completion (Anon_Id);
7404             return;
7405          end if;
7406
7407          Save_Env (Gen_Unit, Anon_Id);
7408          Style_Check := False;
7409          Current_Sem_Unit := Body_Info.Current_Sem_Unit;
7410          Create_Instantiation_Source
7411            (Inst_Node,
7412             Gen_Body_Id,
7413             False,
7414             S_Adjustment);
7415
7416          Act_Body :=
7417            Copy_Generic_Node
7418              (Original_Node (Gen_Body), Empty, Instantiating => True);
7419          Act_Body_Id := Defining_Entity (Act_Body);
7420          Set_Chars (Act_Body_Id, Chars (Anon_Id));
7421          Set_Sloc (Act_Body_Id, Sloc (Defining_Entity (Inst_Node)));
7422          Set_Corresponding_Spec (Act_Body, Anon_Id);
7423          Set_Has_Completion (Anon_Id);
7424          Check_Generic_Actuals (Pack_Id, False);
7425
7426          --  If it is a child unit, make the parent instance (which is an
7427          --  instance of the parent of the generic) visible. The parent
7428          --  instance is the prefix of the name of the generic unit.
7429
7430          if Ekind (Scope (Gen_Unit)) = E_Generic_Package
7431            and then Nkind (Gen_Id) = N_Expanded_Name
7432          then
7433             Install_Parent (Entity (Prefix (Gen_Id)), In_Body => True);
7434             Parent_Installed := True;
7435
7436          elsif Is_Child_Unit (Gen_Unit) then
7437             Install_Parent (Scope (Gen_Unit), In_Body => True);
7438             Parent_Installed := True;
7439          end if;
7440
7441          --  Inside its body, a reference to the generic unit is a reference
7442          --  to the instance. The corresponding renaming is the first
7443          --  declaration in the body.
7444
7445          Unit_Renaming :=
7446            Make_Subprogram_Renaming_Declaration (Loc,
7447              Specification =>
7448                Copy_Generic_Node (
7449                  Specification (Original_Node (Gen_Body)),
7450                  Empty,
7451                  Instantiating => True),
7452              Name => New_Occurrence_Of (Anon_Id, Loc));
7453
7454          --  If there is a formal subprogram with the same name as the
7455          --  unit itself, do not add this renaming declaration. This is
7456          --  a temporary fix for one ACVC test. ???
7457
7458          Prev_Formal := First_Entity (Pack_Id);
7459          while Present (Prev_Formal) loop
7460             if Chars (Prev_Formal) = Chars (Gen_Unit)
7461               and then Is_Overloadable (Prev_Formal)
7462             then
7463                exit;
7464             end if;
7465
7466             Next_Entity (Prev_Formal);
7467          end loop;
7468
7469          if Present (Prev_Formal) then
7470             Decls :=  New_List (Act_Body);
7471          else
7472             Decls :=  New_List (Unit_Renaming, Act_Body);
7473          end if;
7474
7475          --  The subprogram body is placed in the body of a dummy package
7476          --  body, whose spec contains the subprogram declaration as well
7477          --  as the renaming declarations for the generic parameters.
7478
7479          Pack_Body := Make_Package_Body (Loc,
7480            Defining_Unit_Name => New_Copy (Pack_Id),
7481            Declarations       => Decls);
7482
7483          Set_Corresponding_Spec (Pack_Body, Pack_Id);
7484
7485          --  If the instantiation is a library unit, then build resulting
7486          --  compilation unit nodes for the instance. The declaration of
7487          --  the enclosing package is the grandparent of the subprogram
7488          --  declaration. First replace the instantiation node as the unit
7489          --  of the corresponding compilation.
7490
7491          if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
7492             if Parent (Inst_Node) = Cunit (Main_Unit) then
7493                Set_Unit (Parent (Inst_Node), Inst_Node);
7494                Build_Instance_Compilation_Unit_Nodes
7495                  (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
7496                Analyze (Inst_Node);
7497             else
7498                Set_Parent (Pack_Body, Parent (Inst_Node));
7499                Analyze (Pack_Body);
7500             end if;
7501
7502          else
7503             Insert_Before (Inst_Node, Pack_Body);
7504             Mark_Rewrite_Insertion (Pack_Body);
7505             Analyze (Pack_Body);
7506
7507             if Expander_Active then
7508                Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
7509             end if;
7510          end if;
7511
7512          if not Generic_Separately_Compiled (Gen_Unit) then
7513             Inherit_Context (Gen_Body, Inst_Node);
7514          end if;
7515
7516          Restore_Private_Views (Pack_Id, False);
7517
7518          if Parent_Installed then
7519             Remove_Parent (In_Body => True);
7520          end if;
7521
7522          Restore_Env;
7523          Style_Check := Save_Style_Check;
7524
7525       --  Body not found. Error was emitted already. If there were no
7526       --  previous errors, this may be an instance whose scope is a premature
7527       --  instance. In that case we must insure that the (legal) program does
7528       --  raise program error if executed. We generate a subprogram body for
7529       --  this purpose. See DEC ac30vso.
7530
7531       elsif Serious_Errors_Detected = 0
7532         and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
7533       then
7534          if Ekind (Anon_Id) = E_Procedure then
7535             Act_Body :=
7536               Make_Subprogram_Body (Loc,
7537                  Specification              =>
7538                    Make_Procedure_Specification (Loc,
7539                      Defining_Unit_Name         => New_Copy (Anon_Id),
7540                        Parameter_Specifications =>
7541                        New_Copy_List
7542                          (Parameter_Specifications (Parent (Anon_Id)))),
7543
7544                  Declarations               => Empty_List,
7545                  Handled_Statement_Sequence =>
7546                    Make_Handled_Sequence_Of_Statements (Loc,
7547                      Statements =>
7548                        New_List (
7549                          Make_Raise_Program_Error (Loc,
7550                            Reason =>
7551                              PE_Access_Before_Elaboration))));
7552
7553          else
7554             Ret_Expr :=
7555               Make_Raise_Program_Error (Loc,
7556                 Reason => PE_Access_Before_Elaboration);
7557
7558             Set_Etype (Ret_Expr, (Etype (Anon_Id)));
7559             Set_Analyzed (Ret_Expr);
7560
7561             Act_Body :=
7562               Make_Subprogram_Body (Loc,
7563                 Specification =>
7564                   Make_Function_Specification (Loc,
7565                      Defining_Unit_Name         => New_Copy (Anon_Id),
7566                        Parameter_Specifications =>
7567                        New_Copy_List
7568                          (Parameter_Specifications (Parent (Anon_Id))),
7569                      Subtype_Mark =>
7570                        New_Occurrence_Of (Etype (Anon_Id), Loc)),
7571
7572                   Declarations               => Empty_List,
7573                   Handled_Statement_Sequence =>
7574                     Make_Handled_Sequence_Of_Statements (Loc,
7575                       Statements =>
7576                         New_List (Make_Return_Statement (Loc, Ret_Expr))));
7577          end if;
7578
7579          Pack_Body := Make_Package_Body (Loc,
7580            Defining_Unit_Name => New_Copy (Pack_Id),
7581            Declarations       => New_List (Act_Body));
7582
7583          Insert_After (Inst_Node, Pack_Body);
7584          Set_Corresponding_Spec (Pack_Body, Pack_Id);
7585          Analyze (Pack_Body);
7586       end if;
7587
7588       Expander_Mode_Restore;
7589    end Instantiate_Subprogram_Body;
7590
7591    ----------------------
7592    -- Instantiate_Type --
7593    ----------------------
7594
7595    function Instantiate_Type
7596      (Formal          : Node_Id;
7597       Actual          : Node_Id;
7598       Analyzed_Formal : Node_Id;
7599       Actual_Decls    : List_Id)
7600       return            Node_Id
7601    is
7602       Loc       : constant Source_Ptr := Sloc (Actual);
7603       Gen_T     : constant Entity_Id  := Defining_Identifier (Formal);
7604       A_Gen_T   : constant Entity_Id  := Defining_Identifier (Analyzed_Formal);
7605       Ancestor  : Entity_Id := Empty;
7606       Def       : constant Node_Id    := Formal_Type_Definition (Formal);
7607       Act_T     : Entity_Id;
7608       Decl_Node : Node_Id;
7609
7610       procedure Validate_Array_Type_Instance;
7611       procedure Validate_Access_Subprogram_Instance;
7612       procedure Validate_Access_Type_Instance;
7613       procedure Validate_Derived_Type_Instance;
7614       procedure Validate_Private_Type_Instance;
7615       --  These procedures perform validation tests for the named case
7616
7617       function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
7618       --  Check that base types are the same and that the subtypes match
7619       --  statically. Used in several of the above.
7620
7621       --------------------
7622       -- Subtypes_Match --
7623       --------------------
7624
7625       function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
7626          T : constant Entity_Id := Get_Instance_Of (Gen_T);
7627
7628       begin
7629          return (Base_Type (T) = Base_Type (Act_T)
7630 --  why is the and then commented out here???
7631 --                  and then Is_Constrained (T) = Is_Constrained (Act_T)
7632                   and then Subtypes_Statically_Match (T, Act_T))
7633
7634            or else (Is_Class_Wide_Type (Gen_T)
7635                      and then Is_Class_Wide_Type (Act_T)
7636                      and then
7637                        Subtypes_Match (
7638                          Get_Instance_Of (Root_Type (Gen_T)),
7639                          Root_Type (Act_T)));
7640       end Subtypes_Match;
7641
7642       -----------------------------------------
7643       -- Validate_Access_Subprogram_Instance --
7644       -----------------------------------------
7645
7646       procedure Validate_Access_Subprogram_Instance is
7647       begin
7648          if not Is_Access_Type (Act_T)
7649            or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
7650          then
7651             Error_Msg_NE
7652               ("expect access type in instantiation of &", Actual, Gen_T);
7653             Abandon_Instantiation (Actual);
7654          end if;
7655
7656          Check_Mode_Conformant
7657            (Designated_Type (Act_T),
7658             Designated_Type (A_Gen_T),
7659             Actual,
7660             Get_Inst => True);
7661
7662          if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
7663             if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
7664                Error_Msg_NE
7665                  ("protected access type not allowed for formal &",
7666                   Actual, Gen_T);
7667             end if;
7668
7669          elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
7670             Error_Msg_NE
7671               ("expect protected access type for formal &",
7672                Actual, Gen_T);
7673          end if;
7674       end Validate_Access_Subprogram_Instance;
7675
7676       -----------------------------------
7677       -- Validate_Access_Type_Instance --
7678       -----------------------------------
7679
7680       procedure Validate_Access_Type_Instance is
7681          Desig_Type : constant Entity_Id :=
7682                         Find_Actual_Type
7683                           (Designated_Type (A_Gen_T), Scope (A_Gen_T));
7684
7685       begin
7686          if not Is_Access_Type (Act_T) then
7687             Error_Msg_NE
7688               ("expect access type in instantiation of &", Actual, Gen_T);
7689             Abandon_Instantiation (Actual);
7690          end if;
7691
7692          if Is_Access_Constant (A_Gen_T) then
7693             if not Is_Access_Constant (Act_T) then
7694                Error_Msg_N
7695                  ("actual type must be access-to-constant type", Actual);
7696                Abandon_Instantiation (Actual);
7697             end if;
7698          else
7699             if Is_Access_Constant (Act_T) then
7700                Error_Msg_N
7701                  ("actual type must be access-to-variable type", Actual);
7702                Abandon_Instantiation (Actual);
7703
7704             elsif Ekind (A_Gen_T) = E_General_Access_Type
7705               and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
7706             then
7707                Error_Msg_N ("actual must be general access type!", Actual);
7708                Error_Msg_NE ("add ALL to }!", Actual, Act_T);
7709                Abandon_Instantiation (Actual);
7710             end if;
7711          end if;
7712
7713          --  The designated subtypes, that is to say the subtypes introduced
7714          --  by an access type declaration (and not by a subtype declaration)
7715          --  must match.
7716
7717          if not Subtypes_Match
7718            (Desig_Type, Designated_Type (Base_Type (Act_T)))
7719          then
7720             Error_Msg_NE
7721               ("designated type of actual does not match that of formal &",
7722                  Actual, Gen_T);
7723             Abandon_Instantiation (Actual);
7724
7725          elsif Is_Access_Type (Designated_Type (Act_T))
7726            and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
7727                       /=
7728                   Is_Constrained (Designated_Type (Desig_Type))
7729          then
7730             Error_Msg_NE
7731               ("designated type of actual does not match that of formal &",
7732                  Actual, Gen_T);
7733             Abandon_Instantiation (Actual);
7734          end if;
7735       end Validate_Access_Type_Instance;
7736
7737       ----------------------------------
7738       -- Validate_Array_Type_Instance --
7739       ----------------------------------
7740
7741       procedure Validate_Array_Type_Instance is
7742          I1 : Node_Id;
7743          I2 : Node_Id;
7744          T2 : Entity_Id;
7745
7746          function Formal_Dimensions return Int;
7747          --  Count number of dimensions in array type formal
7748
7749          function Formal_Dimensions return Int is
7750             Num   : Int := 0;
7751             Index : Node_Id;
7752
7753          begin
7754             if Nkind (Def) = N_Constrained_Array_Definition then
7755                Index := First (Discrete_Subtype_Definitions (Def));
7756             else
7757                Index := First (Subtype_Marks (Def));
7758             end if;
7759
7760             while Present (Index) loop
7761                Num := Num + 1;
7762                Next_Index (Index);
7763             end loop;
7764
7765             return Num;
7766          end Formal_Dimensions;
7767
7768       --  Start of processing for Validate_Array_Type_Instance
7769
7770       begin
7771          if not Is_Array_Type (Act_T) then
7772             Error_Msg_NE
7773               ("expect array type in instantiation of &", Actual, Gen_T);
7774             Abandon_Instantiation (Actual);
7775
7776          elsif Nkind (Def) = N_Constrained_Array_Definition then
7777             if not (Is_Constrained (Act_T)) then
7778                Error_Msg_NE
7779                  ("expect constrained array in instantiation of &",
7780                   Actual, Gen_T);
7781                Abandon_Instantiation (Actual);
7782             end if;
7783
7784          else
7785             if Is_Constrained (Act_T) then
7786                Error_Msg_NE
7787                  ("expect unconstrained array in instantiation of &",
7788                   Actual, Gen_T);
7789                Abandon_Instantiation (Actual);
7790             end if;
7791          end if;
7792
7793          if Formal_Dimensions /= Number_Dimensions (Act_T) then
7794             Error_Msg_NE
7795               ("dimensions of actual do not match formal &", Actual, Gen_T);
7796             Abandon_Instantiation (Actual);
7797          end if;
7798
7799          I1 := First_Index (A_Gen_T);
7800          I2 := First_Index (Act_T);
7801          for J in 1 .. Formal_Dimensions loop
7802
7803             --  If the indices of the actual were given by a subtype_mark,
7804             --  the index was transformed into a range attribute. Retrieve
7805             --  the original type mark for checking.
7806
7807             if Is_Entity_Name (Original_Node (I2)) then
7808                T2 := Entity (Original_Node (I2));
7809             else
7810                T2 := Etype (I2);
7811             end if;
7812
7813             if not Subtypes_Match
7814               (Find_Actual_Type (Etype (I1), Scope (A_Gen_T)), T2)
7815             then
7816                Error_Msg_NE
7817                  ("index types of actual do not match those of formal &",
7818                   Actual, Gen_T);
7819                Abandon_Instantiation (Actual);
7820             end if;
7821
7822             Next_Index (I1);
7823             Next_Index (I2);
7824          end loop;
7825
7826          if not Subtypes_Match (
7827             Find_Actual_Type (Component_Type (A_Gen_T), Scope (A_Gen_T)),
7828             Component_Type (Act_T))
7829          then
7830             Error_Msg_NE
7831               ("component subtype of actual does not match that of formal &",
7832                Actual, Gen_T);
7833             Abandon_Instantiation (Actual);
7834          end if;
7835
7836          if Has_Aliased_Components (A_Gen_T)
7837            and then not Has_Aliased_Components (Act_T)
7838          then
7839             Error_Msg_NE
7840               ("actual must have aliased components to match formal type &",
7841                Actual, Gen_T);
7842          end if;
7843
7844       end Validate_Array_Type_Instance;
7845
7846       ------------------------------------
7847       -- Validate_Derived_Type_Instance --
7848       ------------------------------------
7849
7850       procedure Validate_Derived_Type_Instance is
7851          Actual_Discr   : Entity_Id;
7852          Ancestor_Discr : Entity_Id;
7853
7854       begin
7855          --  If the parent type in the generic declaration is itself
7856          --  a previous formal type, then it is local to the generic
7857          --  and absent from the analyzed generic definition. In  that
7858          --  case the ancestor is the instance of the formal (which must
7859          --  have been instantiated previously), unless the ancestor is
7860          --  itself a formal derived type. In this latter case (which is the
7861          --  subject of Corrigendum 8652/0038 (AI-202) the ancestor of the
7862          --  formals is the ancestor of its parent. Otherwise, the analyzed
7863          --  generic carries the parent type. If the parent type is defined
7864          --  in a previous formal package, then the scope of that formal
7865          --  package is that of the generic type itself, and it has already
7866          --  been mapped into the corresponding type in the actual package.
7867
7868          --  Common case: parent type defined outside of the generic
7869
7870          if Is_Entity_Name (Subtype_Mark (Def))
7871            and then Present (Entity (Subtype_Mark (Def)))
7872          then
7873             Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
7874
7875          --  Check whether parent is defined in a previous formal package
7876
7877          elsif
7878            Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
7879          then
7880             Ancestor :=
7881               Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
7882
7883          --  The type may be a local derivation, or a type extension of
7884          --  a previous formal, or of a formal of a parent package.
7885
7886          elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
7887           or else
7888             Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
7889          then
7890             --  Check whether the parent is another derived formal type
7891             --  in the same generic unit.
7892
7893             if Etype (A_Gen_T) /= A_Gen_T
7894               and then Is_Generic_Type (Etype (A_Gen_T))
7895               and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
7896               and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
7897             then
7898                --  Locate ancestor of parent from the subtype declaration
7899                --  created for the actual.
7900
7901                declare
7902                   Decl : Node_Id;
7903
7904                begin
7905                   Decl := First (Actual_Decls);
7906                   while Present (Decl) loop
7907                      if Nkind (Decl) = N_Subtype_Declaration
7908                        and then Chars (Defining_Identifier (Decl)) =
7909                                                     Chars (Etype (A_Gen_T))
7910                      then
7911                         Ancestor := Generic_Parent_Type (Decl);
7912                         exit;
7913                      else
7914                         Next (Decl);
7915                      end if;
7916                   end loop;
7917                end;
7918
7919                pragma Assert (Present (Ancestor));
7920
7921             else
7922                Ancestor :=
7923                  Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
7924             end if;
7925
7926          else
7927             Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
7928          end if;
7929
7930          if not Is_Ancestor (Base_Type (Ancestor), Act_T) then
7931             Error_Msg_NE
7932               ("expect type derived from & in instantiation",
7933                Actual, First_Subtype (Ancestor));
7934             Abandon_Instantiation (Actual);
7935          end if;
7936
7937          --  Perform atomic/volatile checks (RM C.6(12))
7938
7939          if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
7940             Error_Msg_N
7941               ("cannot have atomic actual type for non-atomic formal type",
7942                Actual);
7943
7944          elsif Is_Volatile (Act_T)
7945            and then not Is_Volatile (Ancestor)
7946            and then Is_By_Reference_Type (Ancestor)
7947          then
7948             Error_Msg_N
7949               ("cannot have volatile actual type for non-volatile formal type",
7950                Actual);
7951          end if;
7952
7953          --  It should not be necessary to check for unknown discriminants
7954          --  on Formal, but for some reason Has_Unknown_Discriminants is
7955          --  false for A_Gen_T, so Is_Indefinite_Subtype incorrectly
7956          --  returns False. This needs fixing. ???
7957
7958          if not Is_Indefinite_Subtype (A_Gen_T)
7959            and then not Unknown_Discriminants_Present (Formal)
7960            and then Is_Indefinite_Subtype (Act_T)
7961          then
7962             Error_Msg_N
7963               ("actual subtype must be constrained", Actual);
7964             Abandon_Instantiation (Actual);
7965          end if;
7966
7967          if not Unknown_Discriminants_Present (Formal) then
7968             if Is_Constrained (Ancestor) then
7969                if not Is_Constrained (Act_T) then
7970                   Error_Msg_N
7971                     ("actual subtype must be constrained", Actual);
7972                   Abandon_Instantiation (Actual);
7973                end if;
7974
7975             --  Ancestor is unconstrained
7976
7977             elsif Is_Constrained (Act_T) then
7978                if Ekind (Ancestor) = E_Access_Type
7979                  or else Is_Composite_Type (Ancestor)
7980                then
7981                   Error_Msg_N
7982                     ("actual subtype must be unconstrained", Actual);
7983                   Abandon_Instantiation (Actual);
7984                end if;
7985
7986             --  A class-wide type is only allowed if the formal has
7987             --  unknown discriminants.
7988
7989             elsif Is_Class_Wide_Type (Act_T)
7990               and then not Has_Unknown_Discriminants (Ancestor)
7991             then
7992                Error_Msg_NE
7993                  ("actual for & cannot be a class-wide type", Actual, Gen_T);
7994                Abandon_Instantiation (Actual);
7995
7996             --  Otherwise, the formal and actual shall have the same
7997             --  number of discriminants and each discriminant of the
7998             --  actual must correspond to a discriminant of the formal.
7999
8000             elsif Has_Discriminants (Act_T)
8001               and then not Has_Unknown_Discriminants (Act_T)
8002               and then Has_Discriminants (Ancestor)
8003             then
8004                Actual_Discr   := First_Discriminant (Act_T);
8005                Ancestor_Discr := First_Discriminant (Ancestor);
8006                while Present (Actual_Discr)
8007                  and then Present (Ancestor_Discr)
8008                loop
8009                   if Base_Type (Act_T) /= Base_Type (Ancestor) and then
8010                     not Present (Corresponding_Discriminant (Actual_Discr))
8011                   then
8012                      Error_Msg_NE
8013                        ("discriminant & does not correspond " &
8014                         "to ancestor discriminant", Actual, Actual_Discr);
8015                      Abandon_Instantiation (Actual);
8016                   end if;
8017
8018                   Next_Discriminant (Actual_Discr);
8019                   Next_Discriminant (Ancestor_Discr);
8020                end loop;
8021
8022                if Present (Actual_Discr) or else Present (Ancestor_Discr) then
8023                   Error_Msg_NE
8024                     ("actual for & must have same number of discriminants",
8025                      Actual, Gen_T);
8026                   Abandon_Instantiation (Actual);
8027                end if;
8028
8029             --  This case should be caught by the earlier check for
8030             --  for constrainedness, but the check here is added for
8031             --  completeness.
8032
8033             elsif Has_Discriminants (Act_T)
8034               and then not Has_Unknown_Discriminants (Act_T)
8035             then
8036                Error_Msg_NE
8037                  ("actual for & must not have discriminants", Actual, Gen_T);
8038                Abandon_Instantiation (Actual);
8039
8040             elsif Has_Discriminants (Ancestor) then
8041                Error_Msg_NE
8042                  ("actual for & must have known discriminants", Actual, Gen_T);
8043                Abandon_Instantiation (Actual);
8044             end if;
8045
8046             if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
8047                Error_Msg_N
8048                  ("constraint on actual is incompatible with formal", Actual);
8049                Abandon_Instantiation (Actual);
8050             end if;
8051          end if;
8052       end Validate_Derived_Type_Instance;
8053
8054       ------------------------------------
8055       -- Validate_Private_Type_Instance --
8056       ------------------------------------
8057
8058       procedure Validate_Private_Type_Instance is
8059          Formal_Discr : Entity_Id;
8060          Actual_Discr : Entity_Id;
8061          Formal_Subt  : Entity_Id;
8062
8063       begin
8064          if Is_Limited_Type (Act_T)
8065            and then not Is_Limited_Type (A_Gen_T)
8066          then
8067             Error_Msg_NE
8068               ("actual for non-limited  & cannot be a limited type", Actual,
8069                Gen_T);
8070             Explain_Limited_Type (Act_T, Actual);
8071             Abandon_Instantiation (Actual);
8072
8073          elsif Is_Indefinite_Subtype (Act_T)
8074             and then not Is_Indefinite_Subtype (A_Gen_T)
8075             and then Ada_Version >= Ada_95
8076          then
8077             Error_Msg_NE
8078               ("actual for & must be a definite subtype", Actual, Gen_T);
8079
8080          elsif not Is_Tagged_Type (Act_T)
8081            and then Is_Tagged_Type (A_Gen_T)
8082          then
8083             Error_Msg_NE
8084               ("actual for & must be a tagged type", Actual, Gen_T);
8085
8086          elsif Has_Discriminants (A_Gen_T) then
8087             if not Has_Discriminants (Act_T) then
8088                Error_Msg_NE
8089                  ("actual for & must have discriminants", Actual, Gen_T);
8090                Abandon_Instantiation (Actual);
8091
8092             elsif Is_Constrained (Act_T) then
8093                Error_Msg_NE
8094                  ("actual for & must be unconstrained", Actual, Gen_T);
8095                Abandon_Instantiation (Actual);
8096
8097             else
8098                Formal_Discr := First_Discriminant (A_Gen_T);
8099                Actual_Discr := First_Discriminant (Act_T);
8100                while Formal_Discr /= Empty loop
8101                   if Actual_Discr = Empty then
8102                      Error_Msg_NE
8103                        ("discriminants on actual do not match formal",
8104                         Actual, Gen_T);
8105                      Abandon_Instantiation (Actual);
8106                   end if;
8107
8108                   Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
8109
8110                   --  access discriminants match if designated types do.
8111
8112                   if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
8113                     and then (Ekind (Base_Type (Etype (Actual_Discr))))
8114                       = E_Anonymous_Access_Type
8115                     and then Get_Instance_Of (
8116                       Designated_Type (Base_Type (Formal_Subt)))
8117                       = Designated_Type (Base_Type (Etype (Actual_Discr)))
8118                   then
8119                      null;
8120
8121                   elsif Base_Type (Formal_Subt) /=
8122                                        Base_Type (Etype (Actual_Discr))
8123                   then
8124                      Error_Msg_NE
8125                        ("types of actual discriminants must match formal",
8126                         Actual, Gen_T);
8127                      Abandon_Instantiation (Actual);
8128
8129                   elsif not Subtypes_Statically_Match
8130                               (Formal_Subt, Etype (Actual_Discr))
8131                     and then Ada_Version >= Ada_95
8132                   then
8133                      Error_Msg_NE
8134                        ("subtypes of actual discriminants must match formal",
8135                         Actual, Gen_T);
8136                      Abandon_Instantiation (Actual);
8137                   end if;
8138
8139                   Next_Discriminant (Formal_Discr);
8140                   Next_Discriminant (Actual_Discr);
8141                end loop;
8142
8143                if Actual_Discr /= Empty then
8144                   Error_Msg_NE
8145                     ("discriminants on actual do not match formal",
8146                      Actual, Gen_T);
8147                   Abandon_Instantiation (Actual);
8148                end if;
8149             end if;
8150
8151          end if;
8152
8153          Ancestor := Gen_T;
8154       end Validate_Private_Type_Instance;
8155
8156    --  Start of processing for Instantiate_Type
8157
8158    begin
8159       if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
8160          Error_Msg_N ("duplicate instantiation of generic type", Actual);
8161          return Error;
8162
8163       elsif not Is_Entity_Name (Actual)
8164         or else not Is_Type (Entity (Actual))
8165       then
8166          Error_Msg_NE
8167            ("expect valid subtype mark to instantiate &", Actual, Gen_T);
8168          Abandon_Instantiation (Actual);
8169
8170       else
8171          Act_T := Entity (Actual);
8172
8173          --  Deal with fixed/floating restrictions
8174
8175          if Is_Floating_Point_Type (Act_T) then
8176             Check_Restriction (No_Floating_Point, Actual);
8177          elsif Is_Fixed_Point_Type (Act_T) then
8178             Check_Restriction (No_Fixed_Point, Actual);
8179          end if;
8180
8181          --  Deal with error of using incomplete type as generic actual
8182
8183          if Ekind (Act_T) = E_Incomplete_Type then
8184             if No (Underlying_Type (Act_T)) then
8185                Error_Msg_N ("premature use of incomplete type", Actual);
8186                Abandon_Instantiation (Actual);
8187             else
8188                Act_T := Full_View (Act_T);
8189                Set_Entity (Actual, Act_T);
8190
8191                if Has_Private_Component (Act_T) then
8192                   Error_Msg_N
8193                     ("premature use of type with private component", Actual);
8194                end if;
8195             end if;
8196
8197          --  Deal with error of premature use of private type as generic actual
8198
8199          elsif Is_Private_Type (Act_T)
8200            and then Is_Private_Type (Base_Type (Act_T))
8201            and then not Is_Generic_Type (Act_T)
8202            and then not Is_Derived_Type (Act_T)
8203            and then No (Full_View (Root_Type (Act_T)))
8204          then
8205             Error_Msg_N ("premature use of private type", Actual);
8206
8207          elsif Has_Private_Component (Act_T) then
8208             Error_Msg_N
8209               ("premature use of type with private component", Actual);
8210          end if;
8211
8212          Set_Instance_Of (A_Gen_T, Act_T);
8213
8214          --  If the type is generic, the class-wide type may also be used
8215
8216          if Is_Tagged_Type (A_Gen_T)
8217            and then Is_Tagged_Type (Act_T)
8218            and then not Is_Class_Wide_Type (A_Gen_T)
8219          then
8220             Set_Instance_Of (Class_Wide_Type (A_Gen_T),
8221               Class_Wide_Type (Act_T));
8222          end if;
8223
8224          if not Is_Abstract (A_Gen_T)
8225            and then Is_Abstract (Act_T)
8226          then
8227             Error_Msg_N
8228               ("actual of non-abstract formal cannot be abstract", Actual);
8229          end if;
8230
8231          if Is_Scalar_Type (Gen_T) then
8232             Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
8233          end if;
8234       end if;
8235
8236       case Nkind (Def) is
8237          when N_Formal_Private_Type_Definition =>
8238             Validate_Private_Type_Instance;
8239
8240          when N_Formal_Derived_Type_Definition =>
8241             Validate_Derived_Type_Instance;
8242
8243          when N_Formal_Discrete_Type_Definition =>
8244             if not Is_Discrete_Type (Act_T) then
8245                Error_Msg_NE
8246                  ("expect discrete type in instantiation of&", Actual, Gen_T);
8247                Abandon_Instantiation (Actual);
8248             end if;
8249
8250          when N_Formal_Signed_Integer_Type_Definition =>
8251             if not Is_Signed_Integer_Type (Act_T) then
8252                Error_Msg_NE
8253                  ("expect signed integer type in instantiation of&",
8254                   Actual, Gen_T);
8255                Abandon_Instantiation (Actual);
8256             end if;
8257
8258          when N_Formal_Modular_Type_Definition =>
8259             if not Is_Modular_Integer_Type (Act_T) then
8260                Error_Msg_NE
8261                  ("expect modular type in instantiation of &", Actual, Gen_T);
8262                Abandon_Instantiation (Actual);
8263             end if;
8264
8265          when N_Formal_Floating_Point_Definition =>
8266             if not Is_Floating_Point_Type (Act_T) then
8267                Error_Msg_NE
8268                  ("expect float type in instantiation of &", Actual, Gen_T);
8269                Abandon_Instantiation (Actual);
8270             end if;
8271
8272          when N_Formal_Ordinary_Fixed_Point_Definition =>
8273             if not Is_Ordinary_Fixed_Point_Type (Act_T) then
8274                Error_Msg_NE
8275                  ("expect ordinary fixed point type in instantiation of &",
8276                   Actual, Gen_T);
8277                Abandon_Instantiation (Actual);
8278             end if;
8279
8280          when N_Formal_Decimal_Fixed_Point_Definition =>
8281             if not Is_Decimal_Fixed_Point_Type (Act_T) then
8282                Error_Msg_NE
8283                  ("expect decimal type in instantiation of &",
8284                   Actual, Gen_T);
8285                Abandon_Instantiation (Actual);
8286             end if;
8287
8288          when N_Array_Type_Definition =>
8289             Validate_Array_Type_Instance;
8290
8291          when N_Access_To_Object_Definition =>
8292             Validate_Access_Type_Instance;
8293
8294          when N_Access_Function_Definition |
8295               N_Access_Procedure_Definition =>
8296             Validate_Access_Subprogram_Instance;
8297
8298          when others =>
8299             raise Program_Error;
8300
8301       end case;
8302
8303       Decl_Node :=
8304         Make_Subtype_Declaration (Loc,
8305           Defining_Identifier => New_Copy (Gen_T),
8306           Subtype_Indication  => New_Reference_To (Act_T, Loc));
8307
8308       if Is_Private_Type (Act_T) then
8309          Set_Has_Private_View (Subtype_Indication (Decl_Node));
8310
8311       elsif Is_Access_Type (Act_T)
8312         and then Is_Private_Type (Designated_Type (Act_T))
8313       then
8314          Set_Has_Private_View (Subtype_Indication (Decl_Node));
8315       end if;
8316
8317       --  Flag actual derived types so their elaboration produces the
8318       --  appropriate renamings for the primitive operations of the ancestor.
8319       --  Flag actual for formal private types as well, to determine whether
8320       --  operations in the private part may override inherited operations.
8321
8322       if Nkind (Def) = N_Formal_Derived_Type_Definition
8323         or else Nkind (Def) = N_Formal_Private_Type_Definition
8324       then
8325          Set_Generic_Parent_Type (Decl_Node, Ancestor);
8326       end if;
8327
8328       return Decl_Node;
8329    end Instantiate_Type;
8330
8331    ---------------------
8332    -- Is_In_Main_Unit --
8333    ---------------------
8334
8335    function Is_In_Main_Unit (N : Node_Id) return Boolean is
8336       Unum : constant Unit_Number_Type := Get_Source_Unit (N);
8337
8338       Current_Unit : Node_Id;
8339
8340    begin
8341       if Unum = Main_Unit then
8342          return True;
8343
8344       --  If the current unit is a subunit then it is either the main unit
8345       --  or is being compiled as part of the main unit.
8346
8347       elsif Nkind (N) = N_Compilation_Unit then
8348          return Nkind (Unit (N)) = N_Subunit;
8349       end if;
8350
8351       Current_Unit := Parent (N);
8352       while Present (Current_Unit)
8353         and then Nkind (Current_Unit) /= N_Compilation_Unit
8354       loop
8355          Current_Unit := Parent (Current_Unit);
8356       end loop;
8357
8358       --  The instantiation node is in the main unit, or else the current
8359       --  node (perhaps as the result of nested instantiations) is in the
8360       --  main unit, or in the declaration of the main unit, which in this
8361       --  last case must be a body.
8362
8363       return Unum = Main_Unit
8364         or else Current_Unit = Cunit (Main_Unit)
8365         or else Current_Unit = Library_Unit (Cunit (Main_Unit))
8366         or else (Present (Library_Unit (Current_Unit))
8367                   and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
8368    end Is_In_Main_Unit;
8369
8370    ----------------------------
8371    -- Load_Parent_Of_Generic --
8372    ----------------------------
8373
8374    procedure Load_Parent_Of_Generic (N : Node_Id; Spec : Node_Id) is
8375       Comp_Unit        : constant Node_Id := Cunit (Get_Source_Unit (Spec));
8376       Save_Style_Check : constant Boolean := Style_Check;
8377       True_Parent      : Node_Id;
8378       Inst_Node        : Node_Id;
8379       OK               : Boolean;
8380
8381    begin
8382       if not In_Same_Source_Unit (N, Spec)
8383         or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
8384         or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
8385                    and then not Is_In_Main_Unit (Spec))
8386       then
8387          --  Find body of parent of spec, and analyze it. A special case
8388          --  arises when the parent is an instantiation, that is to say when
8389          --  we are currently instantiating a nested generic. In that case,
8390          --  there is no separate file for the body of the enclosing instance.
8391          --  Instead, the enclosing body must be instantiated as if it were
8392          --  a pending instantiation, in order to produce the body for the
8393          --  nested generic we require now. Note that in that case the
8394          --  generic may be defined in a package body, the instance defined
8395          --  in the same package body, and the original enclosing body may not
8396          --  be in the main unit.
8397
8398          True_Parent := Parent (Spec);
8399          Inst_Node   := Empty;
8400
8401          while Present (True_Parent)
8402            and then Nkind (True_Parent) /= N_Compilation_Unit
8403          loop
8404             if Nkind (True_Parent) = N_Package_Declaration
8405               and then
8406                 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
8407             then
8408                --  Parent is a compilation unit that is an instantiation.
8409                --  Instantiation node has been replaced with package decl.
8410
8411                Inst_Node := Original_Node (True_Parent);
8412                exit;
8413
8414             elsif Nkind (True_Parent) = N_Package_Declaration
8415               and then Present (Generic_Parent (Specification (True_Parent)))
8416               and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
8417             then
8418                --  Parent is an instantiation within another specification.
8419                --  Declaration for instance has been inserted before original
8420                --  instantiation node. A direct link would be preferable?
8421
8422                Inst_Node := Next (True_Parent);
8423
8424                while Present (Inst_Node)
8425                  and then Nkind (Inst_Node) /= N_Package_Instantiation
8426                loop
8427                   Next (Inst_Node);
8428                end loop;
8429
8430                --  If the instance appears within a generic, and the generic
8431                --  unit is defined within a formal package of the enclosing
8432                --  generic, there is no generic body available, and none
8433                --  needed. A more precise test should be used ???
8434
8435                if No (Inst_Node) then
8436                   return;
8437                end if;
8438
8439                exit;
8440             else
8441                True_Parent := Parent (True_Parent);
8442             end if;
8443          end loop;
8444
8445          --  Case where we are currently instantiating a nested generic
8446
8447          if Present (Inst_Node) then
8448             if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
8449
8450                --  Instantiation node and declaration of instantiated package
8451                --  were exchanged when only the declaration was needed.
8452                --  Restore instantiation node before proceeding with body.
8453
8454                Set_Unit (Parent (True_Parent), Inst_Node);
8455             end if;
8456
8457             --  Now complete instantiation of enclosing body, if it appears
8458             --  in some other unit. If it appears in the current unit, the
8459             --  body will have been instantiated already.
8460
8461             if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
8462
8463                --  We need to determine the expander mode to instantiate
8464                --  the enclosing body. Because the generic body we need
8465                --  may use global entities declared in the enclosing package
8466                --  (including aggregates) it is in general necessary to
8467                --  compile this body with expansion enabled. The exception
8468                --  is if we are within a generic package, in which case
8469                --  the usual generic rule applies.
8470
8471                declare
8472                   Exp_Status : Boolean := True;
8473                   Scop       : Entity_Id;
8474
8475                begin
8476                   --  Loop through scopes looking for generic package
8477
8478                   Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
8479                   while Present (Scop)
8480                     and then Scop /= Standard_Standard
8481                   loop
8482                      if Ekind (Scop) = E_Generic_Package then
8483                         Exp_Status := False;
8484                         exit;
8485                      end if;
8486
8487                      Scop := Scope (Scop);
8488                   end loop;
8489
8490                   Instantiate_Package_Body
8491                     (Pending_Body_Info'(
8492                        Inst_Node, True_Parent, Exp_Status,
8493                          Get_Code_Unit (Sloc (Inst_Node))));
8494                end;
8495             end if;
8496
8497          --  Case where we are not instantiating a nested generic
8498
8499          else
8500             Opt.Style_Check := False;
8501             Expander_Mode_Save_And_Set (True);
8502             Load_Needed_Body (Comp_Unit, OK);
8503             Opt.Style_Check := Save_Style_Check;
8504             Expander_Mode_Restore;
8505
8506             if not OK
8507               and then Unit_Requires_Body (Defining_Entity (Spec))
8508             then
8509                declare
8510                   Bname : constant Unit_Name_Type :=
8511                             Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
8512
8513                begin
8514                   Error_Msg_Unit_1 := Bname;
8515                   Error_Msg_N ("this instantiation requires$!", N);
8516                   Error_Msg_Name_1 :=
8517                     Get_File_Name (Bname, Subunit => False);
8518                   Error_Msg_N ("\but file{ was not found!", N);
8519                   raise Unrecoverable_Error;
8520                end;
8521             end if;
8522          end if;
8523       end if;
8524
8525       --  If loading the parent of the generic caused an instantiation
8526       --  circularity, we abandon compilation at this point, because
8527       --  otherwise in some cases we get into trouble with infinite
8528       --  recursions after this point.
8529
8530       if Circularity_Detected then
8531          raise Unrecoverable_Error;
8532       end if;
8533    end Load_Parent_Of_Generic;
8534
8535    -----------------------
8536    -- Move_Freeze_Nodes --
8537    -----------------------
8538
8539    procedure Move_Freeze_Nodes
8540      (Out_Of : Entity_Id;
8541       After  : Node_Id;
8542       L      : List_Id)
8543    is
8544       Decl      : Node_Id;
8545       Next_Decl : Node_Id;
8546       Next_Node : Node_Id := After;
8547       Spec      : Node_Id;
8548
8549       function Is_Outer_Type (T : Entity_Id) return Boolean;
8550       --  Check whether entity is declared in a scope external to that
8551       --  of the generic unit.
8552
8553       -------------------
8554       -- Is_Outer_Type --
8555       -------------------
8556
8557       function Is_Outer_Type (T : Entity_Id) return Boolean is
8558          Scop : Entity_Id := Scope (T);
8559
8560       begin
8561          if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
8562             return True;
8563
8564          else
8565             while Scop /= Standard_Standard loop
8566
8567                if Scop = Out_Of then
8568                   return False;
8569                else
8570                   Scop := Scope (Scop);
8571                end if;
8572             end loop;
8573
8574             return True;
8575          end if;
8576       end Is_Outer_Type;
8577
8578    --  Start of processing for Move_Freeze_Nodes
8579
8580    begin
8581       if No (L) then
8582          return;
8583       end if;
8584
8585       --  First remove the freeze nodes that may appear before all other
8586       --  declarations.
8587
8588       Decl := First (L);
8589       while Present (Decl)
8590         and then Nkind (Decl) = N_Freeze_Entity
8591         and then Is_Outer_Type (Entity (Decl))
8592       loop
8593          Decl := Remove_Head (L);
8594          Insert_After (Next_Node, Decl);
8595          Set_Analyzed (Decl, False);
8596          Next_Node := Decl;
8597          Decl := First (L);
8598       end loop;
8599
8600       --  Next scan the list of declarations and remove each freeze node that
8601       --  appears ahead of the current node.
8602
8603       while Present (Decl) loop
8604          while Present (Next (Decl))
8605            and then Nkind (Next (Decl)) = N_Freeze_Entity
8606            and then Is_Outer_Type (Entity (Next (Decl)))
8607          loop
8608             Next_Decl := Remove_Next (Decl);
8609             Insert_After (Next_Node, Next_Decl);
8610             Set_Analyzed (Next_Decl, False);
8611             Next_Node := Next_Decl;
8612          end loop;
8613
8614          --  If the declaration is a nested package or concurrent type, then
8615          --  recurse. Nested generic packages will have been processed from the
8616          --  inside out.
8617
8618          if Nkind (Decl) = N_Package_Declaration then
8619             Spec := Specification (Decl);
8620
8621          elsif Nkind (Decl) = N_Task_Type_Declaration then
8622             Spec := Task_Definition (Decl);
8623
8624          elsif Nkind (Decl) = N_Protected_Type_Declaration then
8625             Spec := Protected_Definition (Decl);
8626
8627          else
8628             Spec := Empty;
8629          end if;
8630
8631          if Present (Spec) then
8632             Move_Freeze_Nodes (Out_Of, Next_Node,
8633               Visible_Declarations (Spec));
8634             Move_Freeze_Nodes (Out_Of, Next_Node,
8635               Private_Declarations (Spec));
8636          end if;
8637
8638          Next (Decl);
8639       end loop;
8640    end Move_Freeze_Nodes;
8641
8642    ----------------
8643    -- Next_Assoc --
8644    ----------------
8645
8646    function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
8647    begin
8648       return Generic_Renamings.Table (E).Next_In_HTable;
8649    end Next_Assoc;
8650
8651    ------------------------
8652    -- Preanalyze_Actuals --
8653    ------------------------
8654
8655    procedure Pre_Analyze_Actuals (N : Node_Id) is
8656       Assoc : Node_Id;
8657       Act   : Node_Id;
8658       Errs  : constant Int := Serious_Errors_Detected;
8659
8660    begin
8661       Assoc := First (Generic_Associations (N));
8662
8663       while Present (Assoc) loop
8664          Act := Explicit_Generic_Actual_Parameter (Assoc);
8665
8666          --  Within a nested instantiation, a defaulted actual is an
8667          --  empty association, so nothing to analyze. If the actual for
8668          --  a subprogram is an attribute, analyze prefix only, because
8669          --  actual is not a complete attribute reference.
8670
8671          --  If actual is an allocator, analyze expression only. The full
8672          --  analysis can generate code, and if the instance is a compilation
8673          --  unit we have to wait until the package instance is installed to
8674          --  have a proper place to insert this code.
8675
8676          --  String literals may be operators, but at this point we do not
8677          --  know whether the actual is a formal subprogram or a string.
8678
8679          if No (Act) then
8680             null;
8681
8682          elsif Nkind (Act) = N_Attribute_Reference then
8683             Analyze (Prefix (Act));
8684
8685          elsif Nkind (Act) = N_Explicit_Dereference then
8686             Analyze (Prefix (Act));
8687
8688          elsif Nkind (Act) = N_Allocator then
8689             declare
8690                Expr : constant Node_Id := Expression (Act);
8691
8692             begin
8693                if Nkind (Expr) = N_Subtype_Indication then
8694                   Analyze (Subtype_Mark (Expr));
8695                   Analyze_List (Constraints (Constraint (Expr)));
8696                else
8697                   Analyze (Expr);
8698                end if;
8699             end;
8700
8701          elsif Nkind (Act) /= N_Operator_Symbol then
8702             Analyze (Act);
8703          end if;
8704
8705          if Errs /= Serious_Errors_Detected then
8706             Abandon_Instantiation (Act);
8707          end if;
8708
8709          Next (Assoc);
8710       end loop;
8711    end Pre_Analyze_Actuals;
8712
8713    -------------------
8714    -- Remove_Parent --
8715    -------------------
8716
8717    procedure Remove_Parent (In_Body : Boolean := False) is
8718       S      : Entity_Id := Current_Scope;
8719       E      : Entity_Id;
8720       P      : Entity_Id;
8721       Hidden : Elmt_Id;
8722
8723    begin
8724       --  After child instantiation is complete, remove from scope stack
8725       --  the extra copy of the current scope, and then remove parent
8726       --  instances.
8727
8728       if not In_Body then
8729          Pop_Scope;
8730
8731          while Current_Scope /= S loop
8732             P := Current_Scope;
8733             End_Package_Scope (Current_Scope);
8734
8735             if In_Open_Scopes (P) then
8736                E := First_Entity (P);
8737
8738                while Present (E) loop
8739                   Set_Is_Immediately_Visible (E, True);
8740                   Next_Entity (E);
8741                end loop;
8742
8743                if Is_Generic_Instance (Current_Scope)
8744                  and then P /= Current_Scope
8745                then
8746                   --  We are within an instance of some sibling. Retain
8747                   --  visibility of parent, for proper subsequent cleanup.
8748
8749                   Set_In_Private_Part (P);
8750                end if;
8751
8752             --  This looks incomplete: what about compilation units that
8753             --  were made visible by Install_Parent but should not remain
8754             --  visible??? Standard is on the scope stack.
8755
8756             elsif not In_Open_Scopes (Scope (P)) then
8757                Set_Is_Immediately_Visible (P, False);
8758             end if;
8759          end loop;
8760
8761          --  Reset visibility of entities in the enclosing scope.
8762
8763          Set_Is_Hidden_Open_Scope (Current_Scope, False);
8764          Hidden := First_Elmt (Hidden_Entities);
8765
8766          while Present (Hidden) loop
8767             Set_Is_Immediately_Visible (Node (Hidden), True);
8768             Next_Elmt (Hidden);
8769          end loop;
8770
8771       else
8772          --  Each body is analyzed separately, and there is no context
8773          --  that needs preserving from one body instance to the next,
8774          --  so remove all parent scopes that have been installed.
8775
8776          while Present (S) loop
8777             End_Package_Scope (S);
8778             Set_Is_Immediately_Visible (S, False);
8779             S := Current_Scope;
8780             exit when S = Standard_Standard;
8781          end loop;
8782       end if;
8783
8784    end Remove_Parent;
8785
8786    -----------------
8787    -- Restore_Env --
8788    -----------------
8789
8790    procedure Restore_Env is
8791       Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
8792
8793    begin
8794       Ada_Version := Saved.Ada_Version;
8795
8796       if No (Current_Instantiated_Parent.Act_Id) then
8797
8798          --  Restore environment after subprogram inlining
8799
8800          Restore_Private_Views (Empty);
8801       end if;
8802
8803       Current_Instantiated_Parent  := Saved.Instantiated_Parent;
8804       Exchanged_Views              := Saved.Exchanged_Views;
8805       Hidden_Entities              := Saved.Hidden_Entities;
8806       Current_Sem_Unit             := Saved.Current_Sem_Unit;
8807
8808       Instance_Envs.Decrement_Last;
8809    end Restore_Env;
8810
8811    ---------------------------
8812    -- Restore_Private_Views --
8813    ---------------------------
8814
8815    procedure Restore_Private_Views
8816      (Pack_Id    : Entity_Id;
8817       Is_Package : Boolean := True)
8818    is
8819       M        : Elmt_Id;
8820       E        : Entity_Id;
8821       Typ      : Entity_Id;
8822       Dep_Elmt : Elmt_Id;
8823       Dep_Typ  : Node_Id;
8824
8825    begin
8826       M := First_Elmt (Exchanged_Views);
8827       while Present (M) loop
8828          Typ := Node (M);
8829
8830          --  Subtypes of types whose views have been exchanged, and that
8831          --  are defined within the instance, were not on the list of
8832          --  Private_Dependents on entry to the instance, so they have to
8833          --  be exchanged explicitly now, in order to remain consistent with
8834          --  the view of the parent type.
8835
8836          if Ekind (Typ) = E_Private_Type
8837            or else Ekind (Typ) = E_Limited_Private_Type
8838            or else Ekind (Typ) = E_Record_Type_With_Private
8839          then
8840             Dep_Elmt := First_Elmt (Private_Dependents (Typ));
8841
8842             while Present (Dep_Elmt) loop
8843                Dep_Typ := Node (Dep_Elmt);
8844
8845                if Scope (Dep_Typ) = Pack_Id
8846                  and then Present (Full_View (Dep_Typ))
8847                then
8848                   Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
8849                   Exchange_Declarations (Dep_Typ);
8850                end if;
8851
8852                Next_Elmt (Dep_Elmt);
8853             end loop;
8854          end if;
8855
8856          Exchange_Declarations (Node (M));
8857          Next_Elmt (M);
8858       end loop;
8859
8860       if No (Pack_Id) then
8861          return;
8862       end if;
8863
8864       --  Make the generic formal parameters private, and make the formal
8865       --  types into subtypes of the actuals again.
8866
8867       E := First_Entity (Pack_Id);
8868
8869       while Present (E) loop
8870          Set_Is_Hidden (E, True);
8871
8872          if Is_Type (E)
8873            and then Nkind (Parent (E)) = N_Subtype_Declaration
8874          then
8875             Set_Is_Generic_Actual_Type (E, False);
8876
8877             --  An unusual case of aliasing: the actual may also be directly
8878             --  visible in the generic, and be private there, while it is
8879             --  fully visible in the context of the instance. The internal
8880             --  subtype is private in the instance, but has full visibility
8881             --  like its parent in the enclosing scope. This enforces the
8882             --  invariant that the privacy status of all private dependents of
8883             --  a type coincide with that of the parent type. This can only
8884             --  happen when a generic child unit is instantiated within a
8885             --  sibling.
8886
8887             if Is_Private_Type (E)
8888               and then not Is_Private_Type (Etype (E))
8889             then
8890                Exchange_Declarations (E);
8891             end if;
8892
8893          elsif Ekind (E) = E_Package then
8894
8895             --  The end of the renaming list is the renaming of the generic
8896             --  package itself. If the instance is a subprogram, all entities
8897             --  in the corresponding package are renamings. If this entity is
8898             --  a formal package, make its own formals private as well. The
8899             --  actual in this case is itself the renaming of an instantation.
8900             --  If the entity is not a package renaming, it is the entity
8901             --  created to validate formal package actuals: ignore.
8902
8903             --  If the actual is itself a formal package for the enclosing
8904             --  generic, or the actual for such a formal package, it remains
8905             --  visible after the current instance, and therefore nothing
8906             --  needs to be done either, except to keep it accessible.
8907
8908             if Is_Package
8909               and then Renamed_Object (E) = Pack_Id
8910             then
8911                exit;
8912
8913             elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
8914                null;
8915
8916             elsif Denotes_Formal_Package (Renamed_Object (E)) then
8917                Set_Is_Hidden (E, False);
8918
8919             else
8920                declare
8921                   Act_P : constant Entity_Id := Renamed_Object (E);
8922                   Id    : Entity_Id;
8923
8924                begin
8925                   Id := First_Entity (Act_P);
8926                   while Present (Id)
8927                     and then Id /= First_Private_Entity (Act_P)
8928                   loop
8929                      Set_Is_Hidden (Id, True);
8930                      Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
8931                      exit when Ekind (Id) = E_Package
8932                                  and then Renamed_Object (Id) = Act_P;
8933
8934                      Next_Entity (Id);
8935                   end loop;
8936                end;
8937                null;
8938             end if;
8939          end if;
8940
8941          Next_Entity (E);
8942       end loop;
8943    end Restore_Private_Views;
8944
8945    --------------
8946    -- Save_Env --
8947    --------------
8948
8949    procedure Save_Env
8950      (Gen_Unit : Entity_Id;
8951       Act_Unit : Entity_Id)
8952    is
8953    begin
8954       Init_Env;
8955       Set_Instance_Env (Gen_Unit, Act_Unit);
8956    end Save_Env;
8957
8958    ----------------------------
8959    -- Save_Global_References --
8960    ----------------------------
8961
8962    procedure Save_Global_References (N : Node_Id) is
8963       Gen_Scope : Entity_Id;
8964       E         : Entity_Id;
8965       N2        : Node_Id;
8966
8967       function Is_Global (E : Entity_Id) return Boolean;
8968       --  Check whether entity is defined outside of generic unit.
8969       --  Examine the scope of an entity, and the scope of the scope,
8970       --  etc, until we find either Standard, in which case the entity
8971       --  is global, or the generic unit itself, which indicates that
8972       --  the entity is local. If the entity is the generic unit itself,
8973       --  as in the case of a recursive call, or the enclosing generic unit,
8974       --  if different from the current scope, then it is local as well,
8975       --  because it will be replaced at the point of instantiation. On
8976       --  the other hand, if it is a reference to a child unit of a common
8977       --  ancestor, which appears in an instantiation, it is global because
8978       --  it is used to denote a specific compilation unit at the time the
8979       --  instantiations will be analyzed.
8980
8981       procedure Reset_Entity (N : Node_Id);
8982       --  Save semantic information on global entity, so that it is not
8983       --  resolved again at instantiation time.
8984
8985       procedure Save_Entity_Descendants (N : Node_Id);
8986       --  Apply Save_Global_References to the two syntactic descendants of
8987       --  non-terminal nodes that carry an Associated_Node and are processed
8988       --  through Reset_Entity. Once the global entity (if any) has been
8989       --  captured together with its type, only two syntactic descendants
8990       --  need to be traversed to complete the processing of the tree rooted
8991       --  at N. This applies to Selected_Components, Expanded_Names, and to
8992       --  Operator nodes. N can also be a character literal, identifier, or
8993       --  operator symbol node, but the call has no effect in these cases.
8994
8995       procedure Save_Global_Defaults (N1, N2 : Node_Id);
8996       --  Default actuals in nested instances must be handled specially
8997       --  because there is no link to them from the original tree. When an
8998       --  actual subprogram is given by a default, we add an explicit generic
8999       --  association for it in the instantiation node. When we save the
9000       --  global references on the name of the instance, we recover the list
9001       --  of generic associations, and add an explicit one to the original
9002       --  generic tree, through which a global actual can be preserved.
9003       --  Similarly, if a child unit is instantiated within a sibling, in the
9004       --  context of the parent, we must preserve the identifier of the parent
9005       --  so that it can be properly resolved in a subsequent instantiation.
9006
9007       procedure Save_Global_Descendant (D : Union_Id);
9008       --  Apply Save_Global_References recursively to the descendents of
9009       --  current node.
9010
9011       procedure Save_References (N : Node_Id);
9012       --  This is the recursive procedure that does the work, once the
9013       --  enclosing generic scope has been established.
9014
9015       ---------------
9016       -- Is_Global --
9017       ---------------
9018
9019       function Is_Global (E : Entity_Id) return Boolean is
9020          Se  : Entity_Id := Scope (E);
9021
9022          function Is_Instance_Node (Decl : Node_Id) return Boolean;
9023          --  Determine whether the parent node of a reference to a child unit
9024          --  denotes an instantiation or a formal package, in which case the
9025          --  reference to the child unit is global, even if it appears within
9026          --  the current scope (e.g. when the instance appears within the body
9027          --  of an ancestor).
9028
9029          function Is_Instance_Node (Decl : Node_Id) return Boolean is
9030          begin
9031             return (Nkind (Decl) in N_Generic_Instantiation
9032               or else
9033                 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration);
9034          end Is_Instance_Node;
9035
9036       --  Start of processing for Is_Global
9037
9038       begin
9039          if E = Gen_Scope then
9040             return False;
9041
9042          elsif E = Standard_Standard then
9043             return True;
9044
9045          elsif Is_Child_Unit (E)
9046            and then (Is_Instance_Node (Parent (N2))
9047              or else (Nkind (Parent (N2)) = N_Expanded_Name
9048                        and then N2 = Selector_Name (Parent (N2))
9049                        and then Is_Instance_Node (Parent (Parent (N2)))))
9050          then
9051             return True;
9052
9053          else
9054             while Se /= Gen_Scope loop
9055                if Se = Standard_Standard then
9056                   return True;
9057                else
9058                   Se := Scope (Se);
9059                end if;
9060             end loop;
9061
9062             return False;
9063          end if;
9064       end Is_Global;
9065
9066       ------------------
9067       -- Reset_Entity --
9068       ------------------
9069
9070       procedure Reset_Entity (N : Node_Id) is
9071
9072          procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
9073          --  The type of N2 is global to the generic unit. Save the
9074          --  type in the generic node.
9075
9076          function Top_Ancestor (E : Entity_Id) return Entity_Id;
9077          --  Find the ultimate ancestor of the current unit. If it is
9078          --  not a generic unit, then the name of the current unit
9079          --  in the prefix of an expanded name must be replaced with
9080          --  its generic homonym to ensure that it will be properly
9081          --  resolved in an instance.
9082
9083          ---------------------
9084          -- Set_Global_Type --
9085          ---------------------
9086
9087          procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
9088             Typ : constant Entity_Id := Etype (N2);
9089
9090          begin
9091             Set_Etype (N, Typ);
9092
9093             if Entity (N) /= N2
9094               and then Has_Private_View (Entity (N))
9095             then
9096                --  If the entity of N is not the associated node, this is
9097                --  a nested generic and it has an associated node as well,
9098                --  whose type is already the full view (see below). Indicate
9099                --  that the original node has a private view.
9100
9101                Set_Has_Private_View (N);
9102             end if;
9103
9104             --  If not a private type, nothing else to do
9105
9106             if not Is_Private_Type (Typ) then
9107                if Is_Array_Type (Typ)
9108                  and then Is_Private_Type (Component_Type (Typ))
9109                then
9110                   Set_Has_Private_View (N);
9111                end if;
9112
9113             --  If it is a derivation of a private type in a context where
9114             --  no full view is needed, nothing to do either.
9115
9116             elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
9117                null;
9118
9119             --  Otherwise mark the type for flipping and use the full_view
9120             --  when available.
9121
9122             else
9123                Set_Has_Private_View (N);
9124
9125                if Present (Full_View (Typ)) then
9126                   Set_Etype (N2, Full_View (Typ));
9127                end if;
9128             end if;
9129          end Set_Global_Type;
9130
9131          ------------------
9132          -- Top_Ancestor --
9133          ------------------
9134
9135          function Top_Ancestor (E : Entity_Id) return Entity_Id is
9136             Par : Entity_Id := E;
9137
9138          begin
9139             while Is_Child_Unit (Par) loop
9140                Par := Scope (Par);
9141             end loop;
9142
9143             return Par;
9144          end Top_Ancestor;
9145
9146       --  Start of processing for Reset_Entity
9147
9148       begin
9149          N2 := Get_Associated_Node (N);
9150          E := Entity (N2);
9151
9152          if Present (E) then
9153             if Is_Global (E) then
9154                Set_Global_Type (N, N2);
9155
9156             elsif Nkind (N) = N_Op_Concat
9157               and then Is_Generic_Type (Etype (N2))
9158               and then
9159                (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
9160                   or else Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
9161               and then Is_Intrinsic_Subprogram (E)
9162             then
9163                null;
9164
9165             else
9166                --  Entity is local. Mark generic node as unresolved.
9167                --  Note that now it does not have an entity.
9168
9169                Set_Associated_Node (N, Empty);
9170                Set_Etype  (N, Empty);
9171             end if;
9172
9173             if (Nkind (Parent (N)) = N_Package_Instantiation
9174                  or else Nkind (Parent (N)) = N_Function_Instantiation
9175                  or else Nkind (Parent (N)) = N_Procedure_Instantiation)
9176               and then N = Name (Parent (N))
9177             then
9178                Save_Global_Defaults (Parent (N), Parent (N2));
9179             end if;
9180
9181          elsif Nkind (Parent (N)) = N_Selected_Component
9182            and then Nkind (Parent (N2)) = N_Expanded_Name
9183          then
9184
9185             if Is_Global (Entity (Parent (N2))) then
9186                Change_Selected_Component_To_Expanded_Name (Parent (N));
9187                Set_Associated_Node (Parent (N), Parent (N2));
9188                Set_Global_Type (Parent (N), Parent (N2));
9189                Save_Entity_Descendants (N);
9190
9191             --  If this is a reference to the current generic entity,
9192             --  replace by the name of the generic homonym of the current
9193             --  package. This is because in an instantiation  Par.P.Q will
9194             --  not resolve to the name of the instance, whose enclosing
9195             --  scope is not necessarily Par. We use the generic homonym
9196             --  rather that the name of the generic itself, because it may
9197             --  be hidden by a local declaration.
9198
9199             elsif In_Open_Scopes (Entity (Parent (N2)))
9200               and then not
9201                 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
9202             then
9203                if Ekind (Entity (Parent (N2))) = E_Generic_Package then
9204                   Rewrite (Parent (N),
9205                     Make_Identifier (Sloc (N),
9206                       Chars =>
9207                         Chars (Generic_Homonym (Entity (Parent (N2))))));
9208                else
9209                   Rewrite (Parent (N),
9210                     Make_Identifier (Sloc (N),
9211                       Chars => Chars (Selector_Name (Parent (N2)))));
9212                end if;
9213             end if;
9214
9215             if (Nkind (Parent (Parent (N))) = N_Package_Instantiation
9216                  or else Nkind (Parent (Parent (N)))
9217                    = N_Function_Instantiation
9218                  or else Nkind (Parent (Parent (N)))
9219                    = N_Procedure_Instantiation)
9220               and then Parent (N) = Name (Parent (Parent (N)))
9221             then
9222                Save_Global_Defaults
9223                  (Parent (Parent (N)), Parent (Parent ((N2))));
9224             end if;
9225
9226          --  A selected component may denote a static constant that has
9227          --  been folded. Make the same replacement in original tree.
9228
9229          elsif Nkind (Parent (N)) = N_Selected_Component
9230            and then (Nkind (Parent (N2)) = N_Integer_Literal
9231                       or else Nkind (Parent (N2)) = N_Real_Literal)
9232          then
9233             Rewrite (Parent (N),
9234               New_Copy (Parent (N2)));
9235             Set_Analyzed (Parent (N), False);
9236
9237          --  A selected component may be transformed into a parameterless
9238          --  function call. If the called entity is global, rewrite the
9239          --  node appropriately, i.e. as an extended name for the global
9240          --  entity.
9241
9242          elsif Nkind (Parent (N)) = N_Selected_Component
9243            and then Nkind (Parent (N2)) = N_Function_Call
9244            and then Is_Global (Entity (Name (Parent (N2))))
9245          then
9246             Change_Selected_Component_To_Expanded_Name (Parent (N));
9247             Set_Associated_Node (Parent (N), Name (Parent (N2)));
9248             Set_Global_Type (Parent (N), Name (Parent (N2)));
9249             Save_Entity_Descendants (N);
9250
9251          else
9252             --  Entity is local. Reset in generic unit, so that node
9253             --  is resolved anew at the point of instantiation.
9254
9255             Set_Associated_Node (N, Empty);
9256             Set_Etype (N, Empty);
9257          end if;
9258       end Reset_Entity;
9259
9260       -----------------------------
9261       -- Save_Entity_Descendants --
9262       -----------------------------
9263
9264       procedure Save_Entity_Descendants (N : Node_Id) is
9265       begin
9266          case Nkind (N) is
9267             when N_Binary_Op =>
9268                Save_Global_Descendant (Union_Id (Left_Opnd (N)));
9269                Save_Global_Descendant (Union_Id (Right_Opnd (N)));
9270
9271             when N_Unary_Op =>
9272                Save_Global_Descendant (Union_Id (Right_Opnd (N)));
9273
9274             when N_Expanded_Name | N_Selected_Component =>
9275                Save_Global_Descendant (Union_Id (Prefix (N)));
9276                Save_Global_Descendant (Union_Id (Selector_Name (N)));
9277
9278             when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
9279                null;
9280
9281             when others =>
9282                raise Program_Error;
9283          end case;
9284       end Save_Entity_Descendants;
9285
9286       --------------------------
9287       -- Save_Global_Defaults --
9288       --------------------------
9289
9290       procedure Save_Global_Defaults (N1, N2 : Node_Id) is
9291          Loc    : constant Source_Ptr := Sloc (N1);
9292          Assoc2 : constant List_Id    := Generic_Associations (N2);
9293          Gen_Id : constant Entity_Id  := Get_Generic_Entity (N2);
9294          Assoc1 : List_Id;
9295          Act1   : Node_Id;
9296          Act2   : Node_Id;
9297          Def    : Node_Id;
9298          Ndec   : Node_Id;
9299          Subp   : Entity_Id;
9300          Actual : Entity_Id;
9301
9302       begin
9303          Assoc1 := Generic_Associations (N1);
9304
9305          if Present (Assoc1) then
9306             Act1 := First (Assoc1);
9307          else
9308             Act1 := Empty;
9309             Set_Generic_Associations (N1, New_List);
9310             Assoc1 := Generic_Associations (N1);
9311          end if;
9312
9313          if Present (Assoc2) then
9314             Act2 := First (Assoc2);
9315          else
9316             return;
9317          end if;
9318
9319          while Present (Act1) and then Present (Act2) loop
9320             Next (Act1);
9321             Next (Act2);
9322          end loop;
9323
9324          --  Find the associations added for default suprograms.
9325
9326          if Present (Act2) then
9327             while Nkind (Act2) /= N_Generic_Association
9328               or else No (Entity (Selector_Name (Act2)))
9329               or else not Is_Overloadable (Entity (Selector_Name (Act2)))
9330             loop
9331                Next (Act2);
9332             end loop;
9333
9334             --  Add a similar association if the default is global. The
9335             --  renaming declaration for the actual has been analyzed, and
9336             --  its alias is the program it renames. Link the actual in the
9337             --  original generic tree with the node in the analyzed tree.
9338
9339             while Present (Act2) loop
9340                Subp := Entity (Selector_Name (Act2));
9341                Def  := Explicit_Generic_Actual_Parameter (Act2);
9342
9343                --  Following test is defence against rubbish errors
9344
9345                if No (Alias (Subp)) then
9346                   return;
9347                end if;
9348
9349                --  Retrieve the resolved actual from the renaming declaration
9350                --  created for the instantiated formal.
9351
9352                Actual := Entity (Name (Parent (Parent (Subp))));
9353                Set_Entity (Def, Actual);
9354                Set_Etype (Def, Etype (Actual));
9355
9356                if Is_Global (Actual) then
9357                   Ndec :=
9358                     Make_Generic_Association (Loc,
9359                       Selector_Name => New_Occurrence_Of (Subp, Loc),
9360                         Explicit_Generic_Actual_Parameter =>
9361                           New_Occurrence_Of (Actual, Loc));
9362
9363                   Set_Associated_Node
9364                     (Explicit_Generic_Actual_Parameter (Ndec), Def);
9365
9366                   Append (Ndec, Assoc1);
9367
9368                --  If there are other defaults, add a dummy association
9369                --  in case there are other defaulted formals with the same
9370                --  name.
9371
9372                elsif Present (Next (Act2)) then
9373                   Ndec :=
9374                     Make_Generic_Association (Loc,
9375                       Selector_Name => New_Occurrence_Of (Subp, Loc),
9376                         Explicit_Generic_Actual_Parameter => Empty);
9377
9378                   Append (Ndec, Assoc1);
9379                end if;
9380
9381                Next (Act2);
9382             end loop;
9383          end if;
9384
9385          if Nkind (Name (N1)) = N_Identifier
9386            and then Is_Child_Unit (Gen_Id)
9387            and then Is_Global (Gen_Id)
9388            and then Is_Generic_Unit (Scope (Gen_Id))
9389            and then In_Open_Scopes (Scope (Gen_Id))
9390          then
9391             --  This is an instantiation of a child unit within a sibling,
9392             --  so that the generic parent is in scope. An eventual instance
9393             --  must occur within the scope of an instance of the parent.
9394             --  Make name in instance into an expanded name, to preserve the
9395             --  identifier of the parent, so it can be resolved subsequently.
9396
9397             Rewrite (Name (N2),
9398               Make_Expanded_Name (Loc,
9399                 Chars         => Chars (Gen_Id),
9400                 Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
9401                 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
9402             Set_Entity (Name (N2), Gen_Id);
9403
9404             Rewrite (Name (N1),
9405                Make_Expanded_Name (Loc,
9406                 Chars         => Chars (Gen_Id),
9407                 Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
9408                 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
9409
9410             Set_Associated_Node (Name (N1), Name (N2));
9411             Set_Associated_Node (Prefix (Name (N1)), Empty);
9412             Set_Associated_Node
9413               (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
9414             Set_Etype (Name (N1), Etype (Gen_Id));
9415          end if;
9416
9417       end Save_Global_Defaults;
9418
9419       ----------------------------
9420       -- Save_Global_Descendant --
9421       ----------------------------
9422
9423       procedure Save_Global_Descendant (D : Union_Id) is
9424          N1 : Node_Id;
9425
9426       begin
9427          if D in Node_Range then
9428             if D = Union_Id (Empty) then
9429                null;
9430
9431             elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
9432                Save_References (Node_Id (D));
9433             end if;
9434
9435          elsif D in List_Range then
9436             if D = Union_Id (No_List)
9437               or else Is_Empty_List (List_Id (D))
9438             then
9439                null;
9440
9441             else
9442                N1 := First (List_Id (D));
9443                while Present (N1) loop
9444                   Save_References (N1);
9445                   Next (N1);
9446                end loop;
9447             end if;
9448
9449          --  Element list or other non-node field, nothing to do
9450
9451          else
9452             null;
9453          end if;
9454       end Save_Global_Descendant;
9455
9456       ---------------------
9457       -- Save_References --
9458       ---------------------
9459
9460       --  This is the recursive procedure that does the work, once the
9461       --  enclosing generic scope has been established. We have to treat
9462       --  specially a number of node rewritings that are required by semantic
9463       --  processing and which change the kind of nodes in the generic copy:
9464       --  typically constant-folding, replacing an operator node by a string
9465       --  literal, or a selected component by an expanded name. In  each of
9466       --  those cases, the transformation is propagated to the generic unit.
9467
9468       procedure Save_References (N : Node_Id) is
9469       begin
9470          if N = Empty then
9471             null;
9472
9473          elsif Nkind (N) = N_Character_Literal
9474            or else Nkind (N) = N_Operator_Symbol
9475          then
9476             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
9477                Reset_Entity (N);
9478
9479             elsif Nkind (N) = N_Operator_Symbol
9480               and then Nkind (Get_Associated_Node (N)) = N_String_Literal
9481             then
9482                Change_Operator_Symbol_To_String_Literal (N);
9483             end if;
9484
9485          elsif Nkind (N) in N_Op then
9486
9487             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
9488
9489                if Nkind (N) = N_Op_Concat then
9490                   Set_Is_Component_Left_Opnd (N,
9491                     Is_Component_Left_Opnd (Get_Associated_Node (N)));
9492
9493                   Set_Is_Component_Right_Opnd (N,
9494                     Is_Component_Right_Opnd (Get_Associated_Node (N)));
9495                end if;
9496
9497                Reset_Entity (N);
9498             else
9499                --  Node may be transformed into call to a user-defined operator
9500
9501                N2 := Get_Associated_Node (N);
9502
9503                if Nkind (N2) = N_Function_Call then
9504                   E := Entity (Name (N2));
9505
9506                   if Present (E)
9507                     and then Is_Global (E)
9508                   then
9509                      Set_Etype (N, Etype (N2));
9510                   else
9511                      Set_Associated_Node (N, Empty);
9512                      Set_Etype (N, Empty);
9513                   end if;
9514
9515                elsif Nkind (N2) = N_Integer_Literal
9516                  or else Nkind (N2) = N_Real_Literal
9517                  or else Nkind (N2) = N_String_Literal
9518                then
9519                   --  Operation was constant-folded, perform the same
9520                   --  replacement in generic.
9521
9522                   Rewrite (N, New_Copy (N2));
9523                   Set_Analyzed (N, False);
9524
9525                elsif Nkind (N2) = N_Identifier
9526                  and then Ekind (Entity (N2)) = E_Enumeration_Literal
9527                then
9528                   --  Same if call was folded into a literal, but in this
9529                   --  case retain the entity to avoid spurious ambiguities
9530                   --  if id is overloaded at the point of instantiation or
9531                   --  inlining.
9532
9533                   Rewrite (N, New_Copy (N2));
9534                   Set_Associated_Node (N, N2);
9535                   Set_Analyzed (N, False);
9536                end if;
9537             end if;
9538
9539             --  Complete the check on operands, if node has not been
9540             --  constant-folded.
9541
9542             if Nkind (N) in N_Op then
9543                Save_Entity_Descendants (N);
9544             end if;
9545
9546          elsif Nkind (N) = N_Identifier then
9547             if Nkind (N) = Nkind (Get_Associated_Node (N)) then
9548
9549                --  If this is a discriminant reference, always save it.
9550                --  It is used in the instance to find the corresponding
9551                --  discriminant positionally rather than  by name.
9552
9553                Set_Original_Discriminant
9554                  (N, Original_Discriminant (Get_Associated_Node (N)));
9555                Reset_Entity (N);
9556
9557             else
9558                N2 := Get_Associated_Node (N);
9559
9560                if Nkind (N2) = N_Function_Call then
9561                   E := Entity (Name (N2));
9562
9563                   --  Name resolves to a call to parameterless function.
9564                   --  If original entity is global, mark node as resolved.
9565
9566                   if Present (E)
9567                     and then Is_Global (E)
9568                   then
9569                      Set_Etype (N, Etype (N2));
9570                   else
9571                      Set_Associated_Node (N, Empty);
9572                      Set_Etype (N, Empty);
9573                   end if;
9574
9575                elsif
9576                  Nkind (N2) = N_Integer_Literal or else
9577                  Nkind (N2) = N_Real_Literal    or else
9578                  Nkind (N2) = N_String_Literal
9579                then
9580                   --  Name resolves to named number that is constant-folded,
9581                   --  or to string literal from concatenation.
9582                   --  Perform the same replacement in generic.
9583
9584                   Rewrite (N, New_Copy (N2));
9585                   Set_Analyzed (N, False);
9586
9587                elsif Nkind (N2) = N_Explicit_Dereference then
9588
9589                   --  An identifier is rewritten as a dereference if it is
9590                   --  the prefix in a selected component, and it denotes an
9591                   --  access to a composite type, or a parameterless function
9592                   --  call that returns an access type.
9593
9594                   --  Check whether corresponding entity in prefix is global.
9595
9596                   if Is_Entity_Name (Prefix (N2))
9597                     and then Present (Entity (Prefix (N2)))
9598                     and then Is_Global (Entity (Prefix (N2)))
9599                   then
9600                      Rewrite (N,
9601                        Make_Explicit_Dereference (Sloc (N),
9602                           Prefix => Make_Identifier (Sloc (N),
9603                             Chars => Chars (N))));
9604                      Set_Associated_Node (Prefix (N), Prefix (N2));
9605
9606                   elsif Nkind (Prefix (N2)) = N_Function_Call
9607                     and then Is_Global (Entity (Name (Prefix (N2))))
9608                   then
9609                      Rewrite (N,
9610                        Make_Explicit_Dereference (Sloc (N),
9611                           Prefix => Make_Function_Call (Sloc (N),
9612                             Name  =>
9613                               Make_Identifier (Sloc (N),
9614                               Chars => Chars (N)))));
9615
9616                      Set_Associated_Node
9617                       (Name (Prefix (N)), Name (Prefix (N2)));
9618
9619                   else
9620                      Set_Associated_Node (N, Empty);
9621                      Set_Etype (N, Empty);
9622                   end if;
9623
9624                --  The subtype mark of a nominally unconstrained object
9625                --  is rewritten as a subtype indication using the bounds
9626                --  of the expression. Recover the original subtype mark.
9627
9628                elsif Nkind (N2) = N_Subtype_Indication
9629                  and then Is_Entity_Name (Original_Node (N2))
9630                then
9631                   Set_Associated_Node (N, Original_Node (N2));
9632                   Reset_Entity (N);
9633
9634                else
9635                   null;
9636                end if;
9637             end if;
9638
9639          elsif Nkind (N) in N_Entity then
9640             null;
9641
9642          else
9643             declare
9644                use Atree.Unchecked_Access;
9645                --  This code section is part of implementing an untyped tree
9646                --  traversal, so it needs direct access to node fields.
9647
9648             begin
9649                if Nkind (N) = N_Aggregate
9650                     or else
9651                   Nkind (N) = N_Extension_Aggregate
9652                then
9653                   N2 := Get_Associated_Node (N);
9654
9655                   if No (N2)
9656                     or else No (Etype (N2))
9657                     or else not Is_Global (Etype (N2))
9658                   then
9659                      Set_Associated_Node (N, Empty);
9660                   end if;
9661
9662                   Save_Global_Descendant (Field1 (N));
9663                   Save_Global_Descendant (Field2 (N));
9664                   Save_Global_Descendant (Field3 (N));
9665                   Save_Global_Descendant (Field5 (N));
9666
9667                --  All other cases than aggregates
9668
9669                else
9670                   Save_Global_Descendant (Field1 (N));
9671                   Save_Global_Descendant (Field2 (N));
9672                   Save_Global_Descendant (Field3 (N));
9673                   Save_Global_Descendant (Field4 (N));
9674                   Save_Global_Descendant (Field5 (N));
9675                end if;
9676             end;
9677          end if;
9678       end Save_References;
9679
9680    --  Start of processing for Save_Global_References
9681
9682    begin
9683       Gen_Scope := Current_Scope;
9684
9685       --  If the generic unit is a child unit, references to entities in
9686       --  the parent are treated as local, because they will be resolved
9687       --  anew in the context of the instance of the parent.
9688
9689       while Is_Child_Unit (Gen_Scope)
9690         and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
9691       loop
9692          Gen_Scope := Scope (Gen_Scope);
9693       end loop;
9694
9695       Save_References (N);
9696    end Save_Global_References;
9697
9698    --------------------------------------
9699    -- Set_Copied_Sloc_For_Inlined_Body --
9700    --------------------------------------
9701
9702    procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
9703    begin
9704       Create_Instantiation_Source (N, E, True, S_Adjustment);
9705    end Set_Copied_Sloc_For_Inlined_Body;
9706
9707    ---------------------
9708    -- Set_Instance_Of --
9709    ---------------------
9710
9711    procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
9712    begin
9713       Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
9714       Generic_Renamings_HTable.Set (Generic_Renamings.Last);
9715       Generic_Renamings.Increment_Last;
9716    end Set_Instance_Of;
9717
9718    --------------------
9719    -- Set_Next_Assoc --
9720    --------------------
9721
9722    procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
9723    begin
9724       Generic_Renamings.Table (E).Next_In_HTable := Next;
9725    end Set_Next_Assoc;
9726
9727    -------------------
9728    -- Start_Generic --
9729    -------------------
9730
9731    procedure Start_Generic is
9732    begin
9733       --  ??? I am sure more things could be factored out in this
9734       --  routine. Should probably be done at a later stage.
9735
9736       Generic_Flags.Increment_Last;
9737       Generic_Flags.Table (Generic_Flags.Last) := Inside_A_Generic;
9738       Inside_A_Generic := True;
9739
9740       Expander_Mode_Save_And_Set (False);
9741    end Start_Generic;
9742
9743    ----------------------
9744    -- Set_Instance_Env --
9745    ----------------------
9746
9747    procedure Set_Instance_Env
9748      (Gen_Unit : Entity_Id;
9749       Act_Unit : Entity_Id)
9750    is
9751
9752    begin
9753       --  Regardless of the current mode, predefined units are analyzed in
9754       --  the most current Ada mode, and earlier version Ada checks do not
9755       --  apply to predefined units.
9756
9757       if Is_Internal_File_Name
9758           (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
9759            Renamings_Included => True) then
9760          Ada_Version := Ada_Version_Type'Last;
9761       end if;
9762
9763       Current_Instantiated_Parent := (Gen_Unit, Act_Unit, Assoc_Null);
9764    end Set_Instance_Env;
9765
9766    -----------------
9767    -- Switch_View --
9768    -----------------
9769
9770    procedure Switch_View (T : Entity_Id) is
9771       BT        : constant Entity_Id := Base_Type (T);
9772       Priv_Elmt : Elmt_Id := No_Elmt;
9773       Priv_Sub  : Entity_Id;
9774
9775    begin
9776       --  T may be private but its base type may have been exchanged through
9777       --  some other occurrence, in which case there is nothing to switch.
9778
9779       if not Is_Private_Type (BT) then
9780          return;
9781       end if;
9782
9783       Priv_Elmt := First_Elmt (Private_Dependents (BT));
9784
9785       if Present (Full_View (BT)) then
9786          Append_Elmt (Full_View (BT), Exchanged_Views);
9787          Exchange_Declarations (BT);
9788       end if;
9789
9790       while Present (Priv_Elmt) loop
9791          Priv_Sub := (Node (Priv_Elmt));
9792
9793          --  We avoid flipping the subtype if the Etype of its full
9794          --  view is private because this would result in a malformed
9795          --  subtype. This occurs when the Etype of the subtype full
9796          --  view is the full view of the base type (and since the
9797          --  base types were just switched, the subtype is pointing
9798          --  to the wrong view). This is currently the case for
9799          --  tagged record types, access types (maybe more?) and
9800          --  needs to be resolved. ???
9801
9802          if Present (Full_View (Priv_Sub))
9803            and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
9804          then
9805             Append_Elmt (Full_View (Priv_Sub), Exchanged_Views);
9806             Exchange_Declarations (Priv_Sub);
9807          end if;
9808
9809          Next_Elmt (Priv_Elmt);
9810       end loop;
9811    end Switch_View;
9812
9813    -----------------------------
9814    -- Valid_Default_Attribute --
9815    -----------------------------
9816
9817    procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
9818       Attr_Id : constant Attribute_Id :=
9819                   Get_Attribute_Id (Attribute_Name (Def));
9820       T       : constant Entity_Id := Entity (Prefix (Def));
9821       Is_Fun  : constant Boolean := (Ekind (Nam) = E_Function);
9822       F       : Entity_Id;
9823       Num_F   : Int;
9824       OK      : Boolean;
9825
9826    begin
9827       if No (T)
9828         or else T = Any_Id
9829       then
9830          return;
9831       end if;
9832
9833       Num_F := 0;
9834       F := First_Formal (Nam);
9835       while Present (F) loop
9836          Num_F := Num_F + 1;
9837          Next_Formal (F);
9838       end loop;
9839
9840       case Attr_Id is
9841          when Attribute_Adjacent |  Attribute_Ceiling   | Attribute_Copy_Sign |
9842               Attribute_Floor    |  Attribute_Fraction  | Attribute_Machine   |
9843               Attribute_Model    |  Attribute_Remainder | Attribute_Rounding  |
9844               Attribute_Unbiased_Rounding  =>
9845             OK := Is_Fun
9846                     and then Num_F = 1
9847                     and then Is_Floating_Point_Type (T);
9848
9849          when Attribute_Image    | Attribute_Pred       | Attribute_Succ |
9850               Attribute_Value    | Attribute_Wide_Image |
9851               Attribute_Wide_Value  =>
9852             OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
9853
9854          when Attribute_Max      |  Attribute_Min  =>
9855             OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
9856
9857          when Attribute_Input =>
9858             OK := (Is_Fun and then Num_F = 1);
9859
9860          when Attribute_Output | Attribute_Read | Attribute_Write =>
9861             OK := (not Is_Fun and then Num_F = 2);
9862
9863          when others =>
9864             OK := False;
9865       end case;
9866
9867       if not OK then
9868          Error_Msg_N ("attribute reference has wrong profile for subprogram",
9869            Def);
9870       end if;
9871    end Valid_Default_Attribute;
9872
9873 end Sem_Ch12;