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-2015, Free Software Foundation, Inc.         --
10--                                                                          --
11-- GNAT is free software;  you can  redistribute it  and/or modify it under --
12-- terms of the  GNU General Public License as published  by the Free Soft- --
13-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16-- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17-- for  more details.  You should have  received  a copy of the GNU General --
18-- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
19-- http://www.gnu.org/licenses for a complete copy of the license.          --
20--                                                                          --
21-- GNAT was originally developed  by the GNAT team at  New York University. --
22-- Extensive contributions were provided by Ada Core Technologies Inc.      --
23--                                                                          --
24------------------------------------------------------------------------------
25
26with Aspects;  use Aspects;
27with Atree;    use Atree;
28with Einfo;    use Einfo;
29with Elists;   use Elists;
30with Errout;   use Errout;
31with Expander; use Expander;
32with Exp_Disp; use Exp_Disp;
33with Fname;    use Fname;
34with Fname.UF; use Fname.UF;
35with Freeze;   use Freeze;
36with Ghost;    use Ghost;
37with Itypes;   use Itypes;
38with Lib;      use Lib;
39with Lib.Load; use Lib.Load;
40with Lib.Xref; use Lib.Xref;
41with Nlists;   use Nlists;
42with Namet;    use Namet;
43with Nmake;    use Nmake;
44with Opt;      use Opt;
45with Rident;   use Rident;
46with Restrict; use Restrict;
47with Rtsfind;  use Rtsfind;
48with Sem;      use Sem;
49with Sem_Aux;  use Sem_Aux;
50with Sem_Cat;  use Sem_Cat;
51with Sem_Ch3;  use Sem_Ch3;
52with Sem_Ch6;  use Sem_Ch6;
53with Sem_Ch7;  use Sem_Ch7;
54with Sem_Ch8;  use Sem_Ch8;
55with Sem_Ch10; use Sem_Ch10;
56with Sem_Ch13; use Sem_Ch13;
57with Sem_Dim;  use Sem_Dim;
58with Sem_Disp; use Sem_Disp;
59with Sem_Elab; use Sem_Elab;
60with Sem_Elim; use Sem_Elim;
61with Sem_Eval; use Sem_Eval;
62with Sem_Res;  use Sem_Res;
63with Sem_Type; use Sem_Type;
64with Sem_Util; use Sem_Util;
65with Sem_Warn; use Sem_Warn;
66with Stand;    use Stand;
67with Sinfo;    use Sinfo;
68with Sinfo.CN; use Sinfo.CN;
69with Sinput;   use Sinput;
70with Sinput.L; use Sinput.L;
71with Snames;   use Snames;
72with Stringt;  use Stringt;
73with Uname;    use Uname;
74with Table;
75with Tbuild;   use Tbuild;
76with Uintp;    use Uintp;
77with Urealp;   use Urealp;
78with Warnsw;   use Warnsw;
79
80with GNAT.HTable;
81
82package body Sem_Ch12 is
83
84   ----------------------------------------------------------
85   -- Implementation of Generic Analysis and Instantiation --
86   ----------------------------------------------------------
87
88   --  GNAT implements generics by macro expansion. No attempt is made to share
89   --  generic instantiations (for now). Analysis of a generic definition does
90   --  not perform any expansion action, but the expander must be called on the
91   --  tree for each instantiation, because the expansion may of course depend
92   --  on the generic actuals. All of this is best achieved as follows:
93   --
94   --  a) Semantic analysis of a generic unit is performed on a copy of the
95   --  tree for the generic unit. All tree modifications that follow analysis
96   --  do not affect the original tree. Links are kept between the original
97   --  tree and the copy, in order to recognize non-local references within
98   --  the generic, and propagate them to each instance (recall that name
99   --  resolution is done on the generic declaration: generics are not really
100   --  macros). This is summarized in the following diagram:
101
102   --              .-----------.               .----------.
103   --              |  semantic |<--------------|  generic |
104   --              |    copy   |               |    unit  |
105   --              |           |==============>|          |
106   --              |___________|    global     |__________|
107   --                             references     |   |  |
108   --                                            |   |  |
109   --                                          .-----|--|.
110   --                                          |  .-----|---.
111   --                                          |  |  .----------.
112   --                                          |  |  |  generic |
113   --                                          |__|  |          |
114   --                                             |__| instance |
115   --                                                |__________|
116
117   --  b) Each instantiation copies the original tree, and inserts into it a
118   --  series of declarations that describe the mapping between generic formals
119   --  and actuals. For example, a generic In OUT parameter is an object
120   --  renaming of the corresponding actual, etc. Generic IN parameters are
121   --  constant declarations.
122
123   --  c) In order to give the right visibility for these renamings, we use
124   --  a different scheme for package and subprogram instantiations. For
125   --  packages, the list of renamings is inserted into the package
126   --  specification, before the visible declarations of the package. The
127   --  renamings are analyzed before any of the text of the instance, and are
128   --  thus visible at the right place. Furthermore, outside of the instance,
129   --  the generic parameters are visible and denote their corresponding
130   --  actuals.
131
132   --  For subprograms, we create a container package to hold the renamings
133   --  and the subprogram instance itself. Analysis of the package makes the
134   --  renaming declarations visible to the subprogram. After analyzing the
135   --  package, the defining entity for the subprogram is touched-up so that
136   --  it appears declared in the current scope, and not inside the container
137   --  package.
138
139   --  If the instantiation is a compilation unit, the container package is
140   --  given the same name as the subprogram instance. This ensures that
141   --  the elaboration procedure called by the binder, using the compilation
142   --  unit name, calls in fact the elaboration procedure for the package.
143
144   --  Not surprisingly, private types complicate this approach. By saving in
145   --  the original generic object the non-local references, we guarantee that
146   --  the proper entities are referenced at the point of instantiation.
147   --  However, for private types, this by itself does not insure that the
148   --  proper VIEW of the entity is used (the full type may be visible at the
149   --  point of generic definition, but not at instantiation, or vice-versa).
150   --  In  order to reference the proper view, we special-case any reference
151   --  to private types in the generic object, by saving both views, one in
152   --  the generic and one in the semantic copy. At time of instantiation, we
153   --  check whether the two views are consistent, and exchange declarations if
154   --  necessary, in order to restore the correct visibility. Similarly, if
155   --  the instance view is private when the generic view was not, we perform
156   --  the exchange. After completing the instantiation, we restore the
157   --  current visibility. The flag Has_Private_View marks identifiers in the
158   --  the generic unit that require checking.
159
160   --  Visibility within nested generic units requires special handling.
161   --  Consider the following scheme:
162
163   --  type Global is ...         --  outside of generic unit.
164   --  generic ...
165   --  package Outer is
166   --     ...
167   --     type Semi_Global is ... --  global to inner.
168
169   --     generic ...                                         -- 1
170   --     procedure inner (X1 : Global;  X2 : Semi_Global);
171
172   --     procedure in2 is new inner (...);                   -- 4
173   --  end Outer;
174
175   --  package New_Outer is new Outer (...);                  -- 2
176   --  procedure New_Inner is new New_Outer.Inner (...);      -- 3
177
178   --  The semantic analysis of Outer captures all occurrences of Global.
179   --  The semantic analysis of Inner (at 1) captures both occurrences of
180   --  Global and Semi_Global.
181
182   --  At point 2 (instantiation of Outer), we also produce a generic copy
183   --  of Inner, even though Inner is, at that point, not being instantiated.
184   --  (This is just part of the semantic analysis of New_Outer).
185
186   --  Critically, references to Global within Inner must be preserved, while
187   --  references to Semi_Global should not preserved, because they must now
188   --  resolve to an entity within New_Outer. To distinguish between these, we
189   --  use a global variable, Current_Instantiated_Parent, which is set when
190   --  performing a generic copy during instantiation (at 2). This variable is
191   --  used when performing a generic copy that is not an instantiation, but
192   --  that is nested within one, as the occurrence of 1 within 2. The analysis
193   --  of a nested generic only preserves references that are global to the
194   --  enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
195   --  determine whether a reference is external to the given parent.
196
197   --  The instantiation at point 3 requires no special treatment. The method
198   --  works as well for further nestings of generic units, but of course the
199   --  variable Current_Instantiated_Parent must be stacked because nested
200   --  instantiations can occur, e.g. the occurrence of 4 within 2.
201
202   --  The instantiation of package and subprogram bodies is handled in a
203   --  similar manner, except that it is delayed until after semantic
204   --  analysis is complete. In this fashion complex cross-dependencies
205   --  between several package declarations and bodies containing generics
206   --  can be compiled which otherwise would diagnose spurious circularities.
207
208   --  For example, it is possible to compile two packages A and B that
209   --  have the following structure:
210
211   --    package A is                         package B is
212   --       generic ...                          generic ...
213   --       package G_A is                       package G_B is
214
215   --    with B;                              with A;
216   --    package body A is                    package body B is
217   --       package N_B is new G_B (..)          package N_A is new G_A (..)
218
219   --  The table Pending_Instantiations in package Inline is used to keep
220   --  track of body instantiations that are delayed in this manner. Inline
221   --  handles the actual calls to do the body instantiations. This activity
222   --  is part of Inline, since the processing occurs at the same point, and
223   --  for essentially the same reason, as the handling of inlined routines.
224
225   ----------------------------------------------
226   -- Detection of Instantiation Circularities --
227   ----------------------------------------------
228
229   --  If we have a chain of instantiations that is circular, this is static
230   --  error which must be detected at compile time. The detection of these
231   --  circularities is carried out at the point that we insert a generic
232   --  instance spec or body. If there is a circularity, then the analysis of
233   --  the offending spec or body will eventually result in trying to load the
234   --  same unit again, and we detect this problem as we analyze the package
235   --  instantiation for the second time.
236
237   --  At least in some cases after we have detected the circularity, we get
238   --  into trouble if we try to keep going. The following flag is set if a
239   --  circularity is detected, and used to abandon compilation after the
240   --  messages have been posted.
241
242   Circularity_Detected : Boolean := False;
243   --  This should really be reset on encountering a new main unit, but in
244   --  practice we are not using multiple main units so it is not critical.
245
246   --------------------------------------------------
247   -- Formal packages and partial parameterization --
248   --------------------------------------------------
249
250   --  When compiling a generic, a formal package is a local instantiation. If
251   --  declared with a box, its generic formals are visible in the enclosing
252   --  generic. If declared with a partial list of actuals, those actuals that
253   --  are defaulted (covered by an Others clause, or given an explicit box
254   --  initialization) are also visible in the enclosing generic, while those
255   --  that have a corresponding actual are not.
256
257   --  In our source model of instantiation, the same visibility must be
258   --  present in the spec and body of an instance: the names of the formals
259   --  that are defaulted must be made visible within the instance, and made
260   --  invisible (hidden) after the instantiation is complete, so that they
261   --  are not accessible outside of the instance.
262
263   --  In a generic, a formal package is treated like a special instantiation.
264   --  Our Ada 95 compiler handled formals with and without box in different
265   --  ways. With partial parameterization, we use a single model for both.
266   --  We create a package declaration that consists of the specification of
267   --  the generic package, and a set of declarations that map the actuals
268   --  into local renamings, just as we do for bona fide instantiations. For
269   --  defaulted parameters and formals with a box, we copy directly the
270   --  declarations of the formal into this local package. The result is a
271   --  a package whose visible declarations may include generic formals. This
272   --  package is only used for type checking and visibility analysis, and
273   --  never reaches the back-end, so it can freely violate the placement
274   --  rules for generic formal declarations.
275
276   --  The list of declarations (renamings and copies of formals) is built
277   --  by Analyze_Associations, just as for regular instantiations.
278
279   --  At the point of instantiation, conformance checking must be applied only
280   --  to those parameters that were specified in the formal. We perform this
281   --  checking by creating another internal instantiation, this one including
282   --  only the renamings and the formals (the rest of the package spec is not
283   --  relevant to conformance checking). We can then traverse two lists: the
284   --  list of actuals in the instance that corresponds to the formal package,
285   --  and the list of actuals produced for this bogus instantiation. We apply
286   --  the conformance rules to those actuals that are not defaulted (i.e.
287   --  which still appear as generic formals.
288
289   --  When we compile an instance body we must make the right parameters
290   --  visible again. The predicate Is_Generic_Formal indicates which of the
291   --  formals should have its Is_Hidden flag reset.
292
293   -----------------------
294   -- Local subprograms --
295   -----------------------
296
297   procedure Abandon_Instantiation (N : Node_Id);
298   pragma No_Return (Abandon_Instantiation);
299   --  Posts an error message "instantiation abandoned" at the indicated node
300   --  and then raises the exception Instantiation_Error to do it.
301
302   procedure Analyze_Formal_Array_Type
303     (T   : in out Entity_Id;
304      Def : Node_Id);
305   --  A formal array type is treated like an array type declaration, and
306   --  invokes Array_Type_Declaration (sem_ch3) whose first parameter is
307   --  in-out, because in the case of an anonymous type the entity is
308   --  actually created in the procedure.
309
310   --  The following procedures treat other kinds of formal parameters
311
312   procedure Analyze_Formal_Derived_Interface_Type
313     (N   : Node_Id;
314      T   : Entity_Id;
315      Def : Node_Id);
316
317   procedure Analyze_Formal_Derived_Type
318     (N   : Node_Id;
319      T   : Entity_Id;
320      Def : Node_Id);
321
322   procedure Analyze_Formal_Interface_Type
323     (N   : Node_Id;
324      T   : Entity_Id;
325      Def : Node_Id);
326
327   --  The following subprograms create abbreviated declarations for formal
328   --  scalar types. We introduce an anonymous base of the proper class for
329   --  each of them, and define the formals as constrained first subtypes of
330   --  their bases. The bounds are expressions that are non-static in the
331   --  generic.
332
333   procedure Analyze_Formal_Decimal_Fixed_Point_Type
334                                                (T : Entity_Id; Def : Node_Id);
335   procedure Analyze_Formal_Discrete_Type       (T : Entity_Id; Def : Node_Id);
336   procedure Analyze_Formal_Floating_Type       (T : Entity_Id; Def : Node_Id);
337   procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
338   procedure Analyze_Formal_Modular_Type        (T : Entity_Id; Def : Node_Id);
339   procedure Analyze_Formal_Ordinary_Fixed_Point_Type
340                                                (T : Entity_Id; Def : Node_Id);
341
342   procedure Analyze_Formal_Private_Type
343     (N   : Node_Id;
344      T   : Entity_Id;
345      Def : Node_Id);
346   --  Creates a new private type, which does not require completion
347
348   procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
349   --  Ada 2012: Creates a new incomplete type whose actual does not freeze
350
351   procedure Analyze_Generic_Formal_Part (N : Node_Id);
352   --  Analyze generic formal part
353
354   procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
355   --  Create a new access type with the given designated type
356
357   function Analyze_Associations
358     (I_Node  : Node_Id;
359      Formals : List_Id;
360      F_Copy  : List_Id) return List_Id;
361   --  At instantiation time, build the list of associations between formals
362   --  and actuals. Each association becomes a renaming declaration for the
363   --  formal entity. F_Copy is the analyzed list of formals in the generic
364   --  copy. It is used to apply legality checks to the actuals. I_Node is the
365   --  instantiation node itself.
366
367   procedure Analyze_Subprogram_Instantiation
368     (N : Node_Id;
369      K : Entity_Kind);
370
371   procedure Build_Instance_Compilation_Unit_Nodes
372     (N        : Node_Id;
373      Act_Body : Node_Id;
374      Act_Decl : Node_Id);
375   --  This procedure is used in the case where the generic instance of a
376   --  subprogram body or package body is a library unit. In this case, the
377   --  original library unit node for the generic instantiation must be
378   --  replaced by the resulting generic body, and a link made to a new
379   --  compilation unit node for the generic declaration. The argument N is
380   --  the original generic instantiation. Act_Body and Act_Decl are the body
381   --  and declaration of the instance (either package body and declaration
382   --  nodes or subprogram body and declaration nodes depending on the case).
383   --  On return, the node N has been rewritten with the actual body.
384
385   procedure Check_Access_Definition (N : Node_Id);
386   --  Subsidiary routine to null exclusion processing. Perform an assertion
387   --  check on Ada version and the presence of an access definition in N.
388
389   procedure Check_Formal_Packages (P_Id : Entity_Id);
390   --  Apply the following to all formal packages in generic associations
391
392   procedure Check_Formal_Package_Instance
393     (Formal_Pack : Entity_Id;
394      Actual_Pack : Entity_Id);
395   --  Verify that the actuals of the actual instance match the actuals of
396   --  the template for a formal package that is not declared with a box.
397
398   procedure Check_Forward_Instantiation (Decl : Node_Id);
399   --  If the generic is a local entity and the corresponding body has not
400   --  been seen yet, flag enclosing packages to indicate that it will be
401   --  elaborated after the generic body. Subprograms declared in the same
402   --  package cannot be inlined by the front-end because front-end inlining
403   --  requires a strict linear order of elaboration.
404
405   function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
406   --  Check if some association between formals and actuals requires to make
407   --  visible primitives of a tagged type, and make those primitives visible.
408   --  Return the list of primitives whose visibility is modified (to restore
409   --  their visibility later through Restore_Hidden_Primitives). If no
410   --  candidate is found then return No_Elist.
411
412   procedure Check_Hidden_Child_Unit
413     (N           : Node_Id;
414      Gen_Unit    : Entity_Id;
415      Act_Decl_Id : Entity_Id);
416   --  If the generic unit is an implicit child instance within a parent
417   --  instance, we need to make an explicit test that it is not hidden by
418   --  a child instance of the same name and parent.
419
420   procedure Check_Generic_Actuals
421     (Instance      : Entity_Id;
422      Is_Formal_Box : Boolean);
423   --  Similar to previous one. Check the actuals in the instantiation,
424   --  whose views can change between the point of instantiation and the point
425   --  of instantiation of the body. In addition, mark the generic renamings
426   --  as generic actuals, so that they are not compatible with other actuals.
427   --  Recurse on an actual that is a formal package whose declaration has
428   --  a box.
429
430   function Contains_Instance_Of
431     (Inner : Entity_Id;
432      Outer : Entity_Id;
433      N     : Node_Id) return Boolean;
434   --  Inner is instantiated within the generic Outer. Check whether Inner
435   --  directly or indirectly contains an instance of Outer or of one of its
436   --  parents, in the case of a subunit. Each generic unit holds a list of
437   --  the entities instantiated within (at any depth). This procedure
438   --  determines whether the set of such lists contains a cycle, i.e. an
439   --  illegal circular instantiation.
440
441   function Denotes_Formal_Package
442     (Pack     : Entity_Id;
443      On_Exit  : Boolean := False;
444      Instance : Entity_Id := Empty) return Boolean;
445   --  Returns True if E is a formal package of an enclosing generic, or
446   --  the actual for such a formal in an enclosing instantiation. If such
447   --  a package is used as a formal in an nested generic, or as an actual
448   --  in a nested instantiation, the visibility of ITS formals should not
449   --  be modified. When called from within Restore_Private_Views, the flag
450   --  On_Exit is true, to indicate that the search for a possible enclosing
451   --  instance should ignore the current one. In that case Instance denotes
452   --  the declaration for which this is an actual. This declaration may be
453   --  an instantiation in the source, or the internal instantiation that
454   --  corresponds to the actual for a formal package.
455
456   function Earlier (N1, N2 : Node_Id) return Boolean;
457   --  Yields True if N1 and N2 appear in the same compilation unit,
458   --  ignoring subunits, and if N1 is to the left of N2 in a left-to-right
459   --  traversal of the tree for the unit. Used to determine the placement
460   --  of freeze nodes for instance bodies that may depend on other instances.
461
462   function Find_Actual_Type
463     (Typ       : Entity_Id;
464      Gen_Type  : Entity_Id) return Entity_Id;
465   --  When validating the actual types of a child instance, check whether
466   --  the formal is a formal type of the parent unit, and retrieve the current
467   --  actual for it. Typ is the entity in the analyzed formal type declaration
468   --  (component or index type of an array type, or designated type of an
469   --  access formal) and Gen_Type is the enclosing analyzed formal array
470   --  or access type. The desired actual may be a formal of a parent, or may
471   --  be declared in a formal package of a parent. In both cases it is a
472   --  generic actual type because it appears within a visible instance.
473   --  Finally, it may be declared in a parent unit without being a formal
474   --  of that unit, in which case it must be retrieved by visibility.
475   --  Ambiguities may still arise if two homonyms are declared in two formal
476   --  packages, and the prefix of the formal type may be needed to resolve
477   --  the ambiguity in the instance ???
478
479   function In_Same_Declarative_Part
480     (F_Node : Node_Id;
481      Inst   : Node_Id) return Boolean;
482   --  True if the instantiation Inst and the given freeze_node F_Node appear
483   --  within the same declarative part, ignoring subunits, but with no inter-
484   --  vening subprograms or concurrent units. Used to find the proper plave
485   --  for the freeze node of an instance, when the generic is declared in a
486   --  previous instance. If predicate is true, the freeze node of the instance
487   --  can be placed after the freeze node of the previous instance, Otherwise
488   --  it has to be placed at the end of the current declarative part.
489
490   function In_Main_Context (E : Entity_Id) return Boolean;
491   --  Check whether an instantiation is in the context of the main unit.
492   --  Used to determine whether its body should be elaborated to allow
493   --  front-end inlining.
494
495   procedure Set_Instance_Env
496     (Gen_Unit : Entity_Id;
497      Act_Unit : Entity_Id);
498   --  Save current instance on saved environment, to be used to determine
499   --  the global status of entities in nested instances. Part of Save_Env.
500   --  called after verifying that the generic unit is legal for the instance,
501   --  The procedure also examines whether the generic unit is a predefined
502   --  unit, in order to set configuration switches accordingly. As a result
503   --  the procedure must be called after analyzing and freezing the actuals.
504
505   procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
506   --  Associate analyzed generic parameter with corresponding
507   --  instance. Used for semantic checks at instantiation time.
508
509   function Has_Been_Exchanged (E : Entity_Id) return Boolean;
510   --  Traverse the Exchanged_Views list to see if a type was private
511   --  and has already been flipped during this phase of instantiation.
512
513   procedure Hide_Current_Scope;
514   --  When instantiating a generic child unit, the parent context must be
515   --  present, but the instance and all entities that may be generated
516   --  must be inserted in the current scope. We leave the current scope
517   --  on the stack, but make its entities invisible to avoid visibility
518   --  problems. This is reversed at the end of the instantiation. This is
519   --  not done for the instantiation of the bodies, which only require the
520   --  instances of the generic parents to be in scope.
521
522   procedure Install_Body
523     (Act_Body : Node_Id;
524      N        : Node_Id;
525      Gen_Body : Node_Id;
526      Gen_Decl : Node_Id);
527   --  If the instantiation happens textually before the body of the generic,
528   --  the instantiation of the body must be analyzed after the generic body,
529   --  and not at the point of instantiation. Such early instantiations can
530   --  happen if the generic and the instance appear in  a package declaration
531   --  because the generic body can only appear in the corresponding package
532   --  body. Early instantiations can also appear if generic, instance and
533   --  body are all in the declarative part of a subprogram or entry. Entities
534   --  of packages that are early instantiations are delayed, and their freeze
535   --  node appears after the generic body.
536
537   procedure Insert_Freeze_Node_For_Instance
538     (N      : Node_Id;
539      F_Node : Node_Id);
540   --  N denotes a package or a subprogram instantiation and F_Node is the
541   --  associated freeze node. Insert the freeze node before the first source
542   --  body which follows immediately after N. If no such body is found, the
543   --  freeze node is inserted at the end of the declarative region which
544   --  contains N.
545
546   procedure Freeze_Subprogram_Body
547     (Inst_Node : Node_Id;
548      Gen_Body  : Node_Id;
549      Pack_Id   : Entity_Id);
550   --  The generic body may appear textually after the instance, including
551   --  in the proper body of a stub, or within a different package instance.
552   --  Given that the instance can only be elaborated after the generic, we
553   --  place freeze_nodes for the instance and/or for packages that may enclose
554   --  the instance and the generic, so that the back-end can establish the
555   --  proper order of elaboration.
556
557   procedure Init_Env;
558   --  Establish environment for subsequent instantiation. Separated from
559   --  Save_Env because data-structures for visibility handling must be
560   --  initialized before call to Check_Generic_Child_Unit.
561
562   procedure Install_Formal_Packages (Par : Entity_Id);
563   --  Install the visible part of any formal of the parent that is a formal
564   --  package. Note that for the case of a formal package with a box, this
565   --  includes the formal part of the formal package (12.7(10/2)).
566
567   procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
568   --  When compiling an instance of a child unit the parent (which is
569   --  itself an instance) is an enclosing scope that must be made
570   --  immediately visible. This procedure is also used to install the non-
571   --  generic parent of a generic child unit when compiling its body, so
572   --  that full views of types in the parent are made visible.
573
574   procedure Remove_Parent (In_Body : Boolean := False);
575   --  Reverse effect after instantiation of child is complete
576
577   procedure Install_Hidden_Primitives
578     (Prims_List : in out Elist_Id;
579      Gen_T      : Entity_Id;
580      Act_T      : Entity_Id);
581   --  Remove suffix 'P' from hidden primitives of Act_T to match the
582   --  visibility of primitives of Gen_T. The list of primitives to which
583   --  the suffix is removed is added to Prims_List to restore them later.
584
585   procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
586   --  Restore suffix 'P' to primitives of Prims_List and leave Prims_List
587   --  set to No_Elist.
588
589   procedure Inline_Instance_Body
590     (N        : Node_Id;
591      Gen_Unit : Entity_Id;
592      Act_Decl : Node_Id);
593   --  If front-end inlining is requested, instantiate the package body,
594   --  and preserve the visibility of its compilation unit, to insure
595   --  that successive instantiations succeed.
596
597   --  The functions Instantiate_XXX perform various legality checks and build
598   --  the declarations for instantiated generic parameters. In all of these
599   --  Formal is the entity in the generic unit, Actual is the entity of
600   --  expression in the generic associations, and Analyzed_Formal is the
601   --  formal in the generic copy, which contains the semantic information to
602   --  be used to validate the actual.
603
604   function Instantiate_Object
605     (Formal          : Node_Id;
606      Actual          : Node_Id;
607      Analyzed_Formal : Node_Id) return List_Id;
608
609   function Instantiate_Type
610     (Formal          : Node_Id;
611      Actual          : Node_Id;
612      Analyzed_Formal : Node_Id;
613      Actual_Decls    : List_Id) return List_Id;
614
615   function Instantiate_Formal_Subprogram
616     (Formal          : Node_Id;
617      Actual          : Node_Id;
618      Analyzed_Formal : Node_Id) return Node_Id;
619
620   function Instantiate_Formal_Package
621     (Formal          : Node_Id;
622      Actual          : Node_Id;
623      Analyzed_Formal : Node_Id) return List_Id;
624   --  If the formal package is declared with a box, special visibility rules
625   --  apply to its formals: they are in the visible part of the package. This
626   --  is true in the declarative region of the formal package, that is to say
627   --  in the enclosing generic or instantiation. For an instantiation, the
628   --  parameters of the formal package are made visible in an explicit step.
629   --  Furthermore, if the actual has a visible USE clause, these formals must
630   --  be made potentially use-visible as well. On exit from the enclosing
631   --  instantiation, the reverse must be done.
632
633   --  For a formal package declared without a box, there are conformance rules
634   --  that apply to the actuals in the generic declaration and the actuals of
635   --  the actual package in the enclosing instantiation. The simplest way to
636   --  apply these rules is to repeat the instantiation of the formal package
637   --  in the context of the enclosing instance, and compare the generic
638   --  associations of this instantiation with those of the actual package.
639   --  This internal instantiation only needs to contain the renamings of the
640   --  formals: the visible and private declarations themselves need not be
641   --  created.
642
643   --  In Ada 2005, the formal package may be only partially parameterized.
644   --  In that case the visibility step must make visible those actuals whose
645   --  corresponding formals were given with a box. A final complication
646   --  involves inherited operations from formal derived types, which must
647   --  be visible if the type is.
648
649   function Is_In_Main_Unit (N : Node_Id) return Boolean;
650   --  Test if given node is in the main unit
651
652   procedure Load_Parent_Of_Generic
653     (N             : Node_Id;
654      Spec          : Node_Id;
655      Body_Optional : Boolean := False);
656   --  If the generic appears in a separate non-generic library unit, load the
657   --  corresponding body to retrieve the body of the generic. N is the node
658   --  for the generic instantiation, Spec is the generic package declaration.
659   --
660   --  Body_Optional is a flag that indicates that the body is being loaded to
661   --  ensure that temporaries are generated consistently when there are other
662   --  instances in the current declarative part that precede the one being
663   --  loaded. In that case a missing body is acceptable.
664
665   procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
666   --  Add the context clause of the unit containing a generic unit to a
667   --  compilation unit that is, or contains, an instantiation.
668
669   function Get_Associated_Node (N : Node_Id) return Node_Id;
670   --  In order to propagate semantic information back from the analyzed copy
671   --  to the original generic, we maintain links between selected nodes in the
672   --  generic and their corresponding copies. At the end of generic analysis,
673   --  the routine Save_Global_References traverses the generic tree, examines
674   --  the semantic information, and preserves the links to those nodes that
675   --  contain global information. At instantiation, the information from the
676   --  associated node is placed on the new copy, so that name resolution is
677   --  not repeated.
678   --
679   --  Three kinds of source nodes have associated nodes:
680   --
681   --    a) those that can reference (denote) entities, that is identifiers,
682   --       character literals, expanded_names, operator symbols, operators,
683   --       and attribute reference nodes. These nodes have an Entity field
684   --       and are the set of nodes that are in N_Has_Entity.
685   --
686   --    b) aggregates (N_Aggregate and N_Extension_Aggregate)
687   --
688   --    c) selected components (N_Selected_Component)
689   --
690   --  For the first class, the associated node preserves the entity if it is
691   --  global. If the generic contains nested instantiations, the associated
692   --  node itself has been recopied, and a chain of them must be followed.
693   --
694   --  For aggregates, the associated node allows retrieval of the type, which
695   --  may otherwise not appear in the generic. The view of this type may be
696   --  different between generic and instantiation, and the full view can be
697   --  installed before the instantiation is analyzed. For aggregates of type
698   --  extensions, the same view exchange may have to be performed for some of
699   --  the ancestor types, if their view is private at the point of
700   --  instantiation.
701   --
702   --  Nodes that are selected components in the parse tree may be rewritten
703   --  as expanded names after resolution, and must be treated as potential
704   --  entity holders, which is why they also have an Associated_Node.
705   --
706   --  Nodes that do not come from source, such as freeze nodes, do not appear
707   --  in the generic tree, and need not have an associated node.
708   --
709   --  The associated node is stored in the Associated_Node field. Note that
710   --  this field overlaps Entity, which is fine, because the whole point is
711   --  that we don't need or want the normal Entity field in this situation.
712
713   procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
714   --  Within the generic part, entities in the formal package are
715   --  visible. To validate subsequent type declarations, indicate
716   --  the correspondence between the entities in the analyzed formal,
717   --  and the entities in  the actual package. There are three packages
718   --  involved in the instantiation of a formal package: the parent
719   --  generic P1 which appears in the generic declaration, the fake
720   --  instantiation P2 which appears in the analyzed generic, and whose
721   --  visible entities may be used in subsequent formals, and the actual
722   --  P3 in the instance. To validate subsequent formals, me indicate
723   --  that the entities in P2 are mapped into those of P3. The mapping of
724   --  entities has to be done recursively for nested packages.
725
726   procedure Move_Freeze_Nodes
727     (Out_Of : Entity_Id;
728      After  : Node_Id;
729      L      : List_Id);
730   --  Freeze nodes can be generated in the analysis of a generic unit, but
731   --  will not be seen by the back-end. It is necessary to move those nodes
732   --  to the enclosing scope if they freeze an outer entity. We place them
733   --  at the end of the enclosing generic package, which is semantically
734   --  neutral.
735
736   procedure Preanalyze_Actuals (N : Node_Id);
737   --  Analyze actuals to perform name resolution. Full resolution is done
738   --  later, when the expected types are known, but names have to be captured
739   --  before installing parents of generics, that are not visible for the
740   --  actuals themselves.
741
742   function True_Parent (N : Node_Id) return Node_Id;
743   --  For a subunit, return parent of corresponding stub, else return
744   --  parent of node.
745
746   procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
747   --  Verify that an attribute that appears as the default for a formal
748   --  subprogram is a function or procedure with the correct profile.
749
750   -------------------------------------------
751   -- Data Structures for Generic Renamings --
752   -------------------------------------------
753
754   --  The map Generic_Renamings associates generic entities with their
755   --  corresponding actuals. Currently used to validate type instances. It
756   --  will eventually be used for all generic parameters to eliminate the
757   --  need for overload resolution in the instance.
758
759   type Assoc_Ptr is new Int;
760
761   Assoc_Null : constant Assoc_Ptr := -1;
762
763   type Assoc is record
764      Gen_Id         : Entity_Id;
765      Act_Id         : Entity_Id;
766      Next_In_HTable : Assoc_Ptr;
767   end record;
768
769   package Generic_Renamings is new Table.Table
770     (Table_Component_Type => Assoc,
771      Table_Index_Type     => Assoc_Ptr,
772      Table_Low_Bound      => 0,
773      Table_Initial        => 10,
774      Table_Increment      => 100,
775      Table_Name           => "Generic_Renamings");
776
777   --  Variable to hold enclosing instantiation. When the environment is
778   --  saved for a subprogram inlining, the corresponding Act_Id is empty.
779
780   Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
781
782   --  Hash table for associations
783
784   HTable_Size : constant := 37;
785   type HTable_Range is range 0 .. HTable_Size - 1;
786
787   procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
788   function  Next_Assoc     (E : Assoc_Ptr) return Assoc_Ptr;
789   function Get_Gen_Id      (E : Assoc_Ptr) return Entity_Id;
790   function Hash            (F : Entity_Id) return HTable_Range;
791
792   package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
793      Header_Num => HTable_Range,
794      Element    => Assoc,
795      Elmt_Ptr   => Assoc_Ptr,
796      Null_Ptr   => Assoc_Null,
797      Set_Next   => Set_Next_Assoc,
798      Next       => Next_Assoc,
799      Key        => Entity_Id,
800      Get_Key    => Get_Gen_Id,
801      Hash       => Hash,
802      Equal      => "=");
803
804   Exchanged_Views : Elist_Id;
805   --  This list holds the private views that have been exchanged during
806   --  instantiation to restore the visibility of the generic declaration.
807   --  (see comments above). After instantiation, the current visibility is
808   --  reestablished by means of a traversal of this list.
809
810   Hidden_Entities : Elist_Id;
811   --  This list holds the entities of the current scope that are removed
812   --  from immediate visibility when instantiating a child unit. Their
813   --  visibility is restored in Remove_Parent.
814
815   --  Because instantiations can be recursive, the following must be saved
816   --  on entry and restored on exit from an instantiation (spec or body).
817   --  This is done by the two procedures Save_Env and Restore_Env. For
818   --  package and subprogram instantiations (but not for the body instances)
819   --  the action of Save_Env is done in two steps: Init_Env is called before
820   --  Check_Generic_Child_Unit, because setting the parent instances requires
821   --  that the visibility data structures be properly initialized. Once the
822   --  generic is unit is validated, Set_Instance_Env completes Save_Env.
823
824   Parent_Unit_Visible : Boolean := False;
825   --  Parent_Unit_Visible is used when the generic is a child unit, and
826   --  indicates whether the ultimate parent of the generic is visible in the
827   --  instantiation environment. It is used to reset the visibility of the
828   --  parent at the end of the instantiation (see Remove_Parent).
829
830   Instance_Parent_Unit : Entity_Id := Empty;
831   --  This records the ultimate parent unit of an instance of a generic
832   --  child unit and is used in conjunction with Parent_Unit_Visible to
833   --  indicate the unit to which the Parent_Unit_Visible flag corresponds.
834
835   type Instance_Env is record
836      Instantiated_Parent  : Assoc;
837      Exchanged_Views      : Elist_Id;
838      Hidden_Entities      : Elist_Id;
839      Current_Sem_Unit     : Unit_Number_Type;
840      Parent_Unit_Visible  : Boolean   := False;
841      Instance_Parent_Unit : Entity_Id := Empty;
842      Switches             : Config_Switches_Type;
843   end record;
844
845   package Instance_Envs is new Table.Table (
846     Table_Component_Type => Instance_Env,
847     Table_Index_Type     => Int,
848     Table_Low_Bound      => 0,
849     Table_Initial        => 32,
850     Table_Increment      => 100,
851     Table_Name           => "Instance_Envs");
852
853   procedure Restore_Private_Views
854     (Pack_Id    : Entity_Id;
855      Is_Package : Boolean := True);
856   --  Restore the private views of external types, and unmark the generic
857   --  renamings of actuals, so that they become compatible subtypes again.
858   --  For subprograms, Pack_Id is the package constructed to hold the
859   --  renamings.
860
861   procedure Switch_View (T : Entity_Id);
862   --  Switch the partial and full views of a type and its private
863   --  dependents (i.e. its subtypes and derived types).
864
865   ------------------------------------
866   -- Structures for Error Reporting --
867   ------------------------------------
868
869   Instantiation_Node : Node_Id;
870   --  Used by subprograms that validate instantiation of formal parameters
871   --  where there might be no actual on which to place the error message.
872   --  Also used to locate the instantiation node for generic subunits.
873
874   Instantiation_Error : exception;
875   --  When there is a semantic error in the generic parameter matching,
876   --  there is no point in continuing the instantiation, because the
877   --  number of cascaded errors is unpredictable. This exception aborts
878   --  the instantiation process altogether.
879
880   S_Adjustment : Sloc_Adjustment;
881   --  Offset created for each node in an instantiation, in order to keep
882   --  track of the source position of the instantiation in each of its nodes.
883   --  A subsequent semantic error or warning on a construct of the instance
884   --  points to both places: the original generic node, and the point of
885   --  instantiation. See Sinput and Sinput.L for additional details.
886
887   ------------------------------------------------------------
888   -- Data structure for keeping track when inside a Generic --
889   ------------------------------------------------------------
890
891   --  The following table is used to save values of the Inside_A_Generic
892   --  flag (see spec of Sem) when they are saved by Start_Generic.
893
894   package Generic_Flags is new Table.Table (
895     Table_Component_Type => Boolean,
896     Table_Index_Type     => Int,
897     Table_Low_Bound      => 0,
898     Table_Initial        => 32,
899     Table_Increment      => 200,
900     Table_Name           => "Generic_Flags");
901
902   ---------------------------
903   -- Abandon_Instantiation --
904   ---------------------------
905
906   procedure Abandon_Instantiation (N : Node_Id) is
907   begin
908      Error_Msg_N ("\instantiation abandoned!", N);
909      raise Instantiation_Error;
910   end Abandon_Instantiation;
911
912   --------------------------
913   -- Analyze_Associations --
914   --------------------------
915
916   function Analyze_Associations
917     (I_Node  : Node_Id;
918      Formals : List_Id;
919      F_Copy  : List_Id) return List_Id
920   is
921      Actuals_To_Freeze : constant Elist_Id  := New_Elmt_List;
922      Assoc             : constant List_Id   := New_List;
923      Default_Actuals   : constant List_Id   := New_List;
924      Gen_Unit          : constant Entity_Id :=
925                            Defining_Entity (Parent (F_Copy));
926
927      Actuals         : List_Id;
928      Actual          : Node_Id;
929      Analyzed_Formal : Node_Id;
930      First_Named     : Node_Id := Empty;
931      Formal          : Node_Id;
932      Match           : Node_Id;
933      Named           : Node_Id;
934      Saved_Formal    : Node_Id;
935
936      Default_Formals : constant List_Id := New_List;
937      --  If an Others_Choice is present, some of the formals may be defaulted.
938      --  To simplify the treatment of visibility in an instance, we introduce
939      --  individual defaults for each such formal. These defaults are
940      --  appended to the list of associations and replace the Others_Choice.
941
942      Found_Assoc : Node_Id;
943      --  Association for the current formal being match. Empty if there are
944      --  no remaining actuals, or if there is no named association with the
945      --  name of the formal.
946
947      Is_Named_Assoc : Boolean;
948      Num_Matched    : Int := 0;
949      Num_Actuals    : Int := 0;
950
951      Others_Present : Boolean := False;
952      Others_Choice  : Node_Id := Empty;
953      --  In Ada 2005, indicates partial parameterization of a formal
954      --  package. As usual an other association must be last in the list.
955
956      procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
957      --  Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
958      --  cannot have a named association for it. AI05-0025 extends this rule
959      --  to formals of formal packages by AI05-0025, and it also applies to
960      --  box-initialized formals.
961
962      function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
963      --  Determine whether the parameter types and the return type of Subp
964      --  are fully defined at the point of instantiation.
965
966      function Matching_Actual
967        (F   : Entity_Id;
968         A_F : Entity_Id) return Node_Id;
969      --  Find actual that corresponds to a given a formal parameter. If the
970      --  actuals are positional, return the next one, if any. If the actuals
971      --  are named, scan the parameter associations to find the right one.
972      --  A_F is the corresponding entity in the analyzed generic,which is
973      --  placed on the selector name for ASIS use.
974      --
975      --  In Ada 2005, a named association may be given with a box, in which
976      --  case Matching_Actual sets Found_Assoc to the generic association,
977      --  but return Empty for the actual itself. In this case the code below
978      --  creates a corresponding declaration for the formal.
979
980      function Partial_Parameterization return Boolean;
981      --  Ada 2005: if no match is found for a given formal, check if the
982      --  association for it includes a box, or whether the associations
983      --  include an Others clause.
984
985      procedure Process_Default (F : Entity_Id);
986      --  Add a copy of the declaration of generic formal  F to the list of
987      --  associations, and add an explicit box association for F  if there
988      --  is none yet, and the default comes from an Others_Choice.
989
990      function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
991      --  Determine whether Subp renames one of the subprograms defined in the
992      --  generated package Standard.
993
994      procedure Set_Analyzed_Formal;
995      --  Find the node in the generic copy that corresponds to a given formal.
996      --  The semantic information on this node is used to perform legality
997      --  checks on the actuals. Because semantic analysis can introduce some
998      --  anonymous entities or modify the declaration node itself, the
999      --  correspondence between the two lists is not one-one. In addition to
1000      --  anonymous types, the presence a formal equality will introduce an
1001      --  implicit declaration for the corresponding inequality.
1002
1003      ----------------------------------------
1004      -- Check_Overloaded_Formal_Subprogram --
1005      ----------------------------------------
1006
1007      procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1008         Temp_Formal : Entity_Id;
1009
1010      begin
1011         Temp_Formal := First (Formals);
1012         while Present (Temp_Formal) loop
1013            if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1014              and then Temp_Formal /= Formal
1015              and then
1016                Chars (Defining_Unit_Name (Specification (Formal))) =
1017                Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1018            then
1019               if Present (Found_Assoc) then
1020                  Error_Msg_N
1021                    ("named association not allowed for overloaded formal",
1022                     Found_Assoc);
1023
1024               else
1025                  Error_Msg_N
1026                    ("named association not allowed for overloaded formal",
1027                     Others_Choice);
1028               end if;
1029
1030               Abandon_Instantiation (Instantiation_Node);
1031            end if;
1032
1033            Next (Temp_Formal);
1034         end loop;
1035      end Check_Overloaded_Formal_Subprogram;
1036
1037      -------------------------------
1038      -- Has_Fully_Defined_Profile --
1039      -------------------------------
1040
1041      function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1042         function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1043         --  Determine whethet type Typ is fully defined
1044
1045         ---------------------------
1046         -- Is_Fully_Defined_Type --
1047         ---------------------------
1048
1049         function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1050         begin
1051            --  A private type without a full view is not fully defined
1052
1053            if Is_Private_Type (Typ)
1054              and then No (Full_View (Typ))
1055            then
1056               return False;
1057
1058            --  An incomplete type is never fully defined
1059
1060            elsif Is_Incomplete_Type (Typ) then
1061               return False;
1062
1063            --  All other types are fully defined
1064
1065            else
1066               return True;
1067            end if;
1068         end Is_Fully_Defined_Type;
1069
1070         --  Local declarations
1071
1072         Param : Entity_Id;
1073
1074      --  Start of processing for Has_Fully_Defined_Profile
1075
1076      begin
1077         --  Check the parameters
1078
1079         Param := First_Formal (Subp);
1080         while Present (Param) loop
1081            if not Is_Fully_Defined_Type (Etype (Param)) then
1082               return False;
1083            end if;
1084
1085            Next_Formal (Param);
1086         end loop;
1087
1088         --  Check the return type
1089
1090         return Is_Fully_Defined_Type (Etype (Subp));
1091      end Has_Fully_Defined_Profile;
1092
1093      ---------------------
1094      -- Matching_Actual --
1095      ---------------------
1096
1097      function Matching_Actual
1098        (F   : Entity_Id;
1099         A_F : Entity_Id) return Node_Id
1100      is
1101         Prev  : Node_Id;
1102         Act   : Node_Id;
1103
1104      begin
1105         Is_Named_Assoc := False;
1106
1107         --  End of list of purely positional parameters
1108
1109         if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1110            Found_Assoc := Empty;
1111            Act         := Empty;
1112
1113         --  Case of positional parameter corresponding to current formal
1114
1115         elsif No (Selector_Name (Actual)) then
1116            Found_Assoc := Actual;
1117            Act :=  Explicit_Generic_Actual_Parameter (Actual);
1118            Num_Matched := Num_Matched + 1;
1119            Next (Actual);
1120
1121         --  Otherwise scan list of named actuals to find the one with the
1122         --  desired name. All remaining actuals have explicit names.
1123
1124         else
1125            Is_Named_Assoc := True;
1126            Found_Assoc := Empty;
1127            Act         := Empty;
1128            Prev        := Empty;
1129
1130            while Present (Actual) loop
1131               if Chars (Selector_Name (Actual)) = Chars (F) then
1132                  Set_Entity (Selector_Name (Actual), A_F);
1133                  Set_Etype  (Selector_Name (Actual), Etype (A_F));
1134                  Generate_Reference (A_F, Selector_Name (Actual));
1135                  Found_Assoc := Actual;
1136                  Act :=  Explicit_Generic_Actual_Parameter (Actual);
1137                  Num_Matched := Num_Matched + 1;
1138                  exit;
1139               end if;
1140
1141               Prev := Actual;
1142               Next (Actual);
1143            end loop;
1144
1145            --  Reset for subsequent searches. In most cases the named
1146            --  associations are in order. If they are not, we reorder them
1147            --  to avoid scanning twice the same actual. This is not just a
1148            --  question of efficiency: there may be multiple defaults with
1149            --  boxes that have the same name. In a nested instantiation we
1150            --  insert actuals for those defaults, and cannot rely on their
1151            --  names to disambiguate them.
1152
1153            if Actual = First_Named  then
1154               Next (First_Named);
1155
1156            elsif Present (Actual) then
1157               Insert_Before (First_Named, Remove_Next (Prev));
1158            end if;
1159
1160            Actual := First_Named;
1161         end if;
1162
1163         if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1164            Set_Used_As_Generic_Actual (Entity (Act));
1165         end if;
1166
1167         return Act;
1168      end Matching_Actual;
1169
1170      ------------------------------
1171      -- Partial_Parameterization --
1172      ------------------------------
1173
1174      function Partial_Parameterization return Boolean is
1175      begin
1176         return Others_Present
1177          or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1178      end Partial_Parameterization;
1179
1180      ---------------------
1181      -- Process_Default --
1182      ---------------------
1183
1184      procedure Process_Default (F : Entity_Id)  is
1185         Loc     : constant Source_Ptr := Sloc (I_Node);
1186         F_Id    : constant Entity_Id  := Defining_Entity (F);
1187         Decl    : Node_Id;
1188         Default : Node_Id;
1189         Id      : Entity_Id;
1190
1191      begin
1192         --  Append copy of formal declaration to associations, and create new
1193         --  defining identifier for it.
1194
1195         Decl := New_Copy_Tree (F);
1196         Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1197
1198         if Nkind (F) in N_Formal_Subprogram_Declaration then
1199            Set_Defining_Unit_Name (Specification (Decl), Id);
1200
1201         else
1202            Set_Defining_Identifier (Decl, Id);
1203         end if;
1204
1205         Append (Decl, Assoc);
1206
1207         if No (Found_Assoc) then
1208            Default :=
1209               Make_Generic_Association (Loc,
1210                 Selector_Name                     =>
1211                   New_Occurrence_Of (Id, Loc),
1212                 Explicit_Generic_Actual_Parameter => Empty);
1213            Set_Box_Present (Default);
1214            Append (Default, Default_Formals);
1215         end if;
1216      end Process_Default;
1217
1218      ---------------------------------
1219      -- Renames_Standard_Subprogram --
1220      ---------------------------------
1221
1222      function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1223         Id : Entity_Id;
1224
1225      begin
1226         Id := Alias (Subp);
1227         while Present (Id) loop
1228            if Scope (Id) = Standard_Standard then
1229               return True;
1230            end if;
1231
1232            Id := Alias (Id);
1233         end loop;
1234
1235         return False;
1236      end Renames_Standard_Subprogram;
1237
1238      -------------------------
1239      -- Set_Analyzed_Formal --
1240      -------------------------
1241
1242      procedure Set_Analyzed_Formal is
1243         Kind : Node_Kind;
1244
1245      begin
1246         while Present (Analyzed_Formal) loop
1247            Kind := Nkind (Analyzed_Formal);
1248
1249            case Nkind (Formal) is
1250
1251               when N_Formal_Subprogram_Declaration =>
1252                  exit when Kind in N_Formal_Subprogram_Declaration
1253                    and then
1254                      Chars
1255                        (Defining_Unit_Name (Specification (Formal))) =
1256                      Chars
1257                        (Defining_Unit_Name (Specification (Analyzed_Formal)));
1258
1259               when N_Formal_Package_Declaration =>
1260                  exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1261                                            N_Generic_Package_Declaration,
1262                                            N_Package_Declaration);
1263
1264               when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1265
1266               when others =>
1267
1268                  --  Skip freeze nodes, and nodes inserted to replace
1269                  --  unrecognized pragmas.
1270
1271                  exit when
1272                    Kind not in N_Formal_Subprogram_Declaration
1273                      and then not Nkind_In (Kind, N_Subprogram_Declaration,
1274                                                   N_Freeze_Entity,
1275                                                   N_Null_Statement,
1276                                                   N_Itype_Reference)
1277                      and then Chars (Defining_Identifier (Formal)) =
1278                               Chars (Defining_Identifier (Analyzed_Formal));
1279            end case;
1280
1281            Next (Analyzed_Formal);
1282         end loop;
1283      end Set_Analyzed_Formal;
1284
1285   --  Start of processing for Analyze_Associations
1286
1287   begin
1288      Actuals := Generic_Associations (I_Node);
1289
1290      if Present (Actuals) then
1291
1292         --  Check for an Others choice, indicating a partial parameterization
1293         --  for a formal package.
1294
1295         Actual := First (Actuals);
1296         while Present (Actual) loop
1297            if Nkind (Actual) = N_Others_Choice then
1298               Others_Present := True;
1299               Others_Choice  := Actual;
1300
1301               if Present (Next (Actual)) then
1302                  Error_Msg_N ("others must be last association", Actual);
1303               end if;
1304
1305               --  This subprogram is used both for formal packages and for
1306               --  instantiations. For the latter, associations must all be
1307               --  explicit.
1308
1309               if Nkind (I_Node) /= N_Formal_Package_Declaration
1310                 and then Comes_From_Source (I_Node)
1311               then
1312                  Error_Msg_N
1313                    ("others association not allowed in an instance",
1314                      Actual);
1315               end if;
1316
1317               --  In any case, nothing to do after the others association
1318
1319               exit;
1320
1321            elsif Box_Present (Actual)
1322              and then Comes_From_Source (I_Node)
1323              and then Nkind (I_Node) /= N_Formal_Package_Declaration
1324            then
1325               Error_Msg_N
1326                 ("box association not allowed in an instance", Actual);
1327            end if;
1328
1329            Next (Actual);
1330         end loop;
1331
1332         --  If named associations are present, save first named association
1333         --  (it may of course be Empty) to facilitate subsequent name search.
1334
1335         First_Named := First (Actuals);
1336         while Present (First_Named)
1337           and then Nkind (First_Named) /= N_Others_Choice
1338           and then No (Selector_Name (First_Named))
1339         loop
1340            Num_Actuals := Num_Actuals + 1;
1341            Next (First_Named);
1342         end loop;
1343      end if;
1344
1345      Named := First_Named;
1346      while Present (Named) loop
1347         if Nkind (Named) /= N_Others_Choice
1348           and then No (Selector_Name (Named))
1349         then
1350            Error_Msg_N ("invalid positional actual after named one", Named);
1351            Abandon_Instantiation (Named);
1352         end if;
1353
1354         --  A named association may lack an actual parameter, if it was
1355         --  introduced for a default subprogram that turns out to be local
1356         --  to the outer instantiation.
1357
1358         if Nkind (Named) /= N_Others_Choice
1359           and then Present (Explicit_Generic_Actual_Parameter (Named))
1360         then
1361            Num_Actuals := Num_Actuals + 1;
1362         end if;
1363
1364         Next (Named);
1365      end loop;
1366
1367      if Present (Formals) then
1368         Formal := First_Non_Pragma (Formals);
1369         Analyzed_Formal := First_Non_Pragma (F_Copy);
1370
1371         if Present (Actuals) then
1372            Actual := First (Actuals);
1373
1374         --  All formals should have default values
1375
1376         else
1377            Actual := Empty;
1378         end if;
1379
1380         while Present (Formal) loop
1381            Set_Analyzed_Formal;
1382            Saved_Formal := Next_Non_Pragma (Formal);
1383
1384            case Nkind (Formal) is
1385               when N_Formal_Object_Declaration =>
1386                  Match :=
1387                    Matching_Actual
1388                      (Defining_Identifier (Formal),
1389                       Defining_Identifier (Analyzed_Formal));
1390
1391                  if No (Match) and then Partial_Parameterization then
1392                     Process_Default (Formal);
1393
1394                  else
1395                     Append_List
1396                       (Instantiate_Object (Formal, Match, Analyzed_Formal),
1397                        Assoc);
1398
1399                     --  For a defaulted in_parameter, create an entry in the
1400                     --  the list of defaulted actuals, for GNATProve use. Do
1401                     --  not included these defaults for an instance nested
1402                     --  within a generic, because the defaults are also used
1403                     --  in the analysis of the enclosing generic, and only
1404                     --  defaulted subprograms are relevant there.
1405
1406                     if No (Match) and then not Inside_A_Generic then
1407                        Append_To (Default_Actuals,
1408                          Make_Generic_Association (Sloc (I_Node),
1409                            Selector_Name                     =>
1410                              New_Occurrence_Of
1411                                (Defining_Identifier (Formal), Sloc (I_Node)),
1412                            Explicit_Generic_Actual_Parameter =>
1413                              New_Copy_Tree (Default_Expression (Formal))));
1414                     end if;
1415                  end if;
1416
1417                  --  If the object is a call to an expression function, this
1418                  --  is a freezing point for it.
1419
1420                  if Is_Entity_Name (Match)
1421                    and then Present (Entity (Match))
1422                    and then Nkind
1423                      (Original_Node (Unit_Declaration_Node (Entity (Match))))
1424                                                     = N_Expression_Function
1425                  then
1426                     Append_Elmt (Entity (Match), Actuals_To_Freeze);
1427                  end if;
1428
1429               when N_Formal_Type_Declaration =>
1430                  Match :=
1431                    Matching_Actual
1432                      (Defining_Identifier (Formal),
1433                       Defining_Identifier (Analyzed_Formal));
1434
1435                  if No (Match) then
1436                     if Partial_Parameterization then
1437                        Process_Default (Formal);
1438
1439                     else
1440                        Error_Msg_Sloc := Sloc (Gen_Unit);
1441                        Error_Msg_NE
1442                          ("missing actual&",
1443                           Instantiation_Node, Defining_Identifier (Formal));
1444                        Error_Msg_NE
1445                          ("\in instantiation of & declared#",
1446                           Instantiation_Node, Gen_Unit);
1447                        Abandon_Instantiation (Instantiation_Node);
1448                     end if;
1449
1450                  else
1451                     Analyze (Match);
1452                     Append_List
1453                       (Instantiate_Type
1454                          (Formal, Match, Analyzed_Formal, Assoc),
1455                        Assoc);
1456
1457                     --  An instantiation is a freeze point for the actuals,
1458                     --  unless this is a rewritten formal package, or the
1459                     --  formal is an Ada 2012 formal incomplete type.
1460
1461                     if Nkind (I_Node) = N_Formal_Package_Declaration
1462                       or else
1463                         (Ada_Version >= Ada_2012
1464                           and then
1465                             Ekind (Defining_Identifier (Analyzed_Formal)) =
1466                                                            E_Incomplete_Type)
1467                     then
1468                        null;
1469
1470                     else
1471                        Append_Elmt (Entity (Match), Actuals_To_Freeze);
1472                     end if;
1473                  end if;
1474
1475                  --  A remote access-to-class-wide type is not a legal actual
1476                  --  for a generic formal of an access type (E.2.2(17/2)).
1477                  --  In GNAT an exception to this rule is introduced when
1478                  --  the formal is marked as remote using implementation
1479                  --  defined aspect/pragma Remote_Access_Type. In that case
1480                  --  the actual must be remote as well.
1481
1482                  --  If the current instantiation is the construction of a
1483                  --  local copy for a formal package the actuals may be
1484                  --  defaulted, and there is no matching actual to check.
1485
1486                  if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1487                    and then
1488                      Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1489                                            N_Access_To_Object_Definition
1490                     and then Present (Match)
1491                  then
1492                     declare
1493                        Formal_Ent : constant Entity_Id :=
1494                                       Defining_Identifier (Analyzed_Formal);
1495                     begin
1496                        if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1497                                                = Is_Remote_Types (Formal_Ent)
1498                        then
1499                           --  Remoteness of formal and actual match
1500
1501                           null;
1502
1503                        elsif Is_Remote_Types (Formal_Ent) then
1504
1505                           --  Remote formal, non-remote actual
1506
1507                           Error_Msg_NE
1508                             ("actual for& must be remote", Match, Formal_Ent);
1509
1510                        else
1511                           --  Non-remote formal, remote actual
1512
1513                           Error_Msg_NE
1514                             ("actual for& may not be remote",
1515                              Match, Formal_Ent);
1516                        end if;
1517                     end;
1518                  end if;
1519
1520               when N_Formal_Subprogram_Declaration =>
1521                  Match :=
1522                    Matching_Actual
1523                      (Defining_Unit_Name (Specification (Formal)),
1524                       Defining_Unit_Name (Specification (Analyzed_Formal)));
1525
1526                  --  If the formal subprogram has the same name as another
1527                  --  formal subprogram of the generic, then a named
1528                  --  association is illegal (12.3(9)). Exclude named
1529                  --  associations that are generated for a nested instance.
1530
1531                  if Present (Match)
1532                    and then Is_Named_Assoc
1533                    and then Comes_From_Source (Found_Assoc)
1534                  then
1535                     Check_Overloaded_Formal_Subprogram (Formal);
1536                  end if;
1537
1538                  --  If there is no corresponding actual, this may be case
1539                  --  of partial parameterization, or else the formal has a
1540                  --  default or a box.
1541
1542                  if No (Match) and then Partial_Parameterization then
1543                     Process_Default (Formal);
1544
1545                     if Nkind (I_Node) = N_Formal_Package_Declaration then
1546                        Check_Overloaded_Formal_Subprogram (Formal);
1547                     end if;
1548
1549                  else
1550                     Append_To (Assoc,
1551                       Instantiate_Formal_Subprogram
1552                         (Formal, Match, Analyzed_Formal));
1553
1554                     --  An instantiation is a freeze point for the actuals,
1555                     --  unless this is a rewritten formal package.
1556
1557                     if Nkind (I_Node) /= N_Formal_Package_Declaration
1558                       and then Nkind (Match) = N_Identifier
1559                       and then Is_Subprogram (Entity (Match))
1560
1561                       --  The actual subprogram may rename a routine defined
1562                       --  in Standard. Avoid freezing such renamings because
1563                       --  subprograms coming from Standard cannot be frozen.
1564
1565                       and then
1566                         not Renames_Standard_Subprogram (Entity (Match))
1567
1568                       --  If the actual subprogram comes from a different
1569                       --  unit, it is already frozen, either by a body in
1570                       --  that unit or by the end of the declarative part
1571                       --  of the unit. This check avoids the freezing of
1572                       --  subprograms defined in Standard which are used
1573                       --  as generic actuals.
1574
1575                       and then In_Same_Code_Unit (Entity (Match), I_Node)
1576                       and then Has_Fully_Defined_Profile (Entity (Match))
1577                     then
1578                        --  Mark the subprogram as having a delayed freeze
1579                        --  since this may be an out-of-order action.
1580
1581                        Set_Has_Delayed_Freeze (Entity (Match));
1582                        Append_Elmt (Entity (Match), Actuals_To_Freeze);
1583                     end if;
1584                  end if;
1585
1586                  --  If this is a nested generic, preserve default for later
1587                  --  instantiations. We do this as well for GNATProve use,
1588                  --  so that the list of generic associations is complete.
1589
1590                  if No (Match) and then Box_Present (Formal) then
1591                     declare
1592                        Subp : constant Entity_Id :=
1593                          Defining_Unit_Name (Specification (Last (Assoc)));
1594
1595                     begin
1596                        Append_To (Default_Actuals,
1597                          Make_Generic_Association (Sloc (I_Node),
1598                            Selector_Name                     =>
1599                              New_Occurrence_Of (Subp, Sloc (I_Node)),
1600                            Explicit_Generic_Actual_Parameter =>
1601                              New_Occurrence_Of (Subp, Sloc (I_Node))));
1602                     end;
1603                  end if;
1604
1605               when N_Formal_Package_Declaration =>
1606                  Match :=
1607                    Matching_Actual
1608                      (Defining_Identifier (Formal),
1609                       Defining_Identifier (Original_Node (Analyzed_Formal)));
1610
1611                  if No (Match) then
1612                     if Partial_Parameterization then
1613                        Process_Default (Formal);
1614
1615                     else
1616                        Error_Msg_Sloc := Sloc (Gen_Unit);
1617                        Error_Msg_NE
1618                          ("missing actual&",
1619                           Instantiation_Node, Defining_Identifier (Formal));
1620                        Error_Msg_NE
1621                          ("\in instantiation of & declared#",
1622                           Instantiation_Node, Gen_Unit);
1623
1624                        Abandon_Instantiation (Instantiation_Node);
1625                     end if;
1626
1627                  else
1628                     Analyze (Match);
1629                     Append_List
1630                       (Instantiate_Formal_Package
1631                         (Formal, Match, Analyzed_Formal),
1632                        Assoc);
1633                  end if;
1634
1635               --  For use type and use package appearing in the generic part,
1636               --  we have already copied them, so we can just move them where
1637               --  they belong (we mustn't recopy them since this would mess up
1638               --  the Sloc values).
1639
1640               when N_Use_Package_Clause |
1641                    N_Use_Type_Clause    =>
1642                  if Nkind (Original_Node (I_Node)) =
1643                                     N_Formal_Package_Declaration
1644                  then
1645                     Append (New_Copy_Tree (Formal), Assoc);
1646                  else
1647                     Remove (Formal);
1648                     Append (Formal, Assoc);
1649                  end if;
1650
1651               when others =>
1652                  raise Program_Error;
1653
1654            end case;
1655
1656            Formal := Saved_Formal;
1657            Next_Non_Pragma (Analyzed_Formal);
1658         end loop;
1659
1660         if Num_Actuals > Num_Matched then
1661            Error_Msg_Sloc := Sloc (Gen_Unit);
1662
1663            if Present (Selector_Name (Actual)) then
1664               Error_Msg_NE
1665                 ("unmatched actual &", Actual, Selector_Name (Actual));
1666               Error_Msg_NE
1667                 ("\in instantiation of & declared#", Actual, Gen_Unit);
1668            else
1669               Error_Msg_NE
1670                 ("unmatched actual in instantiation of & declared#",
1671                  Actual, Gen_Unit);
1672            end if;
1673         end if;
1674
1675      elsif Present (Actuals) then
1676         Error_Msg_N
1677           ("too many actuals in generic instantiation", Instantiation_Node);
1678      end if;
1679
1680      --  An instantiation freezes all generic actuals. The only exceptions
1681      --  to this are incomplete types and subprograms which are not fully
1682      --  defined at the point of instantiation.
1683
1684      declare
1685         Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1686      begin
1687         while Present (Elmt) loop
1688            Freeze_Before (I_Node, Node (Elmt));
1689            Next_Elmt (Elmt);
1690         end loop;
1691      end;
1692
1693      --  If there are default subprograms, normalize the tree by adding
1694      --  explicit associations for them. This is required if the instance
1695      --  appears within a generic.
1696
1697      if not Is_Empty_List (Default_Actuals) then
1698         declare
1699            Default : Node_Id;
1700
1701         begin
1702            Default := First (Default_Actuals);
1703            while Present (Default) loop
1704               Mark_Rewrite_Insertion (Default);
1705               Next (Default);
1706            end loop;
1707
1708            if No (Actuals) then
1709               Set_Generic_Associations (I_Node, Default_Actuals);
1710            else
1711               Append_List_To (Actuals, Default_Actuals);
1712            end if;
1713         end;
1714      end if;
1715
1716      --  If this is a formal package, normalize the parameter list by adding
1717      --  explicit box associations for the formals that are covered by an
1718      --  Others_Choice.
1719
1720      if not Is_Empty_List (Default_Formals) then
1721         Append_List (Default_Formals, Formals);
1722      end if;
1723
1724      return Assoc;
1725   end Analyze_Associations;
1726
1727   -------------------------------
1728   -- Analyze_Formal_Array_Type --
1729   -------------------------------
1730
1731   procedure Analyze_Formal_Array_Type
1732     (T   : in out Entity_Id;
1733      Def : Node_Id)
1734   is
1735      DSS : Node_Id;
1736
1737   begin
1738      --  Treated like a non-generic array declaration, with additional
1739      --  semantic checks.
1740
1741      Enter_Name (T);
1742
1743      if Nkind (Def) = N_Constrained_Array_Definition then
1744         DSS := First (Discrete_Subtype_Definitions (Def));
1745         while Present (DSS) loop
1746            if Nkind_In (DSS, N_Subtype_Indication,
1747                              N_Range,
1748                              N_Attribute_Reference)
1749            then
1750               Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1751            end if;
1752
1753            Next (DSS);
1754         end loop;
1755      end if;
1756
1757      Array_Type_Declaration (T, Def);
1758      Set_Is_Generic_Type (Base_Type (T));
1759
1760      if Ekind (Component_Type (T)) = E_Incomplete_Type
1761        and then No (Full_View (Component_Type (T)))
1762      then
1763         Error_Msg_N ("premature usage of incomplete type", Def);
1764
1765      --  Check that range constraint is not allowed on the component type
1766      --  of a generic formal array type (AARM 12.5.3(3))
1767
1768      elsif Is_Internal (Component_Type (T))
1769        and then Present (Subtype_Indication (Component_Definition (Def)))
1770        and then Nkind (Original_Node
1771                         (Subtype_Indication (Component_Definition (Def)))) =
1772                                                         N_Subtype_Indication
1773      then
1774         Error_Msg_N
1775           ("in a formal, a subtype indication can only be "
1776            & "a subtype mark (RM 12.5.3(3))",
1777            Subtype_Indication (Component_Definition (Def)));
1778      end if;
1779
1780   end Analyze_Formal_Array_Type;
1781
1782   ---------------------------------------------
1783   -- Analyze_Formal_Decimal_Fixed_Point_Type --
1784   ---------------------------------------------
1785
1786   --  As for other generic types, we create a valid type representation with
1787   --  legal but arbitrary attributes, whose values are never considered
1788   --  static. For all scalar types we introduce an anonymous base type, with
1789   --  the same attributes. We choose the corresponding integer type to be
1790   --  Standard_Integer.
1791   --  Here and in other similar routines, the Sloc of the generated internal
1792   --  type must be the same as the sloc of the defining identifier of the
1793   --  formal type declaration, to provide proper source navigation.
1794
1795   procedure Analyze_Formal_Decimal_Fixed_Point_Type
1796     (T   : Entity_Id;
1797      Def : Node_Id)
1798   is
1799      Loc : constant Source_Ptr := Sloc (Def);
1800
1801      Base : constant Entity_Id :=
1802               New_Internal_Entity
1803                 (E_Decimal_Fixed_Point_Type,
1804                  Current_Scope,
1805                  Sloc (Defining_Identifier (Parent (Def))), 'G');
1806
1807      Int_Base  : constant Entity_Id := Standard_Integer;
1808      Delta_Val : constant Ureal := Ureal_1;
1809      Digs_Val  : constant Uint  := Uint_6;
1810
1811      function Make_Dummy_Bound return Node_Id;
1812      --  Return a properly typed universal real literal to use as a bound
1813
1814      ----------------------
1815      -- Make_Dummy_Bound --
1816      ----------------------
1817
1818      function Make_Dummy_Bound return Node_Id is
1819         Bound : constant Node_Id := Make_Real_Literal (Loc, Ureal_1);
1820      begin
1821         Set_Etype (Bound, Universal_Real);
1822         return Bound;
1823      end Make_Dummy_Bound;
1824
1825   --  Start of processing for Analyze_Formal_Decimal_Fixed_Point_Type
1826
1827   begin
1828      Enter_Name (T);
1829
1830      Set_Etype          (Base, Base);
1831      Set_Size_Info      (Base, Int_Base);
1832      Set_RM_Size        (Base, RM_Size (Int_Base));
1833      Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1834      Set_Digits_Value   (Base, Digs_Val);
1835      Set_Delta_Value    (Base, Delta_Val);
1836      Set_Small_Value    (Base, Delta_Val);
1837      Set_Scalar_Range   (Base,
1838        Make_Range (Loc,
1839          Low_Bound  => Make_Dummy_Bound,
1840          High_Bound => Make_Dummy_Bound));
1841
1842      Set_Is_Generic_Type (Base);
1843      Set_Parent          (Base, Parent (Def));
1844
1845      Set_Ekind          (T, E_Decimal_Fixed_Point_Subtype);
1846      Set_Etype          (T, Base);
1847      Set_Size_Info      (T, Int_Base);
1848      Set_RM_Size        (T, RM_Size (Int_Base));
1849      Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1850      Set_Digits_Value   (T, Digs_Val);
1851      Set_Delta_Value    (T, Delta_Val);
1852      Set_Small_Value    (T, Delta_Val);
1853      Set_Scalar_Range   (T, Scalar_Range (Base));
1854      Set_Is_Constrained (T);
1855
1856      Check_Restriction (No_Fixed_Point, Def);
1857   end Analyze_Formal_Decimal_Fixed_Point_Type;
1858
1859   -------------------------------------------
1860   -- Analyze_Formal_Derived_Interface_Type --
1861   -------------------------------------------
1862
1863   procedure Analyze_Formal_Derived_Interface_Type
1864     (N   : Node_Id;
1865      T   : Entity_Id;
1866      Def : Node_Id)
1867   is
1868      Loc   : constant Source_Ptr := Sloc (Def);
1869
1870   begin
1871      --  Rewrite as a type declaration of a derived type. This ensures that
1872      --  the interface list and primitive operations are properly captured.
1873
1874      Rewrite (N,
1875        Make_Full_Type_Declaration (Loc,
1876          Defining_Identifier => T,
1877          Type_Definition     => Def));
1878      Analyze (N);
1879      Set_Is_Generic_Type (T);
1880   end Analyze_Formal_Derived_Interface_Type;
1881
1882   ---------------------------------
1883   -- Analyze_Formal_Derived_Type --
1884   ---------------------------------
1885
1886   procedure Analyze_Formal_Derived_Type
1887     (N   : Node_Id;
1888      T   : Entity_Id;
1889      Def : Node_Id)
1890   is
1891      Loc      : constant Source_Ptr := Sloc (Def);
1892      Unk_Disc : constant Boolean    := Unknown_Discriminants_Present (N);
1893      New_N    : Node_Id;
1894
1895   begin
1896      Set_Is_Generic_Type (T);
1897
1898      if Private_Present (Def) then
1899         New_N :=
1900           Make_Private_Extension_Declaration (Loc,
1901             Defining_Identifier           => T,
1902             Discriminant_Specifications   => Discriminant_Specifications (N),
1903             Unknown_Discriminants_Present => Unk_Disc,
1904             Subtype_Indication            => Subtype_Mark (Def),
1905             Interface_List                => Interface_List (Def));
1906
1907         Set_Abstract_Present     (New_N, Abstract_Present     (Def));
1908         Set_Limited_Present      (New_N, Limited_Present      (Def));
1909         Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1910
1911      else
1912         New_N :=
1913           Make_Full_Type_Declaration (Loc,
1914             Defining_Identifier         => T,
1915             Discriminant_Specifications =>
1916               Discriminant_Specifications (Parent (T)),
1917             Type_Definition             =>
1918               Make_Derived_Type_Definition (Loc,
1919                 Subtype_Indication => Subtype_Mark (Def)));
1920
1921         Set_Abstract_Present
1922           (Type_Definition (New_N), Abstract_Present (Def));
1923         Set_Limited_Present
1924           (Type_Definition (New_N), Limited_Present  (Def));
1925      end if;
1926
1927      Rewrite (N, New_N);
1928      Analyze (N);
1929
1930      if Unk_Disc then
1931         if not Is_Composite_Type (T) then
1932            Error_Msg_N
1933              ("unknown discriminants not allowed for elementary types", N);
1934         else
1935            Set_Has_Unknown_Discriminants (T);
1936            Set_Is_Constrained (T, False);
1937         end if;
1938      end if;
1939
1940      --  If the parent type has a known size, so does the formal, which makes
1941      --  legal representation clauses that involve the formal.
1942
1943      Set_Size_Known_At_Compile_Time
1944        (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1945   end Analyze_Formal_Derived_Type;
1946
1947   ----------------------------------
1948   -- Analyze_Formal_Discrete_Type --
1949   ----------------------------------
1950
1951   --  The operations defined for a discrete types are those of an enumeration
1952   --  type. The size is set to an arbitrary value, for use in analyzing the
1953   --  generic unit.
1954
1955   procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1956      Loc : constant Source_Ptr := Sloc (Def);
1957      Lo  : Node_Id;
1958      Hi  : Node_Id;
1959
1960      Base : constant Entity_Id :=
1961               New_Internal_Entity
1962                 (E_Floating_Point_Type, Current_Scope,
1963                  Sloc (Defining_Identifier (Parent (Def))), 'G');
1964
1965   begin
1966      Enter_Name          (T);
1967      Set_Ekind           (T, E_Enumeration_Subtype);
1968      Set_Etype           (T, Base);
1969      Init_Size           (T, 8);
1970      Init_Alignment      (T);
1971      Set_Is_Generic_Type (T);
1972      Set_Is_Constrained  (T);
1973
1974      --  For semantic analysis, the bounds of the type must be set to some
1975      --  non-static value. The simplest is to create attribute nodes for those
1976      --  bounds, that refer to the type itself. These bounds are never
1977      --  analyzed but serve as place-holders.
1978
1979      Lo :=
1980        Make_Attribute_Reference (Loc,
1981          Attribute_Name => Name_First,
1982          Prefix         => New_Occurrence_Of (T, Loc));
1983      Set_Etype (Lo, T);
1984
1985      Hi :=
1986        Make_Attribute_Reference (Loc,
1987          Attribute_Name => Name_Last,
1988          Prefix         => New_Occurrence_Of (T, Loc));
1989      Set_Etype (Hi, T);
1990
1991      Set_Scalar_Range (T,
1992        Make_Range (Loc,
1993          Low_Bound  => Lo,
1994          High_Bound => Hi));
1995
1996      Set_Ekind           (Base, E_Enumeration_Type);
1997      Set_Etype           (Base, Base);
1998      Init_Size           (Base, 8);
1999      Init_Alignment      (Base);
2000      Set_Is_Generic_Type (Base);
2001      Set_Scalar_Range    (Base, Scalar_Range (T));
2002      Set_Parent          (Base, Parent (Def));
2003   end Analyze_Formal_Discrete_Type;
2004
2005   ----------------------------------
2006   -- Analyze_Formal_Floating_Type --
2007   ---------------------------------
2008
2009   procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
2010      Base : constant Entity_Id :=
2011               New_Internal_Entity
2012                 (E_Floating_Point_Type, Current_Scope,
2013                  Sloc (Defining_Identifier (Parent (Def))), 'G');
2014
2015   begin
2016      --  The various semantic attributes are taken from the predefined type
2017      --  Float, just so that all of them are initialized. Their values are
2018      --  never used because no constant folding or expansion takes place in
2019      --  the generic itself.
2020
2021      Enter_Name (T);
2022      Set_Ekind          (T, E_Floating_Point_Subtype);
2023      Set_Etype          (T, Base);
2024      Set_Size_Info      (T,              (Standard_Float));
2025      Set_RM_Size        (T, RM_Size      (Standard_Float));
2026      Set_Digits_Value   (T, Digits_Value (Standard_Float));
2027      Set_Scalar_Range   (T, Scalar_Range (Standard_Float));
2028      Set_Is_Constrained (T);
2029
2030      Set_Is_Generic_Type (Base);
2031      Set_Etype           (Base, Base);
2032      Set_Size_Info       (Base,              (Standard_Float));
2033      Set_RM_Size         (Base, RM_Size      (Standard_Float));
2034      Set_Digits_Value    (Base, Digits_Value (Standard_Float));
2035      Set_Scalar_Range    (Base, Scalar_Range (Standard_Float));
2036      Set_Parent          (Base, Parent (Def));
2037
2038      Check_Restriction (No_Floating_Point, Def);
2039   end Analyze_Formal_Floating_Type;
2040
2041   -----------------------------------
2042   -- Analyze_Formal_Interface_Type;--
2043   -----------------------------------
2044
2045   procedure Analyze_Formal_Interface_Type
2046      (N   : Node_Id;
2047       T   : Entity_Id;
2048       Def : Node_Id)
2049   is
2050      Loc   : constant Source_Ptr := Sloc (N);
2051      New_N : Node_Id;
2052
2053   begin
2054      New_N :=
2055        Make_Full_Type_Declaration (Loc,
2056          Defining_Identifier => T,
2057          Type_Definition     => Def);
2058
2059      Rewrite (N, New_N);
2060      Analyze (N);
2061      Set_Is_Generic_Type (T);
2062   end Analyze_Formal_Interface_Type;
2063
2064   ---------------------------------
2065   -- Analyze_Formal_Modular_Type --
2066   ---------------------------------
2067
2068   procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2069   begin
2070      --  Apart from their entity kind, generic modular types are treated like
2071      --  signed integer types, and have the same attributes.
2072
2073      Analyze_Formal_Signed_Integer_Type (T, Def);
2074      Set_Ekind (T, E_Modular_Integer_Subtype);
2075      Set_Ekind (Etype (T), E_Modular_Integer_Type);
2076
2077   end Analyze_Formal_Modular_Type;
2078
2079   ---------------------------------------
2080   -- Analyze_Formal_Object_Declaration --
2081   ---------------------------------------
2082
2083   procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2084      E  : constant Node_Id := Default_Expression (N);
2085      Id : constant Node_Id := Defining_Identifier (N);
2086      K  : Entity_Kind;
2087      T  : Node_Id;
2088
2089   begin
2090      Enter_Name (Id);
2091
2092      --  Determine the mode of the formal object
2093
2094      if Out_Present (N) then
2095         K := E_Generic_In_Out_Parameter;
2096
2097         if not In_Present (N) then
2098            Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2099         end if;
2100
2101      else
2102         K := E_Generic_In_Parameter;
2103      end if;
2104
2105      if Present (Subtype_Mark (N)) then
2106         Find_Type (Subtype_Mark (N));
2107         T := Entity (Subtype_Mark (N));
2108
2109         --  Verify that there is no redundant null exclusion
2110
2111         if Null_Exclusion_Present (N) then
2112            if not Is_Access_Type (T) then
2113               Error_Msg_N
2114                 ("null exclusion can only apply to an access type", N);
2115
2116            elsif Can_Never_Be_Null (T) then
2117               Error_Msg_NE
2118                 ("`NOT NULL` not allowed (& already excludes null)", N, T);
2119            end if;
2120         end if;
2121
2122      --  Ada 2005 (AI-423): Formal object with an access definition
2123
2124      else
2125         Check_Access_Definition (N);
2126         T := Access_Definition
2127                (Related_Nod => N,
2128                 N           => Access_Definition (N));
2129      end if;
2130
2131      if Ekind (T) = E_Incomplete_Type then
2132         declare
2133            Error_Node : Node_Id;
2134
2135         begin
2136            if Present (Subtype_Mark (N)) then
2137               Error_Node := Subtype_Mark (N);
2138            else
2139               Check_Access_Definition (N);
2140               Error_Node := Access_Definition (N);
2141            end if;
2142
2143            Error_Msg_N ("premature usage of incomplete type", Error_Node);
2144         end;
2145      end if;
2146
2147      if K = E_Generic_In_Parameter then
2148
2149         --  Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2150
2151         if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2152            Error_Msg_N
2153              ("generic formal of mode IN must not be of limited type", N);
2154            Explain_Limited_Type (T, N);
2155         end if;
2156
2157         if Is_Abstract_Type (T) then
2158            Error_Msg_N
2159              ("generic formal of mode IN must not be of abstract type", N);
2160         end if;
2161
2162         if Present (E) then
2163            Preanalyze_Spec_Expression (E, T);
2164
2165            if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2166               Error_Msg_N
2167                 ("initialization not allowed for limited types", E);
2168               Explain_Limited_Type (T, E);
2169            end if;
2170         end if;
2171
2172         Set_Ekind (Id, K);
2173         Set_Etype (Id, T);
2174
2175      --  Case of generic IN OUT parameter
2176
2177      else
2178         --  If the formal has an unconstrained type, construct its actual
2179         --  subtype, as is done for subprogram formals. In this fashion, all
2180         --  its uses can refer to specific bounds.
2181
2182         Set_Ekind (Id, K);
2183         Set_Etype (Id, T);
2184
2185         if (Is_Array_Type (T) and then not Is_Constrained (T))
2186           or else (Ekind (T) = E_Record_Type and then Has_Discriminants (T))
2187         then
2188            declare
2189               Non_Freezing_Ref : constant Node_Id :=
2190                                    New_Occurrence_Of (Id, Sloc (Id));
2191               Decl : Node_Id;
2192
2193            begin
2194               --  Make sure the actual subtype doesn't generate bogus freezing
2195
2196               Set_Must_Not_Freeze (Non_Freezing_Ref);
2197               Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2198               Insert_Before_And_Analyze (N, Decl);
2199               Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2200            end;
2201         else
2202            Set_Actual_Subtype (Id, T);
2203         end if;
2204
2205         if Present (E) then
2206            Error_Msg_N
2207              ("initialization not allowed for `IN OUT` formals", N);
2208         end if;
2209      end if;
2210
2211      if Has_Aspects (N) then
2212         Analyze_Aspect_Specifications (N, Id);
2213      end if;
2214   end Analyze_Formal_Object_Declaration;
2215
2216   ----------------------------------------------
2217   -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2218   ----------------------------------------------
2219
2220   procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2221     (T   : Entity_Id;
2222      Def : Node_Id)
2223   is
2224      Loc  : constant Source_Ptr := Sloc (Def);
2225      Base : constant Entity_Id :=
2226               New_Internal_Entity
2227                 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2228                  Sloc (Defining_Identifier (Parent (Def))), 'G');
2229
2230   begin
2231      --  The semantic attributes are set for completeness only, their values
2232      --  will never be used, since all properties of the type are non-static.
2233
2234      Enter_Name (T);
2235      Set_Ekind            (T, E_Ordinary_Fixed_Point_Subtype);
2236      Set_Etype            (T, Base);
2237      Set_Size_Info        (T, Standard_Integer);
2238      Set_RM_Size          (T, RM_Size (Standard_Integer));
2239      Set_Small_Value      (T, Ureal_1);
2240      Set_Delta_Value      (T, Ureal_1);
2241      Set_Scalar_Range     (T,
2242        Make_Range (Loc,
2243          Low_Bound  => Make_Real_Literal (Loc, Ureal_1),
2244          High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2245      Set_Is_Constrained   (T);
2246
2247      Set_Is_Generic_Type (Base);
2248      Set_Etype           (Base, Base);
2249      Set_Size_Info       (Base, Standard_Integer);
2250      Set_RM_Size         (Base, RM_Size (Standard_Integer));
2251      Set_Small_Value     (Base, Ureal_1);
2252      Set_Delta_Value     (Base, Ureal_1);
2253      Set_Scalar_Range    (Base, Scalar_Range (T));
2254      Set_Parent          (Base, Parent (Def));
2255
2256      Check_Restriction (No_Fixed_Point, Def);
2257   end Analyze_Formal_Ordinary_Fixed_Point_Type;
2258
2259   ----------------------------------------
2260   -- Analyze_Formal_Package_Declaration --
2261   ----------------------------------------
2262
2263   procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2264      Loc              : constant Source_Ptr := Sloc (N);
2265      Pack_Id          : constant Entity_Id  := Defining_Identifier (N);
2266      Formal           : Entity_Id;
2267      Gen_Id           : constant Node_Id    := Name (N);
2268      Gen_Decl         : Node_Id;
2269      Gen_Unit         : Entity_Id;
2270      New_N            : Node_Id;
2271      Parent_Installed : Boolean := False;
2272      Renaming         : Node_Id;
2273      Parent_Instance  : Entity_Id;
2274      Renaming_In_Par  : Entity_Id;
2275      Associations     : Boolean := True;
2276
2277      Vis_Prims_List : Elist_Id := No_Elist;
2278      --  List of primitives made temporarily visible in the instantiation
2279      --  to match the visibility of the formal type
2280
2281      function Build_Local_Package return Node_Id;
2282      --  The formal package is rewritten so that its parameters are replaced
2283      --  with corresponding declarations. For parameters with bona fide
2284      --  associations these declarations are created by Analyze_Associations
2285      --  as for a regular instantiation. For boxed parameters, we preserve
2286      --  the formal declarations and analyze them, in order to introduce
2287      --  entities of the right kind in the environment of the formal.
2288
2289      -------------------------
2290      -- Build_Local_Package --
2291      -------------------------
2292
2293      function Build_Local_Package return Node_Id is
2294         Decls     : List_Id;
2295         Pack_Decl : Node_Id;
2296
2297      begin
2298         --  Within the formal, the name of the generic package is a renaming
2299         --  of the formal (as for a regular instantiation).
2300
2301         Pack_Decl :=
2302           Make_Package_Declaration (Loc,
2303             Specification =>
2304               Copy_Generic_Node
2305                 (Specification (Original_Node (Gen_Decl)),
2306                    Empty, Instantiating => True));
2307
2308         Renaming := Make_Package_Renaming_Declaration (Loc,
2309             Defining_Unit_Name =>
2310               Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2311             Name => New_Occurrence_Of (Formal, Loc));
2312
2313         if Nkind (Gen_Id) = N_Identifier
2314           and then Chars (Gen_Id) = Chars (Pack_Id)
2315         then
2316            Error_Msg_NE
2317              ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2318         end if;
2319
2320         --  If the formal is declared with a box, or with an others choice,
2321         --  create corresponding declarations for all entities in the formal
2322         --  part, so that names with the proper types are available in the
2323         --  specification of the formal package.
2324
2325         --  On the other hand, if there are no associations, then all the
2326         --  formals must have defaults, and this will be checked by the
2327         --  call to Analyze_Associations.
2328
2329         if Box_Present (N)
2330           or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2331         then
2332            declare
2333               Formal_Decl : Node_Id;
2334
2335            begin
2336               --  TBA : for a formal package, need to recurse ???
2337
2338               Decls := New_List;
2339               Formal_Decl :=
2340                 First
2341                   (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2342               while Present (Formal_Decl) loop
2343                  Append_To
2344                    (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2345                  Next (Formal_Decl);
2346               end loop;
2347            end;
2348
2349         --  If generic associations are present, use Analyze_Associations to
2350         --  create the proper renaming declarations.
2351
2352         else
2353            declare
2354               Act_Tree : constant Node_Id :=
2355                            Copy_Generic_Node
2356                              (Original_Node (Gen_Decl), Empty,
2357                               Instantiating => True);
2358
2359            begin
2360               Generic_Renamings.Set_Last (0);
2361               Generic_Renamings_HTable.Reset;
2362               Instantiation_Node := N;
2363
2364               Decls :=
2365                 Analyze_Associations
2366                   (I_Node  => Original_Node (N),
2367                    Formals => Generic_Formal_Declarations (Act_Tree),
2368                    F_Copy  => Generic_Formal_Declarations (Gen_Decl));
2369
2370               Vis_Prims_List := Check_Hidden_Primitives (Decls);
2371            end;
2372         end if;
2373
2374         Append (Renaming, To => Decls);
2375
2376         --  Add generated declarations ahead of local declarations in
2377         --  the package.
2378
2379         if No (Visible_Declarations (Specification (Pack_Decl))) then
2380            Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2381         else
2382            Insert_List_Before
2383              (First (Visible_Declarations (Specification (Pack_Decl))),
2384                 Decls);
2385         end if;
2386
2387         return Pack_Decl;
2388      end Build_Local_Package;
2389
2390   --  Start of processing for Analyze_Formal_Package_Declaration
2391
2392   begin
2393      Check_Text_IO_Special_Unit (Gen_Id);
2394
2395      Init_Env;
2396      Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2397      Gen_Unit := Entity (Gen_Id);
2398
2399      --  Check for a formal package that is a package renaming
2400
2401      if Present (Renamed_Object (Gen_Unit)) then
2402
2403         --  Indicate that unit is used, before replacing it with renamed
2404         --  entity for use below.
2405
2406         if In_Extended_Main_Source_Unit (N) then
2407            Set_Is_Instantiated (Gen_Unit);
2408            Generate_Reference  (Gen_Unit, N);
2409         end if;
2410
2411         Gen_Unit := Renamed_Object (Gen_Unit);
2412      end if;
2413
2414      if Ekind (Gen_Unit) /= E_Generic_Package then
2415         Error_Msg_N ("expect generic package name", Gen_Id);
2416         Restore_Env;
2417         goto Leave;
2418
2419      elsif Gen_Unit = Current_Scope then
2420         Error_Msg_N
2421           ("generic package cannot be used as a formal package of itself",
2422            Gen_Id);
2423         Restore_Env;
2424         goto Leave;
2425
2426      elsif In_Open_Scopes (Gen_Unit) then
2427         if Is_Compilation_Unit (Gen_Unit)
2428           and then Is_Child_Unit (Current_Scope)
2429         then
2430            --  Special-case the error when the formal is a parent, and
2431            --  continue analysis to minimize cascaded errors.
2432
2433            Error_Msg_N
2434              ("generic parent cannot be used as formal package "
2435               & "of a child unit", Gen_Id);
2436
2437         else
2438            Error_Msg_N
2439              ("generic package cannot be used as a formal package "
2440               & "within itself", Gen_Id);
2441            Restore_Env;
2442            goto Leave;
2443         end if;
2444      end if;
2445
2446      --  Check that name of formal package does not hide name of generic,
2447      --  or its leading prefix. This check must be done separately because
2448      --  the name of the generic has already been analyzed.
2449
2450      declare
2451         Gen_Name : Entity_Id;
2452
2453      begin
2454         Gen_Name := Gen_Id;
2455         while Nkind (Gen_Name) = N_Expanded_Name loop
2456            Gen_Name := Prefix (Gen_Name);
2457         end loop;
2458
2459         if Chars (Gen_Name) = Chars (Pack_Id) then
2460            Error_Msg_NE
2461             ("& is hidden within declaration of formal package",
2462              Gen_Id, Gen_Name);
2463         end if;
2464      end;
2465
2466      if Box_Present (N)
2467        or else No (Generic_Associations (N))
2468        or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2469      then
2470         Associations := False;
2471      end if;
2472
2473      --  If there are no generic associations, the generic parameters appear
2474      --  as local entities and are instantiated like them. We copy the generic
2475      --  package declaration as if it were an instantiation, and analyze it
2476      --  like a regular package, except that we treat the formals as
2477      --  additional visible components.
2478
2479      Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2480
2481      if In_Extended_Main_Source_Unit (N) then
2482         Set_Is_Instantiated (Gen_Unit);
2483         Generate_Reference  (Gen_Unit, N);
2484      end if;
2485
2486      Formal := New_Copy (Pack_Id);
2487      Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2488
2489      begin
2490         --  Make local generic without formals. The formals will be replaced
2491         --  with internal declarations.
2492
2493         New_N := Build_Local_Package;
2494
2495         --  If there are errors in the parameter list, Analyze_Associations
2496         --  raises Instantiation_Error. Patch the declaration to prevent
2497         --  further exception propagation.
2498
2499      exception
2500         when Instantiation_Error =>
2501
2502            Enter_Name (Formal);
2503            Set_Ekind  (Formal, E_Variable);
2504            Set_Etype  (Formal, Any_Type);
2505            Restore_Hidden_Primitives (Vis_Prims_List);
2506
2507            if Parent_Installed then
2508               Remove_Parent;
2509            end if;
2510
2511            goto Leave;
2512      end;
2513
2514      Rewrite (N, New_N);
2515      Set_Defining_Unit_Name (Specification (New_N), Formal);
2516      Set_Generic_Parent (Specification (N), Gen_Unit);
2517      Set_Instance_Env (Gen_Unit, Formal);
2518      Set_Is_Generic_Instance (Formal);
2519
2520      Enter_Name (Formal);
2521      Set_Ekind  (Formal, E_Package);
2522      Set_Etype  (Formal, Standard_Void_Type);
2523      Set_Inner_Instances (Formal, New_Elmt_List);
2524      Push_Scope  (Formal);
2525
2526      if Is_Child_Unit (Gen_Unit) and then Parent_Installed then
2527
2528         --  Similarly, we have to make the name of the formal visible in the
2529         --  parent instance, to resolve properly fully qualified names that
2530         --  may appear in the generic unit. The parent instance has been
2531         --  placed on the scope stack ahead of the current scope.
2532
2533         Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2534
2535         Renaming_In_Par :=
2536           Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2537         Set_Ekind (Renaming_In_Par, E_Package);
2538         Set_Etype (Renaming_In_Par, Standard_Void_Type);
2539         Set_Scope (Renaming_In_Par, Parent_Instance);
2540         Set_Parent (Renaming_In_Par, Parent (Formal));
2541         Set_Renamed_Object (Renaming_In_Par, Formal);
2542         Append_Entity (Renaming_In_Par, Parent_Instance);
2543      end if;
2544
2545      Analyze (Specification (N));
2546
2547      --  The formals for which associations are provided are not visible
2548      --  outside of the formal package. The others are still declared by a
2549      --  formal parameter declaration.
2550
2551      --  If there are no associations, the only local entity to hide is the
2552      --  generated package renaming itself.
2553
2554      declare
2555         E : Entity_Id;
2556
2557      begin
2558         E := First_Entity (Formal);
2559         while Present (E) loop
2560            if Associations and then not Is_Generic_Formal (E) then
2561               Set_Is_Hidden (E);
2562            end if;
2563
2564            if Ekind (E) = E_Package and then Renamed_Entity (E) = Formal then
2565               Set_Is_Hidden (E);
2566               exit;
2567            end if;
2568
2569            Next_Entity (E);
2570         end loop;
2571      end;
2572
2573      End_Package_Scope (Formal);
2574      Restore_Hidden_Primitives (Vis_Prims_List);
2575
2576      if Parent_Installed then
2577         Remove_Parent;
2578      end if;
2579
2580      Restore_Env;
2581
2582      --  Inside the generic unit, the formal package is a regular package, but
2583      --  no body is needed for it. Note that after instantiation, the defining
2584      --  unit name we need is in the new tree and not in the original (see
2585      --  Package_Instantiation). A generic formal package is an instance, and
2586      --  can be used as an actual for an inner instance.
2587
2588      Set_Has_Completion (Formal, True);
2589
2590      --  Add semantic information to the original defining identifier.
2591      --  for ASIS use.
2592
2593      Set_Ekind (Pack_Id, E_Package);
2594      Set_Etype (Pack_Id, Standard_Void_Type);
2595      Set_Scope (Pack_Id, Scope (Formal));
2596      Set_Has_Completion (Pack_Id, True);
2597
2598   <<Leave>>
2599      if Has_Aspects (N) then
2600         Analyze_Aspect_Specifications (N, Pack_Id);
2601      end if;
2602   end Analyze_Formal_Package_Declaration;
2603
2604   ---------------------------------
2605   -- Analyze_Formal_Private_Type --
2606   ---------------------------------
2607
2608   procedure Analyze_Formal_Private_Type
2609     (N   : Node_Id;
2610      T   : Entity_Id;
2611      Def : Node_Id)
2612   is
2613   begin
2614      New_Private_Type (N, T, Def);
2615
2616      --  Set the size to an arbitrary but legal value
2617
2618      Set_Size_Info (T, Standard_Integer);
2619      Set_RM_Size   (T, RM_Size (Standard_Integer));
2620   end Analyze_Formal_Private_Type;
2621
2622   ------------------------------------
2623   -- Analyze_Formal_Incomplete_Type --
2624   ------------------------------------
2625
2626   procedure Analyze_Formal_Incomplete_Type
2627     (T   : Entity_Id;
2628      Def : Node_Id)
2629   is
2630   begin
2631      Enter_Name (T);
2632      Set_Ekind (T, E_Incomplete_Type);
2633      Set_Etype (T, T);
2634      Set_Private_Dependents (T, New_Elmt_List);
2635
2636      if Tagged_Present (Def) then
2637         Set_Is_Tagged_Type (T);
2638         Make_Class_Wide_Type (T);
2639         Set_Direct_Primitive_Operations (T, New_Elmt_List);
2640      end if;
2641   end Analyze_Formal_Incomplete_Type;
2642
2643   ----------------------------------------
2644   -- Analyze_Formal_Signed_Integer_Type --
2645   ----------------------------------------
2646
2647   procedure Analyze_Formal_Signed_Integer_Type
2648     (T   : Entity_Id;
2649      Def : Node_Id)
2650   is
2651      Base : constant Entity_Id :=
2652               New_Internal_Entity
2653                 (E_Signed_Integer_Type,
2654                  Current_Scope,
2655                  Sloc (Defining_Identifier (Parent (Def))), 'G');
2656
2657   begin
2658      Enter_Name (T);
2659
2660      Set_Ekind          (T, E_Signed_Integer_Subtype);
2661      Set_Etype          (T, Base);
2662      Set_Size_Info      (T, Standard_Integer);
2663      Set_RM_Size        (T, RM_Size (Standard_Integer));
2664      Set_Scalar_Range   (T, Scalar_Range (Standard_Integer));
2665      Set_Is_Constrained (T);
2666
2667      Set_Is_Generic_Type (Base);
2668      Set_Size_Info       (Base, Standard_Integer);
2669      Set_RM_Size         (Base, RM_Size (Standard_Integer));
2670      Set_Etype           (Base, Base);
2671      Set_Scalar_Range    (Base, Scalar_Range (Standard_Integer));
2672      Set_Parent          (Base, Parent (Def));
2673   end Analyze_Formal_Signed_Integer_Type;
2674
2675   -------------------------------------------
2676   -- Analyze_Formal_Subprogram_Declaration --
2677   -------------------------------------------
2678
2679   procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2680      Spec : constant Node_Id   := Specification (N);
2681      Def  : constant Node_Id   := Default_Name (N);
2682      Nam  : constant Entity_Id := Defining_Unit_Name (Spec);
2683      Subp : Entity_Id;
2684
2685   begin
2686      if Nam = Error then
2687         return;
2688      end if;
2689
2690      if Nkind (Nam) = N_Defining_Program_Unit_Name then
2691         Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2692         goto Leave;
2693      end if;
2694
2695      Analyze_Subprogram_Declaration (N);
2696      Set_Is_Formal_Subprogram (Nam);
2697      Set_Has_Completion (Nam);
2698
2699      if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2700         Set_Is_Abstract_Subprogram (Nam);
2701         Set_Is_Dispatching_Operation (Nam);
2702
2703         declare
2704            Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2705         begin
2706            if No (Ctrl_Type) then
2707               Error_Msg_N
2708                 ("abstract formal subprogram must have a controlling type",
2709                  N);
2710
2711            elsif Ada_Version >= Ada_2012
2712              and then Is_Incomplete_Type (Ctrl_Type)
2713            then
2714               Error_Msg_NE
2715                 ("controlling type of abstract formal subprogram cannot "
2716                  & "be incomplete type", N, Ctrl_Type);
2717
2718            else
2719               Check_Controlling_Formals (Ctrl_Type, Nam);
2720            end if;
2721         end;
2722      end if;
2723
2724      --  Default name is resolved at the point of instantiation
2725
2726      if Box_Present (N) then
2727         null;
2728
2729      --  Else default is bound at the point of generic declaration
2730
2731      elsif Present (Def) then
2732         if Nkind (Def) = N_Operator_Symbol then
2733            Find_Direct_Name (Def);
2734
2735         elsif Nkind (Def) /= N_Attribute_Reference then
2736            Analyze (Def);
2737
2738         else
2739            --  For an attribute reference, analyze the prefix and verify
2740            --  that it has the proper profile for the subprogram.
2741
2742            Analyze (Prefix (Def));
2743            Valid_Default_Attribute (Nam, Def);
2744            goto Leave;
2745         end if;
2746
2747         --  Default name may be overloaded, in which case the interpretation
2748         --  with the correct profile must be  selected, as for a renaming.
2749         --  If the definition is an indexed component, it must denote a
2750         --  member of an entry family. If it is a selected component, it
2751         --  can be a protected operation.
2752
2753         if Etype (Def) = Any_Type then
2754            goto Leave;
2755
2756         elsif Nkind (Def) = N_Selected_Component then
2757            if not Is_Overloadable (Entity (Selector_Name (Def))) then
2758               Error_Msg_N ("expect valid subprogram name as default", Def);
2759            end if;
2760
2761         elsif Nkind (Def) = N_Indexed_Component then
2762            if Is_Entity_Name (Prefix (Def)) then
2763               if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2764                  Error_Msg_N ("expect valid subprogram name as default", Def);
2765               end if;
2766
2767            elsif Nkind (Prefix (Def)) = N_Selected_Component then
2768               if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2769                                                          E_Entry_Family
2770               then
2771                  Error_Msg_N ("expect valid subprogram name as default", Def);
2772               end if;
2773
2774            else
2775               Error_Msg_N ("expect valid subprogram name as default", Def);
2776               goto Leave;
2777            end if;
2778
2779         elsif Nkind (Def) = N_Character_Literal then
2780
2781            --  Needs some type checks: subprogram should be parameterless???
2782
2783            Resolve (Def, (Etype (Nam)));
2784
2785         elsif not Is_Entity_Name (Def)
2786           or else not Is_Overloadable (Entity (Def))
2787         then
2788            Error_Msg_N ("expect valid subprogram name as default", Def);
2789            goto Leave;
2790
2791         elsif not Is_Overloaded (Def) then
2792            Subp := Entity (Def);
2793
2794            if Subp = Nam then
2795               Error_Msg_N ("premature usage of formal subprogram", Def);
2796
2797            elsif not Entity_Matches_Spec (Subp, Nam) then
2798               Error_Msg_N ("no visible entity matches specification", Def);
2799            end if;
2800
2801         --  More than one interpretation, so disambiguate as for a renaming
2802
2803         else
2804            declare
2805               I   : Interp_Index;
2806               I1  : Interp_Index := 0;
2807               It  : Interp;
2808               It1 : Interp;
2809
2810            begin
2811               Subp := Any_Id;
2812               Get_First_Interp (Def, I, It);
2813               while Present (It.Nam) loop
2814                  if Entity_Matches_Spec (It.Nam, Nam) then
2815                     if Subp /= Any_Id then
2816                        It1 := Disambiguate (Def, I1, I, Etype (Subp));
2817
2818                        if It1 = No_Interp then
2819                           Error_Msg_N ("ambiguous default subprogram", Def);
2820                        else
2821                           Subp := It1.Nam;
2822                        end if;
2823
2824                        exit;
2825
2826                     else
2827                        I1  := I;
2828                        Subp := It.Nam;
2829                     end if;
2830                  end if;
2831
2832                  Get_Next_Interp (I, It);
2833               end loop;
2834            end;
2835
2836            if Subp /= Any_Id then
2837
2838               --  Subprogram found, generate reference to it
2839
2840               Set_Entity (Def, Subp);
2841               Generate_Reference (Subp, Def);
2842
2843               if Subp = Nam then
2844                  Error_Msg_N ("premature usage of formal subprogram", Def);
2845
2846               elsif Ekind (Subp) /= E_Operator then
2847                  Check_Mode_Conformant (Subp, Nam);
2848               end if;
2849
2850            else
2851               Error_Msg_N ("no visible subprogram matches specification", N);
2852            end if;
2853         end if;
2854      end if;
2855
2856   <<Leave>>
2857      if Has_Aspects (N) then
2858         Analyze_Aspect_Specifications (N, Nam);
2859      end if;
2860
2861   end Analyze_Formal_Subprogram_Declaration;
2862
2863   -------------------------------------
2864   -- Analyze_Formal_Type_Declaration --
2865   -------------------------------------
2866
2867   procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2868      Def : constant Node_Id := Formal_Type_Definition (N);
2869      T   : Entity_Id;
2870
2871   begin
2872      T := Defining_Identifier (N);
2873
2874      if Present (Discriminant_Specifications (N))
2875        and then Nkind (Def) /= N_Formal_Private_Type_Definition
2876      then
2877         Error_Msg_N
2878           ("discriminants not allowed for this formal type", T);
2879      end if;
2880
2881      --  Enter the new name, and branch to specific routine
2882
2883      case Nkind (Def) is
2884         when N_Formal_Private_Type_Definition         =>
2885            Analyze_Formal_Private_Type (N, T, Def);
2886
2887         when N_Formal_Derived_Type_Definition         =>
2888            Analyze_Formal_Derived_Type (N, T, Def);
2889
2890         when N_Formal_Incomplete_Type_Definition         =>
2891            Analyze_Formal_Incomplete_Type (T, Def);
2892
2893         when N_Formal_Discrete_Type_Definition        =>
2894            Analyze_Formal_Discrete_Type (T, Def);
2895
2896         when N_Formal_Signed_Integer_Type_Definition  =>
2897            Analyze_Formal_Signed_Integer_Type (T, Def);
2898
2899         when N_Formal_Modular_Type_Definition         =>
2900            Analyze_Formal_Modular_Type (T, Def);
2901
2902         when N_Formal_Floating_Point_Definition       =>
2903            Analyze_Formal_Floating_Type (T, Def);
2904
2905         when N_Formal_Ordinary_Fixed_Point_Definition =>
2906            Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2907
2908         when N_Formal_Decimal_Fixed_Point_Definition  =>
2909            Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2910
2911         when N_Array_Type_Definition =>
2912            Analyze_Formal_Array_Type (T, Def);
2913
2914         when N_Access_To_Object_Definition            |
2915              N_Access_Function_Definition             |
2916              N_Access_Procedure_Definition            =>
2917            Analyze_Generic_Access_Type (T, Def);
2918
2919         --  Ada 2005: a interface declaration is encoded as an abstract
2920         --  record declaration or a abstract type derivation.
2921
2922         when N_Record_Definition                      =>
2923            Analyze_Formal_Interface_Type (N, T, Def);
2924
2925         when N_Derived_Type_Definition                =>
2926            Analyze_Formal_Derived_Interface_Type (N, T, Def);
2927
2928         when N_Error                                  =>
2929            null;
2930
2931         when others                                   =>
2932            raise Program_Error;
2933
2934      end case;
2935
2936      Set_Is_Generic_Type (T);
2937
2938      if Has_Aspects (N) then
2939         Analyze_Aspect_Specifications (N, T);
2940      end if;
2941   end Analyze_Formal_Type_Declaration;
2942
2943   ------------------------------------
2944   -- Analyze_Function_Instantiation --
2945   ------------------------------------
2946
2947   procedure Analyze_Function_Instantiation (N : Node_Id) is
2948   begin
2949      Analyze_Subprogram_Instantiation (N, E_Function);
2950   end Analyze_Function_Instantiation;
2951
2952   ---------------------------------
2953   -- Analyze_Generic_Access_Type --
2954   ---------------------------------
2955
2956   procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2957   begin
2958      Enter_Name (T);
2959
2960      if Nkind (Def) = N_Access_To_Object_Definition then
2961         Access_Type_Declaration (T, Def);
2962
2963         if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2964           and then No (Full_View (Designated_Type (T)))
2965           and then not Is_Generic_Type (Designated_Type (T))
2966         then
2967            Error_Msg_N ("premature usage of incomplete type", Def);
2968
2969         elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2970            Error_Msg_N
2971              ("only a subtype mark is allowed in a formal", Def);
2972         end if;
2973
2974      else
2975         Access_Subprogram_Declaration (T, Def);
2976      end if;
2977   end Analyze_Generic_Access_Type;
2978
2979   ---------------------------------
2980   -- Analyze_Generic_Formal_Part --
2981   ---------------------------------
2982
2983   procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2984      Gen_Parm_Decl : Node_Id;
2985
2986   begin
2987      --  The generic formals are processed in the scope of the generic unit,
2988      --  where they are immediately visible. The scope is installed by the
2989      --  caller.
2990
2991      Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2992      while Present (Gen_Parm_Decl) loop
2993         Analyze (Gen_Parm_Decl);
2994         Next (Gen_Parm_Decl);
2995      end loop;
2996
2997      Generate_Reference_To_Generic_Formals (Current_Scope);
2998   end Analyze_Generic_Formal_Part;
2999
3000   ------------------------------------------
3001   -- Analyze_Generic_Package_Declaration  --
3002   ------------------------------------------
3003
3004   procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
3005      Loc         : constant Source_Ptr := Sloc (N);
3006      Id          : Entity_Id;
3007      New_N       : Node_Id;
3008      Save_Parent : Node_Id;
3009      Renaming    : Node_Id;
3010      Decls       : constant List_Id :=
3011                      Visible_Declarations (Specification (N));
3012      Decl        : Node_Id;
3013
3014   begin
3015      --  The generic package declaration may be subject to pragma Ghost with
3016      --  policy Ignore. Set the mode now to ensure that any nodes generated
3017      --  during analysis and expansion are properly flagged as ignored Ghost.
3018
3019      Set_Ghost_Mode (N);
3020      Check_SPARK_05_Restriction ("generic is not allowed", N);
3021
3022      --  We introduce a renaming of the enclosing package, to have a usable
3023      --  entity as the prefix of an expanded name for a local entity of the
3024      --  form Par.P.Q, where P is the generic package. This is because a local
3025      --  entity named P may hide it, so that the usual visibility rules in
3026      --  the instance will not resolve properly.
3027
3028      Renaming :=
3029        Make_Package_Renaming_Declaration (Loc,
3030          Defining_Unit_Name =>
3031            Make_Defining_Identifier (Loc,
3032             Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
3033          Name               =>
3034            Make_Identifier (Loc, Chars (Defining_Entity (N))));
3035
3036      if Present (Decls) then
3037         Decl := First (Decls);
3038         while Present (Decl) and then Nkind (Decl) = N_Pragma loop
3039            Next (Decl);
3040         end loop;
3041
3042         if Present (Decl) then
3043            Insert_Before (Decl, Renaming);
3044         else
3045            Append (Renaming, Visible_Declarations (Specification (N)));
3046         end if;
3047
3048      else
3049         Set_Visible_Declarations (Specification (N), New_List (Renaming));
3050      end if;
3051
3052      --  Create copy of generic unit, and save for instantiation. If the unit
3053      --  is a child unit, do not copy the specifications for the parent, which
3054      --  are not part of the generic tree.
3055
3056      Save_Parent := Parent_Spec (N);
3057      Set_Parent_Spec (N, Empty);
3058
3059      New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3060      Set_Parent_Spec (New_N, Save_Parent);
3061      Rewrite (N, New_N);
3062
3063      --  Once the contents of the generic copy and the template are swapped,
3064      --  do the same for their respective aspect specifications.
3065
3066      Exchange_Aspects (N, New_N);
3067      Id := Defining_Entity (N);
3068      Generate_Definition (Id);
3069
3070      --  Expansion is not applied to generic units
3071
3072      Start_Generic;
3073
3074      Enter_Name (Id);
3075      Set_Ekind  (Id, E_Generic_Package);
3076      Set_Etype  (Id, Standard_Void_Type);
3077
3078      --  A generic package declared within a Ghost region is rendered Ghost
3079      --  (SPARK RM 6.9(2)).
3080
3081      if Ghost_Mode > None then
3082         Set_Is_Ghost_Entity (Id);
3083      end if;
3084
3085      --  Analyze aspects now, so that generated pragmas appear in the
3086      --  declarations before building and analyzing the generic copy.
3087
3088      if Has_Aspects (N) then
3089         Analyze_Aspect_Specifications (N, Id);
3090      end if;
3091
3092      Push_Scope (Id);
3093      Enter_Generic_Scope (Id);
3094      Set_Inner_Instances (Id, New_Elmt_List);
3095
3096      Set_Categorization_From_Pragmas (N);
3097      Set_Is_Pure (Id, Is_Pure (Current_Scope));
3098
3099      --  Link the declaration of the generic homonym in the generic copy to
3100      --  the package it renames, so that it is always resolved properly.
3101
3102      Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3103      Set_Entity (Associated_Node (Name (Renaming)), Id);
3104
3105      --  For a library unit, we have reconstructed the entity for the unit,
3106      --  and must reset it in the library tables.
3107
3108      if Nkind (Parent (N)) = N_Compilation_Unit then
3109         Set_Cunit_Entity (Current_Sem_Unit, Id);
3110      end if;
3111
3112      Analyze_Generic_Formal_Part (N);
3113
3114      --  After processing the generic formals, analysis proceeds as for a
3115      --  non-generic package.
3116
3117      Analyze (Specification (N));
3118
3119      Validate_Categorization_Dependency (N, Id);
3120
3121      End_Generic;
3122
3123      End_Package_Scope (Id);
3124      Exit_Generic_Scope (Id);
3125
3126      if Nkind (Parent (N)) /= N_Compilation_Unit then
3127         Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3128         Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3129         Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3130
3131      else
3132         Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3133         Validate_RT_RAT_Component (N);
3134
3135         --  If this is a spec without a body, check that generic parameters
3136         --  are referenced.
3137
3138         if not Body_Required (Parent (N)) then
3139            Check_References (Id);
3140         end if;
3141      end if;
3142
3143      --  If there is a specified storage pool in the context, create an
3144      --  aspect on the package declaration, so that it is used in any
3145      --  instance that does not override it.
3146
3147      if Present (Default_Pool) then
3148         declare
3149            ASN : Node_Id;
3150
3151         begin
3152            ASN :=
3153              Make_Aspect_Specification (Loc,
3154                Identifier => Make_Identifier (Loc, Name_Default_Storage_Pool),
3155                Expression => New_Copy (Default_Pool));
3156
3157            if No (Aspect_Specifications (Specification (N))) then
3158               Set_Aspect_Specifications (Specification (N), New_List (ASN));
3159            else
3160               Append (ASN, Aspect_Specifications (Specification (N)));
3161            end if;
3162         end;
3163      end if;
3164   end Analyze_Generic_Package_Declaration;
3165
3166   --------------------------------------------
3167   -- Analyze_Generic_Subprogram_Declaration --
3168   --------------------------------------------
3169
3170   procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3171      Formals     : List_Id;
3172      Id          : Entity_Id;
3173      New_N       : Node_Id;
3174      Result_Type : Entity_Id;
3175      Save_Parent : Node_Id;
3176      Spec        : Node_Id;
3177      Typ         : Entity_Id;
3178
3179   begin
3180      --  The generic subprogram declaration may be subject to pragma Ghost
3181      --  with policy Ignore. Set the mode now to ensure that any nodes
3182      --  generated during analysis and expansion are properly flagged as
3183      --  ignored Ghost.
3184
3185      Set_Ghost_Mode (N);
3186      Check_SPARK_05_Restriction ("generic is not allowed", N);
3187
3188      --  Create copy of generic unit, and save for instantiation. If the unit
3189      --  is a child unit, do not copy the specifications for the parent, which
3190      --  are not part of the generic tree.
3191
3192      Save_Parent := Parent_Spec (N);
3193      Set_Parent_Spec (N, Empty);
3194
3195      New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3196      Set_Parent_Spec (New_N, Save_Parent);
3197      Rewrite (N, New_N);
3198
3199      --  Once the contents of the generic copy and the template are swapped,
3200      --  do the same for their respective aspect specifications.
3201
3202      Exchange_Aspects (N, New_N);
3203
3204      Spec := Specification (N);
3205      Id := Defining_Entity (Spec);
3206      Generate_Definition (Id);
3207
3208      if Nkind (Id) = N_Defining_Operator_Symbol then
3209         Error_Msg_N
3210           ("operator symbol not allowed for generic subprogram", Id);
3211      end if;
3212
3213      Start_Generic;
3214
3215      Enter_Name (Id);
3216      Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3217
3218      --  Analyze the aspects of the generic copy to ensure that all generated
3219      --  pragmas (if any) perform their semantic effects.
3220
3221      if Has_Aspects (N) then
3222         Analyze_Aspect_Specifications (N, Id);
3223      end if;
3224
3225      Push_Scope (Id);
3226      Enter_Generic_Scope (Id);
3227      Set_Inner_Instances (Id, New_Elmt_List);
3228      Set_Is_Pure (Id, Is_Pure (Current_Scope));
3229
3230      Analyze_Generic_Formal_Part (N);
3231
3232      Formals := Parameter_Specifications (Spec);
3233
3234      if Present (Formals) then
3235         Process_Formals (Formals, Spec);
3236      end if;
3237
3238      if Nkind (Spec) = N_Function_Specification then
3239         Set_Ekind (Id, E_Generic_Function);
3240
3241         if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3242            Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3243            Set_Etype (Id, Result_Type);
3244
3245            --  Check restriction imposed by AI05-073: a generic function
3246            --  cannot return an abstract type or an access to such.
3247
3248            --  This is a binding interpretation should it apply to earlier
3249            --  versions of Ada as well as Ada 2012???
3250
3251            if Is_Abstract_Type (Designated_Type (Result_Type))
3252              and then Ada_Version >= Ada_2012
3253            then
3254               Error_Msg_N
3255                 ("generic function cannot have an access result "
3256                  & "that designates an abstract type", Spec);
3257            end if;
3258
3259         else
3260            Find_Type (Result_Definition (Spec));
3261            Typ := Entity (Result_Definition (Spec));
3262
3263            if Is_Abstract_Type (Typ)
3264              and then Ada_Version >= Ada_2012
3265            then
3266               Error_Msg_N
3267                 ("generic function cannot have abstract result type", Spec);
3268            end if;
3269
3270            --  If a null exclusion is imposed on the result type, then create
3271            --  a null-excluding itype (an access subtype) and use it as the
3272            --  function's Etype.
3273
3274            if Is_Access_Type (Typ)
3275              and then Null_Exclusion_Present (Spec)
3276            then
3277               Set_Etype  (Id,
3278                 Create_Null_Excluding_Itype
3279                   (T           => Typ,
3280                    Related_Nod => Spec,
3281                    Scope_Id    => Defining_Unit_Name (Spec)));
3282            else
3283               Set_Etype (Id, Typ);
3284            end if;
3285         end if;
3286
3287      else
3288         Set_Ekind (Id, E_Generic_Procedure);
3289         Set_Etype (Id, Standard_Void_Type);
3290      end if;
3291
3292      --  A generic subprogram declared within a Ghost region is rendered Ghost
3293      --  (SPARK RM 6.9(2)).
3294
3295      if Ghost_Mode > None then
3296         Set_Is_Ghost_Entity (Id);
3297      end if;
3298
3299      --  For a library unit, we have reconstructed the entity for the unit,
3300      --  and must reset it in the library tables. We also make sure that
3301      --  Body_Required is set properly in the original compilation unit node.
3302
3303      if Nkind (Parent (N)) = N_Compilation_Unit then
3304         Set_Cunit_Entity (Current_Sem_Unit, Id);
3305         Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3306      end if;
3307
3308      Set_Categorization_From_Pragmas (N);
3309      Validate_Categorization_Dependency (N, Id);
3310
3311      --  Capture all global references that occur within the profile of the
3312      --  generic subprogram. Aspects are not part of this processing because
3313      --  they must be delayed. If processed now, Save_Global_References will
3314      --  destroy the Associated_Node links and prevent the capture of global
3315      --  references when the contract of the generic subprogram is analyzed.
3316
3317      Save_Global_References (Original_Node (N));
3318
3319      End_Generic;
3320      End_Scope;
3321      Exit_Generic_Scope (Id);
3322      Generate_Reference_To_Formals (Id);
3323
3324      List_Inherited_Pre_Post_Aspects (Id);
3325   end Analyze_Generic_Subprogram_Declaration;
3326
3327   -----------------------------------
3328   -- Analyze_Package_Instantiation --
3329   -----------------------------------
3330
3331   procedure Analyze_Package_Instantiation (N : Node_Id) is
3332      Loc    : constant Source_Ptr := Sloc (N);
3333      Gen_Id : constant Node_Id    := Name (N);
3334
3335      Act_Decl      : Node_Id;
3336      Act_Decl_Name : Node_Id;
3337      Act_Decl_Id   : Entity_Id;
3338      Act_Spec      : Node_Id;
3339      Act_Tree      : Node_Id;
3340
3341      Gen_Decl : Node_Id;
3342      Gen_Spec : Node_Id;
3343      Gen_Unit : Entity_Id;
3344
3345      Is_Actual_Pack : constant Boolean :=
3346                         Is_Internal (Defining_Entity (N));
3347
3348      Env_Installed     : Boolean := False;
3349      Parent_Installed  : Boolean := False;
3350      Renaming_List     : List_Id;
3351      Unit_Renaming     : Node_Id;
3352      Needs_Body        : Boolean;
3353      Inline_Now        : Boolean := False;
3354      Has_Inline_Always : Boolean := False;
3355
3356      Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
3357      --  Save flag Ignore_Pragma_SPARK_Mode for restore on exit
3358
3359      Save_SM  : constant SPARK_Mode_Type := SPARK_Mode;
3360      Save_SMP : constant Node_Id         := SPARK_Mode_Pragma;
3361      --  Save the SPARK_Mode-related data for restore on exit
3362
3363      Save_Style_Check : constant Boolean := Style_Check;
3364      --  Save style check mode for restore on exit
3365
3366      procedure Delay_Descriptors (E : Entity_Id);
3367      --  Delay generation of subprogram descriptors for given entity
3368
3369      function Might_Inline_Subp return Boolean;
3370      --  If inlining is active and the generic contains inlined subprograms,
3371      --  we instantiate the body. This may cause superfluous instantiations,
3372      --  but it is simpler than detecting the need for the body at the point
3373      --  of inlining, when the context of the instance is not available.
3374
3375      -----------------------
3376      -- Delay_Descriptors --
3377      -----------------------
3378
3379      procedure Delay_Descriptors (E : Entity_Id) is
3380      begin
3381         if not Delay_Subprogram_Descriptors (E) then
3382            Set_Delay_Subprogram_Descriptors (E);
3383            Pending_Descriptor.Append (E);
3384         end if;
3385      end Delay_Descriptors;
3386
3387      -----------------------
3388      -- Might_Inline_Subp --
3389      -----------------------
3390
3391      function Might_Inline_Subp return Boolean is
3392         E : Entity_Id;
3393
3394      begin
3395         if not Inline_Processing_Required then
3396            return False;
3397
3398         else
3399            E := First_Entity (Gen_Unit);
3400            while Present (E) loop
3401               if Is_Subprogram (E) and then Is_Inlined (E) then
3402                  --  Remember if there are any subprograms with Inline_Always
3403
3404                  if Has_Pragma_Inline_Always (E) then
3405                     Has_Inline_Always := True;
3406                  end if;
3407
3408                  return True;
3409               end if;
3410
3411               Next_Entity (E);
3412            end loop;
3413         end if;
3414
3415         return False;
3416      end Might_Inline_Subp;
3417
3418      --  Local declarations
3419
3420      Vis_Prims_List : Elist_Id := No_Elist;
3421      --  List of primitives made temporarily visible in the instantiation
3422      --  to match the visibility of the formal type
3423
3424   --  Start of processing for Analyze_Package_Instantiation
3425
3426   begin
3427      Check_SPARK_05_Restriction ("generic is not allowed", N);
3428
3429      --  Very first thing: check for Text_IO sp[ecial unit in case we are
3430      --  instantiating one of the children of [[Wide_]Wide_]Text_IO.
3431
3432      Check_Text_IO_Special_Unit (Name (N));
3433
3434      --  Make node global for error reporting
3435
3436      Instantiation_Node := N;
3437
3438      --  Turn off style checking in instances. If the check is enabled on the
3439      --  generic unit, a warning in an instance would just be noise. If not
3440      --  enabled on the generic, then a warning in an instance is just wrong.
3441
3442      Style_Check := False;
3443
3444      --  Case of instantiation of a generic package
3445
3446      if Nkind (N) = N_Package_Instantiation then
3447         Act_Decl_Id := New_Copy (Defining_Entity (N));
3448         Set_Comes_From_Source (Act_Decl_Id, True);
3449
3450         if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3451            Act_Decl_Name :=
3452              Make_Defining_Program_Unit_Name (Loc,
3453                Name                =>
3454                  New_Copy_Tree (Name (Defining_Unit_Name (N))),
3455                Defining_Identifier => Act_Decl_Id);
3456         else
3457            Act_Decl_Name :=  Act_Decl_Id;
3458         end if;
3459
3460      --  Case of instantiation of a formal package
3461
3462      else
3463         Act_Decl_Id   := Defining_Identifier (N);
3464         Act_Decl_Name := Act_Decl_Id;
3465      end if;
3466
3467      Generate_Definition (Act_Decl_Id);
3468      Preanalyze_Actuals (N);
3469
3470      Init_Env;
3471      Env_Installed := True;
3472
3473      --  Reset renaming map for formal types. The mapping is established
3474      --  when analyzing the generic associations, but some mappings are
3475      --  inherited from formal packages of parent units, and these are
3476      --  constructed when the parents are installed.
3477
3478      Generic_Renamings.Set_Last (0);
3479      Generic_Renamings_HTable.Reset;
3480
3481      Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3482      Gen_Unit := Entity (Gen_Id);
3483
3484      --  Verify that it is the name of a generic package
3485
3486      --  A visibility glitch: if the instance is a child unit and the generic
3487      --  is the generic unit of a parent instance (i.e. both the parent and
3488      --  the child units are instances of the same package) the name now
3489      --  denotes the renaming within the parent, not the intended generic
3490      --  unit. See if there is a homonym that is the desired generic. The
3491      --  renaming declaration must be visible inside the instance of the
3492      --  child, but not when analyzing the name in the instantiation itself.
3493
3494      if Ekind (Gen_Unit) = E_Package
3495        and then Present (Renamed_Entity (Gen_Unit))
3496        and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3497        and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3498        and then Present (Homonym (Gen_Unit))
3499      then
3500         Gen_Unit := Homonym (Gen_Unit);
3501      end if;
3502
3503      if Etype (Gen_Unit) = Any_Type then
3504         Restore_Env;
3505         goto Leave;
3506
3507      elsif Ekind (Gen_Unit) /= E_Generic_Package then
3508
3509         --  Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3510
3511         if From_Limited_With (Gen_Unit) then
3512            Error_Msg_N
3513              ("cannot instantiate a limited withed package", Gen_Id);
3514         else
3515            Error_Msg_NE
3516              ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3517         end if;
3518
3519         Restore_Env;
3520         goto Leave;
3521      end if;
3522
3523      if In_Extended_Main_Source_Unit (N) then
3524         Set_Is_Instantiated (Gen_Unit);
3525         Generate_Reference  (Gen_Unit, N);
3526
3527         if Present (Renamed_Object (Gen_Unit)) then
3528            Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3529            Generate_Reference  (Renamed_Object (Gen_Unit), N);
3530         end if;
3531      end if;
3532
3533      if Nkind (Gen_Id) = N_Identifier
3534        and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3535      then
3536         Error_Msg_NE
3537           ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3538
3539      elsif Nkind (Gen_Id) = N_Expanded_Name
3540        and then Is_Child_Unit (Gen_Unit)
3541        and then Nkind (Prefix (Gen_Id)) = N_Identifier
3542        and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3543      then
3544         Error_Msg_N
3545           ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3546      end if;
3547
3548      Set_Entity (Gen_Id, Gen_Unit);
3549
3550      --  If generic is a renaming, get original generic unit
3551
3552      if Present (Renamed_Object (Gen_Unit))
3553        and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3554      then
3555         Gen_Unit := Renamed_Object (Gen_Unit);
3556      end if;
3557
3558      --  Verify that there are no circular instantiations
3559
3560      if In_Open_Scopes (Gen_Unit) then
3561         Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3562         Restore_Env;
3563         goto Leave;
3564
3565      elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3566         Error_Msg_Node_2 := Current_Scope;
3567         Error_Msg_NE
3568           ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3569         Circularity_Detected := True;
3570         Restore_Env;
3571         goto Leave;
3572
3573      else
3574         --  If the context of the instance is subject to SPARK_Mode "off",
3575         --  set the global flag which signals Analyze_Pragma to ignore all
3576         --  SPARK_Mode pragmas within the instance.
3577
3578         if SPARK_Mode = Off then
3579            Ignore_Pragma_SPARK_Mode := True;
3580         end if;
3581
3582         Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3583         Gen_Spec := Specification (Gen_Decl);
3584
3585         --  Initialize renamings map, for error checking, and the list that
3586         --  holds private entities whose views have changed between generic
3587         --  definition and instantiation. If this is the instance created to
3588         --  validate an actual package, the instantiation environment is that
3589         --  of the enclosing instance.
3590
3591         Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3592
3593         --  Copy original generic tree, to produce text for instantiation
3594
3595         Act_Tree :=
3596           Copy_Generic_Node
3597             (Original_Node (Gen_Decl), Empty, Instantiating => True);
3598
3599         Act_Spec := Specification (Act_Tree);
3600
3601         --  If this is the instance created to validate an actual package,
3602         --  only the formals matter, do not examine the package spec itself.
3603
3604         if Is_Actual_Pack then
3605            Set_Visible_Declarations (Act_Spec, New_List);
3606            Set_Private_Declarations (Act_Spec, New_List);
3607         end if;
3608
3609         Renaming_List :=
3610           Analyze_Associations
3611             (I_Node  => N,
3612              Formals => Generic_Formal_Declarations (Act_Tree),
3613              F_Copy  => Generic_Formal_Declarations (Gen_Decl));
3614
3615         Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3616
3617         Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3618         Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3619         Set_Is_Generic_Instance (Act_Decl_Id);
3620         Set_Generic_Parent (Act_Spec, Gen_Unit);
3621
3622         --  References to the generic in its own declaration or its body are
3623         --  references to the instance. Add a renaming declaration for the
3624         --  generic unit itself. This declaration, as well as the renaming
3625         --  declarations for the generic formals, must remain private to the
3626         --  unit: the formals, because this is the language semantics, and
3627         --  the unit because its use is an artifact of the implementation.
3628
3629         Unit_Renaming :=
3630           Make_Package_Renaming_Declaration (Loc,
3631             Defining_Unit_Name =>
3632               Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3633             Name               => New_Occurrence_Of (Act_Decl_Id, Loc));
3634
3635         Append (Unit_Renaming, Renaming_List);
3636
3637         --  The renaming declarations are the first local declarations of the
3638         --  new unit.
3639
3640         if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3641            Insert_List_Before
3642              (First (Visible_Declarations (Act_Spec)), Renaming_List);
3643         else
3644            Set_Visible_Declarations (Act_Spec, Renaming_List);
3645         end if;
3646
3647         Act_Decl := Make_Package_Declaration (Loc, Specification => Act_Spec);
3648
3649         --  Propagate the aspect specifications from the package declaration
3650         --  template to the instantiated version of the package declaration.
3651
3652         if Has_Aspects (Act_Tree) then
3653            Set_Aspect_Specifications (Act_Decl,
3654              New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3655         end if;
3656
3657         --  The generic may have a generated Default_Storage_Pool aspect,
3658         --  set at the point of generic declaration. If the instance has
3659         --  that aspect, it overrides the one inherited from the generic.
3660
3661         if Has_Aspects (Gen_Spec) then
3662            if No (Aspect_Specifications (N)) then
3663               Set_Aspect_Specifications (N,
3664                 (New_Copy_List_Tree
3665                   (Aspect_Specifications (Gen_Spec))));
3666
3667            else
3668               declare
3669                  ASN1, ASN2 : Node_Id;
3670
3671               begin
3672                  ASN1 := First (Aspect_Specifications (N));
3673                  while Present (ASN1) loop
3674                     if Chars (Identifier (ASN1)) = Name_Default_Storage_Pool
3675                     then
3676                        --  If generic carries a default storage pool, remove
3677                        --  it in favor of the instance one.
3678
3679                        ASN2 := First (Aspect_Specifications (Gen_Spec));
3680                        while Present (ASN2) loop
3681                           if Chars (Identifier (ASN2)) =
3682                                                    Name_Default_Storage_Pool
3683                           then
3684                              Remove (ASN2);
3685                              exit;
3686                           end if;
3687
3688                           Next (ASN2);
3689                        end loop;
3690                     end if;
3691
3692                     Next (ASN1);
3693                  end loop;
3694
3695                  Prepend_List_To (Aspect_Specifications (N),
3696                    (New_Copy_List_Tree
3697                      (Aspect_Specifications (Gen_Spec))));
3698               end;
3699            end if;
3700         end if;
3701
3702         --  Save the instantiation node, for subsequent instantiation of the
3703         --  body, if there is one and we are generating code for the current
3704         --  unit. Mark unit as having a body (avoids premature error message).
3705
3706         --  We instantiate the body if we are generating code, if we are
3707         --  generating cross-reference information, or if we are building
3708         --  trees for ASIS use or GNATprove use.
3709
3710         declare
3711            Enclosing_Body_Present : Boolean := False;
3712            --  If the generic unit is not a compilation unit, then a body may
3713            --  be present in its parent even if none is required. We create a
3714            --  tentative pending instantiation for the body, which will be
3715            --  discarded if none is actually present.
3716
3717            Scop : Entity_Id;
3718
3719         begin
3720            if Scope (Gen_Unit) /= Standard_Standard
3721              and then not Is_Child_Unit (Gen_Unit)
3722            then
3723               Scop := Scope (Gen_Unit);
3724               while Present (Scop) and then Scop /= Standard_Standard loop
3725                  if Unit_Requires_Body (Scop) then
3726                     Enclosing_Body_Present := True;
3727                     exit;
3728
3729                  elsif In_Open_Scopes (Scop)
3730                    and then In_Package_Body (Scop)
3731                  then
3732                     Enclosing_Body_Present := True;
3733                     exit;
3734                  end if;
3735
3736                  exit when Is_Compilation_Unit (Scop);
3737                  Scop := Scope (Scop);
3738               end loop;
3739            end if;
3740
3741            --  If front-end inlining is enabled or there are any subprograms
3742            --  marked with Inline_Always, and this is a unit for which code
3743            --  will be generated, we instantiate the body at once.
3744
3745            --  This is done if the instance is not the main unit, and if the
3746            --  generic is not a child unit of another generic, to avoid scope
3747            --  problems and the reinstallation of parent instances.
3748
3749            if Expander_Active
3750              and then (not Is_Child_Unit (Gen_Unit)
3751                         or else not Is_Generic_Unit (Scope (Gen_Unit)))
3752              and then Might_Inline_Subp
3753              and then not Is_Actual_Pack
3754            then
3755               if not Back_End_Inlining
3756                 and then (Front_End_Inlining or else Has_Inline_Always)
3757                 and then (Is_In_Main_Unit (N)
3758                            or else In_Main_Context (Current_Scope))
3759                 and then Nkind (Parent (N)) /= N_Compilation_Unit
3760               then
3761                  Inline_Now := True;
3762
3763               --  In configurable_run_time mode we force the inlining of
3764               --  predefined subprograms marked Inline_Always, to minimize
3765               --  the use of the run-time library.
3766
3767               elsif Is_Predefined_File_Name
3768                       (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3769                 and then Configurable_Run_Time_Mode
3770                 and then Nkind (Parent (N)) /= N_Compilation_Unit
3771               then
3772                  Inline_Now := True;
3773               end if;
3774
3775               --  If the current scope is itself an instance within a child
3776               --  unit, there will be duplications in the scope stack, and the
3777               --  unstacking mechanism in Inline_Instance_Body will fail.
3778               --  This loses some rare cases of optimization, and might be
3779               --  improved some day, if we can find a proper abstraction for
3780               --  "the complete compilation context" that can be saved and
3781               --  restored. ???
3782
3783               if Is_Generic_Instance (Current_Scope) then
3784                  declare
3785                     Curr_Unit : constant Entity_Id :=
3786                                   Cunit_Entity (Current_Sem_Unit);
3787                  begin
3788                     if Curr_Unit /= Current_Scope
3789                       and then Is_Child_Unit (Curr_Unit)
3790                     then
3791                        Inline_Now := False;
3792                     end if;
3793                  end;
3794               end if;
3795            end if;
3796
3797            Needs_Body :=
3798              (Unit_Requires_Body (Gen_Unit)
3799                or else Enclosing_Body_Present
3800                or else Present (Corresponding_Body (Gen_Decl)))
3801               and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
3802               and then not Is_Actual_Pack
3803               and then not Inline_Now
3804               and then (Operating_Mode = Generate_Code
3805
3806                          --  Need comment for this check ???
3807
3808                          or else (Operating_Mode = Check_Semantics
3809                                    and then (ASIS_Mode or GNATprove_Mode)));
3810
3811            --  If front-end inlining is enabled or there are any subprograms
3812            --  marked with Inline_Always, do not instantiate body when within
3813            --  a generic context.
3814
3815            if ((Front_End_Inlining or else Has_Inline_Always)
3816                  and then not Expander_Active)
3817              or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3818            then
3819               Needs_Body := False;
3820            end if;
3821
3822            --  If the current context is generic, and the package being
3823            --  instantiated is declared within a formal package, there is no
3824            --  body to instantiate until the enclosing generic is instantiated
3825            --  and there is an actual for the formal package. If the formal
3826            --  package has parameters, we build a regular package instance for
3827            --  it, that precedes the original formal package declaration.
3828
3829            if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3830               declare
3831                  Decl : constant Node_Id :=
3832                           Original_Node
3833                             (Unit_Declaration_Node (Scope (Gen_Unit)));
3834               begin
3835                  if Nkind (Decl) = N_Formal_Package_Declaration
3836                    or else (Nkind (Decl) = N_Package_Declaration
3837                              and then Is_List_Member (Decl)
3838                              and then Present (Next (Decl))
3839                              and then
3840                                Nkind (Next (Decl)) =
3841                                                N_Formal_Package_Declaration)
3842                  then
3843                     Needs_Body := False;
3844                  end if;
3845               end;
3846            end if;
3847         end;
3848
3849         --  For RCI unit calling stubs, we omit the instance body if the
3850         --  instance is the RCI library unit itself.
3851
3852         --  However there is a special case for nested instances: in this case
3853         --  we do generate the instance body, as it might be required, e.g.
3854         --  because it provides stream attributes for some type used in the
3855         --  profile of a remote subprogram. This is consistent with 12.3(12),
3856         --  which indicates that the instance body occurs at the place of the
3857         --  instantiation, and thus is part of the RCI declaration, which is
3858         --  present on all client partitions (this is E.2.3(18)).
3859
3860         --  Note that AI12-0002 may make it illegal at some point to have
3861         --  stream attributes defined in an RCI unit, in which case this
3862         --  special case will become unnecessary. In the meantime, there
3863         --  is known application code in production that depends on this
3864         --  being possible, so we definitely cannot eliminate the body in
3865         --  the case of nested instances for the time being.
3866
3867         --  When we generate a nested instance body, calling stubs for any
3868         --  relevant subprogram will be be inserted immediately after the
3869         --  subprogram declarations, and will take precedence over the
3870         --  subsequent (original) body. (The stub and original body will be
3871         --  complete homographs, but this is permitted in an instance).
3872         --  (Could we do better and remove the original body???)
3873
3874         if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3875           and then Comes_From_Source (N)
3876           and then Nkind (Parent (N)) = N_Compilation_Unit
3877         then
3878            Needs_Body := False;
3879         end if;
3880
3881         if Needs_Body then
3882
3883            --  Here is a defence against a ludicrous number of instantiations
3884            --  caused by a circular set of instantiation attempts.
3885
3886            if Pending_Instantiations.Last > Maximum_Instantiations then
3887               Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3888               Error_Msg_N ("too many instantiations, exceeds max of^", N);
3889               Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3890               raise Unrecoverable_Error;
3891            end if;
3892
3893            --  Indicate that the enclosing scopes contain an instantiation,
3894            --  and that cleanup actions should be delayed until after the
3895            --  instance body is expanded.
3896
3897            Check_Forward_Instantiation (Gen_Decl);
3898            if Nkind (N) = N_Package_Instantiation then
3899               declare
3900                  Enclosing_Master : Entity_Id;
3901
3902               begin
3903                  --  Loop to search enclosing masters
3904
3905                  Enclosing_Master := Current_Scope;
3906                  Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3907                     if Ekind (Enclosing_Master) = E_Package then
3908                        if Is_Compilation_Unit (Enclosing_Master) then
3909                           if In_Package_Body (Enclosing_Master) then
3910                              Delay_Descriptors
3911                                (Body_Entity (Enclosing_Master));
3912                           else
3913                              Delay_Descriptors
3914                                (Enclosing_Master);
3915                           end if;
3916
3917                           exit Scope_Loop;
3918
3919                        else
3920                           Enclosing_Master := Scope (Enclosing_Master);
3921                        end if;
3922
3923                     elsif Is_Generic_Unit (Enclosing_Master)
3924                       or else Ekind (Enclosing_Master) = E_Void
3925                     then
3926                        --  Cleanup actions will eventually be performed on the
3927                        --  enclosing subprogram or package instance, if any.
3928                        --  Enclosing scope is void in the formal part of a
3929                        --  generic subprogram.
3930
3931                        exit Scope_Loop;
3932
3933                     else
3934                        if Ekind (Enclosing_Master) = E_Entry
3935                          and then
3936                            Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3937                        then
3938                           if not Expander_Active then
3939                              exit Scope_Loop;
3940                           else
3941                              Enclosing_Master :=
3942                                Protected_Body_Subprogram (Enclosing_Master);
3943                           end if;
3944                        end if;
3945
3946                        Set_Delay_Cleanups (Enclosing_Master);
3947
3948                        while Ekind (Enclosing_Master) = E_Block loop
3949                           Enclosing_Master := Scope (Enclosing_Master);
3950                        end loop;
3951
3952                        if Is_Subprogram (Enclosing_Master) then
3953                           Delay_Descriptors (Enclosing_Master);
3954
3955                        elsif Is_Task_Type (Enclosing_Master) then
3956                           declare
3957                              TBP : constant Node_Id :=
3958                                      Get_Task_Body_Procedure
3959                                        (Enclosing_Master);
3960                           begin
3961                              if Present (TBP) then
3962                                 Delay_Descriptors  (TBP);
3963                                 Set_Delay_Cleanups (TBP);
3964                              end if;
3965                           end;
3966                        end if;
3967
3968                        exit Scope_Loop;
3969                     end if;
3970                  end loop Scope_Loop;
3971               end;
3972
3973               --  Make entry in table
3974
3975               Pending_Instantiations.Append
3976                 ((Inst_Node                => N,
3977                   Act_Decl                 => Act_Decl,
3978                   Expander_Status          => Expander_Active,
3979                   Current_Sem_Unit         => Current_Sem_Unit,
3980                   Scope_Suppress           => Scope_Suppress,
3981                   Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3982                   Version                  => Ada_Version,
3983                   Version_Pragma           => Ada_Version_Pragma,
3984                   Warnings                 => Save_Warnings,
3985                   SPARK_Mode               => SPARK_Mode,
3986                   SPARK_Mode_Pragma        => SPARK_Mode_Pragma));
3987            end if;
3988         end if;
3989
3990         Set_Categorization_From_Pragmas (Act_Decl);
3991
3992         if Parent_Installed then
3993            Hide_Current_Scope;
3994         end if;
3995
3996         Set_Instance_Spec (N, Act_Decl);
3997
3998         --  If not a compilation unit, insert the package declaration before
3999         --  the original instantiation node.
4000
4001         if Nkind (Parent (N)) /= N_Compilation_Unit then
4002            Mark_Rewrite_Insertion (Act_Decl);
4003            Insert_Before (N, Act_Decl);
4004
4005            if Has_Aspects (N) then
4006               Analyze_Aspect_Specifications (N, Act_Decl_Id);
4007
4008               --  The pragma created for a Default_Storage_Pool aspect must
4009               --  appear ahead of the declarations in the instance spec.
4010               --  Analysis has placed it after the instance node, so remove
4011               --  it and reinsert it properly now.
4012
4013               declare
4014                  ASN : constant Node_Id := First (Aspect_Specifications (N));
4015                  A_Name : constant Name_Id := Chars (Identifier (ASN));
4016                  Decl : Node_Id;
4017
4018               begin
4019                  if A_Name = Name_Default_Storage_Pool then
4020                     if No (Visible_Declarations (Act_Spec)) then
4021                        Set_Visible_Declarations (Act_Spec, New_List);
4022                     end if;
4023
4024                     Decl := Next (N);
4025                     while Present (Decl) loop
4026                        if Nkind (Decl) = N_Pragma then
4027                           Remove (Decl);
4028                           Prepend (Decl, Visible_Declarations (Act_Spec));
4029                           exit;
4030                        end if;
4031
4032                        Next (Decl);
4033                     end loop;
4034                  end if;
4035               end;
4036            end if;
4037
4038            Analyze (Act_Decl);
4039
4040         --  For an instantiation that is a compilation unit, place
4041         --  declaration on current node so context is complete for analysis
4042         --  (including nested instantiations). If this is the main unit,
4043         --  the declaration eventually replaces the instantiation node.
4044         --  If the instance body is created later, it replaces the
4045         --  instance node, and the declaration is attached to it
4046         --  (see Build_Instance_Compilation_Unit_Nodes).
4047
4048         else
4049            if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
4050
4051               --  The entity for the current unit is the newly created one,
4052               --  and all semantic information is attached to it.
4053
4054               Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
4055
4056               --  If this is the main unit, replace the main entity as well
4057
4058               if Current_Sem_Unit = Main_Unit then
4059                  Main_Unit_Entity := Act_Decl_Id;
4060               end if;
4061            end if;
4062
4063            Set_Unit (Parent (N), Act_Decl);
4064            Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4065            Set_Package_Instantiation (Act_Decl_Id, N);
4066
4067            --  Process aspect specifications of the instance node, if any, to
4068            --  take into account categorization pragmas before analyzing the
4069            --  instance.
4070
4071            if Has_Aspects (N) then
4072               Analyze_Aspect_Specifications (N, Act_Decl_Id);
4073            end if;
4074
4075            Analyze (Act_Decl);
4076            Set_Unit (Parent (N), N);
4077            Set_Body_Required (Parent (N), False);
4078
4079            --  We never need elaboration checks on instantiations, since by
4080            --  definition, the body instantiation is elaborated at the same
4081            --  time as the spec instantiation.
4082
4083            Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4084            Set_Kill_Elaboration_Checks       (Act_Decl_Id);
4085         end if;
4086
4087         Check_Elab_Instantiation (N);
4088
4089         if ABE_Is_Certain (N) and then Needs_Body then
4090            Pending_Instantiations.Decrement_Last;
4091         end if;
4092
4093         Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4094
4095         Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
4096           First_Private_Entity (Act_Decl_Id));
4097
4098         --  If the instantiation will receive a body, the unit will be
4099         --  transformed into a package body, and receive its own elaboration
4100         --  entity. Otherwise, the nature of the unit is now a package
4101         --  declaration.
4102
4103         if Nkind (Parent (N)) = N_Compilation_Unit
4104           and then not Needs_Body
4105         then
4106            Rewrite (N, Act_Decl);
4107         end if;
4108
4109         if Present (Corresponding_Body (Gen_Decl))
4110           or else Unit_Requires_Body (Gen_Unit)
4111         then
4112            Set_Has_Completion (Act_Decl_Id);
4113         end if;
4114
4115         Check_Formal_Packages (Act_Decl_Id);
4116
4117         Restore_Hidden_Primitives (Vis_Prims_List);
4118         Restore_Private_Views (Act_Decl_Id);
4119
4120         Inherit_Context (Gen_Decl, N);
4121
4122         if Parent_Installed then
4123            Remove_Parent;
4124         end if;
4125
4126         Restore_Env;
4127         Env_Installed := False;
4128      end if;
4129
4130      Validate_Categorization_Dependency (N, Act_Decl_Id);
4131
4132      --  There used to be a check here to prevent instantiations in local
4133      --  contexts if the No_Local_Allocators restriction was active. This
4134      --  check was removed by a binding interpretation in AI-95-00130/07,
4135      --  but we retain the code for documentation purposes.
4136
4137      --  if Ekind (Act_Decl_Id) /= E_Void
4138      --    and then not Is_Library_Level_Entity (Act_Decl_Id)
4139      --  then
4140      --     Check_Restriction (No_Local_Allocators, N);
4141      --  end if;
4142
4143      if Inline_Now then
4144         Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4145      end if;
4146
4147      --  The following is a tree patch for ASIS: ASIS needs separate nodes to
4148      --  be used as defining identifiers for a formal package and for the
4149      --  corresponding expanded package.
4150
4151      if Nkind (N) = N_Formal_Package_Declaration then
4152         Act_Decl_Id := New_Copy (Defining_Entity (N));
4153         Set_Comes_From_Source (Act_Decl_Id, True);
4154         Set_Is_Generic_Instance (Act_Decl_Id, False);
4155         Set_Defining_Identifier (N, Act_Decl_Id);
4156      end if;
4157
4158      Ignore_Pragma_SPARK_Mode := Save_IPSM;
4159      SPARK_Mode               := Save_SM;
4160      SPARK_Mode_Pragma        := Save_SMP;
4161      Style_Check              := Save_Style_Check;
4162
4163      if SPARK_Mode = On then
4164         Dynamic_Elaboration_Checks := False;
4165      end if;
4166
4167      --  Check that if N is an instantiation of System.Dim_Float_IO or
4168      --  System.Dim_Integer_IO, the formal type has a dimension system.
4169
4170      if Nkind (N) = N_Package_Instantiation
4171        and then Is_Dim_IO_Package_Instantiation (N)
4172      then
4173         declare
4174            Assoc : constant Node_Id := First (Generic_Associations (N));
4175         begin
4176            if not Has_Dimension_System
4177                     (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4178            then
4179               Error_Msg_N ("type with a dimension system expected", Assoc);
4180            end if;
4181         end;
4182      end if;
4183
4184   <<Leave>>
4185      if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4186         Analyze_Aspect_Specifications (N, Act_Decl_Id);
4187      end if;
4188
4189   exception
4190      when Instantiation_Error =>
4191         if Parent_Installed then
4192            Remove_Parent;
4193         end if;
4194
4195         if Env_Installed then
4196            Restore_Env;
4197         end if;
4198
4199         Ignore_Pragma_SPARK_Mode := Save_IPSM;
4200         SPARK_Mode               := Save_SM;
4201         SPARK_Mode_Pragma        := Save_SMP;
4202         Style_Check              := Save_Style_Check;
4203
4204         if SPARK_Mode = On then
4205            Dynamic_Elaboration_Checks := False;
4206         end if;
4207   end Analyze_Package_Instantiation;
4208
4209   --------------------------
4210   -- Inline_Instance_Body --
4211   --------------------------
4212
4213   procedure Inline_Instance_Body
4214     (N        : Node_Id;
4215      Gen_Unit : Entity_Id;
4216      Act_Decl : Node_Id)
4217   is
4218      Curr_Comp : constant Node_Id   := Cunit (Current_Sem_Unit);
4219      Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4220      Gen_Comp  : constant Entity_Id :=
4221                    Cunit_Entity (Get_Source_Unit (Gen_Unit));
4222
4223      Save_SM  : constant SPARK_Mode_Type := SPARK_Mode;
4224      Save_SMP : constant Node_Id         := SPARK_Mode_Pragma;
4225      --  Save all SPARK_Mode-related attributes as removing enclosing scopes
4226      --  to provide a clean environment for analysis of the inlined body will
4227      --  eliminate any previously set SPARK_Mode.
4228
4229      Scope_Stack_Depth : constant Int :=
4230                            Scope_Stack.Last - Scope_Stack.First + 1;
4231
4232      Use_Clauses  : array (1 .. Scope_Stack_Depth) of Node_Id;
4233      Instances    : array (1 .. Scope_Stack_Depth) of Entity_Id;
4234      Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4235      Curr_Scope   : Entity_Id := Empty;
4236      List         : Elist_Id;
4237      Num_Inner    : Int := 0;
4238      Num_Scopes   : Int := 0;
4239      N_Instances  : Int := 0;
4240      Removed      : Boolean := False;
4241      S            : Entity_Id;
4242      Vis          : Boolean;
4243
4244   begin
4245      --  Case of generic unit defined in another unit. We must remove the
4246      --  complete context of the current unit to install that of the generic.
4247
4248      if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4249
4250         --  Add some comments for the following two loops ???
4251
4252         S := Current_Scope;
4253         while Present (S) and then S /= Standard_Standard loop
4254            loop
4255               Num_Scopes := Num_Scopes + 1;
4256
4257               Use_Clauses (Num_Scopes) :=
4258                 (Scope_Stack.Table
4259                    (Scope_Stack.Last - Num_Scopes + 1).
4260                       First_Use_Clause);
4261               End_Use_Clauses (Use_Clauses (Num_Scopes));
4262
4263               exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4264                 or else Scope_Stack.Table
4265                           (Scope_Stack.Last - Num_Scopes).Entity = Scope (S);
4266            end loop;
4267
4268            exit when Is_Generic_Instance (S)
4269              and then (In_Package_Body (S)
4270                         or else Ekind (S) = E_Procedure
4271                         or else Ekind (S) = E_Function);
4272            S := Scope (S);
4273         end loop;
4274
4275         Vis := Is_Immediately_Visible (Gen_Comp);
4276
4277         --  Find and save all enclosing instances
4278
4279         S := Current_Scope;
4280
4281         while Present (S)
4282           and then S /= Standard_Standard
4283         loop
4284            if Is_Generic_Instance (S) then
4285               N_Instances := N_Instances + 1;
4286               Instances (N_Instances) := S;
4287
4288               exit when In_Package_Body (S);
4289            end if;
4290
4291            S := Scope (S);
4292         end loop;
4293
4294         --  Remove context of current compilation unit, unless we are within a
4295         --  nested package instantiation, in which case the context has been
4296         --  removed previously.
4297
4298         --  If current scope is the body of a child unit, remove context of
4299         --  spec as well. If an enclosing scope is an instance body, the
4300         --  context has already been removed, but the entities in the body
4301         --  must be made invisible as well.
4302
4303         S := Current_Scope;
4304         while Present (S) and then S /= Standard_Standard loop
4305            if Is_Generic_Instance (S)
4306              and then (In_Package_Body (S)
4307                         or else Ekind_In (S, E_Procedure, E_Function))
4308            then
4309               --  We still have to remove the entities of the enclosing
4310               --  instance from direct visibility.
4311
4312               declare
4313                  E : Entity_Id;
4314               begin
4315                  E := First_Entity (S);
4316                  while Present (E) loop
4317                     Set_Is_Immediately_Visible (E, False);
4318                     Next_Entity (E);
4319                  end loop;
4320               end;
4321
4322               exit;
4323            end if;
4324
4325            if S = Curr_Unit
4326              or else (Ekind (Curr_Unit) = E_Package_Body
4327                        and then S = Spec_Entity (Curr_Unit))
4328              or else (Ekind (Curr_Unit) = E_Subprogram_Body
4329                        and then S = Corresponding_Spec
4330                                       (Unit_Declaration_Node (Curr_Unit)))
4331            then
4332               Removed := True;
4333
4334               --  Remove entities in current scopes from visibility, so that
4335               --  instance body is compiled in a clean environment.
4336
4337               List := Save_Scope_Stack (Handle_Use => False);
4338
4339               if Is_Child_Unit (S) then
4340
4341                  --  Remove child unit from stack, as well as inner scopes.
4342                  --  Removing the context of a child unit removes parent units
4343                  --  as well.
4344
4345                  while Current_Scope /= S loop
4346                     Num_Inner := Num_Inner + 1;
4347                     Inner_Scopes (Num_Inner) := Current_Scope;
4348                     Pop_Scope;
4349                  end loop;
4350
4351                  Pop_Scope;
4352                  Remove_Context (Curr_Comp);
4353                  Curr_Scope := S;
4354
4355               else
4356                  Remove_Context (Curr_Comp);
4357               end if;
4358
4359               if Ekind (Curr_Unit) = E_Package_Body then
4360                  Remove_Context (Library_Unit (Curr_Comp));
4361               end if;
4362            end if;
4363
4364            S := Scope (S);
4365         end loop;
4366
4367         pragma Assert (Num_Inner < Num_Scopes);
4368
4369         --  The inlined package body must be analyzed with the SPARK_Mode of
4370         --  the enclosing context, otherwise the body may cause bogus errors
4371         --  if a configuration SPARK_Mode pragma in in effect.
4372
4373         Push_Scope (Standard_Standard);
4374         Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4375         Instantiate_Package_Body
4376           (Body_Info =>
4377             ((Inst_Node                => N,
4378               Act_Decl                 => Act_Decl,
4379               Expander_Status          => Expander_Active,
4380               Current_Sem_Unit         => Current_Sem_Unit,
4381               Scope_Suppress           => Scope_Suppress,
4382               Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4383               Version                  => Ada_Version,
4384               Version_Pragma           => Ada_Version_Pragma,
4385               Warnings                 => Save_Warnings,
4386               SPARK_Mode               => Save_SM,
4387               SPARK_Mode_Pragma        => Save_SMP)),
4388            Inlined_Body => True);
4389
4390         Pop_Scope;
4391
4392         --  Restore context
4393
4394         Set_Is_Immediately_Visible (Gen_Comp, Vis);
4395
4396         --  Reset Generic_Instance flag so that use clauses can be installed
4397         --  in the proper order. (See Use_One_Package for effect of enclosing
4398         --  instances on processing of use clauses).
4399
4400         for J in 1 .. N_Instances loop
4401            Set_Is_Generic_Instance (Instances (J), False);
4402         end loop;
4403
4404         if Removed then
4405            Install_Context (Curr_Comp);
4406
4407            if Present (Curr_Scope)
4408              and then Is_Child_Unit (Curr_Scope)
4409            then
4410               Push_Scope (Curr_Scope);
4411               Set_Is_Immediately_Visible (Curr_Scope);
4412
4413               --  Finally, restore inner scopes as well
4414
4415               for J in reverse 1 .. Num_Inner loop
4416                  Push_Scope (Inner_Scopes (J));
4417               end loop;
4418            end if;
4419
4420            Restore_Scope_Stack (List, Handle_Use => False);
4421
4422            if Present (Curr_Scope)
4423              and then
4424                (In_Private_Part (Curr_Scope)
4425                  or else In_Package_Body (Curr_Scope))
4426            then
4427               --  Install private declaration of ancestor units, which are
4428               --  currently available. Restore_Scope_Stack and Install_Context
4429               --  only install the visible part of parents.
4430
4431               declare
4432                  Par : Entity_Id;
4433               begin
4434                  Par := Scope (Curr_Scope);
4435                  while (Present (Par)) and then Par /= Standard_Standard loop
4436                     Install_Private_Declarations (Par);
4437                     Par := Scope (Par);
4438                  end loop;
4439               end;
4440            end if;
4441         end if;
4442
4443         --  Restore use clauses. For a child unit, use clauses in the parents
4444         --  are restored when installing the context, so only those in inner
4445         --  scopes (and those local to the child unit itself) need to be
4446         --  installed explicitly.
4447
4448         if Is_Child_Unit (Curr_Unit) and then Removed then
4449            for J in reverse 1 .. Num_Inner + 1 loop
4450               Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4451                 Use_Clauses (J);
4452               Install_Use_Clauses (Use_Clauses (J));
4453            end  loop;
4454
4455         else
4456            for J in reverse 1 .. Num_Scopes loop
4457               Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4458                 Use_Clauses (J);
4459               Install_Use_Clauses (Use_Clauses (J));
4460            end  loop;
4461         end if;
4462
4463         --  Restore status of instances. If one of them is a body, make its
4464         --  local entities visible again.
4465
4466         declare
4467            E    : Entity_Id;
4468            Inst : Entity_Id;
4469
4470         begin
4471            for J in 1 .. N_Instances loop
4472               Inst := Instances (J);
4473               Set_Is_Generic_Instance (Inst, True);
4474
4475               if In_Package_Body (Inst)
4476                 or else Ekind_In (S, E_Procedure, E_Function)
4477               then
4478                  E := First_Entity (Instances (J));
4479                  while Present (E) loop
4480                     Set_Is_Immediately_Visible (E);
4481                     Next_Entity (E);
4482                  end loop;
4483               end if;
4484            end loop;
4485         end;
4486
4487      --  If generic unit is in current unit, current context is correct. Note
4488      --  that the context is guaranteed to carry the correct SPARK_Mode as no
4489      --  enclosing scopes were removed.
4490
4491      else
4492         Instantiate_Package_Body
4493           (Body_Info =>
4494             ((Inst_Node                => N,
4495               Act_Decl                 => Act_Decl,
4496               Expander_Status          => Expander_Active,
4497               Current_Sem_Unit         => Current_Sem_Unit,
4498               Scope_Suppress           => Scope_Suppress,
4499               Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4500               Version                  => Ada_Version,
4501               Version_Pragma           => Ada_Version_Pragma,
4502               Warnings                 => Save_Warnings,
4503               SPARK_Mode               => SPARK_Mode,
4504               SPARK_Mode_Pragma        => SPARK_Mode_Pragma)),
4505            Inlined_Body => True);
4506      end if;
4507   end Inline_Instance_Body;
4508
4509   -------------------------------------
4510   -- Analyze_Procedure_Instantiation --
4511   -------------------------------------
4512
4513   procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4514   begin
4515      Analyze_Subprogram_Instantiation (N, E_Procedure);
4516   end Analyze_Procedure_Instantiation;
4517
4518   -----------------------------------
4519   -- Need_Subprogram_Instance_Body --
4520   -----------------------------------
4521
4522   function Need_Subprogram_Instance_Body
4523     (N    : Node_Id;
4524      Subp : Entity_Id) return Boolean
4525   is
4526   begin
4527      --  Must be inlined (or inlined renaming)
4528
4529      if (Is_In_Main_Unit (N)
4530           or else Is_Inlined (Subp)
4531           or else Is_Inlined (Alias (Subp)))
4532
4533        --  Must be generating code or analyzing code in ASIS/GNATprove mode
4534
4535        and then (Operating_Mode = Generate_Code
4536                   or else (Operating_Mode = Check_Semantics
4537                             and then (ASIS_Mode or GNATprove_Mode)))
4538
4539        --  The body is needed when generating code (full expansion), in ASIS
4540        --  mode for other tools, and in GNATprove mode (special expansion) for
4541        --  formal verification of the body itself.
4542
4543        and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4544
4545        --  No point in inlining if ABE is inevitable
4546
4547        and then not ABE_Is_Certain (N)
4548
4549        --  Or if subprogram is eliminated
4550
4551        and then not Is_Eliminated (Subp)
4552      then
4553         Pending_Instantiations.Append
4554           ((Inst_Node                => N,
4555             Act_Decl                 => Unit_Declaration_Node (Subp),
4556             Expander_Status          => Expander_Active,
4557             Current_Sem_Unit         => Current_Sem_Unit,
4558             Scope_Suppress           => Scope_Suppress,
4559             Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4560             Version                  => Ada_Version,
4561             Version_Pragma           => Ada_Version_Pragma,
4562             Warnings                 => Save_Warnings,
4563             SPARK_Mode               => SPARK_Mode,
4564             SPARK_Mode_Pragma        => SPARK_Mode_Pragma));
4565         return True;
4566
4567      --  Here if not inlined, or we ignore the inlining
4568
4569      else
4570         return False;
4571      end if;
4572   end Need_Subprogram_Instance_Body;
4573
4574   --------------------------------------
4575   -- Analyze_Subprogram_Instantiation --
4576   --------------------------------------
4577
4578   procedure Analyze_Subprogram_Instantiation
4579     (N : Node_Id;
4580      K : Entity_Kind)
4581   is
4582      Loc    : constant Source_Ptr := Sloc (N);
4583      Gen_Id : constant Node_Id    := Name (N);
4584
4585      Anon_Id : constant Entity_Id :=
4586                  Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4587                    Chars => New_External_Name
4588                               (Chars (Defining_Entity (N)), 'R'));
4589
4590      Act_Decl_Id : Entity_Id;
4591      Act_Decl    : Node_Id;
4592      Act_Spec    : Node_Id;
4593      Act_Tree    : Node_Id;
4594
4595      Env_Installed    : Boolean := False;
4596      Gen_Unit         : Entity_Id;
4597      Gen_Decl         : Node_Id;
4598      Pack_Id          : Entity_Id;
4599      Parent_Installed : Boolean := False;
4600
4601      Renaming_List : List_Id;
4602      --  The list of declarations that link formals and actuals of the
4603      --  instance. These are subtype declarations for formal types, and
4604      --  renaming declarations for other formals. The subprogram declaration
4605      --  for the instance is then appended to the list, and the last item on
4606      --  the list is the renaming declaration for the instance.
4607
4608      procedure Analyze_Instance_And_Renamings;
4609      --  The instance must be analyzed in a context that includes the mappings
4610      --  of generic parameters into actuals. We create a package declaration
4611      --  for this purpose, and a subprogram with an internal name within the
4612      --  package. The subprogram instance is simply an alias for the internal
4613      --  subprogram, declared in the current scope.
4614
4615      procedure Build_Subprogram_Renaming;
4616      --  If the subprogram is recursive, there are occurrences of the name of
4617      --  the generic within the body, which must resolve to the current
4618      --  instance. We add a renaming declaration after the declaration, which
4619      --  is available in the instance body, as well as in the analysis of
4620      --  aspects that appear in the generic. This renaming declaration is
4621      --  inserted after the instance declaration which it renames.
4622
4623      procedure Instantiate_Contract (Subp_Id : Entity_Id);
4624      --  Instantiate all source pragmas found in the contract of subprogram
4625      --  Subp_Id. The instantiated pragmas are added to list Renaming_List.
4626
4627      ------------------------------------
4628      -- Analyze_Instance_And_Renamings --
4629      ------------------------------------
4630
4631      procedure Analyze_Instance_And_Renamings is
4632         Def_Ent   : constant Entity_Id := Defining_Entity (N);
4633         Pack_Decl : Node_Id;
4634
4635      begin
4636         if Nkind (Parent (N)) = N_Compilation_Unit then
4637
4638            --  For the case of a compilation unit, the container package has
4639            --  the same name as the instantiation, to insure that the binder
4640            --  calls the elaboration procedure with the right name. Copy the
4641            --  entity of the instance, which may have compilation level flags
4642            --  (e.g. Is_Child_Unit) set.
4643
4644            Pack_Id := New_Copy (Def_Ent);
4645
4646         else
4647            --  Otherwise we use the name of the instantiation concatenated
4648            --  with its source position to ensure uniqueness if there are
4649            --  several instantiations with the same name.
4650
4651            Pack_Id :=
4652              Make_Defining_Identifier (Loc,
4653                Chars => New_External_Name
4654                           (Related_Id   => Chars (Def_Ent),
4655                            Suffix       => "GP",
4656                            Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4657         end if;
4658
4659         Pack_Decl :=
4660           Make_Package_Declaration (Loc,
4661             Specification => Make_Package_Specification (Loc,
4662               Defining_Unit_Name   => Pack_Id,
4663               Visible_Declarations => Renaming_List,
4664               End_Label            => Empty));
4665
4666         Set_Instance_Spec (N, Pack_Decl);
4667         Set_Is_Generic_Instance (Pack_Id);
4668         Set_Debug_Info_Needed (Pack_Id);
4669
4670         --  Case of not a compilation unit
4671
4672         if Nkind (Parent (N)) /= N_Compilation_Unit then
4673            Mark_Rewrite_Insertion (Pack_Decl);
4674            Insert_Before (N, Pack_Decl);
4675            Set_Has_Completion (Pack_Id);
4676
4677         --  Case of an instantiation that is a compilation unit
4678
4679         --  Place declaration on current node so context is complete for
4680         --  analysis (including nested instantiations), and for use in a
4681         --  context_clause (see Analyze_With_Clause).
4682
4683         else
4684            Set_Unit (Parent (N), Pack_Decl);
4685            Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4686         end if;
4687
4688         Analyze (Pack_Decl);
4689         Check_Formal_Packages (Pack_Id);
4690         Set_Is_Generic_Instance (Pack_Id, False);
4691
4692         --  Why do we clear Is_Generic_Instance??? We set it 20 lines
4693         --  above???
4694
4695         --  Body of the enclosing package is supplied when instantiating the
4696         --  subprogram body, after semantic analysis is completed.
4697
4698         if Nkind (Parent (N)) = N_Compilation_Unit then
4699
4700            --  Remove package itself from visibility, so it does not
4701            --  conflict with subprogram.
4702
4703            Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4704
4705            --  Set name and scope of internal subprogram so that the proper
4706            --  external name will be generated. The proper scope is the scope
4707            --  of the wrapper package. We need to generate debugging info for
4708            --  the internal subprogram, so set flag accordingly.
4709
4710            Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4711            Set_Scope (Anon_Id, Scope (Pack_Id));
4712
4713            --  Mark wrapper package as referenced, to avoid spurious warnings
4714            --  if the instantiation appears in various with_ clauses of
4715            --  subunits of the main unit.
4716
4717            Set_Referenced (Pack_Id);
4718         end if;
4719
4720         Set_Is_Generic_Instance (Anon_Id);
4721         Set_Debug_Info_Needed   (Anon_Id);
4722         Act_Decl_Id := New_Copy (Anon_Id);
4723
4724         Set_Parent            (Act_Decl_Id, Parent (Anon_Id));
4725         Set_Chars             (Act_Decl_Id, Chars (Defining_Entity (N)));
4726         Set_Sloc              (Act_Decl_Id, Sloc (Defining_Entity (N)));
4727
4728         --  Subprogram instance comes from source only if generic does
4729
4730         Set_Comes_From_Source (Act_Decl_Id, Comes_From_Source (Gen_Unit));
4731
4732         --  The signature may involve types that are not frozen yet, but the
4733         --  subprogram will be frozen at the point the wrapper package is
4734         --  frozen, so it does not need its own freeze node. In fact, if one
4735         --  is created, it might conflict with the freezing actions from the
4736         --  wrapper package.
4737
4738         Set_Has_Delayed_Freeze (Anon_Id, False);
4739
4740         --  If the instance is a child unit, mark the Id accordingly. Mark
4741         --  the anonymous entity as well, which is the real subprogram and
4742         --  which is used when the instance appears in a context clause.
4743         --  Similarly, propagate the Is_Eliminated flag to handle properly
4744         --  nested eliminated subprograms.
4745
4746         Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4747         Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4748         New_Overloaded_Entity (Act_Decl_Id);
4749         Check_Eliminated  (Act_Decl_Id);
4750         Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4751
4752         --  In compilation unit case, kill elaboration checks on the
4753         --  instantiation, since they are never needed -- the body is
4754         --  instantiated at the same point as the spec.
4755
4756         if Nkind (Parent (N)) = N_Compilation_Unit then
4757            Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4758            Set_Kill_Elaboration_Checks       (Act_Decl_Id);
4759            Set_Is_Compilation_Unit (Anon_Id);
4760
4761            Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4762         end if;
4763
4764         --  The instance is not a freezing point for the new subprogram
4765
4766         Set_Is_Frozen (Act_Decl_Id, False);
4767
4768         if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4769            Valid_Operator_Definition (Act_Decl_Id);
4770         end if;
4771
4772         Set_Alias  (Act_Decl_Id, Anon_Id);
4773         Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4774         Set_Has_Completion (Act_Decl_Id);
4775         Set_Related_Instance (Pack_Id, Act_Decl_Id);
4776
4777         if Nkind (Parent (N)) = N_Compilation_Unit then
4778            Set_Body_Required (Parent (N), False);
4779         end if;
4780      end Analyze_Instance_And_Renamings;
4781
4782      -------------------------------
4783      -- Build_Subprogram_Renaming --
4784      -------------------------------
4785
4786      procedure Build_Subprogram_Renaming is
4787         Renaming_Decl : Node_Id;
4788         Unit_Renaming : Node_Id;
4789
4790      begin
4791         Unit_Renaming :=
4792           Make_Subprogram_Renaming_Declaration (Loc,
4793             Specification =>
4794               Copy_Generic_Node
4795                 (Specification (Original_Node (Gen_Decl)),
4796                  Empty,
4797                  Instantiating => True),
4798             Name          => New_Occurrence_Of (Anon_Id, Loc));
4799
4800         --  The generic may be a a child unit. The renaming needs an
4801         --  identifier with the proper name.
4802
4803         Set_Defining_Unit_Name (Specification (Unit_Renaming),
4804            Make_Defining_Identifier (Loc, Chars (Gen_Unit)));
4805
4806         --  If there is a formal subprogram with the same name as the unit
4807         --  itself, do not add this renaming declaration, to prevent
4808         --  ambiguities when there is a call with that name in the body.
4809         --  This is a partial and ugly fix for one ACATS test. ???
4810
4811         Renaming_Decl := First (Renaming_List);
4812         while Present (Renaming_Decl) loop
4813            if Nkind (Renaming_Decl) = N_Subprogram_Renaming_Declaration
4814              and then
4815                Chars (Defining_Entity (Renaming_Decl)) = Chars (Gen_Unit)
4816            then
4817               exit;
4818            end if;
4819
4820            Next (Renaming_Decl);
4821         end loop;
4822
4823         if No (Renaming_Decl) then
4824            Append  (Unit_Renaming, Renaming_List);
4825         end if;
4826      end Build_Subprogram_Renaming;
4827
4828      --------------------------
4829      -- Instantiate_Contract --
4830      --------------------------
4831
4832      procedure Instantiate_Contract (Subp_Id : Entity_Id) is
4833         procedure Instantiate_Pragmas (First_Prag : Node_Id);
4834         --  Instantiate all contract-related source pragmas found in the list
4835         --  starting with pragma First_Prag. Each instantiated pragma is added
4836         --  to list Renaming_List.
4837
4838         -------------------------
4839         -- Instantiate_Pragmas --
4840         -------------------------
4841
4842         procedure Instantiate_Pragmas (First_Prag : Node_Id) is
4843            Inst_Prag : Node_Id;
4844            Prag      : Node_Id;
4845
4846         begin
4847            Prag := First_Prag;
4848            while Present (Prag) loop
4849               if Comes_From_Source (Prag)
4850                 and then Nam_In (Pragma_Name (Prag), Name_Contract_Cases,
4851                                                      Name_Depends,
4852                                                      Name_Extensions_Visible,
4853                                                      Name_Global,
4854                                                      Name_Postcondition,
4855                                                      Name_Precondition,
4856                                                      Name_Test_Case)
4857               then
4858                  Inst_Prag :=
4859                    Copy_Generic_Node
4860                      (Original_Node (Prag), Empty, Instantiating => True);
4861
4862                  Set_Analyzed (Inst_Prag, False);
4863                  Append_To (Renaming_List, Inst_Prag);
4864               end if;
4865
4866               Prag := Next_Pragma (Prag);
4867            end loop;
4868         end Instantiate_Pragmas;
4869
4870         --  Local variables
4871
4872         Items : constant Node_Id := Contract (Subp_Id);
4873
4874      --  Start of processing for Instantiate_Contract
4875
4876      begin
4877         if Present (Items) then
4878            Instantiate_Pragmas (Pre_Post_Conditions (Items));
4879            Instantiate_Pragmas (Contract_Test_Cases (Items));
4880            Instantiate_Pragmas (Classifications     (Items));
4881         end if;
4882      end Instantiate_Contract;
4883
4884      --  Local variables
4885
4886      Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
4887      --  Save flag Ignore_Pragma_SPARK_Mode for restore on exit
4888
4889      Save_SM  : constant SPARK_Mode_Type := SPARK_Mode;
4890      Save_SMP : constant Node_Id         := SPARK_Mode_Pragma;
4891      --  Save the SPARK_Mode-related data for restore on exit
4892
4893      Vis_Prims_List : Elist_Id := No_Elist;
4894      --  List of primitives made temporarily visible in the instantiation
4895      --  to match the visibility of the formal type
4896
4897   --  Start of processing for Analyze_Subprogram_Instantiation
4898
4899   begin
4900      Check_SPARK_05_Restriction ("generic is not allowed", N);
4901
4902      --  Very first thing: check for special Text_IO unit in case we are
4903      --  instantiating one of the children of [[Wide_]Wide_]Text_IO. Of course
4904      --  such an instantiation is bogus (these are packages, not subprograms),
4905      --  but we get a better error message if we do this.
4906
4907      Check_Text_IO_Special_Unit (Gen_Id);
4908
4909      --  Make node global for error reporting
4910
4911      Instantiation_Node := N;
4912
4913      --  For package instantiations we turn off style checks, because they
4914      --  will have been emitted in the generic. For subprogram instantiations
4915      --  we want to apply at least the check on overriding indicators so we
4916      --  do not modify the style check status.
4917
4918      --  The renaming declarations for the actuals do not come from source and
4919      --  will not generate spurious warnings.
4920
4921      Preanalyze_Actuals (N);
4922
4923      Init_Env;
4924      Env_Installed := True;
4925      Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4926      Gen_Unit := Entity (Gen_Id);
4927
4928      Generate_Reference (Gen_Unit, Gen_Id);
4929
4930      if Nkind (Gen_Id) = N_Identifier
4931        and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4932      then
4933         Error_Msg_NE
4934           ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4935      end if;
4936
4937      if Etype (Gen_Unit) = Any_Type then
4938         Restore_Env;
4939         return;
4940      end if;
4941
4942      --  Verify that it is a generic subprogram of the right kind, and that
4943      --  it does not lead to a circular instantiation.
4944
4945      if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
4946         Error_Msg_NE
4947           ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
4948
4949      elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
4950         Error_Msg_NE
4951           ("& is not the name of a generic function", Gen_Id, Gen_Unit);
4952
4953      elsif In_Open_Scopes (Gen_Unit) then
4954         Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4955
4956      else
4957         --  If the context of the instance is subject to SPARK_Mode "off",
4958         --  set the global flag which signals Analyze_Pragma to ignore all
4959         --  SPARK_Mode pragmas within the instance.
4960
4961         if SPARK_Mode = Off then
4962            Ignore_Pragma_SPARK_Mode := True;
4963         end if;
4964
4965         Set_Entity (Gen_Id, Gen_Unit);
4966         Set_Is_Instantiated (Gen_Unit);
4967
4968         if In_Extended_Main_Source_Unit (N) then
4969            Generate_Reference (Gen_Unit, N);
4970         end if;
4971
4972         --  If renaming, get original unit
4973
4974         if Present (Renamed_Object (Gen_Unit))
4975           and then Ekind_In (Renamed_Object (Gen_Unit), E_Generic_Procedure,
4976                                                         E_Generic_Function)
4977         then
4978            Gen_Unit := Renamed_Object (Gen_Unit);
4979            Set_Is_Instantiated (Gen_Unit);
4980            Generate_Reference  (Gen_Unit, N);
4981         end if;
4982
4983         if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4984            Error_Msg_Node_2 := Current_Scope;
4985            Error_Msg_NE
4986              ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4987            Circularity_Detected := True;
4988            Restore_Hidden_Primitives (Vis_Prims_List);
4989            goto Leave;
4990         end if;
4991
4992         Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4993
4994         --  Initialize renamings map, for error checking
4995
4996         Generic_Renamings.Set_Last (0);
4997         Generic_Renamings_HTable.Reset;
4998
4999         Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
5000
5001         --  Copy original generic tree, to produce text for instantiation
5002
5003         Act_Tree :=
5004           Copy_Generic_Node
5005             (Original_Node (Gen_Decl), Empty, Instantiating => True);
5006
5007         --  Inherit overriding indicator from instance node
5008
5009         Act_Spec := Specification (Act_Tree);
5010         Set_Must_Override     (Act_Spec, Must_Override (N));
5011         Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
5012
5013         Renaming_List :=
5014           Analyze_Associations
5015             (I_Node  => N,
5016              Formals => Generic_Formal_Declarations (Act_Tree),
5017              F_Copy  => Generic_Formal_Declarations (Gen_Decl));
5018
5019         Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
5020
5021         --  The subprogram itself cannot contain a nested instance, so the
5022         --  current parent is left empty.
5023
5024         Set_Instance_Env (Gen_Unit, Empty);
5025
5026         --  Build the subprogram declaration, which does not appear in the
5027         --  generic template, and give it a sloc consistent with that of the
5028         --  template.
5029
5030         Set_Defining_Unit_Name (Act_Spec, Anon_Id);
5031         Set_Generic_Parent (Act_Spec, Gen_Unit);
5032         Act_Decl :=
5033           Make_Subprogram_Declaration (Sloc (Act_Spec),
5034             Specification => Act_Spec);
5035
5036         --  The aspects have been copied previously, but they have to be
5037         --  linked explicitly to the new subprogram declaration. Explicit
5038         --  pre/postconditions on the instance are analyzed below, in a
5039         --  separate step.
5040
5041         Move_Aspects (Act_Tree, To => Act_Decl);
5042         Set_Categorization_From_Pragmas (Act_Decl);
5043
5044         if Parent_Installed then
5045            Hide_Current_Scope;
5046         end if;
5047
5048         Append (Act_Decl, Renaming_List);
5049         Instantiate_Contract (Gen_Unit);
5050         Build_Subprogram_Renaming;
5051
5052         Analyze_Instance_And_Renamings;
5053
5054         --  If the generic is marked Import (Intrinsic), then so is the
5055         --  instance. This indicates that there is no body to instantiate. If
5056         --  generic is marked inline, so it the instance, and the anonymous
5057         --  subprogram it renames. If inlined, or else if inlining is enabled
5058         --  for the compilation, we generate the instance body even if it is
5059         --  not within the main unit.
5060
5061         if Is_Intrinsic_Subprogram (Gen_Unit) then
5062            Set_Is_Intrinsic_Subprogram (Anon_Id);
5063            Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
5064
5065            if Chars (Gen_Unit) = Name_Unchecked_Conversion then
5066               Validate_Unchecked_Conversion (N, Act_Decl_Id);
5067            end if;
5068         end if;
5069
5070         --  Inherit convention from generic unit. Intrinsic convention, as for
5071         --  an instance of unchecked conversion, is not inherited because an
5072         --  explicit Ada instance has been created.
5073
5074         if Has_Convention_Pragma (Gen_Unit)
5075           and then Convention (Gen_Unit) /= Convention_Intrinsic
5076         then
5077            Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
5078            Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
5079         end if;
5080
5081         Generate_Definition (Act_Decl_Id);
5082
5083         --  Inherit all inlining-related flags which apply to the generic in
5084         --  the subprogram and its declaration.
5085
5086         Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
5087         Set_Is_Inlined (Anon_Id,     Is_Inlined (Gen_Unit));
5088
5089         Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
5090         Set_Has_Pragma_Inline (Anon_Id,     Has_Pragma_Inline (Gen_Unit));
5091
5092         Set_Has_Pragma_Inline_Always
5093           (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
5094         Set_Has_Pragma_Inline_Always
5095           (Anon_Id,     Has_Pragma_Inline_Always (Gen_Unit));
5096
5097         if not Is_Intrinsic_Subprogram (Gen_Unit) then
5098            Check_Elab_Instantiation (N);
5099         end if;
5100
5101         if Is_Dispatching_Operation (Act_Decl_Id)
5102           and then Ada_Version >= Ada_2005
5103         then
5104            declare
5105               Formal : Entity_Id;
5106
5107            begin
5108               Formal := First_Formal (Act_Decl_Id);
5109               while Present (Formal) loop
5110                  if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
5111                    and then Is_Controlling_Formal (Formal)
5112                    and then not Can_Never_Be_Null (Formal)
5113                  then
5114                     Error_Msg_NE
5115                       ("access parameter& is controlling,", N, Formal);
5116                     Error_Msg_NE
5117                       ("\corresponding parameter of & must be "
5118                       & "explicitly null-excluding", N, Gen_Id);
5119                  end if;
5120
5121                  Next_Formal (Formal);
5122               end loop;
5123            end;
5124         end if;
5125
5126         Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
5127
5128         Validate_Categorization_Dependency (N, Act_Decl_Id);
5129
5130         if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
5131            Inherit_Context (Gen_Decl, N);
5132
5133            Restore_Private_Views (Pack_Id, False);
5134
5135            --  If the context requires a full instantiation, mark node for
5136            --  subsequent construction of the body.
5137
5138            if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
5139               Check_Forward_Instantiation (Gen_Decl);
5140
5141               --  The wrapper package is always delayed, because it does not
5142               --  constitute a freeze point, but to insure that the freeze
5143               --  node is placed properly, it is created directly when
5144               --  instantiating the body (otherwise the freeze node might
5145               --  appear to early for nested instantiations).
5146
5147            elsif Nkind (Parent (N)) = N_Compilation_Unit then
5148
5149               --  For ASIS purposes, indicate that the wrapper package has
5150               --  replaced the instantiation node.
5151
5152               Rewrite (N, Unit (Parent (N)));
5153               Set_Unit (Parent (N), N);
5154            end if;
5155
5156         elsif Nkind (Parent (N)) = N_Compilation_Unit then
5157
5158               --  Replace instance node for library-level instantiations of
5159               --  intrinsic subprograms, for ASIS use.
5160
5161               Rewrite (N, Unit (Parent (N)));
5162               Set_Unit (Parent (N), N);
5163         end if;
5164
5165         if Parent_Installed then
5166            Remove_Parent;
5167         end if;
5168
5169         Restore_Hidden_Primitives (Vis_Prims_List);
5170         Restore_Env;
5171         Env_Installed := False;
5172         Generic_Renamings.Set_Last (0);
5173         Generic_Renamings_HTable.Reset;
5174
5175         Ignore_Pragma_SPARK_Mode := Save_IPSM;
5176         SPARK_Mode               := Save_SM;
5177         SPARK_Mode_Pragma        := Save_SMP;
5178
5179         if SPARK_Mode = On then
5180            Dynamic_Elaboration_Checks := False;
5181         end if;
5182
5183      end if;
5184
5185   <<Leave>>
5186      if Has_Aspects (N) then
5187         Analyze_Aspect_Specifications (N, Act_Decl_Id);
5188      end if;
5189
5190   exception
5191      when Instantiation_Error =>
5192         if Parent_Installed then
5193            Remove_Parent;
5194         end if;
5195
5196         if Env_Installed then
5197            Restore_Env;
5198         end if;
5199
5200         Ignore_Pragma_SPARK_Mode := Save_IPSM;
5201         SPARK_Mode               := Save_SM;
5202         SPARK_Mode_Pragma        := Save_SMP;
5203
5204         if SPARK_Mode = On then
5205            Dynamic_Elaboration_Checks := False;
5206         end if;
5207   end Analyze_Subprogram_Instantiation;
5208
5209   -------------------------
5210   -- Get_Associated_Node --
5211   -------------------------
5212
5213   function Get_Associated_Node (N : Node_Id) return Node_Id is
5214      Assoc : Node_Id;
5215
5216   begin
5217      Assoc := Associated_Node (N);
5218
5219      if Nkind (Assoc) /= Nkind (N) then
5220         return Assoc;
5221
5222      elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
5223         return Assoc;
5224
5225      else
5226         --  If the node is part of an inner generic, it may itself have been
5227         --  remapped into a further generic copy. Associated_Node is otherwise
5228         --  used for the entity of the node, and will be of a different node
5229         --  kind, or else N has been rewritten as a literal or function call.
5230
5231         while Present (Associated_Node (Assoc))
5232           and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
5233         loop
5234            Assoc := Associated_Node (Assoc);
5235         end loop;
5236
5237         --  Follow and additional link in case the final node was rewritten.
5238         --  This can only happen with nested generic units.
5239
5240         if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
5241           and then Present (Associated_Node (Assoc))
5242           and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
5243                                                        N_Explicit_Dereference,
5244                                                        N_Integer_Literal,
5245                                                        N_Real_Literal,
5246                                                        N_String_Literal))
5247         then
5248            Assoc := Associated_Node (Assoc);
5249         end if;
5250
5251         --  An additional special case: an unconstrained type in an object
5252         --  declaration may have been rewritten as a local subtype constrained
5253         --  by the expression in the declaration. We need to recover the
5254         --  original entity which may be global.
5255
5256         if Present (Original_Node (Assoc))
5257           and then Nkind (Parent (N)) = N_Object_Declaration
5258         then
5259            Assoc := Original_Node (Assoc);
5260         end if;
5261
5262         return Assoc;
5263      end if;
5264   end Get_Associated_Node;
5265
5266   ----------------------------
5267   -- Build_Function_Wrapper --
5268   ----------------------------
5269
5270   function Build_Function_Wrapper
5271     (Formal_Subp : Entity_Id;
5272      Actual_Subp : Entity_Id) return Node_Id
5273   is
5274      Loc       : constant Source_Ptr := Sloc (Current_Scope);
5275      Ret_Type  : constant Entity_Id  := Get_Instance_Of (Etype (Formal_Subp));
5276      Actuals   : List_Id;
5277      Decl      : Node_Id;
5278      Func_Name : Node_Id;
5279      Func      : Entity_Id;
5280      Parm_Type : Node_Id;
5281      Profile   : List_Id := New_List;
5282      Spec      : Node_Id;
5283      Act_F     : Entity_Id;
5284      Form_F    : Entity_Id;
5285      New_F     : Entity_Id;
5286
5287   begin
5288      Func_Name := New_Occurrence_Of (Actual_Subp, Loc);
5289
5290      Func := Make_Defining_Identifier (Loc, Chars (Formal_Subp));
5291      Set_Ekind (Func, E_Function);
5292      Set_Is_Generic_Actual_Subprogram (Func);
5293
5294      Actuals := New_List;
5295      Profile := New_List;
5296
5297      Act_F  := First_Formal (Actual_Subp);
5298      Form_F := First_Formal (Formal_Subp);
5299      while Present (Form_F) loop
5300
5301         --  Create new formal for profile of wrapper, and add a reference
5302         --  to it in the list of actuals for the enclosing call. The name
5303         --  must be that of the formal in the formal subprogram, because
5304         --  calls to it in the generic body may use named associations.
5305
5306         New_F := Make_Defining_Identifier (Loc, Chars (Form_F));
5307
5308         Parm_Type :=
5309           New_Occurrence_Of (Get_Instance_Of (Etype (Form_F)), Loc);
5310
5311         Append_To (Profile,
5312           Make_Parameter_Specification (Loc,
5313             Defining_Identifier => New_F,
5314             Parameter_Type      => Parm_Type));
5315
5316         Append_To (Actuals, New_Occurrence_Of (New_F, Loc));
5317         Next_Formal (Form_F);
5318
5319         if Present (Act_F) then
5320            Next_Formal (Act_F);
5321         end if;
5322      end loop;
5323
5324      Spec :=
5325        Make_Function_Specification (Loc,
5326          Defining_Unit_Name       => Func,
5327          Parameter_Specifications => Profile,
5328          Result_Definition        => New_Occurrence_Of (Ret_Type, Loc));
5329
5330      Decl :=
5331        Make_Expression_Function (Loc,
5332          Specification => Spec,
5333          Expression    =>
5334            Make_Function_Call (Loc,
5335              Name                   => Func_Name,
5336              Parameter_Associations => Actuals));
5337
5338      return Decl;
5339   end Build_Function_Wrapper;
5340
5341   ----------------------------
5342   -- Build_Operator_Wrapper --
5343   ----------------------------
5344
5345   function Build_Operator_Wrapper
5346     (Formal_Subp : Entity_Id;
5347      Actual_Subp : Entity_Id) return Node_Id
5348   is
5349      Loc       : constant Source_Ptr := Sloc (Current_Scope);
5350      Ret_Type  : constant Entity_Id  :=
5351                    Get_Instance_Of (Etype (Formal_Subp));
5352      Op_Type   : constant Entity_Id  :=
5353                    Get_Instance_Of (Etype (First_Formal (Formal_Subp)));
5354      Is_Binary : constant Boolean    :=
5355                    Present (Next_Formal (First_Formal (Formal_Subp)));
5356
5357      Decl    : Node_Id;
5358      Expr    : Node_Id;
5359      F1, F2  : Entity_Id;
5360      Func    : Entity_Id;
5361      Op_Name : Name_Id;
5362      Spec    : Node_Id;
5363      L, R    : Node_Id;
5364
5365   begin
5366      Op_Name := Chars (Actual_Subp);
5367
5368      --  Create entities for wrapper function and its formals
5369
5370      F1 := Make_Temporary (Loc, 'A');
5371      F2 := Make_Temporary (Loc, 'B');
5372      L  := New_Occurrence_Of (F1, Loc);
5373      R  := New_Occurrence_Of (F2, Loc);
5374
5375      Func := Make_Defining_Identifier (Loc, Chars (Formal_Subp));
5376      Set_Ekind (Func, E_Function);
5377      Set_Is_Generic_Actual_Subprogram (Func);
5378
5379      Spec :=
5380        Make_Function_Specification (Loc,
5381          Defining_Unit_Name       => Func,
5382          Parameter_Specifications => New_List (
5383            Make_Parameter_Specification (Loc,
5384               Defining_Identifier => F1,
5385               Parameter_Type      => New_Occurrence_Of (Op_Type, Loc))),
5386          Result_Definition        =>  New_Occurrence_Of (Ret_Type, Loc));
5387
5388      if Is_Binary then
5389         Append_To (Parameter_Specifications (Spec),
5390            Make_Parameter_Specification (Loc,
5391              Defining_Identifier => F2,
5392              Parameter_Type      => New_Occurrence_Of (Op_Type, Loc)));
5393      end if;
5394
5395      --  Build expression as a function call, or as an operator node
5396      --  that corresponds to the name of the actual, starting with
5397      --  binary operators.
5398
5399      if Op_Name not in Any_Operator_Name then
5400         Expr :=
5401           Make_Function_Call (Loc,
5402             Name                   =>
5403               New_Occurrence_Of (Actual_Subp, Loc),
5404             Parameter_Associations => New_List (L));
5405
5406         if Is_Binary then
5407            Append_To (Parameter_Associations (Expr), R);
5408         end if;
5409
5410      --  Binary operators
5411
5412      elsif Is_Binary then
5413         if Op_Name = Name_Op_And then
5414            Expr := Make_Op_And      (Loc, Left_Opnd => L, Right_Opnd => R);
5415         elsif Op_Name = Name_Op_Or then
5416            Expr := Make_Op_Or       (Loc, Left_Opnd => L, Right_Opnd => R);
5417         elsif Op_Name = Name_Op_Xor then
5418            Expr := Make_Op_Xor      (Loc, Left_Opnd => L, Right_Opnd => R);
5419         elsif Op_Name = Name_Op_Eq then
5420            Expr := Make_Op_Eq       (Loc, Left_Opnd => L, Right_Opnd => R);
5421         elsif Op_Name = Name_Op_Ne then
5422            Expr := Make_Op_Ne       (Loc, Left_Opnd => L, Right_Opnd => R);
5423         elsif Op_Name = Name_Op_Le then
5424            Expr := Make_Op_Le       (Loc, Left_Opnd => L, Right_Opnd => R);
5425         elsif Op_Name = Name_Op_Gt then
5426            Expr := Make_Op_Gt       (Loc, Left_Opnd => L, Right_Opnd => R);
5427         elsif Op_Name = Name_Op_Ge then
5428            Expr := Make_Op_Ge       (Loc, Left_Opnd => L, Right_Opnd => R);
5429         elsif Op_Name = Name_Op_Lt then
5430            Expr := Make_Op_Lt       (Loc, Left_Opnd => L, Right_Opnd => R);
5431         elsif Op_Name = Name_Op_Add then
5432            Expr := Make_Op_Add      (Loc, Left_Opnd => L, Right_Opnd => R);
5433         elsif Op_Name = Name_Op_Subtract then
5434            Expr := Make_Op_Subtract (Loc, Left_Opnd => L, Right_Opnd => R);
5435         elsif Op_Name = Name_Op_Concat then
5436            Expr := Make_Op_Concat   (Loc, Left_Opnd => L, Right_Opnd => R);
5437         elsif Op_Name = Name_Op_Multiply then
5438            Expr := Make_Op_Multiply (Loc, Left_Opnd => L, Right_Opnd => R);
5439         elsif Op_Name = Name_Op_Divide then
5440            Expr := Make_Op_Divide   (Loc, Left_Opnd => L, Right_Opnd => R);
5441         elsif Op_Name = Name_Op_Mod then
5442            Expr := Make_Op_Mod      (Loc, Left_Opnd => L, Right_Opnd => R);
5443         elsif Op_Name = Name_Op_Rem then
5444            Expr := Make_Op_Rem      (Loc, Left_Opnd => L, Right_Opnd => R);
5445         elsif Op_Name = Name_Op_Expon then
5446            Expr := Make_Op_Expon    (Loc, Left_Opnd => L, Right_Opnd => R);
5447         end if;
5448
5449      --  Unary operators
5450
5451      else
5452         if Op_Name = Name_Op_Add then
5453            Expr := Make_Op_Plus  (Loc, Right_Opnd => L);
5454         elsif Op_Name = Name_Op_Subtract then
5455            Expr := Make_Op_Minus (Loc, Right_Opnd => L);
5456         elsif Op_Name = Name_Op_Abs then
5457            Expr := Make_Op_Abs   (Loc, Right_Opnd => L);
5458         elsif Op_Name = Name_Op_Not then
5459            Expr := Make_Op_Not   (Loc, Right_Opnd => L);
5460         end if;
5461      end if;
5462
5463      Decl :=
5464        Make_Expression_Function (Loc,
5465          Specification => Spec,
5466          Expression    => Expr);
5467
5468      return Decl;
5469   end Build_Operator_Wrapper;
5470
5471   -------------------------------------------
5472   -- Build_Instance_Compilation_Unit_Nodes --
5473   -------------------------------------------
5474
5475   procedure Build_Instance_Compilation_Unit_Nodes
5476     (N        : Node_Id;
5477      Act_Body : Node_Id;
5478      Act_Decl : Node_Id)
5479   is
5480      Decl_Cunit : Node_Id;
5481      Body_Cunit : Node_Id;
5482      Citem      : Node_Id;
5483      New_Main   : constant Entity_Id := Defining_Entity (Act_Decl);
5484      Old_Main   : constant Entity_Id := Cunit_Entity (Main_Unit);
5485
5486   begin
5487      --  A new compilation unit node is built for the instance declaration
5488
5489      Decl_Cunit :=
5490        Make_Compilation_Unit (Sloc (N),
5491          Context_Items  => Empty_List,
5492          Unit           => Act_Decl,
5493          Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5494
5495      Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5496
5497      --  The new compilation unit is linked to its body, but both share the
5498      --  same file, so we do not set Body_Required on the new unit so as not
5499      --  to create a spurious dependency on a non-existent body in the ali.
5500      --  This simplifies CodePeer unit traversal.
5501
5502      --  We use the original instantiation compilation unit as the resulting
5503      --  compilation unit of the instance, since this is the main unit.
5504
5505      Rewrite (N, Act_Body);
5506
5507      --  Propagate the aspect specifications from the package body template to
5508      --  the instantiated version of the package body.
5509
5510      if Has_Aspects (Act_Body) then
5511         Set_Aspect_Specifications
5512           (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5513      end if;
5514
5515      Body_Cunit := Parent (N);
5516
5517      --  The two compilation unit nodes are linked by the Library_Unit field
5518
5519      Set_Library_Unit (Decl_Cunit, Body_Cunit);
5520      Set_Library_Unit (Body_Cunit, Decl_Cunit);
5521
5522      --  Preserve the private nature of the package if needed
5523
5524      Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5525
5526      --  If the instance is not the main unit, its context, categorization
5527      --  and elaboration entity are not relevant to the compilation.
5528
5529      if Body_Cunit /= Cunit (Main_Unit) then
5530         Make_Instance_Unit (Body_Cunit, In_Main => False);
5531         return;
5532      end if;
5533
5534      --  The context clause items on the instantiation, which are now attached
5535      --  to the body compilation unit (since the body overwrote the original
5536      --  instantiation node), semantically belong on the spec, so copy them
5537      --  there. It's harmless to leave them on the body as well. In fact one
5538      --  could argue that they belong in both places.
5539
5540      Citem := First (Context_Items (Body_Cunit));
5541      while Present (Citem) loop
5542         Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5543         Next (Citem);
5544      end loop;
5545
5546      --  Propagate categorization flags on packages, so that they appear in
5547      --  the ali file for the spec of the unit.
5548
5549      if Ekind (New_Main) = E_Package then
5550         Set_Is_Pure           (Old_Main, Is_Pure (New_Main));
5551         Set_Is_Preelaborated  (Old_Main, Is_Preelaborated (New_Main));
5552         Set_Is_Remote_Types   (Old_Main, Is_Remote_Types (New_Main));
5553         Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5554         Set_Is_Remote_Call_Interface
5555           (Old_Main, Is_Remote_Call_Interface (New_Main));
5556      end if;
5557
5558      --  Make entry in Units table, so that binder can generate call to
5559      --  elaboration procedure for body, if any.
5560
5561      Make_Instance_Unit (Body_Cunit, In_Main => True);
5562      Main_Unit_Entity := New_Main;
5563      Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5564
5565      --  Build elaboration entity, since the instance may certainly generate
5566      --  elaboration code requiring a flag for protection.
5567
5568      Build_Elaboration_Entity (Decl_Cunit, New_Main);
5569   end Build_Instance_Compilation_Unit_Nodes;
5570
5571   -----------------------------
5572   -- Check_Access_Definition --
5573   -----------------------------
5574
5575   procedure Check_Access_Definition (N : Node_Id) is
5576   begin
5577      pragma Assert
5578        (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5579      null;
5580   end Check_Access_Definition;
5581
5582   -----------------------------------
5583   -- Check_Formal_Package_Instance --
5584   -----------------------------------
5585
5586   --  If the formal has specific parameters, they must match those of the
5587   --  actual. Both of them are instances, and the renaming declarations for
5588   --  their formal parameters appear in the same order in both. The analyzed
5589   --  formal has been analyzed in the context of the current instance.
5590
5591   procedure Check_Formal_Package_Instance
5592     (Formal_Pack : Entity_Id;
5593      Actual_Pack : Entity_Id)
5594   is
5595      E1 : Entity_Id := First_Entity (Actual_Pack);
5596      E2 : Entity_Id := First_Entity (Formal_Pack);
5597
5598      Expr1 : Node_Id;
5599      Expr2 : Node_Id;
5600
5601      procedure Check_Mismatch (B : Boolean);
5602      --  Common error routine for mismatch between the parameters of the
5603      --  actual instance and those of the formal package.
5604
5605      function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5606      --  The formal may come from a nested formal package, and the actual may
5607      --  have been constant-folded. To determine whether the two denote the
5608      --  same entity we may have to traverse several definitions to recover
5609      --  the ultimate entity that they refer to.
5610
5611      function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5612      --  Similarly, if the formal comes from a nested formal package, the
5613      --  actual may designate the formal through multiple renamings, which
5614      --  have to be followed to determine the original variable in question.
5615
5616      --------------------
5617      -- Check_Mismatch --
5618      --------------------
5619
5620      procedure Check_Mismatch (B : Boolean) is
5621         Kind : constant Node_Kind := Nkind (Parent (E2));
5622
5623      begin
5624         if Kind = N_Formal_Type_Declaration then
5625            return;
5626
5627         elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5628                               N_Formal_Package_Declaration)
5629           or else Kind in N_Formal_Subprogram_Declaration
5630         then
5631            null;
5632
5633         --  Ada 2012: If both formal and actual are incomplete types they
5634         --  are conformant.
5635
5636         elsif Is_Incomplete_Type (E1) and then Is_Incomplete_Type (E2) then
5637            null;
5638
5639         elsif B then
5640            Error_Msg_NE
5641              ("actual for & in actual instance does not match formal",
5642               Parent (Actual_Pack), E1);
5643         end if;
5644      end Check_Mismatch;
5645
5646      --------------------------------
5647      -- Same_Instantiated_Constant --
5648      --------------------------------
5649
5650      function Same_Instantiated_Constant
5651        (E1, E2 : Entity_Id) return Boolean
5652      is
5653         Ent : Entity_Id;
5654
5655      begin
5656         Ent := E2;
5657         while Present (Ent) loop
5658            if E1 = Ent then
5659               return True;
5660
5661            elsif Ekind (Ent) /= E_Constant then
5662               return False;
5663
5664            elsif Is_Entity_Name (Constant_Value (Ent)) then
5665               if  Entity (Constant_Value (Ent)) = E1 then
5666                  return True;
5667               else
5668                  Ent := Entity (Constant_Value (Ent));
5669               end if;
5670
5671            --  The actual may be a constant that has been folded. Recover
5672            --  original name.
5673
5674            elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5675               Ent := Entity (Original_Node (Constant_Value (Ent)));
5676
5677            else
5678               return False;
5679            end if;
5680         end loop;
5681
5682         return False;
5683      end Same_Instantiated_Constant;
5684
5685      --------------------------------
5686      -- Same_Instantiated_Variable --
5687      --------------------------------
5688
5689      function Same_Instantiated_Variable
5690        (E1, E2 : Entity_Id) return Boolean
5691      is
5692         function Original_Entity (E : Entity_Id) return Entity_Id;
5693         --  Follow chain of renamings to the ultimate ancestor
5694
5695         ---------------------
5696         -- Original_Entity --
5697         ---------------------
5698
5699         function Original_Entity (E : Entity_Id) return Entity_Id is
5700            Orig : Entity_Id;
5701
5702         begin
5703            Orig := E;
5704            while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5705              and then Present (Renamed_Object (Orig))
5706              and then Is_Entity_Name (Renamed_Object (Orig))
5707            loop
5708               Orig := Entity (Renamed_Object (Orig));
5709            end loop;
5710
5711            return Orig;
5712         end Original_Entity;
5713
5714      --  Start of processing for Same_Instantiated_Variable
5715
5716      begin
5717         return Ekind (E1) = Ekind (E2)
5718           and then Original_Entity (E1) = Original_Entity (E2);
5719      end Same_Instantiated_Variable;
5720
5721   --  Start of processing for Check_Formal_Package_Instance
5722
5723   begin
5724      while Present (E1) and then Present (E2) loop
5725         exit when Ekind (E1) = E_Package
5726           and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5727
5728         --  If the formal is the renaming of the formal package, this
5729         --  is the end of its formal part, which may occur before the
5730         --  end of the formal part in the actual in the presence of
5731         --  defaulted parameters in the formal package.
5732
5733         exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5734           and then Renamed_Entity (E2) = Scope (E2);
5735
5736         --  The analysis of the actual may generate additional internal
5737         --  entities. If the formal is defaulted, there is no corresponding
5738         --  analysis and the internal entities must be skipped, until we
5739         --  find corresponding entities again.
5740
5741         if Comes_From_Source (E2)
5742           and then not Comes_From_Source (E1)
5743           and then Chars (E1) /= Chars (E2)
5744         then
5745            while Present (E1) and then  Chars (E1) /= Chars (E2) loop
5746               Next_Entity (E1);
5747            end loop;
5748         end if;
5749
5750         if No (E1) then
5751            return;
5752
5753         --  If the formal entity comes from a formal declaration, it was
5754         --  defaulted in the formal package, and no check is needed on it.
5755
5756         elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5757            goto Next_E;
5758
5759         --  Ditto for defaulted formal subprograms.
5760
5761         elsif Is_Overloadable (E1)
5762           and then Nkind (Unit_Declaration_Node (E2)) in
5763                      N_Formal_Subprogram_Declaration
5764         then
5765            goto Next_E;
5766
5767         elsif Is_Type (E1) then
5768
5769            --  Subtypes must statically match. E1, E2 are the local entities
5770            --  that are subtypes of the actuals. Itypes generated for other
5771            --  parameters need not be checked, the check will be performed
5772            --  on the parameters themselves.
5773
5774            --  If E2 is a formal type declaration, it is a defaulted parameter
5775            --  and needs no checking.
5776
5777            if not Is_Itype (E1) and then not Is_Itype (E2) then
5778               Check_Mismatch
5779                 (not Is_Type (E2)
5780                   or else Etype (E1) /= Etype (E2)
5781                   or else not Subtypes_Statically_Match (E1, E2));
5782            end if;
5783
5784         elsif Ekind (E1) = E_Constant then
5785
5786            --  IN parameters must denote the same static value, or the same
5787            --  constant, or the literal null.
5788
5789            Expr1 := Expression (Parent (E1));
5790
5791            if Ekind (E2) /= E_Constant then
5792               Check_Mismatch (True);
5793               goto Next_E;
5794            else
5795               Expr2 := Expression (Parent (E2));
5796            end if;
5797
5798            if Is_OK_Static_Expression (Expr1) then
5799               if not Is_OK_Static_Expression (Expr2) then
5800                  Check_Mismatch (True);
5801
5802               elsif Is_Discrete_Type (Etype (E1)) then
5803                  declare
5804                     V1 : constant Uint := Expr_Value (Expr1);
5805                     V2 : constant Uint := Expr_Value (Expr2);
5806                  begin
5807                     Check_Mismatch (V1 /= V2);
5808                  end;
5809
5810               elsif Is_Real_Type (Etype (E1)) then
5811                  declare
5812                     V1 : constant Ureal := Expr_Value_R (Expr1);
5813                     V2 : constant Ureal := Expr_Value_R (Expr2);
5814                  begin
5815                     Check_Mismatch (V1 /= V2);
5816                  end;
5817
5818               elsif Is_String_Type (Etype (E1))
5819                 and then Nkind (Expr1) = N_String_Literal
5820               then
5821                  if Nkind (Expr2) /= N_String_Literal then
5822                     Check_Mismatch (True);
5823                  else
5824                     Check_Mismatch
5825                       (not String_Equal (Strval (Expr1), Strval (Expr2)));
5826                  end if;
5827               end if;
5828
5829            elsif Is_Entity_Name (Expr1) then
5830               if Is_Entity_Name (Expr2) then
5831                  if Entity (Expr1) = Entity (Expr2) then
5832                     null;
5833                  else
5834                     Check_Mismatch
5835                       (not Same_Instantiated_Constant
5836                         (Entity (Expr1), Entity (Expr2)));
5837                  end if;
5838
5839               else
5840                  Check_Mismatch (True);
5841               end if;
5842
5843            elsif Is_Entity_Name (Original_Node (Expr1))
5844              and then Is_Entity_Name (Expr2)
5845              and then Same_Instantiated_Constant
5846                         (Entity (Original_Node (Expr1)), Entity (Expr2))
5847            then
5848               null;
5849
5850            elsif Nkind (Expr1) = N_Null then
5851               Check_Mismatch (Nkind (Expr1) /= N_Null);
5852
5853            else
5854               Check_Mismatch (True);
5855            end if;
5856
5857         elsif Ekind (E1) = E_Variable then
5858            Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5859
5860         elsif Ekind (E1) = E_Package then
5861            Check_Mismatch
5862              (Ekind (E1) /= Ekind (E2)
5863                or else Renamed_Object (E1) /= Renamed_Object (E2));
5864
5865         elsif Is_Overloadable (E1) then
5866
5867            --  Verify that the actual subprograms match. Note that actuals
5868            --  that are attributes are rewritten as subprograms. If the
5869            --  subprogram in the formal package is defaulted, no check is
5870            --  needed. Note that this can only happen in Ada 2005 when the
5871            --  formal package can be partially parameterized.
5872
5873            if Nkind (Unit_Declaration_Node (E1)) =
5874                                           N_Subprogram_Renaming_Declaration
5875              and then From_Default (Unit_Declaration_Node (E1))
5876            then
5877               null;
5878
5879            --  If the formal package has an "others"  box association that
5880            --  covers this formal, there is no need for a check either.
5881
5882            elsif Nkind (Unit_Declaration_Node (E2)) in
5883                    N_Formal_Subprogram_Declaration
5884              and then Box_Present (Unit_Declaration_Node (E2))
5885            then
5886               null;
5887
5888            --  No check needed if subprogram is a defaulted null procedure
5889
5890            elsif No (Alias (E2))
5891              and then Ekind (E2) = E_Procedure
5892              and then
5893                Null_Present (Specification (Unit_Declaration_Node (E2)))
5894            then
5895               null;
5896
5897            --  Otherwise the actual in the formal and the actual in the
5898            --  instantiation of the formal must match, up to renamings.
5899
5900            else
5901               Check_Mismatch
5902                 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5903            end if;
5904
5905         else
5906            raise Program_Error;
5907         end if;
5908
5909         <<Next_E>>
5910            Next_Entity (E1);
5911            Next_Entity (E2);
5912      end loop;
5913   end Check_Formal_Package_Instance;
5914
5915   ---------------------------
5916   -- Check_Formal_Packages --
5917   ---------------------------
5918
5919   procedure Check_Formal_Packages (P_Id : Entity_Id) is
5920      E        : Entity_Id;
5921      Formal_P : Entity_Id;
5922
5923   begin
5924      --  Iterate through the declarations in the instance, looking for package
5925      --  renaming declarations that denote instances of formal packages. Stop
5926      --  when we find the renaming of the current package itself. The
5927      --  declaration for a formal package without a box is followed by an
5928      --  internal entity that repeats the instantiation.
5929
5930      E := First_Entity (P_Id);
5931      while Present (E) loop
5932         if Ekind (E) = E_Package then
5933            if Renamed_Object (E) = P_Id then
5934               exit;
5935
5936            elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5937               null;
5938
5939            elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5940               Formal_P := Next_Entity (E);
5941               Check_Formal_Package_Instance (Formal_P, E);
5942
5943               --  After checking, remove the internal validating package. It
5944               --  is only needed for semantic checks, and as it may contain
5945               --  generic formal declarations it should not reach gigi.
5946
5947               Remove (Unit_Declaration_Node (Formal_P));
5948            end if;
5949         end if;
5950
5951         Next_Entity (E);
5952      end loop;
5953   end Check_Formal_Packages;
5954
5955   ---------------------------------
5956   -- Check_Forward_Instantiation --
5957   ---------------------------------
5958
5959   procedure Check_Forward_Instantiation (Decl : Node_Id) is
5960      S        : Entity_Id;
5961      Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5962
5963   begin
5964      --  The instantiation appears before the generic body if we are in the
5965      --  scope of the unit containing the generic, either in its spec or in
5966      --  the package body, and before the generic body.
5967
5968      if Ekind (Gen_Comp) = E_Package_Body then
5969         Gen_Comp := Spec_Entity (Gen_Comp);
5970      end if;
5971
5972      if In_Open_Scopes (Gen_Comp)
5973        and then No (Corresponding_Body (Decl))
5974      then
5975         S := Current_Scope;
5976
5977         while Present (S)
5978           and then not Is_Compilation_Unit (S)
5979           and then not Is_Child_Unit (S)
5980         loop
5981            if Ekind (S) = E_Package then
5982               Set_Has_Forward_Instantiation (S);
5983            end if;
5984
5985            S := Scope (S);
5986         end loop;
5987      end if;
5988   end Check_Forward_Instantiation;
5989
5990   ---------------------------
5991   -- Check_Generic_Actuals --
5992   ---------------------------
5993
5994   --  The visibility of the actuals may be different between the point of
5995   --  generic instantiation and the instantiation of the body.
5996
5997   procedure Check_Generic_Actuals
5998     (Instance      : Entity_Id;
5999      Is_Formal_Box : Boolean)
6000   is
6001      E      : Entity_Id;
6002      Astype : Entity_Id;
6003
6004      function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
6005      --  For a formal that is an array type, the component type is often a
6006      --  previous formal in the same unit. The privacy status of the component
6007      --  type will have been examined earlier in the traversal of the
6008      --  corresponding actuals, and this status should not be modified for
6009      --  the array (sub)type itself. However, if the base type of the array
6010      --  (sub)type is private, its full view must be restored in the body to
6011      --  be consistent with subsequent index subtypes, etc.
6012      --
6013      --  To detect this case we have to rescan the list of formals, which is
6014      --  usually short enough to ignore the resulting inefficiency.
6015
6016      -----------------------------
6017      -- Denotes_Previous_Actual --
6018      -----------------------------
6019
6020      function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
6021         Prev : Entity_Id;
6022
6023      begin
6024         Prev := First_Entity (Instance);
6025         while Present (Prev) loop
6026            if Is_Type (Prev)
6027              and then Nkind (Parent (Prev)) = N_Subtype_Declaration
6028              and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
6029              and then Entity (Subtype_Indication (Parent (Prev))) = Typ
6030            then
6031               return True;
6032
6033            elsif Prev = E then
6034               return False;
6035
6036            else
6037               Next_Entity (Prev);
6038            end if;
6039         end loop;
6040
6041         return False;
6042      end Denotes_Previous_Actual;
6043
6044   --  Start of processing for Check_Generic_Actuals
6045
6046   begin
6047      E := First_Entity (Instance);
6048      while Present (E) loop
6049         if Is_Type (E)
6050           and then Nkind (Parent (E)) = N_Subtype_Declaration
6051           and then Scope (Etype (E)) /= Instance
6052           and then Is_Entity_Name (Subtype_Indication (Parent (E)))
6053         then
6054            if Is_Array_Type (E)
6055              and then not Is_Private_Type (Etype (E))
6056              and then Denotes_Previous_Actual (Component_Type (E))
6057            then
6058               null;
6059            else
6060               Check_Private_View (Subtype_Indication (Parent (E)));
6061            end if;
6062
6063            Set_Is_Generic_Actual_Type (E, True);
6064            Set_Is_Hidden (E, False);
6065            Set_Is_Potentially_Use_Visible (E,
6066              In_Use (Instance));
6067
6068            --  We constructed the generic actual type as a subtype of the
6069            --  supplied type. This means that it normally would not inherit
6070            --  subtype specific attributes of the actual, which is wrong for
6071            --  the generic case.
6072
6073            Astype := Ancestor_Subtype (E);
6074
6075            if No (Astype) then
6076
6077               --  This can happen when E is an itype that is the full view of
6078               --  a private type completed, e.g. with a constrained array. In
6079               --  that case, use the first subtype, which will carry size
6080               --  information. The base type itself is unconstrained and will
6081               --  not carry it.
6082
6083               Astype := First_Subtype (E);
6084            end if;
6085
6086            Set_Size_Info      (E,                (Astype));
6087            Set_RM_Size        (E, RM_Size        (Astype));
6088            Set_First_Rep_Item (E, First_Rep_Item (Astype));
6089
6090            if Is_Discrete_Or_Fixed_Point_Type (E) then
6091               Set_RM_Size (E, RM_Size (Astype));
6092
6093            --  In nested instances, the base type of an access actual may
6094            --  itself be private, and need to be exchanged.
6095
6096            elsif Is_Access_Type (E)
6097              and then Is_Private_Type (Etype (E))
6098            then
6099               Check_Private_View
6100                 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
6101            end if;
6102
6103         elsif Ekind (E) = E_Package then
6104
6105            --  If this is the renaming for the current instance, we're done.
6106            --  Otherwise it is a formal package. If the corresponding formal
6107            --  was declared with a box, the (instantiations of the) generic
6108            --  formal part are also visible. Otherwise, ignore the entity
6109            --  created to validate the actuals.
6110
6111            if Renamed_Object (E) = Instance then
6112               exit;
6113
6114            elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
6115               null;
6116
6117            --  The visibility of a formal of an enclosing generic is already
6118            --  correct.
6119
6120            elsif Denotes_Formal_Package (E) then
6121               null;
6122
6123            elsif Present (Associated_Formal_Package (E))
6124              and then not Is_Generic_Formal (E)
6125            then
6126               if Box_Present (Parent (Associated_Formal_Package (E))) then
6127                  Check_Generic_Actuals (Renamed_Object (E), True);
6128
6129               else
6130                  Check_Generic_Actuals (Renamed_Object (E), False);
6131               end if;
6132
6133               Set_Is_Hidden (E, False);
6134            end if;
6135
6136         --  If this is a subprogram instance (in a wrapper package) the
6137         --  actual is fully visible.
6138
6139         elsif Is_Wrapper_Package (Instance) then
6140            Set_Is_Hidden (E, False);
6141
6142         --  If the formal package is declared with a box, or if the formal
6143         --  parameter is defaulted, it is visible in the body.
6144
6145         elsif Is_Formal_Box or else Is_Visible_Formal (E) then
6146            Set_Is_Hidden (E, False);
6147         end if;
6148
6149         if Ekind (E) = E_Constant then
6150
6151            --  If the type of the actual is a private type declared in the
6152            --  enclosing scope of the generic unit, the body of the generic
6153            --  sees the full view of the type (because it has to appear in
6154            --  the corresponding package body). If the type is private now,
6155            --  exchange views to restore the proper visiblity in the instance.
6156
6157            declare
6158               Typ : constant Entity_Id := Base_Type (Etype (E));
6159               --  The type of the actual
6160
6161               Gen_Id : Entity_Id;
6162               --  The generic unit
6163
6164               Parent_Scope : Entity_Id;
6165               --  The enclosing scope of the generic unit
6166
6167            begin
6168               if Is_Wrapper_Package (Instance) then
6169                  Gen_Id :=
6170                    Generic_Parent
6171                      (Specification
6172                        (Unit_Declaration_Node
6173                          (Related_Instance (Instance))));
6174               else
6175                  Gen_Id :=
6176                    Generic_Parent (Package_Specification (Instance));
6177               end if;
6178
6179               Parent_Scope := Scope (Gen_Id);
6180
6181               --  The exchange is only needed if the generic is defined
6182               --  within a package which is not a common ancestor of the
6183               --  scope of the instance, and is not already in scope.
6184
6185               if Is_Private_Type (Typ)
6186                 and then Scope (Typ) = Parent_Scope
6187                 and then Scope (Instance) /= Parent_Scope
6188                 and then Ekind (Parent_Scope) = E_Package
6189                 and then not Is_Child_Unit (Gen_Id)
6190               then
6191                  Switch_View (Typ);
6192
6193                  --  If the type of the entity is a subtype, it may also have
6194                  --  to be made visible, together with the base type of its
6195                  --  full view, after exchange.
6196
6197                  if Is_Private_Type (Etype (E)) then
6198                     Switch_View (Etype (E));
6199                     Switch_View (Base_Type (Etype (E)));
6200                  end if;
6201               end if;
6202            end;
6203         end if;
6204
6205         Next_Entity (E);
6206      end loop;
6207   end Check_Generic_Actuals;
6208
6209   ------------------------------
6210   -- Check_Generic_Child_Unit --
6211   ------------------------------
6212
6213   procedure Check_Generic_Child_Unit
6214     (Gen_Id           : Node_Id;
6215      Parent_Installed : in out Boolean)
6216   is
6217      Loc      : constant Source_Ptr := Sloc (Gen_Id);
6218      Gen_Par  : Entity_Id := Empty;
6219      E        : Entity_Id;
6220      Inst_Par : Entity_Id;
6221      S        : Node_Id;
6222
6223      function Find_Generic_Child
6224        (Scop : Entity_Id;
6225         Id   : Node_Id) return Entity_Id;
6226      --  Search generic parent for possible child unit with the given name
6227
6228      function In_Enclosing_Instance return Boolean;
6229      --  Within an instance of the parent, the child unit may be denoted by
6230      --  a simple name, or an abbreviated expanded name. Examine enclosing
6231      --  scopes to locate a possible parent instantiation.
6232
6233      ------------------------
6234      -- Find_Generic_Child --
6235      ------------------------
6236
6237      function Find_Generic_Child
6238        (Scop : Entity_Id;
6239         Id   : Node_Id) return Entity_Id
6240      is
6241         E : Entity_Id;
6242
6243      begin
6244         --  If entity of name is already set, instance has already been
6245         --  resolved, e.g. in an enclosing instantiation.
6246
6247         if Present (Entity (Id)) then
6248            if Scope (Entity (Id)) = Scop then
6249               return Entity (Id);
6250            else
6251               return Empty;
6252            end if;
6253
6254         else
6255            E := First_Entity (Scop);
6256            while Present (E) loop
6257               if Chars (E) = Chars (Id)
6258                 and then Is_Child_Unit (E)
6259               then
6260                  if Is_Child_Unit (E)
6261                    and then not Is_Visible_Lib_Unit (E)
6262                  then
6263                     Error_Msg_NE
6264                       ("generic child unit& is not visible", Gen_Id, E);
6265                  end if;
6266
6267                  Set_Entity (Id, E);
6268                  return E;
6269               end if;
6270
6271               Next_Entity (E);
6272            end loop;
6273
6274            return Empty;
6275         end if;
6276      end Find_Generic_Child;
6277
6278      ---------------------------
6279      -- In_Enclosing_Instance --
6280      ---------------------------
6281
6282      function In_Enclosing_Instance return Boolean is
6283         Enclosing_Instance : Node_Id;
6284         Instance_Decl      : Node_Id;
6285
6286      begin
6287         --  We do not inline any call that contains instantiations, except
6288         --  for instantiations of Unchecked_Conversion, so if we are within
6289         --  an inlined body the current instance does not require parents.
6290
6291         if In_Inlined_Body then
6292            pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
6293            return False;
6294         end if;
6295
6296         --  Loop to check enclosing scopes
6297
6298         Enclosing_Instance := Current_Scope;
6299         while Present (Enclosing_Instance) loop
6300            Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
6301
6302            if Ekind (Enclosing_Instance) = E_Package
6303              and then Is_Generic_Instance (Enclosing_Instance)
6304              and then Present
6305                (Generic_Parent (Specification (Instance_Decl)))
6306            then
6307               --  Check whether the generic we are looking for is a child of
6308               --  this instance.
6309
6310               E := Find_Generic_Child
6311                      (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
6312               exit when Present (E);
6313
6314            else
6315               E := Empty;
6316            end if;
6317
6318            Enclosing_Instance := Scope (Enclosing_Instance);
6319         end loop;
6320
6321         if No (E) then
6322
6323            --  Not a child unit
6324
6325            Analyze (Gen_Id);
6326            return False;
6327
6328         else
6329            Rewrite (Gen_Id,
6330              Make_Expanded_Name (Loc,
6331                Chars         => Chars (E),
6332                Prefix        => New_Occurrence_Of (Enclosing_Instance, Loc),
6333                Selector_Name => New_Occurrence_Of (E, Loc)));
6334
6335            Set_Entity (Gen_Id, E);
6336            Set_Etype  (Gen_Id, Etype (E));
6337            Parent_Installed := False;      -- Already in scope.
6338            return True;
6339         end if;
6340      end In_Enclosing_Instance;
6341
6342   --  Start of processing for Check_Generic_Child_Unit
6343
6344   begin
6345      --  If the name of the generic is given by a selected component, it may
6346      --  be the name of a generic child unit, and the prefix is the name of an
6347      --  instance of the parent, in which case the child unit must be visible.
6348      --  If this instance is not in scope, it must be placed there and removed
6349      --  after instantiation, because what is being instantiated is not the
6350      --  original child, but the corresponding child present in the instance
6351      --  of the parent.
6352
6353      --  If the child is instantiated within the parent, it can be given by
6354      --  a simple name. In this case the instance is already in scope, but
6355      --  the child generic must be recovered from the generic parent as well.
6356
6357      if Nkind (Gen_Id) = N_Selected_Component then
6358         S := Selector_Name (Gen_Id);
6359         Analyze (Prefix (Gen_Id));
6360         Inst_Par := Entity (Prefix (Gen_Id));
6361
6362         if Ekind (Inst_Par) = E_Package
6363           and then Present (Renamed_Object (Inst_Par))
6364         then
6365            Inst_Par := Renamed_Object (Inst_Par);
6366         end if;
6367
6368         if Ekind (Inst_Par) = E_Package then
6369            if Nkind (Parent (Inst_Par)) = N_Package_Specification then
6370               Gen_Par := Generic_Parent (Parent (Inst_Par));
6371
6372            elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
6373              and then
6374                Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
6375            then
6376               Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
6377            end if;
6378
6379         elsif Ekind (Inst_Par) = E_Generic_Package
6380           and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
6381         then
6382            --  A formal package may be a real child package, and not the
6383            --  implicit instance within a parent. In this case the child is
6384            --  not visible and has to be retrieved explicitly as well.
6385
6386            Gen_Par := Inst_Par;
6387         end if;
6388
6389         if Present (Gen_Par) then
6390
6391            --  The prefix denotes an instantiation. The entity itself may be a
6392            --  nested generic, or a child unit.
6393
6394            E := Find_Generic_Child (Gen_Par, S);
6395
6396            if Present (E) then
6397               Change_Selected_Component_To_Expanded_Name (Gen_Id);
6398               Set_Entity (Gen_Id, E);
6399               Set_Etype (Gen_Id, Etype (E));
6400               Set_Entity (S, E);
6401               Set_Etype (S, Etype (E));
6402
6403               --  Indicate that this is a reference to the parent
6404
6405               if In_Extended_Main_Source_Unit (Gen_Id) then
6406                  Set_Is_Instantiated (Inst_Par);
6407               end if;
6408
6409               --  A common mistake is to replicate the naming scheme of a
6410               --  hierarchy by instantiating a generic child directly, rather
6411               --  than the implicit child in a parent instance:
6412
6413               --  generic .. package Gpar is ..
6414               --  generic .. package Gpar.Child is ..
6415               --  package Par is new Gpar ();
6416
6417               --  with Gpar.Child;
6418               --  package Par.Child is new Gpar.Child ();
6419               --                           rather than Par.Child
6420
6421               --  In this case the instantiation is within Par, which is an
6422               --  instance, but Gpar does not denote Par because we are not IN
6423               --  the instance of Gpar, so this is illegal. The test below
6424               --  recognizes this particular case.
6425
6426               if Is_Child_Unit (E)
6427                 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
6428                 and then (not In_Instance
6429                            or else Nkind (Parent (Parent (Gen_Id))) =
6430                                                         N_Compilation_Unit)
6431               then
6432                  Error_Msg_N
6433                    ("prefix of generic child unit must be instance of parent",
6434                      Gen_Id);
6435               end if;
6436
6437               if not In_Open_Scopes (Inst_Par)
6438                 and then Nkind (Parent (Gen_Id)) not in
6439                                           N_Generic_Renaming_Declaration
6440               then
6441                  Install_Parent (Inst_Par);
6442                  Parent_Installed := True;
6443
6444               elsif In_Open_Scopes (Inst_Par) then
6445
6446                  --  If the parent is already installed, install the actuals
6447                  --  for its formal packages. This is necessary when the child
6448                  --  instance is a child of the parent instance: in this case,
6449                  --  the parent is placed on the scope stack but the formal
6450                  --  packages are not made visible.
6451
6452                  Install_Formal_Packages (Inst_Par);
6453               end if;
6454
6455            else
6456               --  If the generic parent does not contain an entity that
6457               --  corresponds to the selector, the instance doesn't either.
6458               --  Analyzing the node will yield the appropriate error message.
6459               --  If the entity is not a child unit, then it is an inner
6460               --  generic in the parent.
6461
6462               Analyze (Gen_Id);
6463            end if;
6464
6465         else
6466            Analyze (Gen_Id);
6467
6468            if Is_Child_Unit (Entity (Gen_Id))
6469              and then
6470                Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6471              and then not In_Open_Scopes (Inst_Par)
6472            then
6473               Install_Parent (Inst_Par);
6474               Parent_Installed := True;
6475
6476            --  The generic unit may be the renaming of the implicit child
6477            --  present in an instance. In that case the parent instance is
6478            --  obtained from the name of the renamed entity.
6479
6480            elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6481              and then Present (Renamed_Entity (Entity (Gen_Id)))
6482              and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6483            then
6484               declare
6485                  Renamed_Package : constant Node_Id :=
6486                                      Name (Parent (Entity (Gen_Id)));
6487               begin
6488                  if Nkind (Renamed_Package) = N_Expanded_Name then
6489                     Inst_Par := Entity (Prefix (Renamed_Package));
6490                     Install_Parent (Inst_Par);
6491                     Parent_Installed := True;
6492                  end if;
6493               end;
6494            end if;
6495         end if;
6496
6497      elsif Nkind (Gen_Id) = N_Expanded_Name then
6498
6499         --  Entity already present, analyze prefix, whose meaning may be
6500         --  an instance in the current context. If it is an instance of
6501         --  a relative within another, the proper parent may still have
6502         --  to be installed, if they are not of the same generation.
6503
6504         Analyze (Prefix (Gen_Id));
6505
6506         --  In the unlikely case that a local declaration hides the name
6507         --  of the parent package, locate it on the homonym chain. If the
6508         --  context is an instance of the parent, the renaming entity is
6509         --  flagged as such.
6510
6511         Inst_Par := Entity (Prefix (Gen_Id));
6512         while Present (Inst_Par)
6513           and then not Is_Package_Or_Generic_Package (Inst_Par)
6514         loop
6515            Inst_Par := Homonym (Inst_Par);
6516         end loop;
6517
6518         pragma Assert (Present (Inst_Par));
6519         Set_Entity (Prefix (Gen_Id), Inst_Par);
6520
6521         if In_Enclosing_Instance then
6522            null;
6523
6524         elsif Present (Entity (Gen_Id))
6525           and then Is_Child_Unit (Entity (Gen_Id))
6526           and then not In_Open_Scopes (Inst_Par)
6527         then
6528            Install_Parent (Inst_Par);
6529            Parent_Installed := True;
6530         end if;
6531
6532      elsif In_Enclosing_Instance then
6533
6534         --  The child unit is found in some enclosing scope
6535
6536         null;
6537
6538      else
6539         Analyze (Gen_Id);
6540
6541         --  If this is the renaming of the implicit child in a parent
6542         --  instance, recover the parent name and install it.
6543
6544         if Is_Entity_Name (Gen_Id) then
6545            E := Entity (Gen_Id);
6546
6547            if Is_Generic_Unit (E)
6548              and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6549              and then Is_Child_Unit (Renamed_Object (E))
6550              and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6551              and then Nkind (Name (Parent (E))) = N_Expanded_Name
6552            then
6553               Rewrite (Gen_Id, New_Copy_Tree (Name (Parent (E))));
6554               Inst_Par := Entity (Prefix (Gen_Id));
6555
6556               if not In_Open_Scopes (Inst_Par) then
6557                  Install_Parent (Inst_Par);
6558                  Parent_Installed := True;
6559               end if;
6560
6561            --  If it is a child unit of a non-generic parent, it may be
6562            --  use-visible and given by a direct name. Install parent as
6563            --  for other cases.
6564
6565            elsif Is_Generic_Unit (E)
6566              and then Is_Child_Unit (E)
6567              and then
6568                Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6569              and then not Is_Generic_Unit (Scope (E))
6570            then
6571               if not In_Open_Scopes (Scope (E)) then
6572                  Install_Parent (Scope (E));
6573                  Parent_Installed := True;
6574               end if;
6575            end if;
6576         end if;
6577      end if;
6578   end Check_Generic_Child_Unit;
6579
6580   -----------------------------
6581   -- Check_Hidden_Child_Unit --
6582   -----------------------------
6583
6584   procedure Check_Hidden_Child_Unit
6585     (N           : Node_Id;
6586      Gen_Unit    : Entity_Id;
6587      Act_Decl_Id : Entity_Id)
6588   is
6589      Gen_Id : constant Node_Id := Name (N);
6590
6591   begin
6592      if Is_Child_Unit (Gen_Unit)
6593        and then Is_Child_Unit (Act_Decl_Id)
6594        and then Nkind (Gen_Id) = N_Expanded_Name
6595        and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6596        and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6597      then
6598         Error_Msg_Node_2 := Scope (Act_Decl_Id);
6599         Error_Msg_NE
6600           ("generic unit & is implicitly declared in &",
6601            Defining_Unit_Name (N), Gen_Unit);
6602         Error_Msg_N ("\instance must have different name",
6603           Defining_Unit_Name (N));
6604      end if;
6605   end Check_Hidden_Child_Unit;
6606
6607   ------------------------
6608   -- Check_Private_View --
6609   ------------------------
6610
6611   procedure Check_Private_View (N : Node_Id) is
6612      T : constant Entity_Id := Etype (N);
6613      BT : Entity_Id;
6614
6615   begin
6616      --  Exchange views if the type was not private in the generic but is
6617      --  private at the point of instantiation. Do not exchange views if
6618      --  the scope of the type is in scope. This can happen if both generic
6619      --  and instance are sibling units, or if type is defined in a parent.
6620      --  In this case the visibility of the type will be correct for all
6621      --  semantic checks.
6622
6623      if Present (T) then
6624         BT := Base_Type (T);
6625
6626         if Is_Private_Type (T)
6627           and then not Has_Private_View (N)
6628           and then Present (Full_View (T))
6629           and then not In_Open_Scopes (Scope (T))
6630         then
6631            --  In the generic, the full type was visible. Save the private
6632            --  entity, for subsequent exchange.
6633
6634            Switch_View (T);
6635
6636         elsif Has_Private_View (N)
6637           and then not Is_Private_Type (T)
6638           and then not Has_Been_Exchanged (T)
6639           and then Etype (Get_Associated_Node (N)) /= T
6640         then
6641            --  Only the private declaration was visible in the generic. If
6642            --  the type appears in a subtype declaration, the subtype in the
6643            --  instance must have a view compatible with that of its parent,
6644            --  which must be exchanged (see corresponding code in Restore_
6645            --  Private_Views). Otherwise, if the type is defined in a parent
6646            --  unit, leave full visibility within instance, which is safe.
6647
6648            if In_Open_Scopes (Scope (Base_Type (T)))
6649              and then not Is_Private_Type (Base_Type (T))
6650              and then Comes_From_Source (Base_Type (T))
6651            then
6652               null;
6653
6654            elsif Nkind (Parent (N)) = N_Subtype_Declaration
6655              or else not In_Private_Part (Scope (Base_Type (T)))
6656            then
6657               Prepend_Elmt (T, Exchanged_Views);
6658               Exchange_Declarations (Etype (Get_Associated_Node (N)));
6659            end if;
6660
6661         --  For composite types with inconsistent representation exchange
6662         --  component types accordingly.
6663
6664         elsif Is_Access_Type (T)
6665           and then Is_Private_Type (Designated_Type (T))
6666           and then not Has_Private_View (N)
6667           and then Present (Full_View (Designated_Type (T)))
6668         then
6669            Switch_View (Designated_Type (T));
6670
6671         elsif Is_Array_Type (T) then
6672            if Is_Private_Type (Component_Type (T))
6673              and then not Has_Private_View (N)
6674              and then Present (Full_View (Component_Type (T)))
6675            then
6676               Switch_View (Component_Type (T));
6677            end if;
6678
6679            --  The normal exchange mechanism relies on the setting of a
6680            --  flag on the reference in the generic. However, an additional
6681            --  mechanism is needed for types that are not explicitly
6682            --  mentioned in the generic, but may be needed in expanded code
6683            --  in the instance. This includes component types of arrays and
6684            --  designated types of access types. This processing must also
6685            --  include the index types of arrays which we take care of here.
6686
6687            declare
6688               Indx : Node_Id;
6689               Typ  : Entity_Id;
6690
6691            begin
6692               Indx := First_Index (T);
6693               while Present (Indx) loop
6694                  Typ := Base_Type (Etype (Indx));
6695
6696                  if Is_Private_Type (Typ)
6697                    and then Present (Full_View (Typ))
6698                  then
6699                     Switch_View (Typ);
6700                  end if;
6701
6702                  Next_Index (Indx);
6703               end loop;
6704            end;
6705
6706         elsif Is_Private_Type (T)
6707           and then Present (Full_View (T))
6708           and then Is_Array_Type (Full_View (T))
6709           and then Is_Private_Type (Component_Type (Full_View (T)))
6710         then
6711            Switch_View (T);
6712
6713         --  Finally, a non-private subtype may have a private base type, which
6714         --  must be exchanged for consistency. This can happen when a package
6715         --  body is instantiated, when the scope stack is empty but in fact
6716         --  the subtype and the base type are declared in an enclosing scope.
6717
6718         --  Note that in this case we introduce an inconsistency in the view
6719         --  set, because we switch the base type BT, but there could be some
6720         --  private dependent subtypes of BT which remain unswitched. Such
6721         --  subtypes might need to be switched at a later point (see specific
6722         --  provision for that case in Switch_View).
6723
6724         elsif not Is_Private_Type (T)
6725           and then not Has_Private_View (N)
6726           and then Is_Private_Type (BT)
6727           and then Present (Full_View (BT))
6728           and then not Is_Generic_Type (BT)
6729           and then not In_Open_Scopes (BT)
6730         then
6731            Prepend_Elmt (Full_View (BT), Exchanged_Views);
6732            Exchange_Declarations (BT);
6733         end if;
6734      end if;
6735   end Check_Private_View;
6736
6737   -----------------------------
6738   -- Check_Hidden_Primitives --
6739   -----------------------------
6740
6741   function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6742      Actual : Node_Id;
6743      Gen_T  : Entity_Id;
6744      Result : Elist_Id := No_Elist;
6745
6746   begin
6747      if No (Assoc_List) then
6748         return No_Elist;
6749      end if;
6750
6751      --  Traverse the list of associations between formals and actuals
6752      --  searching for renamings of tagged types
6753
6754      Actual := First (Assoc_List);
6755      while Present (Actual) loop
6756         if Nkind (Actual) = N_Subtype_Declaration then
6757            Gen_T := Generic_Parent_Type (Actual);
6758
6759            if Present (Gen_T) and then Is_Tagged_Type (Gen_T) then
6760
6761               --  Traverse the list of primitives of the actual types
6762               --  searching for hidden primitives that are visible in the
6763               --  corresponding generic formal; leave them visible and
6764               --  append them to Result to restore their decoration later.
6765
6766               Install_Hidden_Primitives
6767                 (Prims_List => Result,
6768                  Gen_T      => Gen_T,
6769                  Act_T      => Entity (Subtype_Indication (Actual)));
6770            end if;
6771         end if;
6772
6773         Next (Actual);
6774      end loop;
6775
6776      return Result;
6777   end Check_Hidden_Primitives;
6778
6779   --------------------------
6780   -- Contains_Instance_Of --
6781   --------------------------
6782
6783   function Contains_Instance_Of
6784     (Inner : Entity_Id;
6785      Outer : Entity_Id;
6786      N     : Node_Id) return Boolean
6787   is
6788      Elmt : Elmt_Id;
6789      Scop : Entity_Id;
6790
6791   begin
6792      Scop := Outer;
6793
6794      --  Verify that there are no circular instantiations. We check whether
6795      --  the unit contains an instance of the current scope or some enclosing
6796      --  scope (in case one of the instances appears in a subunit). Longer
6797      --  circularities involving subunits might seem too pathological to
6798      --  consider, but they were not too pathological for the authors of
6799      --  DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6800      --  enclosing generic scopes as containing an instance.
6801
6802      loop
6803         --  Within a generic subprogram body, the scope is not generic, to
6804         --  allow for recursive subprograms. Use the declaration to determine
6805         --  whether this is a generic unit.
6806
6807         if Ekind (Scop) = E_Generic_Package
6808           or else (Is_Subprogram (Scop)
6809                     and then Nkind (Unit_Declaration_Node (Scop)) =
6810                                        N_Generic_Subprogram_Declaration)
6811         then
6812            Elmt := First_Elmt (Inner_Instances (Inner));
6813
6814            while Present (Elmt) loop
6815               if Node (Elmt) = Scop then
6816                  Error_Msg_Node_2 := Inner;
6817                  Error_Msg_NE
6818                    ("circular Instantiation: & instantiated within &!",
6819                     N, Scop);
6820                  return True;
6821
6822               elsif Node (Elmt) = Inner then
6823                  return True;
6824
6825               elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6826                  Error_Msg_Node_2 := Inner;
6827                  Error_Msg_NE
6828                    ("circular Instantiation: & instantiated within &!",
6829                     N, Node (Elmt));
6830                  return True;
6831               end if;
6832
6833               Next_Elmt (Elmt);
6834            end loop;
6835
6836            --  Indicate that Inner is being instantiated within Scop
6837
6838            Append_Elmt (Inner, Inner_Instances (Scop));
6839         end if;
6840
6841         if Scop = Standard_Standard then
6842            exit;
6843         else
6844            Scop := Scope (Scop);
6845         end if;
6846      end loop;
6847
6848      return False;
6849   end Contains_Instance_Of;
6850
6851   -----------------------
6852   -- Copy_Generic_Node --
6853   -----------------------
6854
6855   function Copy_Generic_Node
6856     (N             : Node_Id;
6857      Parent_Id     : Node_Id;
6858      Instantiating : Boolean) return Node_Id
6859   is
6860      Ent   : Entity_Id;
6861      New_N : Node_Id;
6862
6863      function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6864      --  Check the given value of one of the Fields referenced by the current
6865      --  node to determine whether to copy it recursively. The field may hold
6866      --  a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6867      --  Char) in which case it need not be copied.
6868
6869      procedure Copy_Descendants;
6870      --  Common utility for various nodes
6871
6872      function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6873      --  Make copy of element list
6874
6875      function Copy_Generic_List
6876        (L         : List_Id;
6877         Parent_Id : Node_Id) return List_Id;
6878      --  Apply Copy_Node recursively to the members of a node list
6879
6880      function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6881      --  True if an identifier is part of the defining program unit name of
6882      --  a child unit. The entity of such an identifier must be kept (for
6883      --  ASIS use) even though as the name of an enclosing generic it would
6884      --  otherwise not be preserved in the generic tree.
6885
6886      ----------------------
6887      -- Copy_Descendants --
6888      ----------------------
6889
6890      procedure Copy_Descendants is
6891
6892         use Atree.Unchecked_Access;
6893         --  This code section is part of the implementation of an untyped
6894         --  tree traversal, so it needs direct access to node fields.
6895
6896      begin
6897         Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6898         Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6899         Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6900         Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6901         Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6902      end Copy_Descendants;
6903
6904      -----------------------------
6905      -- Copy_Generic_Descendant --
6906      -----------------------------
6907
6908      function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6909      begin
6910         if D = Union_Id (Empty) then
6911            return D;
6912
6913         elsif D in Node_Range then
6914            return Union_Id
6915              (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6916
6917         elsif D in List_Range then
6918            return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6919
6920         elsif D in Elist_Range then
6921            return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6922
6923         --  Nothing else is copyable (e.g. Uint values), return as is
6924
6925         else
6926            return D;
6927         end if;
6928      end Copy_Generic_Descendant;
6929
6930      ------------------------
6931      -- Copy_Generic_Elist --
6932      ------------------------
6933
6934      function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6935         M : Elmt_Id;
6936         L : Elist_Id;
6937
6938      begin
6939         if Present (E) then
6940            L := New_Elmt_List;
6941            M := First_Elmt (E);
6942            while Present (M) loop
6943               Append_Elmt
6944                 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6945               Next_Elmt (M);
6946            end loop;
6947
6948            return L;
6949
6950         else
6951            return No_Elist;
6952         end if;
6953      end Copy_Generic_Elist;
6954
6955      -----------------------
6956      -- Copy_Generic_List --
6957      -----------------------
6958
6959      function Copy_Generic_List
6960        (L         : List_Id;
6961         Parent_Id : Node_Id) return List_Id
6962      is
6963         N     : Node_Id;
6964         New_L : List_Id;
6965
6966      begin
6967         if Present (L) then
6968            New_L := New_List;
6969            Set_Parent (New_L, Parent_Id);
6970
6971            N := First (L);
6972            while Present (N) loop
6973               Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6974               Next (N);
6975            end loop;
6976
6977            return New_L;
6978
6979         else
6980            return No_List;
6981         end if;
6982      end Copy_Generic_List;
6983
6984      ---------------------------
6985      -- In_Defining_Unit_Name --
6986      ---------------------------
6987
6988      function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6989      begin
6990         return Present (Parent (Nam))
6991           and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6992                      or else
6993                        (Nkind (Parent (Nam)) = N_Expanded_Name
6994                          and then In_Defining_Unit_Name (Parent (Nam))));
6995      end In_Defining_Unit_Name;
6996
6997   --  Start of processing for Copy_Generic_Node
6998
6999   begin
7000      if N = Empty then
7001         return N;
7002      end if;
7003
7004      New_N := New_Copy (N);
7005
7006      --  Copy aspects if present
7007
7008      if Has_Aspects (N) then
7009         Set_Has_Aspects (New_N, False);
7010         Set_Aspect_Specifications
7011           (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
7012      end if;
7013
7014      if Instantiating then
7015         Adjust_Instantiation_Sloc (New_N, S_Adjustment);
7016      end if;
7017
7018      if not Is_List_Member (N) then
7019         Set_Parent (New_N, Parent_Id);
7020      end if;
7021
7022      --  If defining identifier, then all fields have been copied already
7023
7024      if Nkind (New_N) in N_Entity then
7025         null;
7026
7027      --  Special casing for identifiers and other entity names and operators
7028
7029      elsif Nkind_In (New_N, N_Identifier,
7030                             N_Character_Literal,
7031                             N_Expanded_Name,
7032                             N_Operator_Symbol)
7033        or else Nkind (New_N) in N_Op
7034      then
7035         if not Instantiating then
7036
7037            --  Link both nodes in order to assign subsequently the entity of
7038            --  the copy to the original node, in case this is a global
7039            --  reference.
7040
7041            Set_Associated_Node (N, New_N);
7042
7043            --  If we are within an instantiation, this is a nested generic
7044            --  that has already been analyzed at the point of definition.
7045            --  We must preserve references that were global to the enclosing
7046            --  parent at that point. Other occurrences, whether global or
7047            --  local to the current generic, must be resolved anew, so we
7048            --  reset the entity in the generic copy. A global reference has a
7049            --  smaller depth than the parent, or else the same depth in case
7050            --  both are distinct compilation units.
7051
7052            --  A child unit is implicitly declared within the enclosing parent
7053            --  but is in fact global to it, and must be preserved.
7054
7055            --  It is also possible for Current_Instantiated_Parent to be
7056            --  defined, and for this not to be a nested generic, namely if
7057            --  the unit is loaded through Rtsfind. In that case, the entity of
7058            --  New_N is only a link to the associated node, and not a defining
7059            --  occurrence.
7060
7061            --  The entities for parent units in the defining_program_unit of a
7062            --  generic child unit are established when the context of the unit
7063            --  is first analyzed, before the generic copy is made. They are
7064            --  preserved in the copy for use in ASIS queries.
7065
7066            Ent := Entity (New_N);
7067
7068            if No (Current_Instantiated_Parent.Gen_Id) then
7069               if No (Ent)
7070                 or else Nkind (Ent) /= N_Defining_Identifier
7071                 or else not In_Defining_Unit_Name (N)
7072               then
7073                  Set_Associated_Node (New_N, Empty);
7074               end if;
7075
7076            elsif No (Ent)
7077              or else
7078                not Nkind_In (Ent, N_Defining_Identifier,
7079                                   N_Defining_Character_Literal,
7080                                   N_Defining_Operator_Symbol)
7081              or else No (Scope (Ent))
7082              or else
7083                (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
7084                  and then not Is_Child_Unit (Ent))
7085              or else
7086                (Scope_Depth (Scope (Ent)) >
7087                             Scope_Depth (Current_Instantiated_Parent.Gen_Id)
7088                  and then
7089                    Get_Source_Unit (Ent) =
7090                    Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
7091            then
7092               Set_Associated_Node (New_N, Empty);
7093            end if;
7094
7095         --  Case of instantiating identifier or some other name or operator
7096
7097         else
7098            --  If the associated node is still defined, the entity in it
7099            --  is global, and must be copied to the instance. If this copy
7100            --  is being made for a body to inline, it is applied to an
7101            --  instantiated tree, and the entity is already present and
7102            --  must be also preserved.
7103
7104            declare
7105               Assoc : constant Node_Id := Get_Associated_Node (N);
7106
7107            begin
7108               if Present (Assoc) then
7109                  if Nkind (Assoc) = Nkind (N) then
7110                     Set_Entity (New_N, Entity (Assoc));
7111                     Check_Private_View (N);
7112
7113                  --  The name in the call may be a selected component if the
7114                  --  call has not been analyzed yet, as may be the case for
7115                  --  pre/post conditions in a generic unit.
7116
7117                  elsif Nkind (Assoc) = N_Function_Call
7118                    and then Is_Entity_Name (Name (Assoc))
7119                  then
7120                     Set_Entity (New_N, Entity (Name (Assoc)));
7121
7122                  elsif Nkind_In (Assoc, N_Defining_Identifier,
7123                                         N_Defining_Character_Literal,
7124                                         N_Defining_Operator_Symbol)
7125                    and then Expander_Active
7126                  then
7127                     --  Inlining case: we are copying a tree that contains
7128                     --  global entities, which are preserved in the copy to be
7129                     --  used for subsequent inlining.
7130
7131                     null;
7132
7133                  else
7134                     Set_Entity (New_N, Empty);
7135                  end if;
7136               end if;
7137            end;
7138         end if;
7139
7140         --  For expanded name, we must copy the Prefix and Selector_Name
7141
7142         if Nkind (N) = N_Expanded_Name then
7143            Set_Prefix
7144              (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
7145
7146            Set_Selector_Name (New_N,
7147              Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
7148
7149         --  For operators, we must copy the right operand
7150
7151         elsif Nkind (N) in N_Op then
7152            Set_Right_Opnd (New_N,
7153              Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
7154
7155            --  And for binary operators, the left operand as well
7156
7157            if Nkind (N) in N_Binary_Op then
7158               Set_Left_Opnd (New_N,
7159                 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
7160            end if;
7161         end if;
7162
7163      --  Special casing for stubs
7164
7165      elsif Nkind (N) in N_Body_Stub then
7166
7167         --  In any case, we must copy the specification or defining
7168         --  identifier as appropriate.
7169
7170         if Nkind (N) = N_Subprogram_Body_Stub then
7171            Set_Specification (New_N,
7172              Copy_Generic_Node (Specification (N), New_N, Instantiating));
7173
7174         else
7175            Set_Defining_Identifier (New_N,
7176              Copy_Generic_Node
7177                (Defining_Identifier (N), New_N, Instantiating));
7178         end if;
7179
7180         --  If we are not instantiating, then this is where we load and
7181         --  analyze subunits, i.e. at the point where the stub occurs. A
7182         --  more permissive system might defer this analysis to the point
7183         --  of instantiation, but this seems too complicated for now.
7184
7185         if not Instantiating then
7186            declare
7187               Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
7188               Subunit      : Node_Id;
7189               Unum         : Unit_Number_Type;
7190               New_Body     : Node_Id;
7191
7192            begin
7193               --  Make sure that, if it is a subunit of the main unit that is
7194               --  preprocessed and if -gnateG is specified, the preprocessed
7195               --  file will be written.
7196
7197               Lib.Analysing_Subunit_Of_Main :=
7198                 Lib.In_Extended_Main_Source_Unit (N);
7199               Unum :=
7200                 Load_Unit
7201                   (Load_Name  => Subunit_Name,
7202                    Required   => False,
7203                    Subunit    => True,
7204                    Error_Node => N);
7205               Lib.Analysing_Subunit_Of_Main := False;
7206
7207               --  If the proper body is not found, a warning message will be
7208               --  emitted when analyzing the stub, or later at the point of
7209               --  instantiation. Here we just leave the stub as is.
7210
7211               if Unum = No_Unit then
7212                  Subunits_Missing := True;
7213                  goto Subunit_Not_Found;
7214               end if;
7215
7216               Subunit := Cunit (Unum);
7217
7218               if Nkind (Unit (Subunit)) /= N_Subunit then
7219                  Error_Msg_N
7220                    ("found child unit instead of expected SEPARATE subunit",
7221                     Subunit);
7222                  Error_Msg_Sloc := Sloc (N);
7223                  Error_Msg_N ("\to complete stub #", Subunit);
7224                  goto Subunit_Not_Found;
7225               end if;
7226
7227               --  We must create a generic copy of the subunit, in order to
7228               --  perform semantic analysis on it, and we must replace the
7229               --  stub in the original generic unit with the subunit, in order
7230               --  to preserve non-local references within.
7231
7232               --  Only the proper body needs to be copied. Library_Unit and
7233               --  context clause are simply inherited by the generic copy.
7234               --  Note that the copy (which may be recursive if there are
7235               --  nested subunits) must be done first, before attaching it to
7236               --  the enclosing generic.
7237
7238               New_Body :=
7239                 Copy_Generic_Node
7240                   (Proper_Body (Unit (Subunit)),
7241                    Empty, Instantiating => False);
7242
7243               --  Now place the original proper body in the original generic
7244               --  unit. This is a body, not a compilation unit.
7245
7246               Rewrite (N, Proper_Body (Unit (Subunit)));
7247               Set_Is_Compilation_Unit (Defining_Entity (N), False);
7248               Set_Was_Originally_Stub (N);
7249
7250               --  Finally replace the body of the subunit with its copy, and
7251               --  make this new subunit into the library unit of the generic
7252               --  copy, which does not have stubs any longer.
7253
7254               Set_Proper_Body (Unit (Subunit), New_Body);
7255               Set_Library_Unit (New_N, Subunit);
7256               Inherit_Context (Unit (Subunit), N);
7257            end;
7258
7259         --  If we are instantiating, this must be an error case, since
7260         --  otherwise we would have replaced the stub node by the proper body
7261         --  that corresponds. So just ignore it in the copy (i.e. we have
7262         --  copied it, and that is good enough).
7263
7264         else
7265            null;
7266         end if;
7267
7268         <<Subunit_Not_Found>> null;
7269
7270      --  If the node is a compilation unit, it is the subunit of a stub, which
7271      --  has been loaded already (see code below). In this case, the library
7272      --  unit field of N points to the parent unit (which is a compilation
7273      --  unit) and need not (and cannot) be copied.
7274
7275      --  When the proper body of the stub is analyzed, the library_unit link
7276      --  is used to establish the proper context (see sem_ch10).
7277
7278      --  The other fields of a compilation unit are copied as usual
7279
7280      elsif Nkind (N) = N_Compilation_Unit then
7281
7282         --  This code can only be executed when not instantiating, because in
7283         --  the copy made for an instantiation, the compilation unit node has
7284         --  disappeared at the point that a stub is replaced by its proper
7285         --  body.
7286
7287         pragma Assert (not Instantiating);
7288
7289         Set_Context_Items (New_N,
7290           Copy_Generic_List (Context_Items (N), New_N));
7291
7292         Set_Unit (New_N,
7293           Copy_Generic_Node (Unit (N), New_N, False));
7294
7295         Set_First_Inlined_Subprogram (New_N,
7296           Copy_Generic_Node
7297             (First_Inlined_Subprogram (N), New_N, False));
7298
7299         Set_Aux_Decls_Node (New_N,
7300           Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
7301
7302      --  For an assignment node, the assignment is known to be semantically
7303      --  legal if we are instantiating the template. This avoids incorrect
7304      --  diagnostics in generated code.
7305
7306      elsif Nkind (N) = N_Assignment_Statement then
7307
7308         --  Copy name and expression fields in usual manner
7309
7310         Set_Name (New_N,
7311           Copy_Generic_Node (Name (N), New_N, Instantiating));
7312
7313         Set_Expression (New_N,
7314           Copy_Generic_Node (Expression (N), New_N, Instantiating));
7315
7316         if Instantiating then
7317            Set_Assignment_OK (Name (New_N), True);
7318         end if;
7319
7320      elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
7321         if not Instantiating then
7322            Set_Associated_Node (N, New_N);
7323
7324         else
7325            if Present (Get_Associated_Node (N))
7326              and then Nkind (Get_Associated_Node (N)) = Nkind (N)
7327            then
7328               --  In the generic the aggregate has some composite type. If at
7329               --  the point of instantiation the type has a private view,
7330               --  install the full view (and that of its ancestors, if any).
7331
7332               declare
7333                  T   : Entity_Id := (Etype (Get_Associated_Node (New_N)));
7334                  Rt  : Entity_Id;
7335
7336               begin
7337                  if Present (T) and then Is_Private_Type (T) then
7338                     Switch_View (T);
7339                  end if;
7340
7341                  if Present (T)
7342                    and then Is_Tagged_Type (T)
7343                    and then Is_Derived_Type (T)
7344                  then
7345                     Rt := Root_Type (T);
7346
7347                     loop
7348                        T := Etype (T);
7349
7350                        if Is_Private_Type (T) then
7351                           Switch_View (T);
7352                        end if;
7353
7354                        exit when T = Rt;
7355                     end loop;
7356                  end if;
7357               end;
7358            end if;
7359         end if;
7360
7361         --  Do not copy the associated node, which points to the generic copy
7362         --  of the aggregate.
7363
7364         declare
7365            use Atree.Unchecked_Access;
7366            --  This code section is part of the implementation of an untyped
7367            --  tree traversal, so it needs direct access to node fields.
7368
7369         begin
7370            Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
7371            Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
7372            Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
7373            Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
7374         end;
7375
7376      --  Allocators do not have an identifier denoting the access type, so we
7377      --  must locate it through the expression to check whether the views are
7378      --  consistent.
7379
7380      elsif Nkind (N) = N_Allocator
7381        and then Nkind (Expression (N)) = N_Qualified_Expression
7382        and then Is_Entity_Name (Subtype_Mark (Expression (N)))
7383        and then Instantiating
7384      then
7385         declare
7386            T     : constant Node_Id :=
7387                      Get_Associated_Node (Subtype_Mark (Expression (N)));
7388            Acc_T : Entity_Id;
7389
7390         begin
7391            if Present (T) then
7392
7393               --  Retrieve the allocator node in the generic copy
7394
7395               Acc_T := Etype (Parent (Parent (T)));
7396
7397               if Present (Acc_T) and then Is_Private_Type (Acc_T) then
7398                  Switch_View (Acc_T);
7399               end if;
7400            end if;
7401
7402            Copy_Descendants;
7403         end;
7404
7405      --  For a proper body, we must catch the case of a proper body that
7406      --  replaces a stub. This represents the point at which a separate
7407      --  compilation unit, and hence template file, may be referenced, so we
7408      --  must make a new source instantiation entry for the template of the
7409      --  subunit, and ensure that all nodes in the subunit are adjusted using
7410      --  this new source instantiation entry.
7411
7412      elsif Nkind (N) in N_Proper_Body then
7413         declare
7414            Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
7415
7416         begin
7417            if Instantiating and then Was_Originally_Stub (N) then
7418               Create_Instantiation_Source
7419                 (Instantiation_Node,
7420                  Defining_Entity (N),
7421                  False,
7422                  S_Adjustment);
7423            end if;
7424
7425            --  Now copy the fields of the proper body, using the new
7426            --  adjustment factor if one was needed as per test above.
7427
7428            Copy_Descendants;
7429
7430            --  Restore the original adjustment factor in case changed
7431
7432            S_Adjustment := Save_Adjustment;
7433         end;
7434
7435      --  Don't copy Ident or Comment pragmas, since the comment belongs to the
7436      --  generic unit, not to the instantiating unit.
7437
7438      elsif Nkind (N) = N_Pragma and then Instantiating then
7439         declare
7440            Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
7441         begin
7442            if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
7443               New_N := Make_Null_Statement (Sloc (N));
7444            else
7445               Copy_Descendants;
7446            end if;
7447         end;
7448
7449      elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
7450
7451         --  No descendant fields need traversing
7452
7453         null;
7454
7455      elsif Nkind (N) = N_String_Literal
7456        and then Present (Etype (N))
7457        and then Instantiating
7458      then
7459         --  If the string is declared in an outer scope, the string_literal
7460         --  subtype created for it may have the wrong scope. Force reanalysis
7461         --  of the constant to generate a new itype in the proper context.
7462
7463         Set_Etype (New_N, Empty);
7464         Set_Analyzed (New_N, False);
7465
7466      --  For the remaining nodes, copy their descendants recursively
7467
7468      else
7469         Copy_Descendants;
7470
7471         if Instantiating and then Nkind (N) = N_Subprogram_Body then
7472            Set_Generic_Parent (Specification (New_N), N);
7473
7474            --  Should preserve Corresponding_Spec??? (12.3(14))
7475         end if;
7476      end if;
7477
7478      return New_N;
7479   end Copy_Generic_Node;
7480
7481   ----------------------------
7482   -- Denotes_Formal_Package --
7483   ----------------------------
7484
7485   function Denotes_Formal_Package
7486     (Pack     : Entity_Id;
7487      On_Exit  : Boolean := False;
7488      Instance : Entity_Id := Empty) return Boolean
7489   is
7490      Par  : Entity_Id;
7491      Scop : constant Entity_Id := Scope (Pack);
7492      E    : Entity_Id;
7493
7494      function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7495      --  The package in question may be an actual for a previous formal
7496      --  package P of the current instance, so examine its actuals as well.
7497      --  This must be recursive over other formal packages.
7498
7499      ----------------------------------
7500      -- Is_Actual_Of_Previous_Formal --
7501      ----------------------------------
7502
7503      function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7504         E1 : Entity_Id;
7505
7506      begin
7507         E1 := First_Entity (P);
7508         while Present (E1) and then  E1 /= Instance loop
7509            if Ekind (E1) = E_Package
7510              and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7511            then
7512               if Renamed_Object (E1) = Pack then
7513                  return True;
7514
7515               elsif E1 = P or else  Renamed_Object (E1) = P then
7516                  return False;
7517
7518               elsif Is_Actual_Of_Previous_Formal (E1) then
7519                  return True;
7520               end if;
7521            end if;
7522
7523            Next_Entity (E1);
7524         end loop;
7525
7526         return False;
7527      end Is_Actual_Of_Previous_Formal;
7528
7529   --  Start of processing for Denotes_Formal_Package
7530
7531   begin
7532      if On_Exit then
7533         Par :=
7534           Instance_Envs.Table
7535             (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7536      else
7537         Par := Current_Instantiated_Parent.Act_Id;
7538      end if;
7539
7540      if Ekind (Scop) = E_Generic_Package
7541        or else Nkind (Unit_Declaration_Node (Scop)) =
7542                                         N_Generic_Subprogram_Declaration
7543      then
7544         return True;
7545
7546      elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7547        N_Formal_Package_Declaration
7548      then
7549         return True;
7550
7551      elsif No (Par) then
7552         return False;
7553
7554      else
7555         --  Check whether this package is associated with a formal package of
7556         --  the enclosing instantiation. Iterate over the list of renamings.
7557
7558         E := First_Entity (Par);
7559         while Present (E) loop
7560            if Ekind (E) /= E_Package
7561              or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7562            then
7563               null;
7564
7565            elsif Renamed_Object (E) = Par then
7566               return False;
7567
7568            elsif Renamed_Object (E) = Pack then
7569               return True;
7570
7571            elsif Is_Actual_Of_Previous_Formal (E) then
7572               return True;
7573
7574            end if;
7575
7576            Next_Entity (E);
7577         end loop;
7578
7579         return False;
7580      end if;
7581   end Denotes_Formal_Package;
7582
7583   -----------------
7584   -- End_Generic --
7585   -----------------
7586
7587   procedure End_Generic is
7588   begin
7589      --  ??? More things could be factored out in this routine. Should
7590      --  probably be done at a later stage.
7591
7592      Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7593      Generic_Flags.Decrement_Last;
7594
7595      Expander_Mode_Restore;
7596   end End_Generic;
7597
7598   -------------
7599   -- Earlier --
7600   -------------
7601
7602   function Earlier (N1, N2 : Node_Id) return Boolean is
7603      procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7604      --  Find distance from given node to enclosing compilation unit
7605
7606      ----------------
7607      -- Find_Depth --
7608      ----------------
7609
7610      procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7611      begin
7612         while Present (P)
7613           and then Nkind (P) /= N_Compilation_Unit
7614         loop
7615            P := True_Parent (P);
7616            D := D + 1;
7617         end loop;
7618      end Find_Depth;
7619
7620      --  Local declarations
7621
7622      D1 : Integer := 0;
7623      D2 : Integer := 0;
7624      P1 : Node_Id := N1;
7625      P2 : Node_Id := N2;
7626      T1 : Source_Ptr;
7627      T2 : Source_Ptr;
7628
7629   --  Start of processing for Earlier
7630
7631   begin
7632      Find_Depth (P1, D1);
7633      Find_Depth (P2, D2);
7634
7635      if P1 /= P2 then
7636         return False;
7637      else
7638         P1 := N1;
7639         P2 := N2;
7640      end if;
7641
7642      while D1 > D2 loop
7643         P1 := True_Parent (P1);
7644         D1 := D1 - 1;
7645      end loop;
7646
7647      while D2 > D1 loop
7648         P2 := True_Parent (P2);
7649         D2 := D2 - 1;
7650      end loop;
7651
7652      --  At this point P1 and P2 are at the same distance from the root.
7653      --  We examine their parents until we find a common declarative list.
7654      --  If we reach the root, N1 and N2 do not descend from the same
7655      --  declarative list (e.g. one is nested in the declarative part and
7656      --  the other is in a block in the statement part) and the earlier
7657      --  one is already frozen.
7658
7659      while not Is_List_Member (P1)
7660        or else not Is_List_Member (P2)
7661        or else List_Containing (P1) /= List_Containing (P2)
7662      loop
7663         P1 := True_Parent (P1);
7664         P2 := True_Parent (P2);
7665
7666         if Nkind (Parent (P1)) = N_Subunit then
7667            P1 := Corresponding_Stub (Parent (P1));
7668         end if;
7669
7670         if Nkind (Parent (P2)) = N_Subunit then
7671            P2 := Corresponding_Stub (Parent (P2));
7672         end if;
7673
7674         if P1 = P2 then
7675            return False;
7676         end if;
7677      end loop;
7678
7679      --  Expanded code usually shares the source location of the original
7680      --  construct it was generated for. This however may not necessarely
7681      --  reflect the true location of the code within the tree.
7682
7683      --  Before comparing the slocs of the two nodes, make sure that we are
7684      --  working with correct source locations. Assume that P1 is to the left
7685      --  of P2. If either one does not come from source, traverse the common
7686      --  list heading towards the other node and locate the first source
7687      --  statement.
7688
7689      --             P1                     P2
7690      --     ----+===+===+--------------+===+===+----
7691      --          expanded code          expanded code
7692
7693      if not Comes_From_Source (P1) then
7694         while Present (P1) loop
7695
7696            --  Neither P2 nor a source statement were located during the
7697            --  search. If we reach the end of the list, then P1 does not
7698            --  occur earlier than P2.
7699
7700            --                     ---->
7701            --   start --- P2 ----- P1 --- end
7702
7703            if No (Next (P1)) then
7704               return False;
7705
7706            --  We encounter P2 while going to the right of the list. This
7707            --  means that P1 does indeed appear earlier.
7708
7709            --             ---->
7710            --    start --- P1 ===== P2 --- end
7711            --                 expanded code in between
7712
7713            elsif P1 = P2 then
7714               return True;
7715
7716            --  No need to look any further since we have located a source
7717            --  statement.
7718
7719            elsif Comes_From_Source (P1) then
7720               exit;
7721            end if;
7722
7723            --  Keep going right
7724
7725            Next (P1);
7726         end loop;
7727      end if;
7728
7729      if not Comes_From_Source (P2) then
7730         while Present (P2) loop
7731
7732            --  Neither P1 nor a source statement were located during the
7733            --  search. If we reach the start of the list, then P1 does not
7734            --  occur earlier than P2.
7735
7736            --            <----
7737            --    start --- P2 --- P1 --- end
7738
7739            if No (Prev (P2)) then
7740               return False;
7741
7742            --  We encounter P1 while going to the left of the list. This
7743            --  means that P1 does indeed appear earlier.
7744
7745            --                     <----
7746            --    start --- P1 ===== P2 --- end
7747            --                 expanded code in between
7748
7749            elsif P2 = P1 then
7750               return True;
7751
7752            --  No need to look any further since we have located a source
7753            --  statement.
7754
7755            elsif Comes_From_Source (P2) then
7756               exit;
7757            end if;
7758
7759            --  Keep going left
7760
7761            Prev (P2);
7762         end loop;
7763      end if;
7764
7765      --  At this point either both nodes came from source or we approximated
7766      --  their source locations through neighbouring source statements.
7767
7768      T1 := Top_Level_Location (Sloc (P1));
7769      T2 := Top_Level_Location (Sloc (P2));
7770
7771      --  When two nodes come from the same instance, they have identical top
7772      --  level locations. To determine proper relation within the tree, check
7773      --  their locations within the template.
7774
7775      if T1 = T2 then
7776         return Sloc (P1) < Sloc (P2);
7777
7778      --  The two nodes either come from unrelated instances or do not come
7779      --  from instantiated code at all.
7780
7781      else
7782         return T1 < T2;
7783      end if;
7784   end Earlier;
7785
7786   ----------------------
7787   -- Find_Actual_Type --
7788   ----------------------
7789
7790   function Find_Actual_Type
7791     (Typ      : Entity_Id;
7792      Gen_Type : Entity_Id) return Entity_Id
7793   is
7794      Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7795      T         : Entity_Id;
7796
7797   begin
7798      --  Special processing only applies to child units
7799
7800      if not Is_Child_Unit (Gen_Scope) then
7801         return Get_Instance_Of (Typ);
7802
7803      --  If designated or component type is itself a formal of the child unit,
7804      --  its instance is available.
7805
7806      elsif Scope (Typ) = Gen_Scope then
7807         return Get_Instance_Of (Typ);
7808
7809      --  If the array or access type is not declared in the parent unit,
7810      --  no special processing needed.
7811
7812      elsif not Is_Generic_Type (Typ)
7813        and then Scope (Gen_Scope) /= Scope (Typ)
7814      then
7815         return Get_Instance_Of (Typ);
7816
7817      --  Otherwise, retrieve designated or component type by visibility
7818
7819      else
7820         T := Current_Entity (Typ);
7821         while Present (T) loop
7822            if In_Open_Scopes (Scope (T)) then
7823               return T;
7824            elsif Is_Generic_Actual_Type (T) then
7825               return T;
7826            end if;
7827
7828            T := Homonym (T);
7829         end loop;
7830
7831         return Typ;
7832      end if;
7833   end Find_Actual_Type;
7834
7835   ----------------------------
7836   -- Freeze_Subprogram_Body --
7837   ----------------------------
7838
7839   procedure Freeze_Subprogram_Body
7840     (Inst_Node : Node_Id;
7841      Gen_Body  : Node_Id;
7842      Pack_Id   : Entity_Id)
7843  is
7844      Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7845      Par      : constant Entity_Id := Scope (Gen_Unit);
7846      E_G_Id   : Entity_Id;
7847      Enc_G    : Entity_Id;
7848      Enc_I    : Node_Id;
7849      F_Node   : Node_Id;
7850
7851      function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7852      --  Find innermost package body that encloses the given node, and which
7853      --  is not a compilation unit. Freeze nodes for the instance, or for its
7854      --  enclosing body, may be inserted after the enclosing_body of the
7855      --  generic unit. Used to determine proper placement of freeze node for
7856      --  both package and subprogram instances.
7857
7858      function Package_Freeze_Node (B : Node_Id) return Node_Id;
7859      --  Find entity for given package body, and locate or create a freeze
7860      --  node for it.
7861
7862      ----------------------------
7863      -- Enclosing_Package_Body --
7864      ----------------------------
7865
7866      function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7867         P : Node_Id;
7868
7869      begin
7870         P := Parent (N);
7871         while Present (P)
7872           and then Nkind (Parent (P)) /= N_Compilation_Unit
7873         loop
7874            if Nkind (P) = N_Package_Body then
7875               if Nkind (Parent (P)) = N_Subunit then
7876                  return Corresponding_Stub (Parent (P));
7877               else
7878                  return P;
7879               end if;
7880            end if;
7881
7882            P := True_Parent (P);
7883         end loop;
7884
7885         return Empty;
7886      end Enclosing_Package_Body;
7887
7888      -------------------------
7889      -- Package_Freeze_Node --
7890      -------------------------
7891
7892      function Package_Freeze_Node (B : Node_Id) return Node_Id is
7893         Id : Entity_Id;
7894
7895      begin
7896         if Nkind (B) = N_Package_Body then
7897            Id := Corresponding_Spec (B);
7898         else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7899            Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7900         end if;
7901
7902         Ensure_Freeze_Node (Id);
7903         return Freeze_Node (Id);
7904      end Package_Freeze_Node;
7905
7906   --  Start of processing of Freeze_Subprogram_Body
7907
7908   begin
7909      --  If the instance and the generic body appear within the same unit, and
7910      --  the instance precedes the generic, the freeze node for the instance
7911      --  must appear after that of the generic. If the generic is nested
7912      --  within another instance I2, then current instance must be frozen
7913      --  after I2. In both cases, the freeze nodes are those of enclosing
7914      --  packages. Otherwise, the freeze node is placed at the end of the
7915      --  current declarative part.
7916
7917      Enc_G  := Enclosing_Package_Body (Gen_Body);
7918      Enc_I  := Enclosing_Package_Body (Inst_Node);
7919      Ensure_Freeze_Node (Pack_Id);
7920      F_Node := Freeze_Node (Pack_Id);
7921
7922      if Is_Generic_Instance (Par)
7923        and then Present (Freeze_Node (Par))
7924        and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7925      then
7926         --  The parent was a premature instantiation. Insert freeze node at
7927         --  the end the current declarative part.
7928
7929         if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7930            Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7931
7932         --  Handle the following case:
7933         --
7934         --    package Parent_Inst is new ...
7935         --    Parent_Inst []
7936         --
7937         --    procedure P ...  --  this body freezes Parent_Inst
7938         --
7939         --    package Inst is new ...
7940         --
7941         --  In this particular scenario, the freeze node for Inst must be
7942         --  inserted in the same manner as that of Parent_Inst - before the
7943         --  next source body or at the end of the declarative list (body not
7944         --  available). If body P did not exist and Parent_Inst was frozen
7945         --  after Inst, either by a body following Inst or at the end of the
7946         --  declarative region, the freeze node for Inst must be inserted
7947         --  after that of Parent_Inst. This relation is established by
7948         --  comparing the Slocs of Parent_Inst freeze node and Inst.
7949
7950         elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7951               List_Containing (Inst_Node)
7952           and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7953         then
7954            Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7955
7956         else
7957            Insert_After (Freeze_Node (Par), F_Node);
7958         end if;
7959
7960      --  The body enclosing the instance should be frozen after the body that
7961      --  includes the generic, because the body of the instance may make
7962      --  references to entities therein. If the two are not in the same
7963      --  declarative part, or if the one enclosing the instance is frozen
7964      --  already, freeze the instance at the end of the current declarative
7965      --  part.
7966
7967      elsif Is_Generic_Instance (Par)
7968        and then Present (Freeze_Node (Par))
7969        and then Present (Enc_I)
7970      then
7971         if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7972           or else
7973             (Nkind (Enc_I) = N_Package_Body
7974               and then
7975                 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7976         then
7977            --  The enclosing package may contain several instances. Rather
7978            --  than computing the earliest point at which to insert its freeze
7979            --  node, we place it at the end of the declarative part of the
7980            --  parent of the generic.
7981
7982            Insert_Freeze_Node_For_Instance
7983              (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7984         end if;
7985
7986         Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7987
7988      elsif Present (Enc_G)
7989        and then Present (Enc_I)
7990        and then Enc_G /= Enc_I
7991        and then Earlier (Inst_Node, Gen_Body)
7992      then
7993         if Nkind (Enc_G) = N_Package_Body then
7994            E_G_Id :=
7995              Corresponding_Spec (Enc_G);
7996         else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7997            E_G_Id :=
7998              Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7999         end if;
8000
8001         --  Freeze package that encloses instance, and place node after the
8002         --  package that encloses generic. If enclosing package is already
8003         --  frozen we have to assume it is at the proper place. This may be a
8004         --  potential ABE that requires dynamic checking. Do not add a freeze
8005         --  node if the package that encloses the generic is inside the body
8006         --  that encloses the instance, because the freeze node would be in
8007         --  the wrong scope. Additional contortions needed if the bodies are
8008         --  within a subunit.
8009
8010         declare
8011            Enclosing_Body : Node_Id;
8012
8013         begin
8014            if Nkind (Enc_I) = N_Package_Body_Stub then
8015               Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
8016            else
8017               Enclosing_Body := Enc_I;
8018            end if;
8019
8020            if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
8021               Insert_Freeze_Node_For_Instance
8022                 (Enc_G, Package_Freeze_Node (Enc_I));
8023            end if;
8024         end;
8025
8026         --  Freeze enclosing subunit before instance
8027
8028         Ensure_Freeze_Node (E_G_Id);
8029
8030         if not Is_List_Member (Freeze_Node (E_G_Id)) then
8031            Insert_After (Enc_G, Freeze_Node (E_G_Id));
8032         end if;
8033
8034         Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
8035
8036      else
8037         --  If none of the above, insert freeze node at the end of the current
8038         --  declarative part.
8039
8040         Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
8041      end if;
8042   end Freeze_Subprogram_Body;
8043
8044   ----------------
8045   -- Get_Gen_Id --
8046   ----------------
8047
8048   function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
8049   begin
8050      return Generic_Renamings.Table (E).Gen_Id;
8051   end Get_Gen_Id;
8052
8053   ---------------------
8054   -- Get_Instance_Of --
8055   ---------------------
8056
8057   function Get_Instance_Of (A : Entity_Id) return Entity_Id is
8058      Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
8059
8060   begin
8061      if Res /= Assoc_Null then
8062         return Generic_Renamings.Table (Res).Act_Id;
8063
8064      else
8065         --  On exit, entity is not instantiated: not a generic parameter, or
8066         --  else parameter of an inner generic unit.
8067
8068         return A;
8069      end if;
8070   end Get_Instance_Of;
8071
8072   ------------------------------------
8073   -- Get_Package_Instantiation_Node --
8074   ------------------------------------
8075
8076   function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
8077      Decl : Node_Id := Unit_Declaration_Node (A);
8078      Inst : Node_Id;
8079
8080   begin
8081      --  If the Package_Instantiation attribute has been set on the package
8082      --  entity, then use it directly when it (or its Original_Node) refers
8083      --  to an N_Package_Instantiation node. In principle it should be
8084      --  possible to have this field set in all cases, which should be
8085      --  investigated, and would allow this function to be significantly
8086      --  simplified. ???
8087
8088      Inst := Package_Instantiation (A);
8089
8090      if Present (Inst) then
8091         if Nkind (Inst) = N_Package_Instantiation then
8092            return Inst;
8093
8094         elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
8095            return Original_Node (Inst);
8096         end if;
8097      end if;
8098
8099      --  If the instantiation is a compilation unit that does not need body
8100      --  then the instantiation node has been rewritten as a package
8101      --  declaration for the instance, and we return the original node.
8102
8103      --  If it is a compilation unit and the instance node has not been
8104      --  rewritten, then it is still the unit of the compilation. Finally, if
8105      --  a body is present, this is a parent of the main unit whose body has
8106      --  been compiled for inlining purposes, and the instantiation node has
8107      --  been rewritten with the instance body.
8108
8109      --  Otherwise the instantiation node appears after the declaration. If
8110      --  the entity is a formal package, the declaration may have been
8111      --  rewritten as a generic declaration (in the case of a formal with box)
8112      --  or left as a formal package declaration if it has actuals, and is
8113      --  found with a forward search.
8114
8115      if Nkind (Parent (Decl)) = N_Compilation_Unit then
8116         if Nkind (Decl) = N_Package_Declaration
8117           and then Present (Corresponding_Body (Decl))
8118         then
8119            Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
8120         end if;
8121
8122         if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
8123            return Original_Node (Decl);
8124         else
8125            return Unit (Parent (Decl));
8126         end if;
8127
8128      elsif Nkind (Decl) = N_Package_Declaration
8129        and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
8130      then
8131         return Original_Node (Decl);
8132
8133      else
8134         Inst := Next (Decl);
8135         while not Nkind_In (Inst, N_Package_Instantiation,
8136                                   N_Formal_Package_Declaration)
8137         loop
8138            Next (Inst);
8139         end loop;
8140
8141         return Inst;
8142      end if;
8143   end Get_Package_Instantiation_Node;
8144
8145   ------------------------
8146   -- Has_Been_Exchanged --
8147   ------------------------
8148
8149   function Has_Been_Exchanged (E : Entity_Id) return Boolean is
8150      Next : Elmt_Id;
8151
8152   begin
8153      Next := First_Elmt (Exchanged_Views);
8154      while Present (Next) loop
8155         if Full_View (Node (Next)) = E then
8156            return True;
8157         end if;
8158
8159         Next_Elmt (Next);
8160      end loop;
8161
8162      return False;
8163   end Has_Been_Exchanged;
8164
8165   ----------
8166   -- Hash --
8167   ----------
8168
8169   function Hash (F : Entity_Id) return HTable_Range is
8170   begin
8171      return HTable_Range (F mod HTable_Size);
8172   end Hash;
8173
8174   ------------------------
8175   -- Hide_Current_Scope --
8176   ------------------------
8177
8178   procedure Hide_Current_Scope is
8179      C : constant Entity_Id := Current_Scope;
8180      E : Entity_Id;
8181
8182   begin
8183      Set_Is_Hidden_Open_Scope (C);
8184
8185      E := First_Entity (C);
8186      while Present (E) loop
8187         if Is_Immediately_Visible (E) then
8188            Set_Is_Immediately_Visible (E, False);
8189            Append_Elmt (E, Hidden_Entities);
8190         end if;
8191
8192         Next_Entity (E);
8193      end loop;
8194
8195      --  Make the scope name invisible as well. This is necessary, but might
8196      --  conflict with calls to Rtsfind later on, in case the scope is a
8197      --  predefined one. There is no clean solution to this problem, so for
8198      --  now we depend on the user not redefining Standard itself in one of
8199      --  the parent units.
8200
8201      if Is_Immediately_Visible (C) and then C /= Standard_Standard then
8202         Set_Is_Immediately_Visible (C, False);
8203         Append_Elmt (C, Hidden_Entities);
8204      end if;
8205
8206   end Hide_Current_Scope;
8207
8208   --------------
8209   -- Init_Env --
8210   --------------
8211
8212   procedure Init_Env is
8213      Saved : Instance_Env;
8214
8215   begin
8216      Saved.Instantiated_Parent  := Current_Instantiated_Parent;
8217      Saved.Exchanged_Views      := Exchanged_Views;
8218      Saved.Hidden_Entities      := Hidden_Entities;
8219      Saved.Current_Sem_Unit     := Current_Sem_Unit;
8220      Saved.Parent_Unit_Visible  := Parent_Unit_Visible;
8221      Saved.Instance_Parent_Unit := Instance_Parent_Unit;
8222
8223      --  Save configuration switches. These may be reset if the unit is a
8224      --  predefined unit, and the current mode is not Ada 2005.
8225
8226      Save_Opt_Config_Switches (Saved.Switches);
8227
8228      Instance_Envs.Append (Saved);
8229
8230      Exchanged_Views := New_Elmt_List;
8231      Hidden_Entities := New_Elmt_List;
8232
8233      --  Make dummy entry for Instantiated parent. If generic unit is legal,
8234      --  this is set properly in Set_Instance_Env.
8235
8236      Current_Instantiated_Parent :=
8237        (Current_Scope, Current_Scope, Assoc_Null);
8238   end Init_Env;
8239
8240   ------------------------------
8241   -- In_Same_Declarative_Part --
8242   ------------------------------
8243
8244   function In_Same_Declarative_Part
8245     (F_Node : Node_Id;
8246      Inst   : Node_Id) return Boolean
8247   is
8248      Decls : constant Node_Id := Parent (F_Node);
8249      Nod   : Node_Id;
8250
8251   begin
8252      Nod := Parent (Inst);
8253      while Present (Nod) loop
8254         if Nod = Decls then
8255            return True;
8256
8257         elsif Nkind_In (Nod, N_Subprogram_Body,
8258                              N_Package_Body,
8259                              N_Package_Declaration,
8260                              N_Task_Body,
8261                              N_Protected_Body,
8262                              N_Block_Statement)
8263         then
8264            return False;
8265
8266         elsif Nkind (Nod) = N_Subunit then
8267            Nod := Corresponding_Stub (Nod);
8268
8269         elsif Nkind (Nod) = N_Compilation_Unit then
8270            return False;
8271
8272         else
8273            Nod := Parent (Nod);
8274         end if;
8275      end loop;
8276
8277      return False;
8278   end In_Same_Declarative_Part;
8279
8280   ---------------------
8281   -- In_Main_Context --
8282   ---------------------
8283
8284   function In_Main_Context (E : Entity_Id) return Boolean is
8285      Context : List_Id;
8286      Clause  : Node_Id;
8287      Nam     : Node_Id;
8288
8289   begin
8290      if not Is_Compilation_Unit (E)
8291        or else Ekind (E) /= E_Package
8292        or else In_Private_Part (E)
8293      then
8294         return False;
8295      end if;
8296
8297      Context := Context_Items (Cunit (Main_Unit));
8298
8299      Clause  := First (Context);
8300      while Present (Clause) loop
8301         if Nkind (Clause) = N_With_Clause then
8302            Nam := Name (Clause);
8303
8304            --  If the current scope is part of the context of the main unit,
8305            --  analysis of the corresponding with_clause is not complete, and
8306            --  the entity is not set. We use the Chars field directly, which
8307            --  might produce false positives in rare cases, but guarantees
8308            --  that we produce all the instance bodies we will need.
8309
8310            if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
8311                 or else (Nkind (Nam) = N_Selected_Component
8312                           and then Chars (Selector_Name (Nam)) = Chars (E))
8313            then
8314               return True;
8315            end if;
8316         end if;
8317
8318         Next (Clause);
8319      end loop;
8320
8321      return False;
8322   end In_Main_Context;
8323
8324   ---------------------
8325   -- Inherit_Context --
8326   ---------------------
8327
8328   procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
8329      Current_Context : List_Id;
8330      Current_Unit    : Node_Id;
8331      Item            : Node_Id;
8332      New_I           : Node_Id;
8333
8334      Clause   : Node_Id;
8335      OK       : Boolean;
8336      Lib_Unit : Node_Id;
8337
8338   begin
8339      if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
8340
8341         --  The inherited context is attached to the enclosing compilation
8342         --  unit. This is either the main unit, or the declaration for the
8343         --  main unit (in case the instantiation appears within the package
8344         --  declaration and the main unit is its body).
8345
8346         Current_Unit := Parent (Inst);
8347         while Present (Current_Unit)
8348           and then Nkind (Current_Unit) /= N_Compilation_Unit
8349         loop
8350            Current_Unit := Parent (Current_Unit);
8351         end loop;
8352
8353         Current_Context := Context_Items (Current_Unit);
8354
8355         Item := First (Context_Items (Parent (Gen_Decl)));
8356         while Present (Item) loop
8357            if Nkind (Item) = N_With_Clause then
8358               Lib_Unit := Library_Unit (Item);
8359
8360               --  Take care to prevent direct cyclic with's
8361
8362               if Lib_Unit /= Current_Unit then
8363
8364                  --  Do not add a unit if it is already in the context
8365
8366                  Clause := First (Current_Context);
8367                  OK := True;
8368                  while Present (Clause) loop
8369                     if Nkind (Clause) = N_With_Clause and then
8370                       Library_Unit (Clause) = Lib_Unit
8371                     then
8372                        OK := False;
8373                        exit;
8374                     end if;
8375
8376                     Next (Clause);
8377                  end loop;
8378
8379                  if OK then
8380                     New_I := New_Copy (Item);
8381                     Set_Implicit_With (New_I, True);
8382                     Set_Implicit_With_From_Instantiation (New_I, True);
8383                     Append (New_I, Current_Context);
8384                  end if;
8385               end if;
8386            end if;
8387
8388            Next (Item);
8389         end loop;
8390      end if;
8391   end Inherit_Context;
8392
8393   ----------------
8394   -- Initialize --
8395   ----------------
8396
8397   procedure Initialize is
8398   begin
8399      Generic_Renamings.Init;
8400      Instance_Envs.Init;
8401      Generic_Flags.Init;
8402      Generic_Renamings_HTable.Reset;
8403      Circularity_Detected := False;
8404      Exchanged_Views      := No_Elist;
8405      Hidden_Entities      := No_Elist;
8406   end Initialize;
8407
8408   -------------------------------------
8409   -- Insert_Freeze_Node_For_Instance --
8410   -------------------------------------
8411
8412   procedure Insert_Freeze_Node_For_Instance
8413     (N      : Node_Id;
8414      F_Node : Node_Id)
8415   is
8416      Decl  : Node_Id;
8417      Decls : List_Id;
8418      Inst  : Entity_Id;
8419      Par_N : Node_Id;
8420
8421      function Enclosing_Body (N : Node_Id) return Node_Id;
8422      --  Find enclosing package or subprogram body, if any. Freeze node may
8423      --  be placed at end of current declarative list if previous instance
8424      --  and current one have different enclosing bodies.
8425
8426      function Previous_Instance (Gen : Entity_Id) return Entity_Id;
8427      --  Find the local instance, if any, that declares the generic that is
8428      --  being instantiated. If present, the freeze node for this instance
8429      --  must follow the freeze node for the previous instance.
8430
8431      --------------------
8432      -- Enclosing_Body --
8433      --------------------
8434
8435      function Enclosing_Body (N : Node_Id) return Node_Id is
8436         P : Node_Id;
8437
8438      begin
8439         P := Parent (N);
8440         while Present (P)
8441           and then Nkind (Parent (P)) /= N_Compilation_Unit
8442         loop
8443            if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
8444               if Nkind (Parent (P)) = N_Subunit then
8445                  return Corresponding_Stub (Parent (P));
8446               else
8447                  return P;
8448               end if;
8449            end if;
8450
8451            P := True_Parent (P);
8452         end loop;
8453
8454         return Empty;
8455      end Enclosing_Body;
8456
8457      -----------------------
8458      -- Previous_Instance --
8459      -----------------------
8460
8461      function Previous_Instance (Gen : Entity_Id) return Entity_Id is
8462         S : Entity_Id;
8463
8464      begin
8465         S := Scope (Gen);
8466         while Present (S) and then S /= Standard_Standard loop
8467            if Is_Generic_Instance (S)
8468              and then In_Same_Source_Unit (S, N)
8469            then
8470               return S;
8471            end if;
8472
8473            S := Scope (S);
8474         end loop;
8475
8476         return Empty;
8477      end Previous_Instance;
8478
8479   --  Start of processing for Insert_Freeze_Node_For_Instance
8480
8481   begin
8482      if not Is_List_Member (F_Node) then
8483         Decl  := N;
8484         Decls := List_Containing (N);
8485         Inst  := Entity (F_Node);
8486         Par_N := Parent (Decls);
8487
8488         --  When processing a subprogram instantiation, utilize the actual
8489         --  subprogram instantiation rather than its package wrapper as it
8490         --  carries all the context information.
8491
8492         if Is_Wrapper_Package (Inst) then
8493            Inst := Related_Instance (Inst);
8494         end if;
8495
8496         --  If this is a package instance, check whether the generic is
8497         --  declared in a previous instance and the current instance is
8498         --  not within the previous one.
8499
8500         if Present (Generic_Parent (Parent (Inst)))
8501           and then Is_In_Main_Unit (N)
8502         then
8503            declare
8504               Enclosing_N : constant Node_Id := Enclosing_Body (N);
8505               Par_I       : constant Entity_Id :=
8506                               Previous_Instance
8507                                 (Generic_Parent (Parent (Inst)));
8508               Scop        : Entity_Id;
8509
8510            begin
8511               if Present (Par_I)
8512                 and then Earlier (N, Freeze_Node (Par_I))
8513               then
8514                  Scop := Scope (Inst);
8515
8516                  --  If the current instance is within the one that contains
8517                  --  the generic, the freeze node for the current one must
8518                  --  appear in the current declarative part. Ditto, if the
8519                  --  current instance is within another package instance or
8520                  --  within a body that does not enclose the current instance.
8521                  --  In these three cases the freeze node of the previous
8522                  --  instance is not relevant.
8523
8524                  while Present (Scop) and then Scop /= Standard_Standard loop
8525                     exit when Scop = Par_I
8526                       or else
8527                         (Is_Generic_Instance (Scop)
8528                           and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8529                     Scop := Scope (Scop);
8530                  end loop;
8531
8532                  --  Previous instance encloses current instance
8533
8534                  if Scop = Par_I then
8535                     null;
8536
8537                  --  If the next node is a source  body we must freeze in
8538                  --  the current scope as well.
8539
8540                  elsif Present (Next (N))
8541                    and then Nkind_In (Next (N), N_Subprogram_Body,
8542                                                 N_Package_Body)
8543                    and then Comes_From_Source (Next (N))
8544                  then
8545                     null;
8546
8547                  --  Current instance is within an unrelated instance
8548
8549                  elsif Is_Generic_Instance (Scop) then
8550                     null;
8551
8552                  --  Current instance is within an unrelated body
8553
8554                  elsif Present (Enclosing_N)
8555                    and then Enclosing_N /= Enclosing_Body (Par_I)
8556                  then
8557                     null;
8558
8559                  else
8560                     Insert_After (Freeze_Node (Par_I), F_Node);
8561                     return;
8562                  end if;
8563               end if;
8564            end;
8565         end if;
8566
8567         --  When the instantiation occurs in a package declaration, append the
8568         --  freeze node to the private declarations (if any).
8569
8570         if Nkind (Par_N) = N_Package_Specification
8571           and then Decls = Visible_Declarations (Par_N)
8572           and then Present (Private_Declarations (Par_N))
8573           and then not Is_Empty_List (Private_Declarations (Par_N))
8574         then
8575            Decls := Private_Declarations (Par_N);
8576            Decl  := First (Decls);
8577         end if;
8578
8579         --  Determine the proper freeze point of a package instantiation. We
8580         --  adhere to the general rule of a package or subprogram body causing
8581         --  freezing of anything before it in the same declarative region. In
8582         --  this case, the proper freeze point of a package instantiation is
8583         --  before the first source body which follows, or before a stub. This
8584         --  ensures that entities coming from the instance are already frozen
8585         --  and usable in source bodies.
8586
8587         if Nkind (Par_N) /= N_Package_Declaration
8588           and then Ekind (Inst) = E_Package
8589           and then Is_Generic_Instance (Inst)
8590           and then
8591             not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8592         then
8593            while Present (Decl) loop
8594               if (Nkind (Decl) in N_Unit_Body
8595                     or else
8596                   Nkind (Decl) in N_Body_Stub)
8597                 and then Comes_From_Source (Decl)
8598               then
8599                  Insert_Before (Decl, F_Node);
8600                  return;
8601               end if;
8602
8603               Next (Decl);
8604            end loop;
8605         end if;
8606
8607         --  In a package declaration, or if no previous body, insert at end
8608         --  of list.
8609
8610         Set_Sloc (F_Node, Sloc (Last (Decls)));
8611         Insert_After (Last (Decls), F_Node);
8612      end if;
8613   end Insert_Freeze_Node_For_Instance;
8614
8615   ------------------
8616   -- Install_Body --
8617   ------------------
8618
8619   procedure Install_Body
8620     (Act_Body : Node_Id;
8621      N        : Node_Id;
8622      Gen_Body : Node_Id;
8623      Gen_Decl : Node_Id)
8624   is
8625      Act_Id    : constant Entity_Id := Corresponding_Spec (Act_Body);
8626      Act_Unit  : constant Node_Id   := Unit (Cunit (Get_Source_Unit (N)));
8627      Gen_Id    : constant Entity_Id := Corresponding_Spec (Gen_Body);
8628      Par       : constant Entity_Id := Scope (Gen_Id);
8629      Gen_Unit  : constant Node_Id   :=
8630                    Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8631      Orig_Body : Node_Id := Gen_Body;
8632      F_Node    : Node_Id;
8633      Body_Unit : Node_Id;
8634
8635      Must_Delay : Boolean;
8636
8637      function In_Same_Enclosing_Subp return Boolean;
8638      --  Check whether instance and generic body are within same subprogram.
8639
8640      function True_Sloc (N : Node_Id) return Source_Ptr;
8641      --  If the instance is nested inside a generic unit, the Sloc of the
8642      --  instance indicates the place of the original definition, not the
8643      --  point of the current enclosing instance. Pending a better usage of
8644      --  Slocs to indicate instantiation places, we determine the place of
8645      --  origin of a node by finding the maximum sloc of any ancestor node.
8646      --  Why is this not equivalent to Top_Level_Location ???
8647
8648      ----------------------------
8649      -- In_Same_Enclosing_Subp --
8650      ----------------------------
8651
8652      function In_Same_Enclosing_Subp return Boolean is
8653         Scop : Entity_Id;
8654         Subp : Entity_Id;
8655
8656      begin
8657         Scop := Scope (Act_Id);
8658         while Scop /= Standard_Standard
8659           and then not Is_Overloadable (Scop)
8660         loop
8661            Scop := Scope (Scop);
8662         end loop;
8663
8664         if Scop = Standard_Standard then
8665            return False;
8666         else
8667            Subp := Scop;
8668         end if;
8669
8670         Scop := Scope (Gen_Id);
8671         while Scop /= Standard_Standard loop
8672            if Scop = Subp then
8673               return True;
8674            else
8675               Scop := Scope (Scop);
8676            end if;
8677         end loop;
8678
8679         return False;
8680      end In_Same_Enclosing_Subp;
8681
8682      ---------------
8683      -- True_Sloc --
8684      ---------------
8685
8686      function True_Sloc (N : Node_Id) return Source_Ptr is
8687         Res : Source_Ptr;
8688         N1  : Node_Id;
8689
8690      begin
8691         Res := Sloc (N);
8692         N1 := N;
8693         while Present (N1) and then N1 /= Act_Unit loop
8694            if Sloc (N1) > Res then
8695               Res := Sloc (N1);
8696            end if;
8697
8698            N1 := Parent (N1);
8699         end loop;
8700
8701         return Res;
8702      end True_Sloc;
8703
8704   --  Start of processing for Install_Body
8705
8706   begin
8707      --  If the body is a subunit, the freeze point is the corresponding stub
8708      --  in the current compilation, not the subunit itself.
8709
8710      if Nkind (Parent (Gen_Body)) = N_Subunit then
8711         Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8712      else
8713         Orig_Body := Gen_Body;
8714      end if;
8715
8716      Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8717
8718      --  If the instantiation and the generic definition appear in the same
8719      --  package declaration, this is an early instantiation. If they appear
8720      --  in the same declarative part, it is an early instantiation only if
8721      --  the generic body appears textually later, and the generic body is
8722      --  also in the main unit.
8723
8724      --  If instance is nested within a subprogram, and the generic body
8725      --  is not, the instance is delayed because the enclosing body is. If
8726      --  instance and body are within the same scope, or the same subprogram
8727      --  body, indicate explicitly that the instance is delayed.
8728
8729      Must_Delay :=
8730        (Gen_Unit = Act_Unit
8731          and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8732                                        N_Generic_Package_Declaration)
8733                     or else (Gen_Unit = Body_Unit
8734                               and then True_Sloc (N) < Sloc (Orig_Body)))
8735          and then Is_In_Main_Unit (Gen_Unit)
8736          and then (Scope (Act_Id) = Scope (Gen_Id)
8737                     or else In_Same_Enclosing_Subp));
8738
8739      --  If this is an early instantiation, the freeze node is placed after
8740      --  the generic body. Otherwise, if the generic appears in an instance,
8741      --  we cannot freeze the current instance until the outer one is frozen.
8742      --  This is only relevant if the current instance is nested within some
8743      --  inner scope not itself within the outer instance. If this scope is
8744      --  a package body in the same declarative part as the outer instance,
8745      --  then that body needs to be frozen after the outer instance. Finally,
8746      --  if no delay is needed, we place the freeze node at the end of the
8747      --  current declarative part.
8748
8749      if Expander_Active then
8750         Ensure_Freeze_Node (Act_Id);
8751         F_Node := Freeze_Node (Act_Id);
8752
8753         if Must_Delay then
8754            Insert_After (Orig_Body, F_Node);
8755
8756         elsif Is_Generic_Instance (Par)
8757           and then Present (Freeze_Node (Par))
8758           and then Scope (Act_Id) /= Par
8759         then
8760            --  Freeze instance of inner generic after instance of enclosing
8761            --  generic.
8762
8763            if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8764
8765               --  Handle the following case:
8766
8767               --    package Parent_Inst is new ...
8768               --    Parent_Inst []
8769
8770               --    procedure P ...  --  this body freezes Parent_Inst
8771
8772               --    package Inst is new ...
8773
8774               --  In this particular scenario, the freeze node for Inst must
8775               --  be inserted in the same manner as that of Parent_Inst,
8776               --  before the next source body or at the end of the declarative
8777               --  list (body not available). If body P did not exist and
8778               --  Parent_Inst was frozen after Inst, either by a body
8779               --  following Inst or at the end of the declarative region,
8780               --  the freeze node for Inst must be inserted after that of
8781               --  Parent_Inst. This relation is established by comparing
8782               --  the Slocs of Parent_Inst freeze node and Inst.
8783
8784               if List_Containing (Get_Package_Instantiation_Node (Par)) =
8785                  List_Containing (N)
8786                 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8787               then
8788                  Insert_Freeze_Node_For_Instance (N, F_Node);
8789               else
8790                  Insert_After (Freeze_Node (Par), F_Node);
8791               end if;
8792
8793            --  Freeze package enclosing instance of inner generic after
8794            --  instance of enclosing generic.
8795
8796            elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8797              and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8798            then
8799               declare
8800                  Enclosing :  Entity_Id;
8801
8802               begin
8803                  Enclosing := Corresponding_Spec (Parent (N));
8804
8805                  if No (Enclosing) then
8806                     Enclosing := Defining_Entity (Parent (N));
8807                  end if;
8808
8809                  Insert_Freeze_Node_For_Instance (N, F_Node);
8810                  Ensure_Freeze_Node (Enclosing);
8811
8812                  if not Is_List_Member (Freeze_Node (Enclosing)) then
8813
8814                     --  The enclosing context is a subunit, insert the freeze
8815                     --  node after the stub.
8816
8817                     if Nkind (Parent (Parent (N))) = N_Subunit then
8818                        Insert_Freeze_Node_For_Instance
8819                          (Corresponding_Stub (Parent (Parent (N))),
8820                           Freeze_Node (Enclosing));
8821
8822                     --  The enclosing context is a package with a stub body
8823                     --  which has already been replaced by the real body.
8824                     --  Insert the freeze node after the actual body.
8825
8826                     elsif Ekind (Enclosing) = E_Package
8827                       and then Present (Body_Entity (Enclosing))
8828                       and then Was_Originally_Stub
8829                                  (Parent (Body_Entity (Enclosing)))
8830                     then
8831                        Insert_Freeze_Node_For_Instance
8832                          (Parent (Body_Entity (Enclosing)),
8833                           Freeze_Node (Enclosing));
8834
8835                     --  The parent instance has been frozen before the body of
8836                     --  the enclosing package, insert the freeze node after
8837                     --  the body.
8838
8839                     elsif List_Containing (Freeze_Node (Par)) =
8840                           List_Containing (Parent (N))
8841                       and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8842                     then
8843                        Insert_Freeze_Node_For_Instance
8844                          (Parent (N), Freeze_Node (Enclosing));
8845
8846                     else
8847                        Insert_After
8848                          (Freeze_Node (Par), Freeze_Node (Enclosing));
8849                     end if;
8850                  end if;
8851               end;
8852
8853            else
8854               Insert_Freeze_Node_For_Instance (N, F_Node);
8855            end if;
8856
8857         else
8858            Insert_Freeze_Node_For_Instance (N, F_Node);
8859         end if;
8860      end if;
8861
8862      Set_Is_Frozen (Act_Id);
8863      Insert_Before (N, Act_Body);
8864      Mark_Rewrite_Insertion (Act_Body);
8865   end Install_Body;
8866
8867   -----------------------------
8868   -- Install_Formal_Packages --
8869   -----------------------------
8870
8871   procedure Install_Formal_Packages (Par : Entity_Id) is
8872      E     : Entity_Id;
8873      Gen   : Entity_Id;
8874      Gen_E : Entity_Id := Empty;
8875
8876   begin
8877      E := First_Entity (Par);
8878
8879      --  If we are installing an instance parent, locate the formal packages
8880      --  of its generic parent.
8881
8882      if Is_Generic_Instance (Par) then
8883         Gen   := Generic_Parent (Package_Specification (Par));
8884         Gen_E := First_Entity (Gen);
8885      end if;
8886
8887      while Present (E) loop
8888         if Ekind (E) = E_Package
8889           and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8890         then
8891            --  If this is the renaming for the parent instance, done
8892
8893            if Renamed_Object (E) = Par then
8894               exit;
8895
8896            --  The visibility of a formal of an enclosing generic is already
8897            --  correct.
8898
8899            elsif Denotes_Formal_Package (E) then
8900               null;
8901
8902            elsif Present (Associated_Formal_Package (E)) then
8903               Check_Generic_Actuals (Renamed_Object (E), True);
8904               Set_Is_Hidden (E, False);
8905
8906               --  Find formal package in generic unit that corresponds to
8907               --  (instance of) formal package in instance.
8908
8909               while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8910                  Next_Entity (Gen_E);
8911               end loop;
8912
8913               if Present (Gen_E) then
8914                  Map_Formal_Package_Entities (Gen_E, E);
8915               end if;
8916            end if;
8917         end if;
8918
8919         Next_Entity (E);
8920
8921         if Present (Gen_E) then
8922            Next_Entity (Gen_E);
8923         end if;
8924      end loop;
8925   end Install_Formal_Packages;
8926
8927   --------------------
8928   -- Install_Parent --
8929   --------------------
8930
8931   procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8932      Ancestors : constant Elist_Id  := New_Elmt_List;
8933      S         : constant Entity_Id := Current_Scope;
8934      Inst_Par  : Entity_Id;
8935      First_Par : Entity_Id;
8936      Inst_Node : Node_Id;
8937      Gen_Par   : Entity_Id;
8938      First_Gen : Entity_Id;
8939      Elmt      : Elmt_Id;
8940
8941      procedure Install_Noninstance_Specs (Par : Entity_Id);
8942      --  Install the scopes of noninstance parent units ending with Par
8943
8944      procedure Install_Spec (Par : Entity_Id);
8945      --  The child unit is within the declarative part of the parent, so the
8946      --  declarations within the parent are immediately visible.
8947
8948      -------------------------------
8949      -- Install_Noninstance_Specs --
8950      -------------------------------
8951
8952      procedure Install_Noninstance_Specs (Par : Entity_Id) is
8953      begin
8954         if Present (Par)
8955           and then Par /= Standard_Standard
8956           and then not In_Open_Scopes (Par)
8957         then
8958            Install_Noninstance_Specs (Scope (Par));
8959            Install_Spec (Par);
8960         end if;
8961      end Install_Noninstance_Specs;
8962
8963      ------------------
8964      -- Install_Spec --
8965      ------------------
8966
8967      procedure Install_Spec (Par : Entity_Id) is
8968         Spec : constant Node_Id := Package_Specification (Par);
8969
8970      begin
8971         --  If this parent of the child instance is a top-level unit,
8972         --  then record the unit and its visibility for later resetting in
8973         --  Remove_Parent. We exclude units that are generic instances, as we
8974         --  only want to record this information for the ultimate top-level
8975         --  noninstance parent (is that always correct???).
8976
8977         if Scope (Par) = Standard_Standard
8978           and then not Is_Generic_Instance (Par)
8979         then
8980            Parent_Unit_Visible := Is_Immediately_Visible (Par);
8981            Instance_Parent_Unit := Par;
8982         end if;
8983
8984         --  Open the parent scope and make it and its declarations visible.
8985         --  If this point is not within a body, then only the visible
8986         --  declarations should be made visible, and installation of the
8987         --  private declarations is deferred until the appropriate point
8988         --  within analysis of the spec being instantiated (see the handling
8989         --  of parent visibility in Analyze_Package_Specification). This is
8990         --  relaxed in the case where the parent unit is Ada.Tags, to avoid
8991         --  private view problems that occur when compiling instantiations of
8992         --  a generic child of that package (Generic_Dispatching_Constructor).
8993         --  If the instance freezes a tagged type, inlinings of operations
8994         --  from Ada.Tags may need the full view of type Tag. If inlining took
8995         --  proper account of establishing visibility of inlined subprograms'
8996         --  parents then it should be possible to remove this
8997         --  special check. ???
8998
8999         Push_Scope (Par);
9000         Set_Is_Immediately_Visible   (Par);
9001         Install_Visible_Declarations (Par);
9002         Set_Use (Visible_Declarations (Spec));
9003
9004         if In_Body or else Is_RTU (Par, Ada_Tags) then
9005            Install_Private_Declarations (Par);
9006            Set_Use (Private_Declarations (Spec));
9007         end if;
9008      end Install_Spec;
9009
9010   --  Start of processing for Install_Parent
9011
9012   begin
9013      --  We need to install the parent instance to compile the instantiation
9014      --  of the child, but the child instance must appear in the current
9015      --  scope. Given that we cannot place the parent above the current scope
9016      --  in the scope stack, we duplicate the current scope and unstack both
9017      --  after the instantiation is complete.
9018
9019      --  If the parent is itself the instantiation of a child unit, we must
9020      --  also stack the instantiation of its parent, and so on. Each such
9021      --  ancestor is the prefix of the name in a prior instantiation.
9022
9023      --  If this is a nested instance, the parent unit itself resolves to
9024      --  a renaming of the parent instance, whose declaration we need.
9025
9026      --  Finally, the parent may be a generic (not an instance) when the
9027      --  child unit appears as a formal package.
9028
9029      Inst_Par := P;
9030
9031      if Present (Renamed_Entity (Inst_Par)) then
9032         Inst_Par := Renamed_Entity (Inst_Par);
9033      end if;
9034
9035      First_Par := Inst_Par;
9036
9037      Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9038
9039      First_Gen := Gen_Par;
9040
9041      while Present (Gen_Par) and then Is_Child_Unit (Gen_Par) loop
9042
9043         --  Load grandparent instance as well
9044
9045         Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
9046
9047         if Nkind (Name (Inst_Node)) = N_Expanded_Name then
9048            Inst_Par := Entity (Prefix (Name (Inst_Node)));
9049
9050            if Present (Renamed_Entity (Inst_Par)) then
9051               Inst_Par := Renamed_Entity (Inst_Par);
9052            end if;
9053
9054            Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9055
9056            if Present (Gen_Par) then
9057               Prepend_Elmt (Inst_Par, Ancestors);
9058
9059            else
9060               --  Parent is not the name of an instantiation
9061
9062               Install_Noninstance_Specs (Inst_Par);
9063               exit;
9064            end if;
9065
9066         else
9067            --  Previous error
9068
9069            exit;
9070         end if;
9071      end loop;
9072
9073      if Present (First_Gen) then
9074         Append_Elmt (First_Par, Ancestors);
9075      else
9076         Install_Noninstance_Specs (First_Par);
9077      end if;
9078
9079      if not Is_Empty_Elmt_List (Ancestors) then
9080         Elmt := First_Elmt (Ancestors);
9081         while Present (Elmt) loop
9082            Install_Spec (Node (Elmt));
9083            Install_Formal_Packages (Node (Elmt));
9084            Next_Elmt (Elmt);
9085         end loop;
9086      end if;
9087
9088      if not In_Body then
9089         Push_Scope (S);
9090      end if;
9091   end Install_Parent;
9092
9093   -------------------------------
9094   -- Install_Hidden_Primitives --
9095   -------------------------------
9096
9097   procedure Install_Hidden_Primitives
9098     (Prims_List : in out Elist_Id;
9099      Gen_T      : Entity_Id;
9100      Act_T      : Entity_Id)
9101   is
9102      Elmt        : Elmt_Id;
9103      List        : Elist_Id := No_Elist;
9104      Prim_G_Elmt : Elmt_Id;
9105      Prim_A_Elmt : Elmt_Id;
9106      Prim_G      : Node_Id;
9107      Prim_A      : Node_Id;
9108
9109   begin
9110      --  No action needed in case of serious errors because we cannot trust
9111      --  in the order of primitives
9112
9113      if Serious_Errors_Detected > 0 then
9114         return;
9115
9116      --  No action possible if we don't have available the list of primitive
9117      --  operations
9118
9119      elsif No (Gen_T)
9120        or else not Is_Record_Type (Gen_T)
9121        or else not Is_Tagged_Type (Gen_T)
9122        or else not Is_Record_Type (Act_T)
9123        or else not Is_Tagged_Type (Act_T)
9124      then
9125         return;
9126
9127      --  There is no need to handle interface types since their primitives
9128      --  cannot be hidden
9129
9130      elsif Is_Interface (Gen_T) then
9131         return;
9132      end if;
9133
9134      Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
9135
9136      if not Is_Class_Wide_Type (Act_T) then
9137         Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
9138      else
9139         Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
9140      end if;
9141
9142      loop
9143         --  Skip predefined primitives in the generic formal
9144
9145         while Present (Prim_G_Elmt)
9146           and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
9147         loop
9148            Next_Elmt (Prim_G_Elmt);
9149         end loop;
9150
9151         --  Skip predefined primitives in the generic actual
9152
9153         while Present (Prim_A_Elmt)
9154           and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
9155         loop
9156            Next_Elmt (Prim_A_Elmt);
9157         end loop;
9158
9159         exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
9160
9161         Prim_G := Node (Prim_G_Elmt);
9162         Prim_A := Node (Prim_A_Elmt);
9163
9164         --  There is no need to handle interface primitives because their
9165         --  primitives are not hidden
9166
9167         exit when Present (Interface_Alias (Prim_G));
9168
9169         --  Here we install one hidden primitive
9170
9171         if Chars (Prim_G) /= Chars (Prim_A)
9172           and then Has_Suffix (Prim_A, 'P')
9173           and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
9174         then
9175            Set_Chars (Prim_A, Chars (Prim_G));
9176            Append_New_Elmt (Prim_A, To => List);
9177         end if;
9178
9179         Next_Elmt (Prim_A_Elmt);
9180         Next_Elmt (Prim_G_Elmt);
9181      end loop;
9182
9183      --  Append the elements to the list of temporarily visible primitives
9184      --  avoiding duplicates.
9185
9186      if Present (List) then
9187         if No (Prims_List) then
9188            Prims_List := New_Elmt_List;
9189         end if;
9190
9191         Elmt := First_Elmt (List);
9192         while Present (Elmt) loop
9193            Append_Unique_Elmt (Node (Elmt), Prims_List);
9194            Next_Elmt (Elmt);
9195         end loop;
9196      end if;
9197   end Install_Hidden_Primitives;
9198
9199   -------------------------------
9200   -- Restore_Hidden_Primitives --
9201   -------------------------------
9202
9203   procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
9204      Prim_Elmt : Elmt_Id;
9205      Prim      : Node_Id;
9206
9207   begin
9208      if Prims_List /= No_Elist then
9209         Prim_Elmt := First_Elmt (Prims_List);
9210         while Present (Prim_Elmt) loop
9211            Prim := Node (Prim_Elmt);
9212            Set_Chars (Prim, Add_Suffix (Prim, 'P'));
9213            Next_Elmt (Prim_Elmt);
9214         end loop;
9215
9216         Prims_List := No_Elist;
9217      end if;
9218   end Restore_Hidden_Primitives;
9219
9220   --------------------------------
9221   -- Instantiate_Formal_Package --
9222   --------------------------------
9223
9224   function Instantiate_Formal_Package
9225     (Formal          : Node_Id;
9226      Actual          : Node_Id;
9227      Analyzed_Formal : Node_Id) return List_Id
9228   is
9229      Loc         : constant Source_Ptr := Sloc (Actual);
9230      Actual_Pack : Entity_Id;
9231      Formal_Pack : Entity_Id;
9232      Gen_Parent  : Entity_Id;
9233      Decls       : List_Id;
9234      Nod         : Node_Id;
9235      Parent_Spec : Node_Id;
9236
9237      procedure Find_Matching_Actual
9238       (F    : Node_Id;
9239        Act  : in out Entity_Id);
9240      --  We need to associate each formal entity in the formal package with
9241      --  the corresponding entity in the actual package. The actual package
9242      --  has been analyzed and possibly expanded, and as a result there is
9243      --  no one-to-one correspondence between the two lists (for example,
9244      --  the actual may include subtypes, itypes, and inherited primitive
9245      --  operations, interspersed among the renaming declarations for the
9246      --  actuals) . We retrieve the corresponding actual by name because each
9247      --  actual has the same name as the formal, and they do appear in the
9248      --  same order.
9249
9250      function Get_Formal_Entity (N : Node_Id) return Entity_Id;
9251      --  Retrieve entity of defining entity of  generic formal parameter.
9252      --  Only the declarations of formals need to be considered when
9253      --  linking them to actuals, but the declarative list may include
9254      --  internal entities generated during analysis, and those are ignored.
9255
9256      procedure Match_Formal_Entity
9257        (Formal_Node : Node_Id;
9258         Formal_Ent  : Entity_Id;
9259         Actual_Ent  : Entity_Id);
9260      --  Associates the formal entity with the actual. In the case where
9261      --  Formal_Ent is a formal package, this procedure iterates through all
9262      --  of its formals and enters associations between the actuals occurring
9263      --  in the formal package's corresponding actual package (given by
9264      --  Actual_Ent) and the formal package's formal parameters. This
9265      --  procedure recurses if any of the parameters is itself a package.
9266
9267      function Is_Instance_Of
9268        (Act_Spec : Entity_Id;
9269         Gen_Anc  : Entity_Id) return Boolean;
9270      --  The actual can be an instantiation of a generic within another
9271      --  instance, in which case there is no direct link from it to the
9272      --  original generic ancestor. In that case, we recognize that the
9273      --  ultimate ancestor is the same by examining names and scopes.
9274
9275      procedure Process_Nested_Formal (Formal : Entity_Id);
9276      --  If the current formal is declared with a box, its own formals are
9277      --  visible in the instance, as they were in the generic, and their
9278      --  Hidden flag must be reset. If some of these formals are themselves
9279      --  packages declared with a box, the processing must be recursive.
9280
9281      --------------------------
9282      -- Find_Matching_Actual --
9283      --------------------------
9284
9285      procedure Find_Matching_Actual
9286        (F   : Node_Id;
9287         Act : in out Entity_Id)
9288     is
9289         Formal_Ent : Entity_Id;
9290
9291      begin
9292         case Nkind (Original_Node (F)) is
9293            when N_Formal_Object_Declaration |
9294                 N_Formal_Type_Declaration   =>
9295               Formal_Ent := Defining_Identifier (F);
9296
9297               while Chars (Act) /= Chars (Formal_Ent) loop
9298                  Next_Entity (Act);
9299               end loop;
9300
9301            when N_Formal_Subprogram_Declaration |
9302                 N_Formal_Package_Declaration    |
9303                 N_Package_Declaration           |
9304                 N_Generic_Package_Declaration   =>
9305               Formal_Ent := Defining_Entity (F);
9306
9307               while Chars (Act) /= Chars (Formal_Ent) loop
9308                  Next_Entity (Act);
9309               end loop;
9310
9311            when others =>
9312               raise Program_Error;
9313         end case;
9314      end Find_Matching_Actual;
9315
9316      -------------------------
9317      -- Match_Formal_Entity --
9318      -------------------------
9319
9320      procedure Match_Formal_Entity
9321        (Formal_Node : Node_Id;
9322         Formal_Ent  : Entity_Id;
9323         Actual_Ent  : Entity_Id)
9324      is
9325         Act_Pkg   : Entity_Id;
9326
9327      begin
9328         Set_Instance_Of (Formal_Ent, Actual_Ent);
9329
9330         if Ekind (Actual_Ent) = E_Package then
9331
9332            --  Record associations for each parameter
9333
9334            Act_Pkg := Actual_Ent;
9335
9336            declare
9337               A_Ent  : Entity_Id := First_Entity (Act_Pkg);
9338               F_Ent  : Entity_Id;
9339               F_Node : Node_Id;
9340
9341               Gen_Decl : Node_Id;
9342               Formals  : List_Id;
9343               Actual   : Entity_Id;
9344
9345            begin
9346               --  Retrieve the actual given in the formal package declaration
9347
9348               Actual := Entity (Name (Original_Node (Formal_Node)));
9349
9350               --  The actual in the formal package declaration  may be a
9351               --  renamed generic package, in which case we want to retrieve
9352               --  the original generic in order to traverse its formal part.
9353
9354               if Present (Renamed_Entity (Actual)) then
9355                  Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
9356               else
9357                  Gen_Decl := Unit_Declaration_Node (Actual);
9358               end if;
9359
9360               Formals := Generic_Formal_Declarations (Gen_Decl);
9361
9362               if Present (Formals) then
9363                  F_Node := First_Non_Pragma (Formals);
9364               else
9365                  F_Node := Empty;
9366               end if;
9367
9368               while Present (A_Ent)
9369                 and then Present (F_Node)
9370                 and then A_Ent /= First_Private_Entity (Act_Pkg)
9371               loop
9372                  F_Ent := Get_Formal_Entity (F_Node);
9373
9374                  if Present (F_Ent) then
9375
9376                     --  This is a formal of the original package. Record
9377                     --  association and recurse.
9378
9379                     Find_Matching_Actual (F_Node, A_Ent);
9380                     Match_Formal_Entity (F_Node, F_Ent, A_Ent);
9381                     Next_Entity (A_Ent);
9382                  end if;
9383
9384                  Next_Non_Pragma (F_Node);
9385               end loop;
9386            end;
9387         end if;
9388      end Match_Formal_Entity;
9389
9390      -----------------------
9391      -- Get_Formal_Entity --
9392      -----------------------
9393
9394      function Get_Formal_Entity (N : Node_Id) return Entity_Id is
9395         Kind : constant Node_Kind := Nkind (Original_Node (N));
9396      begin
9397         case Kind is
9398            when N_Formal_Object_Declaration     =>
9399               return Defining_Identifier (N);
9400
9401            when N_Formal_Type_Declaration       =>
9402               return Defining_Identifier (N);
9403
9404            when N_Formal_Subprogram_Declaration =>
9405               return Defining_Unit_Name (Specification (N));
9406
9407            when N_Formal_Package_Declaration    =>
9408               return Defining_Identifier (Original_Node (N));
9409
9410            when N_Generic_Package_Declaration   =>
9411               return Defining_Identifier (Original_Node (N));
9412
9413            --  All other declarations are introduced by semantic analysis and
9414            --  have no match in the actual.
9415
9416            when others =>
9417               return Empty;
9418         end case;
9419      end Get_Formal_Entity;
9420
9421      --------------------
9422      -- Is_Instance_Of --
9423      --------------------
9424
9425      function Is_Instance_Of
9426        (Act_Spec : Entity_Id;
9427         Gen_Anc  : Entity_Id) return Boolean
9428      is
9429         Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
9430
9431      begin
9432         if No (Gen_Par) then
9433            return False;
9434
9435         --  Simplest case: the generic parent of the actual is the formal
9436
9437         elsif Gen_Par = Gen_Anc then
9438            return True;
9439
9440         elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
9441            return False;
9442
9443         --  The actual may be obtained through several instantiations. Its
9444         --  scope must itself be an instance of a generic declared in the
9445         --  same scope as the formal. Any other case is detected above.
9446
9447         elsif not Is_Generic_Instance (Scope (Gen_Par)) then
9448            return False;
9449
9450         else
9451            return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
9452         end if;
9453      end Is_Instance_Of;
9454
9455      ---------------------------
9456      -- Process_Nested_Formal --
9457      ---------------------------
9458
9459      procedure Process_Nested_Formal (Formal : Entity_Id) is
9460         Ent : Entity_Id;
9461
9462      begin
9463         if Present (Associated_Formal_Package (Formal))
9464           and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9465         then
9466            Ent := First_Entity (Formal);
9467            while Present (Ent) loop
9468               Set_Is_Hidden (Ent, False);
9469               Set_Is_Visible_Formal (Ent);
9470               Set_Is_Potentially_Use_Visible
9471                 (Ent, Is_Potentially_Use_Visible (Formal));
9472
9473               if Ekind (Ent) = E_Package then
9474                  exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9475                  Process_Nested_Formal (Ent);
9476               end if;
9477
9478               Next_Entity (Ent);
9479            end loop;
9480         end if;
9481      end Process_Nested_Formal;
9482
9483   --  Start of processing for Instantiate_Formal_Package
9484
9485   begin
9486      Analyze (Actual);
9487
9488      if not Is_Entity_Name (Actual)
9489        or else  Ekind (Entity (Actual)) /= E_Package
9490      then
9491         Error_Msg_N
9492           ("expect package instance to instantiate formal", Actual);
9493         Abandon_Instantiation (Actual);
9494         raise Program_Error;
9495
9496      else
9497         Actual_Pack := Entity (Actual);
9498         Set_Is_Instantiated (Actual_Pack);
9499
9500         --  The actual may be a renamed package, or an outer generic formal
9501         --  package whose instantiation is converted into a renaming.
9502
9503         if Present (Renamed_Object (Actual_Pack)) then
9504            Actual_Pack := Renamed_Object (Actual_Pack);
9505         end if;
9506
9507         if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9508            Gen_Parent  := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9509            Formal_Pack := Defining_Identifier (Analyzed_Formal);
9510         else
9511            Gen_Parent :=
9512              Generic_Parent (Specification (Analyzed_Formal));
9513            Formal_Pack :=
9514              Defining_Unit_Name (Specification (Analyzed_Formal));
9515         end if;
9516
9517         if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9518            Parent_Spec := Package_Specification (Actual_Pack);
9519         else
9520            Parent_Spec := Parent (Actual_Pack);
9521         end if;
9522
9523         if Gen_Parent = Any_Id then
9524            Error_Msg_N
9525              ("previous error in declaration of formal package", Actual);
9526            Abandon_Instantiation (Actual);
9527
9528         elsif
9529           Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9530         then
9531            null;
9532
9533         else
9534            Error_Msg_NE
9535              ("actual parameter must be instance of&", Actual, Gen_Parent);
9536            Abandon_Instantiation (Actual);
9537         end if;
9538
9539         Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9540         Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9541
9542         Nod :=
9543           Make_Package_Renaming_Declaration (Loc,
9544             Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9545             Name               => New_Occurrence_Of (Actual_Pack, Loc));
9546
9547         Set_Associated_Formal_Package
9548           (Defining_Unit_Name (Nod), Defining_Identifier (Formal));
9549         Decls := New_List (Nod);
9550
9551         --  If the formal F has a box, then the generic declarations are
9552         --  visible in the generic G. In an instance of G, the corresponding
9553         --  entities in the actual for F (which are the actuals for the
9554         --  instantiation of the generic that F denotes) must also be made
9555         --  visible for analysis of the current instance. On exit from the
9556         --  current instance, those entities are made private again. If the
9557         --  actual is currently in use, these entities are also use-visible.
9558
9559         --  The loop through the actual entities also steps through the formal
9560         --  entities and enters associations from formals to actuals into the
9561         --  renaming map. This is necessary to properly handle checking of
9562         --  actual parameter associations for later formals that depend on
9563         --  actuals declared in the formal package.
9564
9565         --  In Ada 2005, partial parameterization requires that we make
9566         --  visible the actuals corresponding to formals that were defaulted
9567         --  in the formal package. There formals are identified because they
9568         --  remain formal generics within the formal package, rather than
9569         --  being renamings of the actuals supplied.
9570
9571         declare
9572            Gen_Decl : constant Node_Id :=
9573                         Unit_Declaration_Node (Gen_Parent);
9574            Formals  : constant List_Id :=
9575                         Generic_Formal_Declarations (Gen_Decl);
9576
9577            Actual_Ent       : Entity_Id;
9578            Actual_Of_Formal : Node_Id;
9579            Formal_Node      : Node_Id;
9580            Formal_Ent       : Entity_Id;
9581
9582         begin
9583            if Present (Formals) then
9584               Formal_Node := First_Non_Pragma (Formals);
9585            else
9586               Formal_Node := Empty;
9587            end if;
9588
9589            Actual_Ent := First_Entity (Actual_Pack);
9590            Actual_Of_Formal :=
9591               First (Visible_Declarations (Specification (Analyzed_Formal)));
9592            while Present (Actual_Ent)
9593              and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9594            loop
9595               if Present (Formal_Node) then
9596                  Formal_Ent := Get_Formal_Entity (Formal_Node);
9597
9598                  if Present (Formal_Ent) then
9599                     Find_Matching_Actual (Formal_Node, Actual_Ent);
9600                     Match_Formal_Entity (Formal_Node, Formal_Ent, Actual_Ent);
9601
9602                     --  We iterate at the same time over the actuals of the
9603                     --  local package created for the formal, to determine
9604                     --  which one of the formals of the original generic were
9605                     --  defaulted in the formal. The corresponding actual
9606                     --  entities are visible in the enclosing instance.
9607
9608                     if Box_Present (Formal)
9609                       or else
9610                         (Present (Actual_Of_Formal)
9611                           and then
9612                             Is_Generic_Formal
9613                               (Get_Formal_Entity (Actual_Of_Formal)))
9614                     then
9615                        Set_Is_Hidden (Actual_Ent, False);
9616                        Set_Is_Visible_Formal (Actual_Ent);
9617                        Set_Is_Potentially_Use_Visible
9618                          (Actual_Ent, In_Use (Actual_Pack));
9619
9620                        if Ekind (Actual_Ent) = E_Package then
9621                           Process_Nested_Formal (Actual_Ent);
9622                        end if;
9623
9624                     else
9625                        Set_Is_Hidden (Actual_Ent);
9626                        Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9627                     end if;
9628                  end if;
9629
9630                  Next_Non_Pragma (Formal_Node);
9631                  Next (Actual_Of_Formal);
9632
9633               else
9634                  --  No further formals to match, but the generic part may
9635                  --  contain inherited operation that are not hidden in the
9636                  --  enclosing instance.
9637
9638                  Next_Entity (Actual_Ent);
9639               end if;
9640            end loop;
9641
9642            --  Inherited subprograms generated by formal derived types are
9643            --  also visible if the types are.
9644
9645            Actual_Ent := First_Entity (Actual_Pack);
9646            while Present (Actual_Ent)
9647              and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9648            loop
9649               if Is_Overloadable (Actual_Ent)
9650                 and then
9651                   Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9652                 and then
9653                   not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9654               then
9655                  Set_Is_Hidden (Actual_Ent, False);
9656                  Set_Is_Potentially_Use_Visible
9657                    (Actual_Ent, In_Use (Actual_Pack));
9658               end if;
9659
9660               Next_Entity (Actual_Ent);
9661            end loop;
9662         end;
9663
9664         --  If the formal is not declared with a box, reanalyze it as an
9665         --  abbreviated instantiation, to verify the matching rules of 12.7.
9666         --  The actual checks are performed after the generic associations
9667         --  have been analyzed, to guarantee the same visibility for this
9668         --  instantiation and for the actuals.
9669
9670         --  In Ada 2005, the generic associations for the formal can include
9671         --  defaulted parameters. These are ignored during check. This
9672         --  internal instantiation is removed from the tree after conformance
9673         --  checking, because it contains formal declarations for those
9674         --  defaulted parameters, and those should not reach the back-end.
9675
9676         if not Box_Present (Formal) then
9677            declare
9678               I_Pack : constant Entity_Id :=
9679                          Make_Temporary (Sloc (Actual), 'P');
9680
9681            begin
9682               Set_Is_Internal (I_Pack);
9683
9684               Append_To (Decls,
9685                 Make_Package_Instantiation (Sloc (Actual),
9686                   Defining_Unit_Name   => I_Pack,
9687                   Name                 =>
9688                     New_Occurrence_Of
9689                       (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9690                   Generic_Associations => Generic_Associations (Formal)));
9691            end;
9692         end if;
9693
9694         return Decls;
9695      end if;
9696   end Instantiate_Formal_Package;
9697
9698   -----------------------------------
9699   -- Instantiate_Formal_Subprogram --
9700   -----------------------------------
9701
9702   function Instantiate_Formal_Subprogram
9703     (Formal          : Node_Id;
9704      Actual          : Node_Id;
9705      Analyzed_Formal : Node_Id) return Node_Id
9706   is
9707      Analyzed_S : constant Entity_Id :=
9708                     Defining_Unit_Name (Specification (Analyzed_Formal));
9709      Formal_Sub : constant Entity_Id :=
9710                     Defining_Unit_Name (Specification (Formal));
9711
9712      function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9713      --  If the generic is a child unit, the parent has been installed on the
9714      --  scope stack, but a default subprogram cannot resolve to something
9715      --  on the parent because that parent is not really part of the visible
9716      --  context (it is there to resolve explicit local entities). If the
9717      --  default has resolved in this way, we remove the entity from immediate
9718      --  visibility and analyze the node again to emit an error message or
9719      --  find another visible candidate.
9720
9721      procedure Valid_Actual_Subprogram (Act : Node_Id);
9722      --  Perform legality check and raise exception on failure
9723
9724      -----------------------
9725      -- From_Parent_Scope --
9726      -----------------------
9727
9728      function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9729         Gen_Scope : Node_Id;
9730
9731      begin
9732         Gen_Scope := Scope (Analyzed_S);
9733         while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9734            if Scope (Subp) = Scope (Gen_Scope) then
9735               return True;
9736            end if;
9737
9738            Gen_Scope := Scope (Gen_Scope);
9739         end loop;
9740
9741         return False;
9742      end From_Parent_Scope;
9743
9744      -----------------------------
9745      -- Valid_Actual_Subprogram --
9746      -----------------------------
9747
9748      procedure Valid_Actual_Subprogram (Act : Node_Id) is
9749         Act_E : Entity_Id;
9750
9751      begin
9752         if Is_Entity_Name (Act) then
9753            Act_E := Entity (Act);
9754
9755         elsif Nkind (Act) = N_Selected_Component
9756           and then Is_Entity_Name (Selector_Name (Act))
9757         then
9758            Act_E := Entity (Selector_Name (Act));
9759
9760         else
9761            Act_E := Empty;
9762         end if;
9763
9764         if (Present (Act_E) and then Is_Overloadable (Act_E))
9765           or else Nkind_In (Act, N_Attribute_Reference,
9766                                  N_Indexed_Component,
9767                                  N_Character_Literal,
9768                                  N_Explicit_Dereference)
9769         then
9770            return;
9771         end if;
9772
9773         Error_Msg_NE
9774           ("expect subprogram or entry name in instantiation of &",
9775            Instantiation_Node, Formal_Sub);
9776         Abandon_Instantiation (Instantiation_Node);
9777      end Valid_Actual_Subprogram;
9778
9779      --  Local variables
9780
9781      Decl_Node  : Node_Id;
9782      Loc        : Source_Ptr;
9783      Nam        : Node_Id;
9784      New_Spec   : Node_Id;
9785      New_Subp   : Entity_Id;
9786
9787   --  Start of processing for Instantiate_Formal_Subprogram
9788
9789   begin
9790      New_Spec := New_Copy_Tree (Specification (Formal));
9791
9792      --  The tree copy has created the proper instantiation sloc for the
9793      --  new specification. Use this location for all other constructed
9794      --  declarations.
9795
9796      Loc := Sloc (Defining_Unit_Name (New_Spec));
9797
9798      --  Create new entity for the actual (New_Copy_Tree does not), and
9799      --  indicate that it is an actual.
9800
9801      New_Subp := Make_Defining_Identifier (Loc, Chars (Formal_Sub));
9802      Set_Ekind (New_Subp, Ekind (Analyzed_S));
9803      Set_Is_Generic_Actual_Subprogram (New_Subp);
9804      Set_Defining_Unit_Name (New_Spec, New_Subp);
9805
9806      --  Create new entities for the each of the formals in the specification
9807      --  of the renaming declaration built for the actual.
9808
9809      if Present (Parameter_Specifications (New_Spec)) then
9810         declare
9811            F    : Node_Id;
9812            F_Id : Entity_Id;
9813
9814         begin
9815            F := First (Parameter_Specifications (New_Spec));
9816            while Present (F) loop
9817               F_Id := Defining_Identifier (F);
9818
9819               Set_Defining_Identifier (F,
9820                  Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id)));
9821               Next (F);
9822            end loop;
9823         end;
9824      end if;
9825
9826      --  Find entity of actual. If the actual is an attribute reference, it
9827      --  cannot be resolved here (its formal is missing) but is handled
9828      --  instead in Attribute_Renaming. If the actual is overloaded, it is
9829      --  fully resolved subsequently, when the renaming declaration for the
9830      --  formal is analyzed. If it is an explicit dereference, resolve the
9831      --  prefix but not the actual itself, to prevent interpretation as call.
9832
9833      if Present (Actual) then
9834         Loc := Sloc (Actual);
9835         Set_Sloc (New_Spec, Loc);
9836
9837         if Nkind (Actual) = N_Operator_Symbol then
9838            Find_Direct_Name (Actual);
9839
9840         elsif Nkind (Actual) = N_Explicit_Dereference then
9841            Analyze (Prefix (Actual));
9842
9843         elsif Nkind (Actual) /= N_Attribute_Reference then
9844            Analyze (Actual);
9845         end if;
9846
9847         Valid_Actual_Subprogram (Actual);
9848         Nam := Actual;
9849
9850      elsif Present (Default_Name (Formal)) then
9851         if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9852                                                 N_Selected_Component,
9853                                                 N_Indexed_Component,
9854                                                 N_Character_Literal)
9855           and then Present (Entity (Default_Name (Formal)))
9856         then
9857            Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9858         else
9859            Nam := New_Copy (Default_Name (Formal));
9860            Set_Sloc (Nam, Loc);
9861         end if;
9862
9863      elsif Box_Present (Formal) then
9864
9865         --  Actual is resolved at the point of instantiation. Create an
9866         --  identifier or operator with the same name as the formal.
9867
9868         if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9869            Nam :=
9870              Make_Operator_Symbol (Loc,
9871                Chars  => Chars (Formal_Sub),
9872                Strval => No_String);
9873         else
9874            Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9875         end if;
9876
9877      elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9878        and then Null_Present (Specification (Formal))
9879      then
9880         --  Generate null body for procedure, for use in the instance
9881
9882         Decl_Node :=
9883           Make_Subprogram_Body (Loc,
9884             Specification              => New_Spec,
9885             Declarations               => New_List,
9886             Handled_Statement_Sequence =>
9887               Make_Handled_Sequence_Of_Statements (Loc,
9888                 Statements => New_List (Make_Null_Statement (Loc))));
9889
9890         Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9891         return Decl_Node;
9892
9893      else
9894         Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9895         Error_Msg_NE
9896           ("missing actual&", Instantiation_Node, Formal_Sub);
9897         Error_Msg_NE
9898           ("\in instantiation of & declared#",
9899              Instantiation_Node, Scope (Analyzed_S));
9900         Abandon_Instantiation (Instantiation_Node);
9901      end if;
9902
9903      Decl_Node :=
9904        Make_Subprogram_Renaming_Declaration (Loc,
9905          Specification => New_Spec,
9906          Name          => Nam);
9907
9908      --  If we do not have an actual and the formal specified <> then set to
9909      --  get proper default.
9910
9911      if No (Actual) and then Box_Present (Formal) then
9912         Set_From_Default (Decl_Node);
9913      end if;
9914
9915      --  Gather possible interpretations for the actual before analyzing the
9916      --  instance. If overloaded, it will be resolved when analyzing the
9917      --  renaming declaration.
9918
9919      if Box_Present (Formal) and then No (Actual) then
9920         Analyze (Nam);
9921
9922         if Is_Child_Unit (Scope (Analyzed_S))
9923           and then Present (Entity (Nam))
9924         then
9925            if not Is_Overloaded (Nam) then
9926               if From_Parent_Scope (Entity (Nam)) then
9927                  Set_Is_Immediately_Visible (Entity (Nam), False);
9928                  Set_Entity (Nam, Empty);
9929                  Set_Etype (Nam, Empty);
9930
9931                  Analyze (Nam);
9932                  Set_Is_Immediately_Visible (Entity (Nam));
9933               end if;
9934
9935            else
9936               declare
9937                  I  : Interp_Index;
9938                  It : Interp;
9939
9940               begin
9941                  Get_First_Interp (Nam, I, It);
9942                  while Present (It.Nam) loop
9943                     if From_Parent_Scope (It.Nam) then
9944                        Remove_Interp (I);
9945                     end if;
9946
9947                     Get_Next_Interp (I, It);
9948                  end loop;
9949               end;
9950            end if;
9951         end if;
9952      end if;
9953
9954      --  The generic instantiation freezes the actual. This can only be done
9955      --  once the actual is resolved, in the analysis of the renaming
9956      --  declaration. To make the formal subprogram entity available, we set
9957      --  Corresponding_Formal_Spec to point to the formal subprogram entity.
9958      --  This is also needed in Analyze_Subprogram_Renaming for the processing
9959      --  of formal abstract subprograms.
9960
9961      Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9962
9963      --  We cannot analyze the renaming declaration, and thus find the actual,
9964      --  until all the actuals are assembled in the instance. For subsequent
9965      --  checks of other actuals, indicate the node that will hold the
9966      --  instance of this formal.
9967
9968      Set_Instance_Of (Analyzed_S, Nam);
9969
9970      if Nkind (Actual) = N_Selected_Component
9971        and then Is_Task_Type (Etype (Prefix (Actual)))
9972        and then not Is_Frozen (Etype (Prefix (Actual)))
9973      then
9974         --  The renaming declaration will create a body, which must appear
9975         --  outside of the instantiation, We move the renaming declaration
9976         --  out of the instance, and create an additional renaming inside,
9977         --  to prevent freezing anomalies.
9978
9979         declare
9980            Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9981
9982         begin
9983            Set_Defining_Unit_Name (New_Spec, Anon_Id);
9984            Insert_Before (Instantiation_Node, Decl_Node);
9985            Analyze (Decl_Node);
9986
9987            --  Now create renaming within the instance
9988
9989            Decl_Node :=
9990              Make_Subprogram_Renaming_Declaration (Loc,
9991                Specification => New_Copy_Tree (New_Spec),
9992                Name => New_Occurrence_Of (Anon_Id, Loc));
9993
9994            Set_Defining_Unit_Name (Specification (Decl_Node),
9995              Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9996         end;
9997      end if;
9998
9999      return Decl_Node;
10000   end Instantiate_Formal_Subprogram;
10001
10002   ------------------------
10003   -- Instantiate_Object --
10004   ------------------------
10005
10006   function Instantiate_Object
10007     (Formal          : Node_Id;
10008      Actual          : Node_Id;
10009      Analyzed_Formal : Node_Id) return List_Id
10010   is
10011      Gen_Obj     : constant Entity_Id  := Defining_Identifier (Formal);
10012      A_Gen_Obj   : constant Entity_Id  :=
10013                      Defining_Identifier (Analyzed_Formal);
10014      Acc_Def     : Node_Id             := Empty;
10015      Act_Assoc   : constant Node_Id    := Parent (Actual);
10016      Actual_Decl : Node_Id             := Empty;
10017      Decl_Node   : Node_Id;
10018      Def         : Node_Id;
10019      Ftyp        : Entity_Id;
10020      List        : constant List_Id    := New_List;
10021      Loc         : constant Source_Ptr := Sloc (Actual);
10022      Orig_Ftyp   : constant Entity_Id  := Etype (A_Gen_Obj);
10023      Subt_Decl   : Node_Id             := Empty;
10024      Subt_Mark   : Node_Id             := Empty;
10025
10026      function Copy_Access_Def return Node_Id;
10027      --  If formal is an anonymous access, copy access definition of formal
10028      --  for generated object declaration.
10029
10030      ---------------------
10031      -- Copy_Access_Def --
10032      ---------------------
10033
10034      function Copy_Access_Def return Node_Id is
10035      begin
10036         Def := New_Copy_Tree (Acc_Def);
10037
10038         --  In addition, if formal is an access to subprogram we need to
10039         --  generate new formals for the signature of the default, so that
10040         --  the tree is properly formatted for ASIS use.
10041
10042         if Present (Access_To_Subprogram_Definition (Acc_Def)) then
10043            declare
10044               Par_Spec : Node_Id;
10045            begin
10046               Par_Spec :=
10047                 First (Parameter_Specifications
10048                          (Access_To_Subprogram_Definition (Def)));
10049               while Present (Par_Spec) loop
10050                  Set_Defining_Identifier (Par_Spec,
10051                    Make_Defining_Identifier (Sloc (Acc_Def),
10052                      Chars => Chars (Defining_Identifier (Par_Spec))));
10053                  Next (Par_Spec);
10054               end loop;
10055            end;
10056         end if;
10057
10058         return Def;
10059      end Copy_Access_Def;
10060
10061   --  Start of processing for Instantiate_Object
10062
10063   begin
10064      --  Formal may be an anonymous access
10065
10066      if Present (Subtype_Mark (Formal)) then
10067         Subt_Mark := Subtype_Mark (Formal);
10068      else
10069         Check_Access_Definition (Formal);
10070         Acc_Def := Access_Definition (Formal);
10071      end if;
10072
10073      --  Sloc for error message on missing actual
10074
10075      Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
10076
10077      if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
10078         Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
10079      end if;
10080
10081      Set_Parent (List, Parent (Actual));
10082
10083      --  OUT present
10084
10085      if Out_Present (Formal) then
10086
10087         --  An IN OUT generic actual must be a name. The instantiation is a
10088         --  renaming declaration. The actual is the name being renamed. We
10089         --  use the actual directly, rather than a copy, because it is not
10090         --  used further in the list of actuals, and because a copy or a use
10091         --  of relocate_node is incorrect if the instance is nested within a
10092         --  generic. In order to simplify ASIS searches, the Generic_Parent
10093         --  field links the declaration to the generic association.
10094
10095         if No (Actual) then
10096            Error_Msg_NE
10097              ("missing actual &",
10098               Instantiation_Node, Gen_Obj);
10099            Error_Msg_NE
10100              ("\in instantiation of & declared#",
10101               Instantiation_Node, Scope (A_Gen_Obj));
10102            Abandon_Instantiation (Instantiation_Node);
10103         end if;
10104
10105         if Present (Subt_Mark) then
10106            Decl_Node :=
10107              Make_Object_Renaming_Declaration (Loc,
10108                Defining_Identifier => New_Copy (Gen_Obj),
10109                Subtype_Mark        => New_Copy_Tree (Subt_Mark),
10110                Name                => Actual);
10111
10112         else pragma Assert (Present (Acc_Def));
10113            Decl_Node :=
10114              Make_Object_Renaming_Declaration (Loc,
10115                Defining_Identifier => New_Copy (Gen_Obj),
10116                Access_Definition   => New_Copy_Tree (Acc_Def),
10117                Name                => Actual);
10118         end if;
10119
10120         Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10121
10122         --  The analysis of the actual may produce Insert_Action nodes, so
10123         --  the declaration must have a context in which to attach them.
10124
10125         Append (Decl_Node, List);
10126         Analyze (Actual);
10127
10128         --  Return if the analysis of the actual reported some error
10129
10130         if Etype (Actual) = Any_Type then
10131            return List;
10132         end if;
10133
10134         --  This check is performed here because Analyze_Object_Renaming will
10135         --  not check it when Comes_From_Source is False. Note though that the
10136         --  check for the actual being the name of an object will be performed
10137         --  in Analyze_Object_Renaming.
10138
10139         if Is_Object_Reference (Actual)
10140           and then Is_Dependent_Component_Of_Mutable_Object (Actual)
10141         then
10142            Error_Msg_N
10143              ("illegal discriminant-dependent component for in out parameter",
10144               Actual);
10145         end if;
10146
10147         --  The actual has to be resolved in order to check that it is a
10148         --  variable (due to cases such as F (1), where F returns access to
10149         --  an array, and for overloaded prefixes).
10150
10151         Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
10152
10153         --  If the type of the formal is not itself a formal, and the current
10154         --  unit is a child unit, the formal type must be declared in a
10155         --  parent, and must be retrieved by visibility.
10156
10157         if Ftyp = Orig_Ftyp
10158           and then Is_Generic_Unit (Scope (Ftyp))
10159           and then Is_Child_Unit (Scope (A_Gen_Obj))
10160         then
10161            declare
10162               Temp : constant Node_Id :=
10163                        New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
10164            begin
10165               Set_Entity (Temp, Empty);
10166               Find_Type (Temp);
10167               Ftyp := Entity (Temp);
10168            end;
10169         end if;
10170
10171         if Is_Private_Type (Ftyp)
10172           and then not Is_Private_Type (Etype (Actual))
10173           and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
10174                      or else Base_Type (Etype (Actual)) = Ftyp)
10175         then
10176            --  If the actual has the type of the full view of the formal, or
10177            --  else a non-private subtype of the formal, then the visibility
10178            --  of the formal type has changed. Add to the actuals a subtype
10179            --  declaration that will force the exchange of views in the body
10180            --  of the instance as well.
10181
10182            Subt_Decl :=
10183              Make_Subtype_Declaration (Loc,
10184                 Defining_Identifier => Make_Temporary (Loc, 'P'),
10185                 Subtype_Indication  => New_Occurrence_Of (Ftyp, Loc));
10186
10187            Prepend (Subt_Decl, List);
10188
10189            Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
10190            Exchange_Declarations (Ftyp);
10191         end if;
10192
10193         Resolve (Actual, Ftyp);
10194
10195         if not Denotes_Variable (Actual) then
10196            Error_Msg_NE ("actual for& must be a variable", Actual, Gen_Obj);
10197
10198         elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
10199
10200            --  Ada 2005 (AI-423): For a generic formal object of mode in out,
10201            --  the type of the actual shall resolve to a specific anonymous
10202            --  access type.
10203
10204            if Ada_Version < Ada_2005
10205              or else Ekind (Base_Type (Ftyp))           /=
10206                                                  E_Anonymous_Access_Type
10207              or else Ekind (Base_Type (Etype (Actual))) /=
10208                                                  E_Anonymous_Access_Type
10209            then
10210               Error_Msg_NE
10211                 ("type of actual does not match type of&", Actual, Gen_Obj);
10212            end if;
10213         end if;
10214
10215         Note_Possible_Modification (Actual, Sure => True);
10216
10217         --  Check for instantiation of atomic/volatile actual for
10218         --  non-atomic/volatile formal (RM C.6 (12)).
10219
10220         if Is_Atomic_Object (Actual) and then not Is_Atomic (Orig_Ftyp) then
10221            Error_Msg_N
10222              ("cannot instantiate non-atomic formal object "
10223               & "with atomic actual", Actual);
10224
10225         elsif Is_Volatile_Object (Actual) and then not Is_Volatile (Orig_Ftyp)
10226         then
10227            Error_Msg_N
10228              ("cannot instantiate non-volatile formal object "
10229               & "with volatile actual", Actual);
10230         end if;
10231
10232      --  Formal in-parameter
10233
10234      else
10235         --  The instantiation of a generic formal in-parameter is constant
10236         --  declaration. The actual is the expression for that declaration.
10237         --  Its type is a full copy of the type of the formal. This may be
10238         --  an access to subprogram, for which we need to generate entities
10239         --  for the formals in the new signature.
10240
10241         if Present (Actual) then
10242            if Present (Subt_Mark) then
10243               Def := New_Copy_Tree (Subt_Mark);
10244            else pragma Assert (Present (Acc_Def));
10245               Def := Copy_Access_Def;
10246            end if;
10247
10248            Decl_Node :=
10249              Make_Object_Declaration (Loc,
10250                Defining_Identifier    => New_Copy (Gen_Obj),
10251                Constant_Present       => True,
10252                Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10253                Object_Definition      => Def,
10254                Expression             => Actual);
10255
10256            Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10257
10258            --  A generic formal object of a tagged type is defined to be
10259            --  aliased so the new constant must also be treated as aliased.
10260
10261            if Is_Tagged_Type (Etype (A_Gen_Obj)) then
10262               Set_Aliased_Present (Decl_Node);
10263            end if;
10264
10265            Append (Decl_Node, List);
10266
10267            --  No need to repeat (pre-)analysis of some expression nodes
10268            --  already handled in Preanalyze_Actuals.
10269
10270            if Nkind (Actual) /= N_Allocator then
10271               Analyze (Actual);
10272
10273               --  Return if the analysis of the actual reported some error
10274
10275               if Etype (Actual) = Any_Type then
10276                  return List;
10277               end if;
10278            end if;
10279
10280            declare
10281               Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
10282               Typ         : Entity_Id;
10283
10284            begin
10285               Typ := Get_Instance_Of (Formal_Type);
10286
10287               --  If the actual appears in the current or an enclosing scope,
10288               --  use its type directly. This is relevant if it has an actual
10289               --  subtype that is distinct from its nominal one. This cannot
10290               --  be done in general because the type of the actual may
10291               --  depend on other actuals, and only be fully determined when
10292               --  the enclosing instance is analyzed.
10293
10294               if Present (Etype (Actual))
10295                 and then Is_Constr_Subt_For_U_Nominal (Etype (Actual))
10296               then
10297                  Freeze_Before (Instantiation_Node, Etype (Actual));
10298               else
10299                  Freeze_Before (Instantiation_Node, Typ);
10300               end if;
10301
10302               --  If the actual is an aggregate, perform name resolution on
10303               --  its components (the analysis of an aggregate does not do it)
10304               --  to capture local names that may be hidden if the generic is
10305               --  a child unit.
10306
10307               if Nkind (Actual) = N_Aggregate then
10308                  Preanalyze_And_Resolve (Actual, Typ);
10309               end if;
10310
10311               if Is_Limited_Type (Typ)
10312                 and then not OK_For_Limited_Init (Typ, Actual)
10313               then
10314                  Error_Msg_N
10315                    ("initialization not allowed for limited types", Actual);
10316                  Explain_Limited_Type (Typ, Actual);
10317               end if;
10318            end;
10319
10320         elsif Present (Default_Expression (Formal)) then
10321
10322            --  Use default to construct declaration
10323
10324            if Present (Subt_Mark) then
10325               Def := New_Copy (Subt_Mark);
10326            else pragma Assert (Present (Acc_Def));
10327               Def := Copy_Access_Def;
10328            end if;
10329
10330            Decl_Node :=
10331              Make_Object_Declaration (Sloc (Formal),
10332                Defining_Identifier    => New_Copy (Gen_Obj),
10333                Constant_Present       => True,
10334                Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10335                Object_Definition      => Def,
10336                Expression             => New_Copy_Tree
10337                                            (Default_Expression (Formal)));
10338
10339            Append (Decl_Node, List);
10340            Set_Analyzed (Expression (Decl_Node), False);
10341
10342         else
10343            Error_Msg_NE ("missing actual&", Instantiation_Node, Gen_Obj);
10344            Error_Msg_NE ("\in instantiation of & declared#",
10345                          Instantiation_Node, Scope (A_Gen_Obj));
10346
10347            if Is_Scalar_Type (Etype (A_Gen_Obj)) then
10348
10349               --  Create dummy constant declaration so that instance can be
10350               --  analyzed, to minimize cascaded visibility errors.
10351
10352               if Present (Subt_Mark) then
10353                  Def := Subt_Mark;
10354               else pragma Assert (Present (Acc_Def));
10355                  Def := Acc_Def;
10356               end if;
10357
10358               Decl_Node :=
10359                 Make_Object_Declaration (Loc,
10360                   Defining_Identifier    => New_Copy (Gen_Obj),
10361                   Constant_Present       => True,
10362                   Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10363                   Object_Definition      => New_Copy (Def),
10364                   Expression             =>
10365                     Make_Attribute_Reference (Sloc (Gen_Obj),
10366                       Attribute_Name => Name_First,
10367                       Prefix         => New_Copy (Def)));
10368
10369               Append (Decl_Node, List);
10370
10371            else
10372               Abandon_Instantiation (Instantiation_Node);
10373            end if;
10374         end if;
10375      end if;
10376
10377      if Nkind (Actual) in N_Has_Entity then
10378         Actual_Decl := Parent (Entity (Actual));
10379      end if;
10380
10381      --  Ada 2005 (AI-423): For a formal object declaration with a null
10382      --  exclusion or an access definition that has a null exclusion: If the
10383      --  actual matching the formal object declaration denotes a generic
10384      --  formal object of another generic unit G, and the instantiation
10385      --  containing the actual occurs within the body of G or within the body
10386      --  of a generic unit declared within the declarative region of G, then
10387      --  the declaration of the formal object of G must have a null exclusion.
10388      --  Otherwise, the subtype of the actual matching the formal object
10389      --  declaration shall exclude null.
10390
10391      if Ada_Version >= Ada_2005
10392        and then Present (Actual_Decl)
10393        and then Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
10394                                        N_Object_Declaration)
10395        and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
10396        and then not Has_Null_Exclusion (Actual_Decl)
10397        and then Has_Null_Exclusion (Analyzed_Formal)
10398      then
10399         Error_Msg_Sloc := Sloc (Analyzed_Formal);
10400         Error_Msg_N
10401           ("actual must exclude null to match generic formal#", Actual);
10402      end if;
10403
10404      --  An effectively volatile object cannot be used as an actual in
10405      --  a generic instance. The following check is only relevant when
10406      --  SPARK_Mode is on as it is not a standard Ada legality rule.
10407
10408      if SPARK_Mode = On
10409        and then Present (Actual)
10410        and then Is_Effectively_Volatile_Object (Actual)
10411      then
10412         Error_Msg_N
10413           ("volatile object cannot act as actual in generic instantiation "
10414            & "(SPARK RM 7.1.3(8))", Actual);
10415      end if;
10416
10417      return List;
10418   end Instantiate_Object;
10419
10420   ------------------------------
10421   -- Instantiate_Package_Body --
10422   ------------------------------
10423
10424   procedure Instantiate_Package_Body
10425     (Body_Info     : Pending_Body_Info;
10426      Inlined_Body  : Boolean := False;
10427      Body_Optional : Boolean := False)
10428   is
10429      Act_Decl    : constant Node_Id    := Body_Info.Act_Decl;
10430      Inst_Node   : constant Node_Id    := Body_Info.Inst_Node;
10431      Loc         : constant Source_Ptr := Sloc (Inst_Node);
10432
10433      Gen_Id      : constant Node_Id    := Name (Inst_Node);
10434      Gen_Unit    : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
10435      Gen_Decl    : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
10436      Act_Spec    : constant Node_Id    := Specification (Act_Decl);
10437      Act_Decl_Id : constant Entity_Id  := Defining_Entity (Act_Spec);
10438
10439      Act_Body_Name : Node_Id;
10440      Gen_Body      : Node_Id;
10441      Gen_Body_Id   : Node_Id;
10442      Act_Body      : Node_Id;
10443      Act_Body_Id   : Entity_Id;
10444
10445      Parent_Installed : Boolean := False;
10446      Save_Style_Check : constant Boolean := Style_Check;
10447
10448      Par_Ent : Entity_Id := Empty;
10449      Par_Vis : Boolean   := False;
10450
10451      Vis_Prims_List : Elist_Id := No_Elist;
10452      --  List of primitives made temporarily visible in the instantiation
10453      --  to match the visibility of the formal type
10454
10455      procedure Check_Initialized_Types;
10456      --  In a generic package body, an entity of a generic private type may
10457      --  appear uninitialized. This is suspicious, unless the actual is a
10458      --  fully initialized type.
10459
10460      -----------------------------
10461      -- Check_Initialized_Types --
10462      -----------------------------
10463
10464      procedure Check_Initialized_Types is
10465         Decl       : Node_Id;
10466         Formal     : Entity_Id;
10467         Actual     : Entity_Id;
10468         Uninit_Var : Entity_Id;
10469
10470      begin
10471         Decl := First (Generic_Formal_Declarations (Gen_Decl));
10472         while Present (Decl) loop
10473            Uninit_Var := Empty;
10474
10475            if Nkind (Decl) = N_Private_Extension_Declaration then
10476               Uninit_Var := Uninitialized_Variable (Decl);
10477
10478            elsif Nkind (Decl) = N_Formal_Type_Declaration
10479                    and then Nkind (Formal_Type_Definition (Decl)) =
10480                                          N_Formal_Private_Type_Definition
10481            then
10482               Uninit_Var :=
10483                 Uninitialized_Variable (Formal_Type_Definition (Decl));
10484            end if;
10485
10486            if Present (Uninit_Var) then
10487               Formal := Defining_Identifier (Decl);
10488               Actual := First_Entity (Act_Decl_Id);
10489
10490               --  For each formal there is a subtype declaration that renames
10491               --  the actual and has the same name as the formal. Locate the
10492               --  formal for warning message about uninitialized variables
10493               --  in the generic, for which the actual type should be a fully
10494               --  initialized type.
10495
10496               while Present (Actual) loop
10497                  exit when Ekind (Actual) = E_Package
10498                    and then Present (Renamed_Object (Actual));
10499
10500                  if Chars (Actual) = Chars (Formal)
10501                    and then not Is_Scalar_Type (Actual)
10502                    and then not Is_Fully_Initialized_Type (Actual)
10503                    and then Warn_On_No_Value_Assigned
10504                  then
10505                     Error_Msg_Node_2 := Formal;
10506                     Error_Msg_NE
10507                       ("generic unit has uninitialized variable& of "
10508                        & "formal private type &?v?", Actual, Uninit_Var);
10509                     Error_Msg_NE
10510                       ("actual type for& should be fully initialized type?v?",
10511                        Actual, Formal);
10512                     exit;
10513                  end if;
10514
10515                  Next_Entity (Actual);
10516               end loop;
10517            end if;
10518
10519            Next (Decl);
10520         end loop;
10521      end Check_Initialized_Types;
10522
10523   --  Start of processing for Instantiate_Package_Body
10524
10525   begin
10526      Gen_Body_Id := Corresponding_Body (Gen_Decl);
10527
10528      --  The instance body may already have been processed, as the parent of
10529      --  another instance that is inlined (Load_Parent_Of_Generic).
10530
10531      if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10532         return;
10533      end if;
10534
10535      Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10536
10537      --  Re-establish the state of information on which checks are suppressed.
10538      --  This information was set in Body_Info at the point of instantiation,
10539      --  and now we restore it so that the instance is compiled using the
10540      --  check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10541
10542      Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10543      Scope_Suppress           := Body_Info.Scope_Suppress;
10544      Opt.Ada_Version          := Body_Info.Version;
10545      Opt.Ada_Version_Pragma   := Body_Info.Version_Pragma;
10546      Restore_Warnings (Body_Info.Warnings);
10547      Opt.SPARK_Mode           := Body_Info.SPARK_Mode;
10548      Opt.SPARK_Mode_Pragma    := Body_Info.SPARK_Mode_Pragma;
10549
10550      if No (Gen_Body_Id) then
10551
10552         --  Do not look for parent of generic body if none is required.
10553         --  This may happen when the routine is called as part of the
10554         --  Pending_Instantiations processing, when nested instances
10555         --  may precede the one generated from the main unit.
10556
10557         if not Unit_Requires_Body (Defining_Entity (Gen_Decl))
10558           and then Body_Optional
10559         then
10560            return;
10561         else
10562            Load_Parent_Of_Generic
10563              (Inst_Node, Specification (Gen_Decl), Body_Optional);
10564            Gen_Body_Id := Corresponding_Body (Gen_Decl);
10565         end if;
10566      end if;
10567
10568      --  Establish global variable for sloc adjustment and for error recovery
10569
10570      Instantiation_Node := Inst_Node;
10571
10572      if Present (Gen_Body_Id) then
10573         Save_Env (Gen_Unit, Act_Decl_Id);
10574         Style_Check := False;
10575         Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10576
10577         Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10578
10579         Create_Instantiation_Source
10580           (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10581
10582         Act_Body :=
10583           Copy_Generic_Node
10584             (Original_Node (Gen_Body), Empty, Instantiating => True);
10585
10586         --  Build new name (possibly qualified) for body declaration
10587
10588         Act_Body_Id := New_Copy (Act_Decl_Id);
10589
10590         --  Some attributes of spec entity are not inherited by body entity
10591
10592         Set_Handler_Records (Act_Body_Id, No_List);
10593
10594         if Nkind (Defining_Unit_Name (Act_Spec)) =
10595                                           N_Defining_Program_Unit_Name
10596         then
10597            Act_Body_Name :=
10598              Make_Defining_Program_Unit_Name (Loc,
10599                Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10600                Defining_Identifier => Act_Body_Id);
10601         else
10602            Act_Body_Name :=  Act_Body_Id;
10603         end if;
10604
10605         Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10606
10607         Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10608         Check_Generic_Actuals (Act_Decl_Id, False);
10609         Check_Initialized_Types;
10610
10611         --  Install primitives hidden at the point of the instantiation but
10612         --  visible when processing the generic formals
10613
10614         declare
10615            E : Entity_Id;
10616
10617         begin
10618            E := First_Entity (Act_Decl_Id);
10619            while Present (E) loop
10620               if Is_Type (E)
10621                 and then Is_Generic_Actual_Type (E)
10622                 and then Is_Tagged_Type (E)
10623               then
10624                  Install_Hidden_Primitives
10625                    (Prims_List => Vis_Prims_List,
10626                     Gen_T      => Generic_Parent_Type (Parent (E)),
10627                     Act_T      => E);
10628               end if;
10629
10630               Next_Entity (E);
10631            end loop;
10632         end;
10633
10634         --  If it is a child unit, make the parent instance (which is an
10635         --  instance of the parent of the generic) visible. The parent
10636         --  instance is the prefix of the name of the generic unit.
10637
10638         if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10639           and then Nkind (Gen_Id) = N_Expanded_Name
10640         then
10641            Par_Ent := Entity (Prefix (Gen_Id));
10642            Par_Vis := Is_Immediately_Visible (Par_Ent);
10643            Install_Parent (Par_Ent, In_Body => True);
10644            Parent_Installed := True;
10645
10646         elsif Is_Child_Unit (Gen_Unit) then
10647            Par_Ent := Scope (Gen_Unit);
10648            Par_Vis := Is_Immediately_Visible (Par_Ent);
10649            Install_Parent (Par_Ent, In_Body => True);
10650            Parent_Installed := True;
10651         end if;
10652
10653         --  If the instantiation is a library unit, and this is the main unit,
10654         --  then build the resulting compilation unit nodes for the instance.
10655         --  If this is a compilation unit but it is not the main unit, then it
10656         --  is the body of a unit in the context, that is being compiled
10657         --  because it is encloses some inlined unit or another generic unit
10658         --  being instantiated. In that case, this body is not part of the
10659         --  current compilation, and is not attached to the tree, but its
10660         --  parent must be set for analysis.
10661
10662         if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10663
10664            --  Replace instance node with body of instance, and create new
10665            --  node for corresponding instance declaration.
10666
10667            Build_Instance_Compilation_Unit_Nodes
10668              (Inst_Node, Act_Body, Act_Decl);
10669            Analyze (Inst_Node);
10670
10671            if Parent (Inst_Node) = Cunit (Main_Unit) then
10672
10673               --  If the instance is a child unit itself, then set the scope
10674               --  of the expanded body to be the parent of the instantiation
10675               --  (ensuring that the fully qualified name will be generated
10676               --  for the elaboration subprogram).
10677
10678               if Nkind (Defining_Unit_Name (Act_Spec)) =
10679                                              N_Defining_Program_Unit_Name
10680               then
10681                  Set_Scope (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10682               end if;
10683            end if;
10684
10685         --  Case where instantiation is not a library unit
10686
10687         else
10688            --  If this is an early instantiation, i.e. appears textually
10689            --  before the corresponding body and must be elaborated first,
10690            --  indicate that the body instance is to be delayed.
10691
10692            Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10693
10694            --  Now analyze the body. We turn off all checks if this is an
10695            --  internal unit, since there is no reason to have checks on for
10696            --  any predefined run-time library code. All such code is designed
10697            --  to be compiled with checks off.
10698
10699            --  Note that we do NOT apply this criterion to children of GNAT
10700            --  The latter units must suppress checks explicitly if needed.
10701
10702            if Is_Predefined_File_Name
10703                 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10704            then
10705               Analyze (Act_Body, Suppress => All_Checks);
10706            else
10707               Analyze (Act_Body);
10708            end if;
10709         end if;
10710
10711         Inherit_Context (Gen_Body, Inst_Node);
10712
10713         --  Remove the parent instances if they have been placed on the scope
10714         --  stack to compile the body.
10715
10716         if Parent_Installed then
10717            Remove_Parent (In_Body => True);
10718
10719            --  Restore the previous visibility of the parent
10720
10721            Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10722         end if;
10723
10724         Restore_Hidden_Primitives (Vis_Prims_List);
10725         Restore_Private_Views (Act_Decl_Id);
10726
10727         --  Remove the current unit from visibility if this is an instance
10728         --  that is not elaborated on the fly for inlining purposes.
10729
10730         if not Inlined_Body then
10731            Set_Is_Immediately_Visible (Act_Decl_Id, False);
10732         end if;
10733
10734         Restore_Env;
10735         Style_Check := Save_Style_Check;
10736
10737      --  If we have no body, and the unit requires a body, then complain. This
10738      --  complaint is suppressed if we have detected other errors (since a
10739      --  common reason for missing the body is that it had errors).
10740      --  In CodePeer mode, a warning has been emitted already, no need for
10741      --  further messages.
10742
10743      elsif Unit_Requires_Body (Gen_Unit)
10744        and then not Body_Optional
10745      then
10746         if CodePeer_Mode then
10747            null;
10748
10749         elsif Serious_Errors_Detected = 0 then
10750            Error_Msg_NE
10751              ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10752
10753         --  Don't attempt to perform any cleanup actions if some other error
10754         --  was already detected, since this can cause blowups.
10755
10756         else
10757            return;
10758         end if;
10759
10760      --  Case of package that does not need a body
10761
10762      else
10763         --  If the instantiation of the declaration is a library unit, rewrite
10764         --  the original package instantiation as a package declaration in the
10765         --  compilation unit node.
10766
10767         if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10768            Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10769            Rewrite (Inst_Node, Act_Decl);
10770
10771            --  Generate elaboration entity, in case spec has elaboration code.
10772            --  This cannot be done when the instance is analyzed, because it
10773            --  is not known yet whether the body exists.
10774
10775            Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10776            Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10777
10778         --  If the instantiation is not a library unit, then append the
10779         --  declaration to the list of implicitly generated entities, unless
10780         --  it is already a list member which means that it was already
10781         --  processed
10782
10783         elsif not Is_List_Member (Act_Decl) then
10784            Mark_Rewrite_Insertion (Act_Decl);
10785            Insert_Before (Inst_Node, Act_Decl);
10786         end if;
10787      end if;
10788
10789      Expander_Mode_Restore;
10790   end Instantiate_Package_Body;
10791
10792   ---------------------------------
10793   -- Instantiate_Subprogram_Body --
10794   ---------------------------------
10795
10796   procedure Instantiate_Subprogram_Body
10797     (Body_Info     : Pending_Body_Info;
10798      Body_Optional : Boolean := False)
10799   is
10800      Act_Decl    : constant Node_Id    := Body_Info.Act_Decl;
10801      Inst_Node   : constant Node_Id    := Body_Info.Inst_Node;
10802      Loc         : constant Source_Ptr := Sloc (Inst_Node);
10803      Gen_Id      : constant Node_Id    := Name (Inst_Node);
10804      Gen_Unit    : constant Entity_Id  := Get_Generic_Entity (Inst_Node);
10805      Gen_Decl    : constant Node_Id    := Unit_Declaration_Node (Gen_Unit);
10806      Anon_Id     : constant Entity_Id  :=
10807                      Defining_Unit_Name (Specification (Act_Decl));
10808      Pack_Id     : constant Entity_Id  :=
10809                      Defining_Unit_Name (Parent (Act_Decl));
10810
10811      Saved_Style_Check : constant Boolean        := Style_Check;
10812      Saved_Warnings    : constant Warning_Record := Save_Warnings;
10813
10814      Act_Body    : Node_Id;
10815      Gen_Body    : Node_Id;
10816      Gen_Body_Id : Node_Id;
10817      Pack_Body   : Node_Id;
10818      Par_Ent     : Entity_Id := Empty;
10819      Par_Vis     : Boolean   := False;
10820      Ret_Expr    : Node_Id;
10821
10822      Parent_Installed : Boolean := False;
10823
10824   begin
10825      Gen_Body_Id := Corresponding_Body (Gen_Decl);
10826
10827      --  Subprogram body may have been created already because of an inline
10828      --  pragma, or because of multiple elaborations of the enclosing package
10829      --  when several instances of the subprogram appear in the main unit.
10830
10831      if Present (Corresponding_Body (Act_Decl)) then
10832         return;
10833      end if;
10834
10835      Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10836
10837      --  Re-establish the state of information on which checks are suppressed.
10838      --  This information was set in Body_Info at the point of instantiation,
10839      --  and now we restore it so that the instance is compiled using the
10840      --  check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10841
10842      Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10843      Scope_Suppress           := Body_Info.Scope_Suppress;
10844      Opt.Ada_Version          := Body_Info.Version;
10845      Opt.Ada_Version_Pragma   := Body_Info.Version_Pragma;
10846      Restore_Warnings (Body_Info.Warnings);
10847      Opt.SPARK_Mode           := Body_Info.SPARK_Mode;
10848      Opt.SPARK_Mode_Pragma    := Body_Info.SPARK_Mode_Pragma;
10849
10850      if No (Gen_Body_Id) then
10851
10852         --  For imported generic subprogram, no body to compile, complete
10853         --  the spec entity appropriately.
10854
10855         if Is_Imported (Gen_Unit) then
10856            Set_Is_Imported (Anon_Id);
10857            Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10858            Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10859            Set_Convention     (Anon_Id, Convention     (Gen_Unit));
10860            Set_Has_Completion (Anon_Id);
10861            return;
10862
10863         --  For other cases, compile the body
10864
10865         else
10866            Load_Parent_Of_Generic
10867              (Inst_Node, Specification (Gen_Decl), Body_Optional);
10868            Gen_Body_Id := Corresponding_Body (Gen_Decl);
10869         end if;
10870      end if;
10871
10872      Instantiation_Node := Inst_Node;
10873
10874      if Present (Gen_Body_Id) then
10875         Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10876
10877         if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10878
10879            --  Either body is not present, or context is non-expanding, as
10880            --  when compiling a subunit. Mark the instance as completed, and
10881            --  diagnose a missing body when needed.
10882
10883            if Expander_Active
10884              and then Operating_Mode = Generate_Code
10885            then
10886               Error_Msg_N
10887                 ("missing proper body for instantiation", Gen_Body);
10888            end if;
10889
10890            Set_Has_Completion (Anon_Id);
10891            return;
10892         end if;
10893
10894         Save_Env (Gen_Unit, Anon_Id);
10895         Style_Check := False;
10896         Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10897         Create_Instantiation_Source
10898           (Inst_Node,
10899            Gen_Body_Id,
10900            False,
10901            S_Adjustment);
10902
10903         Act_Body :=
10904           Copy_Generic_Node
10905             (Original_Node (Gen_Body), Empty, Instantiating => True);
10906
10907         --  Create proper defining name for the body, to correspond to
10908         --  the one in the spec.
10909
10910         Set_Defining_Unit_Name (Specification (Act_Body),
10911           Make_Defining_Identifier
10912             (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10913         Set_Corresponding_Spec (Act_Body, Anon_Id);
10914         Set_Has_Completion (Anon_Id);
10915         Check_Generic_Actuals (Pack_Id, False);
10916
10917         --  Generate a reference to link the visible subprogram instance to
10918         --  the generic body, which for navigation purposes is the only
10919         --  available source for the instance.
10920
10921         Generate_Reference
10922           (Related_Instance (Pack_Id),
10923             Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10924
10925         --  If it is a child unit, make the parent instance (which is an
10926         --  instance of the parent of the generic) visible. The parent
10927         --  instance is the prefix of the name of the generic unit.
10928
10929         if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10930           and then Nkind (Gen_Id) = N_Expanded_Name
10931         then
10932            Par_Ent := Entity (Prefix (Gen_Id));
10933            Par_Vis := Is_Immediately_Visible (Par_Ent);
10934            Install_Parent (Par_Ent, In_Body => True);
10935            Parent_Installed := True;
10936
10937         elsif Is_Child_Unit (Gen_Unit) then
10938            Par_Ent := Scope (Gen_Unit);
10939            Par_Vis := Is_Immediately_Visible (Par_Ent);
10940            Install_Parent (Par_Ent, In_Body => True);
10941            Parent_Installed := True;
10942         end if;
10943
10944         --  Subprogram body is placed in the body of wrapper package,
10945         --  whose spec contains the subprogram declaration as well as
10946         --  the renaming declarations for the generic parameters.
10947
10948         Pack_Body :=
10949           Make_Package_Body (Loc,
10950             Defining_Unit_Name => New_Copy (Pack_Id),
10951             Declarations       => New_List (Act_Body));
10952
10953         Set_Corresponding_Spec (Pack_Body, Pack_Id);
10954
10955         --  If the instantiation is a library unit, then build resulting
10956         --  compilation unit nodes for the instance. The declaration of
10957         --  the enclosing package is the grandparent of the subprogram
10958         --  declaration. First replace the instantiation node as the unit
10959         --  of the corresponding compilation.
10960
10961         if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10962            if Parent (Inst_Node) = Cunit (Main_Unit) then
10963               Set_Unit (Parent (Inst_Node), Inst_Node);
10964               Build_Instance_Compilation_Unit_Nodes
10965                 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10966               Analyze (Inst_Node);
10967            else
10968               Set_Parent (Pack_Body, Parent (Inst_Node));
10969               Analyze (Pack_Body);
10970            end if;
10971
10972         else
10973            Insert_Before (Inst_Node, Pack_Body);
10974            Mark_Rewrite_Insertion (Pack_Body);
10975            Analyze (Pack_Body);
10976
10977            if Expander_Active then
10978               Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10979            end if;
10980         end if;
10981
10982         Inherit_Context (Gen_Body, Inst_Node);
10983
10984         Restore_Private_Views (Pack_Id, False);
10985
10986         if Parent_Installed then
10987            Remove_Parent (In_Body => True);
10988
10989            --  Restore the previous visibility of the parent
10990
10991            Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10992         end if;
10993
10994         Restore_Env;
10995         Style_Check := Saved_Style_Check;
10996         Restore_Warnings (Saved_Warnings);
10997
10998      --  Body not found. Error was emitted already. If there were no previous
10999      --  errors, this may be an instance whose scope is a premature instance.
11000      --  In that case we must insure that the (legal) program does raise
11001      --  program error if executed. We generate a subprogram body for this
11002      --  purpose. See DEC ac30vso.
11003
11004      --  Should not reference proprietary DEC tests in comments ???
11005
11006      elsif Serious_Errors_Detected = 0
11007        and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
11008      then
11009         if Body_Optional then
11010            return;
11011
11012         elsif Ekind (Anon_Id) = E_Procedure then
11013            Act_Body :=
11014              Make_Subprogram_Body (Loc,
11015                 Specification              =>
11016                   Make_Procedure_Specification (Loc,
11017                     Defining_Unit_Name         =>
11018                       Make_Defining_Identifier (Loc, Chars (Anon_Id)),
11019                       Parameter_Specifications =>
11020                       New_Copy_List
11021                         (Parameter_Specifications (Parent (Anon_Id)))),
11022
11023                 Declarations               => Empty_List,
11024                 Handled_Statement_Sequence =>
11025                   Make_Handled_Sequence_Of_Statements (Loc,
11026                     Statements =>
11027                       New_List (
11028                         Make_Raise_Program_Error (Loc,
11029                           Reason =>
11030                             PE_Access_Before_Elaboration))));
11031
11032         else
11033            Ret_Expr :=
11034              Make_Raise_Program_Error (Loc,
11035                Reason => PE_Access_Before_Elaboration);
11036
11037            Set_Etype (Ret_Expr, (Etype (Anon_Id)));
11038            Set_Analyzed (Ret_Expr);
11039
11040            Act_Body :=
11041              Make_Subprogram_Body (Loc,
11042                Specification =>
11043                  Make_Function_Specification (Loc,
11044                     Defining_Unit_Name         =>
11045                       Make_Defining_Identifier (Loc, Chars (Anon_Id)),
11046                       Parameter_Specifications =>
11047                       New_Copy_List
11048                         (Parameter_Specifications (Parent (Anon_Id))),
11049                     Result_Definition =>
11050                       New_Occurrence_Of (Etype (Anon_Id), Loc)),
11051
11052                  Declarations               => Empty_List,
11053                  Handled_Statement_Sequence =>
11054                    Make_Handled_Sequence_Of_Statements (Loc,
11055                      Statements =>
11056                        New_List
11057                          (Make_Simple_Return_Statement (Loc, Ret_Expr))));
11058         end if;
11059
11060         Pack_Body := Make_Package_Body (Loc,
11061           Defining_Unit_Name => New_Copy (Pack_Id),
11062           Declarations       => New_List (Act_Body));
11063
11064         Insert_After (Inst_Node, Pack_Body);
11065         Set_Corresponding_Spec (Pack_Body, Pack_Id);
11066         Analyze (Pack_Body);
11067      end if;
11068
11069      Expander_Mode_Restore;
11070   end Instantiate_Subprogram_Body;
11071
11072   ----------------------
11073   -- Instantiate_Type --
11074   ----------------------
11075
11076   function Instantiate_Type
11077     (Formal          : Node_Id;
11078      Actual          : Node_Id;
11079      Analyzed_Formal : Node_Id;
11080      Actual_Decls    : List_Id) return List_Id
11081   is
11082      Gen_T      : constant Entity_Id  := Defining_Identifier (Formal);
11083      A_Gen_T    : constant Entity_Id  :=
11084                     Defining_Identifier (Analyzed_Formal);
11085      Ancestor   : Entity_Id := Empty;
11086      Def        : constant Node_Id    := Formal_Type_Definition (Formal);
11087      Act_T      : Entity_Id;
11088      Decl_Node  : Node_Id;
11089      Decl_Nodes : List_Id;
11090      Loc        : Source_Ptr;
11091      Subt       : Entity_Id;
11092
11093      procedure Diagnose_Predicated_Actual;
11094      --  There are a number of constructs in which a discrete type with
11095      --  predicates is illegal, e.g. as an index in an array type declaration.
11096      --  If a generic type is used is such a construct in a generic package
11097      --  declaration, it carries the flag No_Predicate_On_Actual. it is part
11098      --  of the generic contract that the actual cannot have predicates.
11099
11100      procedure Validate_Array_Type_Instance;
11101      procedure Validate_Access_Subprogram_Instance;
11102      procedure Validate_Access_Type_Instance;
11103      procedure Validate_Derived_Type_Instance;
11104      procedure Validate_Derived_Interface_Type_Instance;
11105      procedure Validate_Discriminated_Formal_Type;
11106      procedure Validate_Interface_Type_Instance;
11107      procedure Validate_Private_Type_Instance;
11108      procedure Validate_Incomplete_Type_Instance;
11109      --  These procedures perform validation tests for the named case.
11110      --  Validate_Discriminated_Formal_Type is shared by formal private
11111      --  types and Ada 2012 formal incomplete types.
11112
11113      function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
11114      --  Check that base types are the same and that the subtypes match
11115      --  statically. Used in several of the above.
11116
11117      ---------------------------------
11118      --  Diagnose_Predicated_Actual --
11119      ---------------------------------
11120
11121      procedure Diagnose_Predicated_Actual is
11122      begin
11123         if No_Predicate_On_Actual (A_Gen_T)
11124           and then Has_Predicates (Act_T)
11125         then
11126            Error_Msg_NE
11127              ("actual for& cannot be a type with predicate",
11128               Instantiation_Node, A_Gen_T);
11129
11130         elsif No_Dynamic_Predicate_On_Actual (A_Gen_T)
11131           and then Has_Predicates (Act_T)
11132           and then not Has_Static_Predicate_Aspect (Act_T)
11133         then
11134            Error_Msg_NE
11135              ("actual for& cannot be a type with a dynamic predicate",
11136               Instantiation_Node, A_Gen_T);
11137         end if;
11138      end Diagnose_Predicated_Actual;
11139
11140      --------------------
11141      -- Subtypes_Match --
11142      --------------------
11143
11144      function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
11145         T : constant Entity_Id := Get_Instance_Of (Gen_T);
11146
11147      begin
11148         --  Some detailed comments would be useful here ???
11149
11150         return ((Base_Type (T) = Act_T
11151                   or else Base_Type (T) = Base_Type (Act_T))
11152                  and then Subtypes_Statically_Match (T, Act_T))
11153
11154           or else (Is_Class_Wide_Type (Gen_T)
11155                     and then Is_Class_Wide_Type (Act_T)
11156                     and then Subtypes_Match
11157                                (Get_Instance_Of (Root_Type (Gen_T)),
11158                                 Root_Type (Act_T)))
11159
11160           or else
11161             (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
11162                               E_Anonymous_Access_Type)
11163               and then Ekind (Act_T) = Ekind (Gen_T)
11164               and then Subtypes_Statically_Match
11165                          (Designated_Type (Gen_T), Designated_Type (Act_T)));
11166      end Subtypes_Match;
11167
11168      -----------------------------------------
11169      -- Validate_Access_Subprogram_Instance --
11170      -----------------------------------------
11171
11172      procedure Validate_Access_Subprogram_Instance is
11173      begin
11174         if not Is_Access_Type (Act_T)
11175           or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
11176         then
11177            Error_Msg_NE
11178              ("expect access type in instantiation of &", Actual, Gen_T);
11179            Abandon_Instantiation (Actual);
11180         end if;
11181
11182         --  According to AI05-288, actuals for access_to_subprograms must be
11183         --  subtype conformant with the generic formal. Previous to AI05-288
11184         --  only mode conformance was required.
11185
11186         --  This is a binding interpretation that applies to previous versions
11187         --  of the language, no need to maintain previous weaker checks.
11188
11189         Check_Subtype_Conformant
11190           (Designated_Type (Act_T),
11191            Designated_Type (A_Gen_T),
11192            Actual,
11193            Get_Inst => True);
11194
11195         if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
11196            if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
11197               Error_Msg_NE
11198                 ("protected access type not allowed for formal &",
11199                  Actual, Gen_T);
11200            end if;
11201
11202         elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
11203            Error_Msg_NE
11204              ("expect protected access type for formal &",
11205               Actual, Gen_T);
11206         end if;
11207
11208         --  If the formal has a specified convention (which in most cases
11209         --  will be StdCall) verify that the actual has the same convention.
11210
11211         if Has_Convention_Pragma (A_Gen_T)
11212           and then Convention (A_Gen_T) /= Convention (Act_T)
11213         then
11214            Error_Msg_Name_1 := Get_Convention_Name (Convention (A_Gen_T));
11215            Error_Msg_NE
11216              ("actual for formal & must have convention %", Actual, Gen_T);
11217         end if;
11218      end Validate_Access_Subprogram_Instance;
11219
11220      -----------------------------------
11221      -- Validate_Access_Type_Instance --
11222      -----------------------------------
11223
11224      procedure Validate_Access_Type_Instance is
11225         Desig_Type : constant Entity_Id :=
11226                        Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
11227         Desig_Act  : Entity_Id;
11228
11229      begin
11230         if not Is_Access_Type (Act_T) then
11231            Error_Msg_NE
11232              ("expect access type in instantiation of &", Actual, Gen_T);
11233            Abandon_Instantiation (Actual);
11234         end if;
11235
11236         if Is_Access_Constant (A_Gen_T) then
11237            if not Is_Access_Constant (Act_T) then
11238               Error_Msg_N
11239                 ("actual type must be access-to-constant type", Actual);
11240               Abandon_Instantiation (Actual);
11241            end if;
11242         else
11243            if Is_Access_Constant (Act_T) then
11244               Error_Msg_N
11245                 ("actual type must be access-to-variable type", Actual);
11246               Abandon_Instantiation (Actual);
11247
11248            elsif Ekind (A_Gen_T) = E_General_Access_Type
11249              and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
11250            then
11251               Error_Msg_N -- CODEFIX
11252                 ("actual must be general access type!", Actual);
11253               Error_Msg_NE -- CODEFIX
11254                 ("add ALL to }!", Actual, Act_T);
11255               Abandon_Instantiation (Actual);
11256            end if;
11257         end if;
11258
11259         --  The designated subtypes, that is to say the subtypes introduced
11260         --  by an access type declaration (and not by a subtype declaration)
11261         --  must match.
11262
11263         Desig_Act := Designated_Type (Base_Type (Act_T));
11264
11265         --  The designated type may have been introduced through a limited_
11266         --  with clause, in which case retrieve the non-limited view. This
11267         --  applies to incomplete types as well as to class-wide types.
11268
11269         if From_Limited_With (Desig_Act) then
11270            Desig_Act := Available_View (Desig_Act);
11271         end if;
11272
11273         if not Subtypes_Match (Desig_Type, Desig_Act) then
11274            Error_Msg_NE
11275              ("designated type of actual does not match that of formal &",
11276               Actual, Gen_T);
11277
11278            if not Predicates_Match (Desig_Type, Desig_Act) then
11279               Error_Msg_N ("\predicates do not match", Actual);
11280            end if;
11281
11282            Abandon_Instantiation (Actual);
11283
11284         elsif Is_Access_Type (Designated_Type (Act_T))
11285           and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
11286                      /=
11287                    Is_Constrained (Designated_Type (Desig_Type))
11288         then
11289            Error_Msg_NE
11290              ("designated type of actual does not match that of formal &",
11291               Actual, Gen_T);
11292
11293            if not Predicates_Match (Desig_Type, Desig_Act) then
11294               Error_Msg_N ("\predicates do not match", Actual);
11295            end if;
11296
11297            Abandon_Instantiation (Actual);
11298         end if;
11299
11300         --  Ada 2005: null-exclusion indicators of the two types must agree
11301
11302         if Can_Never_Be_Null (A_Gen_T) /=  Can_Never_Be_Null (Act_T) then
11303            Error_Msg_NE
11304              ("non null exclusion of actual and formal & do not match",
11305                 Actual, Gen_T);
11306         end if;
11307      end Validate_Access_Type_Instance;
11308
11309      ----------------------------------
11310      -- Validate_Array_Type_Instance --
11311      ----------------------------------
11312
11313      procedure Validate_Array_Type_Instance is
11314         I1 : Node_Id;
11315         I2 : Node_Id;
11316         T2 : Entity_Id;
11317
11318         function Formal_Dimensions return Int;
11319         --  Count number of dimensions in array type formal
11320
11321         -----------------------
11322         -- Formal_Dimensions --
11323         -----------------------
11324
11325         function Formal_Dimensions return Int is
11326            Num   : Int := 0;
11327            Index : Node_Id;
11328
11329         begin
11330            if Nkind (Def) = N_Constrained_Array_Definition then
11331               Index := First (Discrete_Subtype_Definitions (Def));
11332            else
11333               Index := First (Subtype_Marks (Def));
11334            end if;
11335
11336            while Present (Index) loop
11337               Num := Num + 1;
11338               Next_Index (Index);
11339            end loop;
11340
11341            return Num;
11342         end Formal_Dimensions;
11343
11344      --  Start of processing for Validate_Array_Type_Instance
11345
11346      begin
11347         if not Is_Array_Type (Act_T) then
11348            Error_Msg_NE
11349              ("expect array type in instantiation of &", Actual, Gen_T);
11350            Abandon_Instantiation (Actual);
11351
11352         elsif Nkind (Def) = N_Constrained_Array_Definition then
11353            if not (Is_Constrained (Act_T)) then
11354               Error_Msg_NE
11355                 ("expect constrained array in instantiation of &",
11356                  Actual, Gen_T);
11357               Abandon_Instantiation (Actual);
11358            end if;
11359
11360         else
11361            if Is_Constrained (Act_T) then
11362               Error_Msg_NE
11363                 ("expect unconstrained array in instantiation of &",
11364                  Actual, Gen_T);
11365               Abandon_Instantiation (Actual);
11366            end if;
11367         end if;
11368
11369         if Formal_Dimensions /= Number_Dimensions (Act_T) then
11370            Error_Msg_NE
11371              ("dimensions of actual do not match formal &", Actual, Gen_T);
11372            Abandon_Instantiation (Actual);
11373         end if;
11374
11375         I1 := First_Index (A_Gen_T);
11376         I2 := First_Index (Act_T);
11377         for J in 1 .. Formal_Dimensions loop
11378
11379            --  If the indexes of the actual were given by a subtype_mark,
11380            --  the index was transformed into a range attribute. Retrieve
11381            --  the original type mark for checking.
11382
11383            if Is_Entity_Name (Original_Node (I2)) then
11384               T2 := Entity (Original_Node (I2));
11385            else
11386               T2 := Etype (I2);
11387            end if;
11388
11389            if not Subtypes_Match
11390                     (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
11391            then
11392               Error_Msg_NE
11393                 ("index types of actual do not match those of formal &",
11394                  Actual, Gen_T);
11395               Abandon_Instantiation (Actual);
11396            end if;
11397
11398            Next_Index (I1);
11399            Next_Index (I2);
11400         end loop;
11401
11402         --  Check matching subtypes. Note that there are complex visibility
11403         --  issues when the generic is a child unit and some aspect of the
11404         --  generic type is declared in a parent unit of the generic. We do
11405         --  the test to handle this special case only after a direct check
11406         --  for static matching has failed. The case where both the component
11407         --  type and the array type are separate formals, and the component
11408         --  type is a private view may also require special checking in
11409         --  Subtypes_Match.
11410
11411         if Subtypes_Match
11412           (Component_Type (A_Gen_T), Component_Type (Act_T))
11413             or else
11414               Subtypes_Match
11415                 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
11416                  Component_Type (Act_T))
11417         then
11418            null;
11419         else
11420            Error_Msg_NE
11421              ("component subtype of actual does not match that of formal &",
11422               Actual, Gen_T);
11423            Abandon_Instantiation (Actual);
11424         end if;
11425
11426         if Has_Aliased_Components (A_Gen_T)
11427           and then not Has_Aliased_Components (Act_T)
11428         then
11429            Error_Msg_NE
11430              ("actual must have aliased components to match formal type &",
11431               Actual, Gen_T);
11432         end if;
11433      end Validate_Array_Type_Instance;
11434
11435      -----------------------------------------------
11436      --  Validate_Derived_Interface_Type_Instance --
11437      -----------------------------------------------
11438
11439      procedure Validate_Derived_Interface_Type_Instance is
11440         Par  : constant Entity_Id := Entity (Subtype_Indication (Def));
11441         Elmt : Elmt_Id;
11442
11443      begin
11444         --  First apply interface instance checks
11445
11446         Validate_Interface_Type_Instance;
11447
11448         --  Verify that immediate parent interface is an ancestor of
11449         --  the actual.
11450
11451         if Present (Par)
11452           and then not Interface_Present_In_Ancestor (Act_T, Par)
11453         then
11454            Error_Msg_NE
11455              ("interface actual must include progenitor&", Actual, Par);
11456         end if;
11457
11458         --  Now verify that the actual includes all other ancestors of
11459         --  the formal.
11460
11461         Elmt := First_Elmt (Interfaces (A_Gen_T));
11462         while Present (Elmt) loop
11463            if not Interface_Present_In_Ancestor
11464                     (Act_T, Get_Instance_Of (Node (Elmt)))
11465            then
11466               Error_Msg_NE
11467                 ("interface actual must include progenitor&",
11468                    Actual, Node (Elmt));
11469            end if;
11470
11471            Next_Elmt (Elmt);
11472         end loop;
11473      end Validate_Derived_Interface_Type_Instance;
11474
11475      ------------------------------------
11476      -- Validate_Derived_Type_Instance --
11477      ------------------------------------
11478
11479      procedure Validate_Derived_Type_Instance is
11480         Actual_Discr   : Entity_Id;
11481         Ancestor_Discr : Entity_Id;
11482
11483      begin
11484         --  If the parent type in the generic declaration is itself a previous
11485         --  formal type, then it is local to the generic and absent from the
11486         --  analyzed generic definition. In that case the ancestor is the
11487         --  instance of the formal (which must have been instantiated
11488         --  previously), unless the ancestor is itself a formal derived type.
11489         --  In this latter case (which is the subject of Corrigendum 8652/0038
11490         --  (AI-202) the ancestor of the formals is the ancestor of its
11491         --  parent. Otherwise, the analyzed generic carries the parent type.
11492         --  If the parent type is defined in a previous formal package, then
11493         --  the scope of that formal package is that of the generic type
11494         --  itself, and it has already been mapped into the corresponding type
11495         --  in the actual package.
11496
11497         --  Common case: parent type defined outside of the generic
11498
11499         if Is_Entity_Name (Subtype_Mark (Def))
11500           and then Present (Entity (Subtype_Mark (Def)))
11501         then
11502            Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
11503
11504         --  Check whether parent is defined in a previous formal package
11505
11506         elsif
11507           Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
11508         then
11509            Ancestor :=
11510              Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
11511
11512         --  The type may be a local derivation, or a type extension of a
11513         --  previous formal, or of a formal of a parent package.
11514
11515         elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
11516          or else
11517            Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
11518         then
11519            --  Check whether the parent is another derived formal type in the
11520            --  same generic unit.
11521
11522            if Etype (A_Gen_T) /= A_Gen_T
11523              and then Is_Generic_Type (Etype (A_Gen_T))
11524              and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
11525              and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
11526            then
11527               --  Locate ancestor of parent from the subtype declaration
11528               --  created for the actual.
11529
11530               declare
11531                  Decl : Node_Id;
11532
11533               begin
11534                  Decl := First (Actual_Decls);
11535                  while Present (Decl) loop
11536                     if Nkind (Decl) = N_Subtype_Declaration
11537                       and then Chars (Defining_Identifier (Decl)) =
11538                                                    Chars (Etype (A_Gen_T))
11539                     then
11540                        Ancestor := Generic_Parent_Type (Decl);
11541                        exit;
11542                     else
11543                        Next (Decl);
11544                     end if;
11545                  end loop;
11546               end;
11547
11548               pragma Assert (Present (Ancestor));
11549
11550               --  The ancestor itself may be a previous formal that has been
11551               --  instantiated.
11552
11553               Ancestor := Get_Instance_Of (Ancestor);
11554
11555            else
11556               Ancestor :=
11557                 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11558            end if;
11559
11560         --  An unusual case: the actual is a type declared in a parent unit,
11561         --  but is not a formal type so there is no instance_of for it.
11562         --  Retrieve it by analyzing the record extension.
11563
11564         elsif Is_Child_Unit (Scope (A_Gen_T))
11565           and then In_Open_Scopes (Scope (Act_T))
11566           and then Is_Generic_Instance (Scope (Act_T))
11567         then
11568            Analyze (Subtype_Mark (Def));
11569            Ancestor := Entity (Subtype_Mark (Def));
11570
11571         else
11572            Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11573         end if;
11574
11575         --  If the formal derived type has pragma Preelaborable_Initialization
11576         --  then the actual type must have preelaborable initialization.
11577
11578         if Known_To_Have_Preelab_Init (A_Gen_T)
11579           and then not Has_Preelaborable_Initialization (Act_T)
11580         then
11581            Error_Msg_NE
11582              ("actual for & must have preelaborable initialization",
11583               Actual, Gen_T);
11584         end if;
11585
11586         --  Ada 2005 (AI-251)
11587
11588         if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11589            if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11590               Error_Msg_NE
11591                 ("(Ada 2005) expected type implementing & in instantiation",
11592                  Actual, Ancestor);
11593            end if;
11594
11595         elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11596            Error_Msg_NE
11597              ("expect type derived from & in instantiation",
11598               Actual, First_Subtype (Ancestor));
11599            Abandon_Instantiation (Actual);
11600         end if;
11601
11602         --  Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11603         --  that the formal type declaration has been rewritten as a private
11604         --  extension.
11605
11606         if Ada_Version >= Ada_2005
11607           and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11608           and then Synchronized_Present (Parent (A_Gen_T))
11609         then
11610            --  The actual must be a synchronized tagged type
11611
11612            if not Is_Tagged_Type (Act_T) then
11613               Error_Msg_N
11614                 ("actual of synchronized type must be tagged", Actual);
11615               Abandon_Instantiation (Actual);
11616
11617            elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11618              and then Nkind (Type_Definition (Parent (Act_T))) =
11619                                                 N_Derived_Type_Definition
11620              and then not Synchronized_Present
11621                             (Type_Definition (Parent (Act_T)))
11622            then
11623               Error_Msg_N
11624                 ("actual of synchronized type must be synchronized", Actual);
11625               Abandon_Instantiation (Actual);
11626            end if;
11627         end if;
11628
11629         --  Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11630         --  removes the second instance of the phrase "or allow pass by copy".
11631
11632         if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11633            Error_Msg_N
11634              ("cannot have atomic actual type for non-atomic formal type",
11635               Actual);
11636
11637         elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11638            Error_Msg_N
11639              ("cannot have volatile actual type for non-volatile formal type",
11640               Actual);
11641         end if;
11642
11643         --  It should not be necessary to check for unknown discriminants on
11644         --  Formal, but for some reason Has_Unknown_Discriminants is false for
11645         --  A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11646         --  needs fixing. ???
11647
11648         if not Is_Indefinite_Subtype (A_Gen_T)
11649           and then not Unknown_Discriminants_Present (Formal)
11650           and then Is_Indefinite_Subtype (Act_T)
11651         then
11652            Error_Msg_N ("actual subtype must be constrained", Actual);
11653            Abandon_Instantiation (Actual);
11654         end if;
11655
11656         if not Unknown_Discriminants_Present (Formal) then
11657            if Is_Constrained (Ancestor) then
11658               if not Is_Constrained (Act_T) then
11659                  Error_Msg_N ("actual subtype must be constrained", Actual);
11660                  Abandon_Instantiation (Actual);
11661               end if;
11662
11663            --  Ancestor is unconstrained, Check if generic formal and actual
11664            --  agree on constrainedness. The check only applies to array types
11665            --  and discriminated types.
11666
11667            elsif Is_Constrained (Act_T) then
11668               if Ekind (Ancestor) = E_Access_Type
11669                 or else (not Is_Constrained (A_Gen_T)
11670                           and then Is_Composite_Type (A_Gen_T))
11671               then
11672                  Error_Msg_N ("actual subtype must be unconstrained", Actual);
11673                  Abandon_Instantiation (Actual);
11674               end if;
11675
11676            --  A class-wide type is only allowed if the formal has unknown
11677            --  discriminants.
11678
11679            elsif Is_Class_Wide_Type (Act_T)
11680              and then not Has_Unknown_Discriminants (Ancestor)
11681            then
11682               Error_Msg_NE
11683                 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11684               Abandon_Instantiation (Actual);
11685
11686            --  Otherwise, the formal and actual must have the same number
11687            --  of discriminants and each discriminant of the actual must
11688            --  correspond to a discriminant of the formal.
11689
11690            elsif Has_Discriminants (Act_T)
11691              and then not Has_Unknown_Discriminants (Act_T)
11692              and then Has_Discriminants (Ancestor)
11693            then
11694               Actual_Discr   := First_Discriminant (Act_T);
11695               Ancestor_Discr := First_Discriminant (Ancestor);
11696               while Present (Actual_Discr)
11697                 and then Present (Ancestor_Discr)
11698               loop
11699                  if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11700                    No (Corresponding_Discriminant (Actual_Discr))
11701                  then
11702                     Error_Msg_NE
11703                       ("discriminant & does not correspond "
11704                        & "to ancestor discriminant", Actual, Actual_Discr);
11705                     Abandon_Instantiation (Actual);
11706                  end if;
11707
11708                  Next_Discriminant (Actual_Discr);
11709                  Next_Discriminant (Ancestor_Discr);
11710               end loop;
11711
11712               if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11713                  Error_Msg_NE
11714                    ("actual for & must have same number of discriminants",
11715                     Actual, Gen_T);
11716                  Abandon_Instantiation (Actual);
11717               end if;
11718
11719            --  This case should be caught by the earlier check for
11720            --  constrainedness, but the check here is added for completeness.
11721
11722            elsif Has_Discriminants (Act_T)
11723              and then not Has_Unknown_Discriminants (Act_T)
11724            then
11725               Error_Msg_NE
11726                 ("actual for & must not have discriminants", Actual, Gen_T);
11727               Abandon_Instantiation (Actual);
11728
11729            elsif Has_Discriminants (Ancestor) then
11730               Error_Msg_NE
11731                 ("actual for & must have known discriminants", Actual, Gen_T);
11732               Abandon_Instantiation (Actual);
11733            end if;
11734
11735            if not Subtypes_Statically_Compatible
11736                     (Act_T, Ancestor, Formal_Derived_Matching => True)
11737            then
11738               Error_Msg_N
11739                 ("constraint on actual is incompatible with formal", Actual);
11740               Abandon_Instantiation (Actual);
11741            end if;
11742         end if;
11743
11744         --  If the formal and actual types are abstract, check that there
11745         --  are no abstract primitives of the actual type that correspond to
11746         --  nonabstract primitives of the formal type (second sentence of
11747         --  RM95-3.9.3(9)).
11748
11749         if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11750            Check_Abstract_Primitives : declare
11751               Gen_Prims  : constant Elist_Id :=
11752                             Primitive_Operations (A_Gen_T);
11753               Gen_Elmt   : Elmt_Id;
11754               Gen_Subp   : Entity_Id;
11755               Anc_Subp   : Entity_Id;
11756               Anc_Formal : Entity_Id;
11757               Anc_F_Type : Entity_Id;
11758
11759               Act_Prims  : constant Elist_Id  := Primitive_Operations (Act_T);
11760               Act_Elmt   : Elmt_Id;
11761               Act_Subp   : Entity_Id;
11762               Act_Formal : Entity_Id;
11763               Act_F_Type : Entity_Id;
11764
11765               Subprograms_Correspond : Boolean;
11766
11767               function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11768               --  Returns true if T2 is derived directly or indirectly from
11769               --  T1, including derivations from interfaces. T1 and T2 are
11770               --  required to be specific tagged base types.
11771
11772               ------------------------
11773               -- Is_Tagged_Ancestor --
11774               ------------------------
11775
11776               function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11777               is
11778                  Intfc_Elmt : Elmt_Id;
11779
11780               begin
11781                  --  The predicate is satisfied if the types are the same
11782
11783                  if T1 = T2 then
11784                     return True;
11785
11786                  --  If we've reached the top of the derivation chain then
11787                  --  we know that T1 is not an ancestor of T2.
11788
11789                  elsif Etype (T2) = T2 then
11790                     return False;
11791
11792                  --  Proceed to check T2's immediate parent
11793
11794                  elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11795                     return True;
11796
11797                  --  Finally, check to see if T1 is an ancestor of any of T2's
11798                  --  progenitors.
11799
11800                  else
11801                     Intfc_Elmt := First_Elmt (Interfaces (T2));
11802                     while Present (Intfc_Elmt) loop
11803                        if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11804                           return True;
11805                        end if;
11806
11807                        Next_Elmt (Intfc_Elmt);
11808                     end loop;
11809                  end if;
11810
11811                  return False;
11812               end Is_Tagged_Ancestor;
11813
11814            --  Start of processing for Check_Abstract_Primitives
11815
11816            begin
11817               --  Loop over all of the formal derived type's primitives
11818
11819               Gen_Elmt := First_Elmt (Gen_Prims);
11820               while Present (Gen_Elmt) loop
11821                  Gen_Subp := Node (Gen_Elmt);
11822
11823                  --  If the primitive of the formal is not abstract, then
11824                  --  determine whether there is a corresponding primitive of
11825                  --  the actual type that's abstract.
11826
11827                  if not Is_Abstract_Subprogram (Gen_Subp) then
11828                     Act_Elmt := First_Elmt (Act_Prims);
11829                     while Present (Act_Elmt) loop
11830                        Act_Subp := Node (Act_Elmt);
11831
11832                        --  If we find an abstract primitive of the actual,
11833                        --  then we need to test whether it corresponds to the
11834                        --  subprogram from which the generic formal primitive
11835                        --  is inherited.
11836
11837                        if Is_Abstract_Subprogram (Act_Subp) then
11838                           Anc_Subp := Alias (Gen_Subp);
11839
11840                           --  Test whether we have a corresponding primitive
11841                           --  by comparing names, kinds, formal types, and
11842                           --  result types.
11843
11844                           if Chars (Anc_Subp) = Chars (Act_Subp)
11845                             and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11846                           then
11847                              Anc_Formal := First_Formal (Anc_Subp);
11848                              Act_Formal := First_Formal (Act_Subp);
11849                              while Present (Anc_Formal)
11850                                and then Present (Act_Formal)
11851                              loop
11852                                 Anc_F_Type := Etype (Anc_Formal);
11853                                 Act_F_Type := Etype (Act_Formal);
11854
11855                                 if Ekind (Anc_F_Type) =
11856                                                        E_Anonymous_Access_Type
11857                                 then
11858                                    Anc_F_Type := Designated_Type (Anc_F_Type);
11859
11860                                    if Ekind (Act_F_Type) =
11861                                                        E_Anonymous_Access_Type
11862                                    then
11863                                       Act_F_Type :=
11864                                         Designated_Type (Act_F_Type);
11865                                    else
11866                                       exit;
11867                                    end if;
11868
11869                                 elsif
11870                                   Ekind (Act_F_Type) = E_Anonymous_Access_Type
11871                                 then
11872                                    exit;
11873                                 end if;
11874
11875                                 Anc_F_Type := Base_Type (Anc_F_Type);
11876                                 Act_F_Type := Base_Type (Act_F_Type);
11877
11878                                 --  If the formal is controlling, then the
11879                                 --  the type of the actual primitive's formal
11880                                 --  must be derived directly or indirectly
11881                                 --  from the type of the ancestor primitive's
11882                                 --  formal.
11883
11884                                 if Is_Controlling_Formal (Anc_Formal) then
11885                                    if not Is_Tagged_Ancestor
11886                                             (Anc_F_Type, Act_F_Type)
11887                                    then
11888                                       exit;
11889                                    end if;
11890
11891                                 --  Otherwise the types of the formals must
11892                                 --  be the same.
11893
11894                                 elsif Anc_F_Type /= Act_F_Type then
11895                                    exit;
11896                                 end if;
11897
11898                                 Next_Entity (Anc_Formal);
11899                                 Next_Entity (Act_Formal);
11900                              end loop;
11901
11902                              --  If we traversed through all of the formals
11903                              --  then so far the subprograms correspond, so
11904                              --  now check that any result types correspond.
11905
11906                              if No (Anc_Formal) and then No (Act_Formal) then
11907                                 Subprograms_Correspond := True;
11908
11909                                 if Ekind (Act_Subp) = E_Function then
11910                                    Anc_F_Type := Etype (Anc_Subp);
11911                                    Act_F_Type := Etype (Act_Subp);
11912
11913                                    if Ekind (Anc_F_Type) =
11914                                                        E_Anonymous_Access_Type
11915                                    then
11916                                       Anc_F_Type :=
11917                                         Designated_Type (Anc_F_Type);
11918
11919                                       if Ekind (Act_F_Type) =
11920                                                        E_Anonymous_Access_Type
11921                                       then
11922                                          Act_F_Type :=
11923                                            Designated_Type (Act_F_Type);
11924                                       else
11925                                          Subprograms_Correspond := False;
11926                                       end if;
11927
11928                                    elsif
11929                                      Ekind (Act_F_Type)
11930                                        = E_Anonymous_Access_Type
11931                                    then
11932                                       Subprograms_Correspond := False;
11933                                    end if;
11934
11935                                    Anc_F_Type := Base_Type (Anc_F_Type);
11936                                    Act_F_Type := Base_Type (Act_F_Type);
11937
11938                                    --  Now either the result types must be
11939                                    --  the same or, if the result type is
11940                                    --  controlling, the result type of the
11941                                    --  actual primitive must descend from the
11942                                    --  result type of the ancestor primitive.
11943
11944                                    if Subprograms_Correspond
11945                                      and then Anc_F_Type /= Act_F_Type
11946                                      and then
11947                                        Has_Controlling_Result (Anc_Subp)
11948                                      and then not Is_Tagged_Ancestor
11949                                                     (Anc_F_Type, Act_F_Type)
11950                                    then
11951                                       Subprograms_Correspond := False;
11952                                    end if;
11953                                 end if;
11954
11955                                 --  Found a matching subprogram belonging to
11956                                 --  formal ancestor type, so actual subprogram
11957                                 --  corresponds and this violates 3.9.3(9).
11958
11959                                 if Subprograms_Correspond then
11960                                    Error_Msg_NE
11961                                      ("abstract subprogram & overrides "
11962                                       & "nonabstract subprogram of ancestor",
11963                                       Actual, Act_Subp);
11964                                 end if;
11965                              end if;
11966                           end if;
11967                        end if;
11968
11969                        Next_Elmt (Act_Elmt);
11970                     end loop;
11971                  end if;
11972
11973                  Next_Elmt (Gen_Elmt);
11974               end loop;
11975            end Check_Abstract_Primitives;
11976         end if;
11977
11978         --  Verify that limitedness matches. If parent is a limited
11979         --  interface then  the generic formal is not unless declared
11980         --  explicitly so. If not declared limited, the actual cannot be
11981         --  limited (see AI05-0087).
11982
11983         --  Even though this AI is a binding interpretation, we enable the
11984         --  check only in Ada 2012 mode, because this improper construct
11985         --  shows up in user code and in existing B-tests.
11986
11987         if Is_Limited_Type (Act_T)
11988           and then not Is_Limited_Type (A_Gen_T)
11989           and then Ada_Version >= Ada_2012
11990         then
11991            if In_Instance then
11992               null;
11993            else
11994               Error_Msg_NE
11995                 ("actual for non-limited & cannot be a limited type",
11996                  Actual, Gen_T);
11997               Explain_Limited_Type (Act_T, Actual);
11998               Abandon_Instantiation (Actual);
11999            end if;
12000         end if;
12001      end Validate_Derived_Type_Instance;
12002
12003      ----------------------------------------
12004      -- Validate_Discriminated_Formal_Type --
12005      ----------------------------------------
12006
12007      procedure Validate_Discriminated_Formal_Type is
12008         Formal_Discr : Entity_Id;
12009         Actual_Discr : Entity_Id;
12010         Formal_Subt  : Entity_Id;
12011
12012      begin
12013         if Has_Discriminants (A_Gen_T) then
12014            if not Has_Discriminants (Act_T) then
12015               Error_Msg_NE
12016                 ("actual for & must have discriminants", Actual, Gen_T);
12017               Abandon_Instantiation (Actual);
12018
12019            elsif Is_Constrained (Act_T) then
12020               Error_Msg_NE
12021                 ("actual for & must be unconstrained", Actual, Gen_T);
12022               Abandon_Instantiation (Actual);
12023
12024            else
12025               Formal_Discr := First_Discriminant (A_Gen_T);
12026               Actual_Discr := First_Discriminant (Act_T);
12027               while Formal_Discr /= Empty loop
12028                  if Actual_Discr = Empty then
12029                     Error_Msg_NE
12030                       ("discriminants on actual do not match formal",
12031                        Actual, Gen_T);
12032                     Abandon_Instantiation (Actual);
12033                  end if;
12034
12035                  Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
12036
12037                  --  Access discriminants match if designated types do
12038
12039                  if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
12040                    and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
12041                                E_Anonymous_Access_Type
12042                    and then
12043                      Get_Instance_Of
12044                        (Designated_Type (Base_Type (Formal_Subt))) =
12045                           Designated_Type (Base_Type (Etype (Actual_Discr)))
12046                  then
12047                     null;
12048
12049                  elsif Base_Type (Formal_Subt) /=
12050                          Base_Type (Etype (Actual_Discr))
12051                  then
12052                     Error_Msg_NE
12053                       ("types of actual discriminants must match formal",
12054                        Actual, Gen_T);
12055                     Abandon_Instantiation (Actual);
12056
12057                  elsif not Subtypes_Statically_Match
12058                              (Formal_Subt, Etype (Actual_Discr))
12059                    and then Ada_Version >= Ada_95
12060                  then
12061                     Error_Msg_NE
12062                       ("subtypes of actual discriminants must match formal",
12063                        Actual, Gen_T);
12064                     Abandon_Instantiation (Actual);
12065                  end if;
12066
12067                  Next_Discriminant (Formal_Discr);
12068                  Next_Discriminant (Actual_Discr);
12069               end loop;
12070
12071               if Actual_Discr /= Empty then
12072                  Error_Msg_NE
12073                    ("discriminants on actual do not match formal",
12074                     Actual, Gen_T);
12075                  Abandon_Instantiation (Actual);
12076               end if;
12077            end if;
12078         end if;
12079      end Validate_Discriminated_Formal_Type;
12080
12081      ---------------------------------------
12082      -- Validate_Incomplete_Type_Instance --
12083      ---------------------------------------
12084
12085      procedure Validate_Incomplete_Type_Instance is
12086      begin
12087         if not Is_Tagged_Type (Act_T)
12088           and then Is_Tagged_Type (A_Gen_T)
12089         then
12090            Error_Msg_NE
12091              ("actual for & must be a tagged type", Actual, Gen_T);
12092         end if;
12093
12094         Validate_Discriminated_Formal_Type;
12095      end Validate_Incomplete_Type_Instance;
12096
12097      --------------------------------------
12098      -- Validate_Interface_Type_Instance --
12099      --------------------------------------
12100
12101      procedure Validate_Interface_Type_Instance is
12102      begin
12103         if not Is_Interface (Act_T) then
12104            Error_Msg_NE
12105              ("actual for formal interface type must be an interface",
12106               Actual, Gen_T);
12107
12108         elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
12109           or else Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
12110           or else Is_Protected_Interface (A_Gen_T) /=
12111                   Is_Protected_Interface (Act_T)
12112           or else Is_Synchronized_Interface (A_Gen_T) /=
12113                   Is_Synchronized_Interface (Act_T)
12114         then
12115            Error_Msg_NE
12116              ("actual for interface& does not match (RM 12.5.5(4))",
12117               Actual, Gen_T);
12118         end if;
12119      end Validate_Interface_Type_Instance;
12120
12121      ------------------------------------
12122      -- Validate_Private_Type_Instance --
12123      ------------------------------------
12124
12125      procedure Validate_Private_Type_Instance is
12126      begin
12127         if Is_Limited_Type (Act_T)
12128           and then not Is_Limited_Type (A_Gen_T)
12129         then
12130            if In_Instance then
12131               null;
12132            else
12133               Error_Msg_NE
12134                 ("actual for non-limited & cannot be a limited type", Actual,
12135                  Gen_T);
12136               Explain_Limited_Type (Act_T, Actual);
12137               Abandon_Instantiation (Actual);
12138            end if;
12139
12140         elsif Known_To_Have_Preelab_Init (A_Gen_T)
12141           and then not Has_Preelaborable_Initialization (Act_T)
12142         then
12143            Error_Msg_NE
12144              ("actual for & must have preelaborable initialization", Actual,
12145               Gen_T);
12146
12147         elsif Is_Indefinite_Subtype (Act_T)
12148            and then not Is_Indefinite_Subtype (A_Gen_T)
12149            and then Ada_Version >= Ada_95
12150         then
12151            Error_Msg_NE
12152              ("actual for & must be a definite subtype", Actual, Gen_T);
12153
12154         elsif not Is_Tagged_Type (Act_T)
12155           and then Is_Tagged_Type (A_Gen_T)
12156         then
12157            Error_Msg_NE
12158              ("actual for & must be a tagged type", Actual, Gen_T);
12159         end if;
12160
12161         Validate_Discriminated_Formal_Type;
12162         Ancestor := Gen_T;
12163      end Validate_Private_Type_Instance;
12164
12165   --  Start of processing for Instantiate_Type
12166
12167   begin
12168      if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
12169         Error_Msg_N ("duplicate instantiation of generic type", Actual);
12170         return New_List (Error);
12171
12172      elsif not Is_Entity_Name (Actual)
12173        or else not Is_Type (Entity (Actual))
12174      then
12175         Error_Msg_NE
12176           ("expect valid subtype mark to instantiate &", Actual, Gen_T);
12177         Abandon_Instantiation (Actual);
12178
12179      else
12180         Act_T := Entity (Actual);
12181
12182         --  Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
12183         --  as a generic actual parameter if the corresponding formal type
12184         --  does not have a known_discriminant_part, or is a formal derived
12185         --  type that is an Unchecked_Union type.
12186
12187         if Is_Unchecked_Union (Base_Type (Act_T)) then
12188            if not Has_Discriminants (A_Gen_T)
12189              or else (Is_Derived_Type (A_Gen_T)
12190                        and then Is_Unchecked_Union (A_Gen_T))
12191            then
12192               null;
12193            else
12194               Error_Msg_N ("unchecked union cannot be the actual for a "
12195                            & "discriminated formal type", Act_T);
12196
12197            end if;
12198         end if;
12199
12200         --  Deal with fixed/floating restrictions
12201
12202         if Is_Floating_Point_Type (Act_T) then
12203            Check_Restriction (No_Floating_Point, Actual);
12204         elsif Is_Fixed_Point_Type (Act_T) then
12205            Check_Restriction (No_Fixed_Point, Actual);
12206         end if;
12207
12208         --  Deal with error of using incomplete type as generic actual.
12209         --  This includes limited views of a type, even if the non-limited
12210         --  view may be available.
12211
12212         if Ekind (Act_T) = E_Incomplete_Type
12213           or else (Is_Class_Wide_Type (Act_T)
12214                     and then Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
12215         then
12216            --  If the formal is an incomplete type, the actual can be
12217            --  incomplete as well.
12218
12219            if Ekind (A_Gen_T) = E_Incomplete_Type then
12220               null;
12221
12222            elsif Is_Class_Wide_Type (Act_T)
12223              or else No (Full_View (Act_T))
12224            then
12225               Error_Msg_N ("premature use of incomplete type", Actual);
12226               Abandon_Instantiation (Actual);
12227            else
12228               Act_T := Full_View (Act_T);
12229               Set_Entity (Actual, Act_T);
12230
12231               if Has_Private_Component (Act_T) then
12232                  Error_Msg_N
12233                    ("premature use of type with private component", Actual);
12234               end if;
12235            end if;
12236
12237         --  Deal with error of premature use of private type as generic actual
12238
12239         elsif Is_Private_Type (Act_T)
12240           and then Is_Private_Type (Base_Type (Act_T))
12241           and then not Is_Generic_Type (Act_T)
12242           and then not Is_Derived_Type (Act_T)
12243           and then No (Full_View (Root_Type (Act_T)))
12244         then
12245            --  If the formal is an incomplete type, the actual can be
12246            --  private or incomplete as well.
12247
12248            if Ekind (A_Gen_T) = E_Incomplete_Type then
12249               null;
12250            else
12251               Error_Msg_N ("premature use of private type", Actual);
12252            end if;
12253
12254         elsif Has_Private_Component (Act_T) then
12255            Error_Msg_N
12256              ("premature use of type with private component", Actual);
12257         end if;
12258
12259         Set_Instance_Of (A_Gen_T, Act_T);
12260
12261         --  If the type is generic, the class-wide type may also be used
12262
12263         if Is_Tagged_Type (A_Gen_T)
12264           and then Is_Tagged_Type (Act_T)
12265           and then not Is_Class_Wide_Type (A_Gen_T)
12266         then
12267            Set_Instance_Of (Class_Wide_Type (A_Gen_T),
12268              Class_Wide_Type (Act_T));
12269         end if;
12270
12271         if not Is_Abstract_Type (A_Gen_T)
12272           and then Is_Abstract_Type (Act_T)
12273         then
12274            Error_Msg_N
12275              ("actual of non-abstract formal cannot be abstract", Actual);
12276         end if;
12277
12278         --  A generic scalar type is a first subtype for which we generate
12279         --  an anonymous base type. Indicate that the instance of this base
12280         --  is the base type of the actual.
12281
12282         if Is_Scalar_Type (A_Gen_T) then
12283            Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
12284         end if;
12285      end if;
12286
12287      if Error_Posted (Act_T) then
12288         null;
12289      else
12290         case Nkind (Def) is
12291            when N_Formal_Private_Type_Definition =>
12292               Validate_Private_Type_Instance;
12293
12294            when N_Formal_Incomplete_Type_Definition =>
12295               Validate_Incomplete_Type_Instance;
12296
12297            when N_Formal_Derived_Type_Definition =>
12298               Validate_Derived_Type_Instance;
12299
12300            when N_Formal_Discrete_Type_Definition =>
12301               if not Is_Discrete_Type (Act_T) then
12302                  Error_Msg_NE
12303                    ("expect discrete type in instantiation of&",
12304                     Actual, Gen_T);
12305                  Abandon_Instantiation (Actual);
12306               end if;
12307
12308               Diagnose_Predicated_Actual;
12309
12310            when N_Formal_Signed_Integer_Type_Definition =>
12311               if not Is_Signed_Integer_Type (Act_T) then
12312                  Error_Msg_NE
12313                    ("expect signed integer type in instantiation of&",
12314                     Actual, Gen_T);
12315                  Abandon_Instantiation (Actual);
12316               end if;
12317
12318               Diagnose_Predicated_Actual;
12319
12320            when N_Formal_Modular_Type_Definition =>
12321               if not Is_Modular_Integer_Type (Act_T) then
12322                  Error_Msg_NE
12323                    ("expect modular type in instantiation of &",
12324                       Actual, Gen_T);
12325                  Abandon_Instantiation (Actual);
12326               end if;
12327
12328               Diagnose_Predicated_Actual;
12329
12330            when N_Formal_Floating_Point_Definition =>
12331               if not Is_Floating_Point_Type (Act_T) then
12332                  Error_Msg_NE
12333                    ("expect float type in instantiation of &", Actual, Gen_T);
12334                  Abandon_Instantiation (Actual);
12335               end if;
12336
12337            when N_Formal_Ordinary_Fixed_Point_Definition =>
12338               if not Is_Ordinary_Fixed_Point_Type (Act_T) then
12339                  Error_Msg_NE
12340                    ("expect ordinary fixed point type in instantiation of &",
12341                     Actual, Gen_T);
12342                  Abandon_Instantiation (Actual);
12343               end if;
12344
12345            when N_Formal_Decimal_Fixed_Point_Definition =>
12346               if not Is_Decimal_Fixed_Point_Type (Act_T) then
12347                  Error_Msg_NE
12348                    ("expect decimal type in instantiation of &",
12349                     Actual, Gen_T);
12350                  Abandon_Instantiation (Actual);
12351               end if;
12352
12353            when N_Array_Type_Definition =>
12354               Validate_Array_Type_Instance;
12355
12356            when N_Access_To_Object_Definition =>
12357               Validate_Access_Type_Instance;
12358
12359            when N_Access_Function_Definition |
12360                 N_Access_Procedure_Definition =>
12361               Validate_Access_Subprogram_Instance;
12362
12363            when N_Record_Definition           =>
12364               Validate_Interface_Type_Instance;
12365
12366            when N_Derived_Type_Definition     =>
12367               Validate_Derived_Interface_Type_Instance;
12368
12369            when others =>
12370               raise Program_Error;
12371
12372         end case;
12373      end if;
12374
12375      Subt := New_Copy (Gen_T);
12376
12377      --  Use adjusted sloc of subtype name as the location for other nodes in
12378      --  the subtype declaration.
12379
12380      Loc  := Sloc (Subt);
12381
12382      Decl_Node :=
12383        Make_Subtype_Declaration (Loc,
12384          Defining_Identifier => Subt,
12385          Subtype_Indication  => New_Occurrence_Of (Act_T, Loc));
12386
12387      if Is_Private_Type (Act_T) then
12388         Set_Has_Private_View (Subtype_Indication (Decl_Node));
12389
12390      elsif Is_Access_Type (Act_T)
12391        and then Is_Private_Type (Designated_Type (Act_T))
12392      then
12393         Set_Has_Private_View (Subtype_Indication (Decl_Node));
12394      end if;
12395
12396      --  In Ada 2012 the actual may be a limited view. Indicate that
12397      --  the local subtype must be treated as such.
12398
12399      if From_Limited_With (Act_T) then
12400         Set_Ekind (Subt, E_Incomplete_Subtype);
12401         Set_From_Limited_With (Subt);
12402      end if;
12403
12404      Decl_Nodes := New_List (Decl_Node);
12405
12406      --  Flag actual derived types so their elaboration produces the
12407      --  appropriate renamings for the primitive operations of the ancestor.
12408      --  Flag actual for formal private types as well, to determine whether
12409      --  operations in the private part may override inherited operations.
12410      --  If the formal has an interface list, the ancestor is not the
12411      --  parent, but the analyzed formal that includes the interface
12412      --  operations of all its progenitors.
12413
12414      --  Same treatment for formal private types, so we can check whether the
12415      --  type is tagged limited when validating derivations in the private
12416      --  part. (See AI05-096).
12417
12418      if Nkind (Def) = N_Formal_Derived_Type_Definition then
12419         if Present (Interface_List (Def)) then
12420            Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12421         else
12422            Set_Generic_Parent_Type (Decl_Node, Ancestor);
12423         end if;
12424
12425      elsif Nkind_In (Def, N_Formal_Private_Type_Definition,
12426                           N_Formal_Incomplete_Type_Definition)
12427      then
12428         Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12429      end if;
12430
12431      --  If the actual is a synchronized type that implements an interface,
12432      --  the primitive operations are attached to the corresponding record,
12433      --  and we have to treat it as an additional generic actual, so that its
12434      --  primitive operations become visible in the instance. The task or
12435      --  protected type itself does not carry primitive operations.
12436
12437      if Is_Concurrent_Type (Act_T)
12438        and then Is_Tagged_Type (Act_T)
12439        and then Present (Corresponding_Record_Type (Act_T))
12440        and then Present (Ancestor)
12441        and then Is_Interface (Ancestor)
12442      then
12443         declare
12444            Corr_Rec  : constant Entity_Id :=
12445                          Corresponding_Record_Type (Act_T);
12446            New_Corr  : Entity_Id;
12447            Corr_Decl : Node_Id;
12448
12449         begin
12450            New_Corr := Make_Temporary (Loc, 'S');
12451            Corr_Decl :=
12452              Make_Subtype_Declaration (Loc,
12453                Defining_Identifier => New_Corr,
12454                Subtype_Indication  =>
12455                  New_Occurrence_Of (Corr_Rec, Loc));
12456            Append_To (Decl_Nodes, Corr_Decl);
12457
12458            if Ekind (Act_T) = E_Task_Type then
12459               Set_Ekind (Subt, E_Task_Subtype);
12460            else
12461               Set_Ekind (Subt, E_Protected_Subtype);
12462            end if;
12463
12464            Set_Corresponding_Record_Type (Subt, Corr_Rec);
12465            Set_Generic_Parent_Type (Corr_Decl, Ancestor);
12466            Set_Generic_Parent_Type (Decl_Node, Empty);
12467         end;
12468      end if;
12469
12470      --  For a floating-point type, capture dimension info if any, because
12471      --  the generated subtype declaration does not come from source and
12472      --  will not process dimensions.
12473
12474      if Is_Floating_Point_Type (Act_T) then
12475         Copy_Dimensions (Act_T, Subt);
12476      end if;
12477
12478      return Decl_Nodes;
12479   end Instantiate_Type;
12480
12481   ---------------------
12482   -- Is_In_Main_Unit --
12483   ---------------------
12484
12485   function Is_In_Main_Unit (N : Node_Id) return Boolean is
12486      Unum         : constant Unit_Number_Type := Get_Source_Unit (N);
12487      Current_Unit : Node_Id;
12488
12489   begin
12490      if Unum = Main_Unit then
12491         return True;
12492
12493      --  If the current unit is a subunit then it is either the main unit or
12494      --  is being compiled as part of the main unit.
12495
12496      elsif Nkind (N) = N_Compilation_Unit then
12497         return Nkind (Unit (N)) = N_Subunit;
12498      end if;
12499
12500      Current_Unit := Parent (N);
12501      while Present (Current_Unit)
12502        and then Nkind (Current_Unit) /= N_Compilation_Unit
12503      loop
12504         Current_Unit := Parent (Current_Unit);
12505      end loop;
12506
12507      --  The instantiation node is in the main unit, or else the current node
12508      --  (perhaps as the result of nested instantiations) is in the main unit,
12509      --  or in the declaration of the main unit, which in this last case must
12510      --  be a body.
12511
12512      return Unum = Main_Unit
12513        or else Current_Unit = Cunit (Main_Unit)
12514        or else Current_Unit = Library_Unit (Cunit (Main_Unit))
12515        or else (Present (Library_Unit (Current_Unit))
12516                  and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
12517   end Is_In_Main_Unit;
12518
12519   ----------------------------
12520   -- Load_Parent_Of_Generic --
12521   ----------------------------
12522
12523   procedure Load_Parent_Of_Generic
12524     (N             : Node_Id;
12525      Spec          : Node_Id;
12526      Body_Optional : Boolean := False)
12527   is
12528      Comp_Unit          : constant Node_Id := Cunit (Get_Source_Unit (Spec));
12529      Saved_Style_Check  : constant Boolean := Style_Check;
12530      Saved_Warnings     : constant Warning_Record := Save_Warnings;
12531      True_Parent        : Node_Id;
12532      Inst_Node          : Node_Id;
12533      OK                 : Boolean;
12534      Previous_Instances : constant Elist_Id := New_Elmt_List;
12535
12536      procedure Collect_Previous_Instances (Decls : List_Id);
12537      --  Collect all instantiations in the given list of declarations, that
12538      --  precede the generic that we need to load. If the bodies of these
12539      --  instantiations are available, we must analyze them, to ensure that
12540      --  the public symbols generated are the same when the unit is compiled
12541      --  to generate code, and when it is compiled in the context of a unit
12542      --  that needs a particular nested instance. This process is applied to
12543      --  both package and subprogram instances.
12544
12545      --------------------------------
12546      -- Collect_Previous_Instances --
12547      --------------------------------
12548
12549      procedure Collect_Previous_Instances (Decls : List_Id) is
12550         Decl : Node_Id;
12551
12552      begin
12553         Decl := First (Decls);
12554         while Present (Decl) loop
12555            if Sloc (Decl) >= Sloc (Inst_Node) then
12556               return;
12557
12558            --  If Decl is an instantiation, then record it as requiring
12559            --  instantiation of the corresponding body, except if it is an
12560            --  abbreviated instantiation generated internally for conformance
12561            --  checking purposes only for the case of a formal package
12562            --  declared without a box (see Instantiate_Formal_Package). Such
12563            --  an instantiation does not generate any code (the actual code
12564            --  comes from actual) and thus does not need to be analyzed here.
12565            --  If the instantiation appears with a generic package body it is
12566            --  not analyzed here either.
12567
12568            elsif Nkind (Decl) = N_Package_Instantiation
12569              and then not Is_Internal (Defining_Entity (Decl))
12570            then
12571               Append_Elmt (Decl, Previous_Instances);
12572
12573            --  For a subprogram instantiation, omit instantiations intrinsic
12574            --  operations (Unchecked_Conversions, etc.) that have no bodies.
12575
12576            elsif Nkind_In (Decl, N_Function_Instantiation,
12577                                  N_Procedure_Instantiation)
12578              and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12579            then
12580               Append_Elmt (Decl, Previous_Instances);
12581
12582            elsif Nkind (Decl) = N_Package_Declaration then
12583               Collect_Previous_Instances
12584                 (Visible_Declarations (Specification (Decl)));
12585               Collect_Previous_Instances
12586                 (Private_Declarations (Specification (Decl)));
12587
12588            --  Previous non-generic bodies may contain instances as well
12589
12590            elsif Nkind (Decl) = N_Package_Body
12591              and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12592            then
12593               Collect_Previous_Instances (Declarations (Decl));
12594
12595            elsif Nkind (Decl) = N_Subprogram_Body
12596              and then not Acts_As_Spec (Decl)
12597              and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12598            then
12599               Collect_Previous_Instances (Declarations (Decl));
12600            end if;
12601
12602            Next (Decl);
12603         end loop;
12604      end Collect_Previous_Instances;
12605
12606   --  Start of processing for Load_Parent_Of_Generic
12607
12608   begin
12609      if not In_Same_Source_Unit (N, Spec)
12610        or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12611        or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12612                  and then not Is_In_Main_Unit (Spec))
12613      then
12614         --  Find body of parent of spec, and analyze it. A special case arises
12615         --  when the parent is an instantiation, that is to say when we are
12616         --  currently instantiating a nested generic. In that case, there is
12617         --  no separate file for the body of the enclosing instance. Instead,
12618         --  the enclosing body must be instantiated as if it were a pending
12619         --  instantiation, in order to produce the body for the nested generic
12620         --  we require now. Note that in that case the generic may be defined
12621         --  in a package body, the instance defined in the same package body,
12622         --  and the original enclosing body may not be in the main unit.
12623
12624         Inst_Node := Empty;
12625
12626         True_Parent := Parent (Spec);
12627         while Present (True_Parent)
12628           and then Nkind (True_Parent) /= N_Compilation_Unit
12629         loop
12630            if Nkind (True_Parent) = N_Package_Declaration
12631              and then
12632                Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12633            then
12634               --  Parent is a compilation unit that is an instantiation.
12635               --  Instantiation node has been replaced with package decl.
12636
12637               Inst_Node := Original_Node (True_Parent);
12638               exit;
12639
12640            elsif Nkind (True_Parent) = N_Package_Declaration
12641              and then Present (Generic_Parent (Specification (True_Parent)))
12642              and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12643            then
12644               --  Parent is an instantiation within another specification.
12645               --  Declaration for instance has been inserted before original
12646               --  instantiation node. A direct link would be preferable?
12647
12648               Inst_Node := Next (True_Parent);
12649               while Present (Inst_Node)
12650                 and then Nkind (Inst_Node) /= N_Package_Instantiation
12651               loop
12652                  Next (Inst_Node);
12653               end loop;
12654
12655               --  If the instance appears within a generic, and the generic
12656               --  unit is defined within a formal package of the enclosing
12657               --  generic, there is no generic body available, and none
12658               --  needed. A more precise test should be used ???
12659
12660               if No (Inst_Node) then
12661                  return;
12662               end if;
12663
12664               exit;
12665
12666            else
12667               True_Parent := Parent (True_Parent);
12668            end if;
12669         end loop;
12670
12671         --  Case where we are currently instantiating a nested generic
12672
12673         if Present (Inst_Node) then
12674            if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12675
12676               --  Instantiation node and declaration of instantiated package
12677               --  were exchanged when only the declaration was needed.
12678               --  Restore instantiation node before proceeding with body.
12679
12680               Set_Unit (Parent (True_Parent), Inst_Node);
12681            end if;
12682
12683            --  Now complete instantiation of enclosing body, if it appears in
12684            --  some other unit. If it appears in the current unit, the body
12685            --  will have been instantiated already.
12686
12687            if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12688
12689               --  We need to determine the expander mode to instantiate the
12690               --  enclosing body. Because the generic body we need may use
12691               --  global entities declared in the enclosing package (including
12692               --  aggregates) it is in general necessary to compile this body
12693               --  with expansion enabled, except if we are within a generic
12694               --  package, in which case the usual generic rule applies.
12695
12696               declare
12697                  Exp_Status         : Boolean := True;
12698                  Scop               : Entity_Id;
12699
12700               begin
12701                  --  Loop through scopes looking for generic package
12702
12703                  Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12704                  while Present (Scop)
12705                    and then Scop /= Standard_Standard
12706                  loop
12707                     if Ekind (Scop) = E_Generic_Package then
12708                        Exp_Status := False;
12709                        exit;
12710                     end if;
12711
12712                     Scop := Scope (Scop);
12713                  end loop;
12714
12715                  --  Collect previous instantiations in the unit that contains
12716                  --  the desired generic.
12717
12718                  if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12719                    and then not Body_Optional
12720                  then
12721                     declare
12722                        Decl : Elmt_Id;
12723                        Info : Pending_Body_Info;
12724                        Par  : Node_Id;
12725
12726                     begin
12727                        Par := Parent (Inst_Node);
12728                        while Present (Par) loop
12729                           exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12730                           Par := Parent (Par);
12731                        end loop;
12732
12733                        pragma Assert (Present (Par));
12734
12735                        if Nkind (Par) = N_Package_Body then
12736                           Collect_Previous_Instances (Declarations (Par));
12737
12738                        elsif Nkind (Par) = N_Package_Declaration then
12739                           Collect_Previous_Instances
12740                             (Visible_Declarations (Specification (Par)));
12741                           Collect_Previous_Instances
12742                             (Private_Declarations (Specification (Par)));
12743
12744                        else
12745                           --  Enclosing unit is a subprogram body. In this
12746                           --  case all instance bodies are processed in order
12747                           --  and there is no need to collect them separately.
12748
12749                           null;
12750                        end if;
12751
12752                        Decl := First_Elmt (Previous_Instances);
12753                        while Present (Decl) loop
12754                           Info :=
12755                             (Inst_Node                => Node (Decl),
12756                              Act_Decl                 =>
12757                                Instance_Spec (Node (Decl)),
12758                              Expander_Status          => Exp_Status,
12759                              Current_Sem_Unit         =>
12760                                Get_Code_Unit (Sloc (Node (Decl))),
12761                              Scope_Suppress           => Scope_Suppress,
12762                              Local_Suppress_Stack_Top =>
12763                                Local_Suppress_Stack_Top,
12764                              Version                  => Ada_Version,
12765                              Version_Pragma           => Ada_Version_Pragma,
12766                              Warnings                 => Save_Warnings,
12767                              SPARK_Mode               => SPARK_Mode,
12768                              SPARK_Mode_Pragma        => SPARK_Mode_Pragma);
12769
12770                           --  Package instance
12771
12772                           if
12773                             Nkind (Node (Decl)) = N_Package_Instantiation
12774                           then
12775                              Instantiate_Package_Body
12776                                (Info, Body_Optional => True);
12777
12778                           --  Subprogram instance
12779
12780                           else
12781                              --  The instance_spec is in the wrapper package,
12782                              --  usually followed by its local renaming
12783                              --  declaration. See Build_Subprogram_Renaming
12784                              --  for details.
12785
12786                              declare
12787                                 Decl : Node_Id :=
12788                                          (Last (Visible_Declarations
12789                                            (Specification (Info.Act_Decl))));
12790                              begin
12791                                 if Nkind (Decl) =
12792                                      N_Subprogram_Renaming_Declaration
12793                                 then
12794                                    Decl := Prev (Decl);
12795                                 end if;
12796
12797                                 Info.Act_Decl := Decl;
12798                              end;
12799
12800                              Instantiate_Subprogram_Body
12801                                (Info, Body_Optional => True);
12802                           end if;
12803
12804                           Next_Elmt (Decl);
12805                        end loop;
12806                     end;
12807                  end if;
12808
12809                  Instantiate_Package_Body
12810                    (Body_Info =>
12811                       ((Inst_Node                => Inst_Node,
12812                         Act_Decl                 => True_Parent,
12813                         Expander_Status          => Exp_Status,
12814                         Current_Sem_Unit         => Get_Code_Unit
12815                                                       (Sloc (Inst_Node)),
12816                         Scope_Suppress           => Scope_Suppress,
12817                         Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12818                         Version                  => Ada_Version,
12819                         Version_Pragma           => Ada_Version_Pragma,
12820                         Warnings                 => Save_Warnings,
12821                         SPARK_Mode               => SPARK_Mode,
12822                         SPARK_Mode_Pragma        => SPARK_Mode_Pragma)),
12823                     Body_Optional => Body_Optional);
12824               end;
12825            end if;
12826
12827         --  Case where we are not instantiating a nested generic
12828
12829         else
12830            Opt.Style_Check := False;
12831            Expander_Mode_Save_And_Set (True);
12832            Load_Needed_Body (Comp_Unit, OK);
12833            Opt.Style_Check := Saved_Style_Check;
12834            Restore_Warnings (Saved_Warnings);
12835            Expander_Mode_Restore;
12836
12837            if not OK
12838              and then Unit_Requires_Body (Defining_Entity (Spec))
12839              and then not Body_Optional
12840            then
12841               declare
12842                  Bname : constant Unit_Name_Type :=
12843                            Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12844
12845               begin
12846                  --  In CodePeer mode, the missing body may make the analysis
12847                  --  incomplete, but we do not treat it as fatal.
12848
12849                  if CodePeer_Mode then
12850                     return;
12851
12852                  else
12853                     Error_Msg_Unit_1 := Bname;
12854                     Error_Msg_N ("this instantiation requires$!", N);
12855                     Error_Msg_File_1 :=
12856                       Get_File_Name (Bname, Subunit => False);
12857                     Error_Msg_N ("\but file{ was not found!", N);
12858                     raise Unrecoverable_Error;
12859                  end if;
12860               end;
12861            end if;
12862         end if;
12863      end if;
12864
12865      --  If loading parent of the generic caused an instantiation circularity,
12866      --  we abandon compilation at this point, because otherwise in some cases
12867      --  we get into trouble with infinite recursions after this point.
12868
12869      if Circularity_Detected then
12870         raise Unrecoverable_Error;
12871      end if;
12872   end Load_Parent_Of_Generic;
12873
12874   ---------------------------------
12875   -- Map_Formal_Package_Entities --
12876   ---------------------------------
12877
12878   procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12879      E1 : Entity_Id;
12880      E2 : Entity_Id;
12881
12882   begin
12883      Set_Instance_Of (Form, Act);
12884
12885      --  Traverse formal and actual package to map the corresponding entities.
12886      --  We skip over internal entities that may be generated during semantic
12887      --  analysis, and find the matching entities by name, given that they
12888      --  must appear in the same order.
12889
12890      E1 := First_Entity (Form);
12891      E2 := First_Entity (Act);
12892      while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12893         --  Could this test be a single condition??? Seems like it could, and
12894         --  isn't FPE (Form) a constant anyway???
12895
12896         if not Is_Internal (E1)
12897           and then Present (Parent (E1))
12898           and then not Is_Class_Wide_Type (E1)
12899           and then not Is_Internal_Name (Chars (E1))
12900         then
12901            while Present (E2) and then Chars (E2) /= Chars (E1) loop
12902               Next_Entity (E2);
12903            end loop;
12904
12905            if No (E2) then
12906               exit;
12907            else
12908               Set_Instance_Of (E1, E2);
12909
12910               if Is_Type (E1) and then Is_Tagged_Type (E2) then
12911                  Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12912               end if;
12913
12914               if Is_Constrained (E1) then
12915                  Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12916               end if;
12917
12918               if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12919                  Map_Formal_Package_Entities (E1, E2);
12920               end if;
12921            end if;
12922         end if;
12923
12924         Next_Entity (E1);
12925      end loop;
12926   end Map_Formal_Package_Entities;
12927
12928   -----------------------
12929   -- Move_Freeze_Nodes --
12930   -----------------------
12931
12932   procedure Move_Freeze_Nodes
12933     (Out_Of : Entity_Id;
12934      After  : Node_Id;
12935      L      : List_Id)
12936   is
12937      Decl      : Node_Id;
12938      Next_Decl : Node_Id;
12939      Next_Node : Node_Id := After;
12940      Spec      : Node_Id;
12941
12942      function Is_Outer_Type (T : Entity_Id) return Boolean;
12943      --  Check whether entity is declared in a scope external to that of the
12944      --  generic unit.
12945
12946      -------------------
12947      -- Is_Outer_Type --
12948      -------------------
12949
12950      function Is_Outer_Type (T : Entity_Id) return Boolean is
12951         Scop : Entity_Id := Scope (T);
12952
12953      begin
12954         if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12955            return True;
12956
12957         else
12958            while Scop /= Standard_Standard loop
12959               if Scop = Out_Of then
12960                  return False;
12961               else
12962                  Scop := Scope (Scop);
12963               end if;
12964            end loop;
12965
12966            return True;
12967         end if;
12968      end Is_Outer_Type;
12969
12970   --  Start of processing for Move_Freeze_Nodes
12971
12972   begin
12973      if No (L) then
12974         return;
12975      end if;
12976
12977      --  First remove the freeze nodes that may appear before all other
12978      --  declarations.
12979
12980      Decl := First (L);
12981      while Present (Decl)
12982        and then Nkind (Decl) = N_Freeze_Entity
12983        and then Is_Outer_Type (Entity (Decl))
12984      loop
12985         Decl := Remove_Head (L);
12986         Insert_After (Next_Node, Decl);
12987         Set_Analyzed (Decl, False);
12988         Next_Node := Decl;
12989         Decl := First (L);
12990      end loop;
12991
12992      --  Next scan the list of declarations and remove each freeze node that
12993      --  appears ahead of the current node.
12994
12995      while Present (Decl) loop
12996         while Present (Next (Decl))
12997           and then Nkind (Next (Decl)) = N_Freeze_Entity
12998           and then Is_Outer_Type (Entity (Next (Decl)))
12999         loop
13000            Next_Decl := Remove_Next (Decl);
13001            Insert_After (Next_Node, Next_Decl);
13002            Set_Analyzed (Next_Decl, False);
13003            Next_Node := Next_Decl;
13004         end loop;
13005
13006         --  If the declaration is a nested package or concurrent type, then
13007         --  recurse. Nested generic packages will have been processed from the
13008         --  inside out.
13009
13010         case Nkind (Decl) is
13011            when N_Package_Declaration =>
13012               Spec := Specification (Decl);
13013
13014            when N_Task_Type_Declaration =>
13015               Spec := Task_Definition (Decl);
13016
13017            when N_Protected_Type_Declaration =>
13018               Spec := Protected_Definition (Decl);
13019
13020            when others =>
13021               Spec := Empty;
13022         end case;
13023
13024         if Present (Spec) then
13025            Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
13026            Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
13027         end if;
13028
13029         Next (Decl);
13030      end loop;
13031   end Move_Freeze_Nodes;
13032
13033   ----------------
13034   -- Next_Assoc --
13035   ----------------
13036
13037   function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
13038   begin
13039      return Generic_Renamings.Table (E).Next_In_HTable;
13040   end Next_Assoc;
13041
13042   ------------------------
13043   -- Preanalyze_Actuals --
13044   ------------------------
13045
13046   procedure Preanalyze_Actuals (N : Node_Id) is
13047      Assoc : Node_Id;
13048      Act   : Node_Id;
13049      Errs  : constant Int := Serious_Errors_Detected;
13050
13051      Cur : Entity_Id := Empty;
13052      --  Current homograph of the instance name
13053
13054      Vis : Boolean;
13055      --  Saved visibility status of the current homograph
13056
13057   begin
13058      Assoc := First (Generic_Associations (N));
13059
13060      --  If the instance is a child unit, its name may hide an outer homonym,
13061      --  so make it invisible to perform name resolution on the actuals.
13062
13063      if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
13064        and then Present
13065          (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
13066      then
13067         Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
13068
13069         if Is_Compilation_Unit (Cur) then
13070            Vis := Is_Immediately_Visible (Cur);
13071            Set_Is_Immediately_Visible (Cur, False);
13072         else
13073            Cur := Empty;
13074         end if;
13075      end if;
13076
13077      while Present (Assoc) loop
13078         if Nkind (Assoc) /= N_Others_Choice then
13079            Act := Explicit_Generic_Actual_Parameter (Assoc);
13080
13081            --  Within a nested instantiation, a defaulted actual is an empty
13082            --  association, so nothing to analyze. If the subprogram actual
13083            --  is an attribute, analyze prefix only, because actual is not a
13084            --  complete attribute reference.
13085
13086            --  If actual is an allocator, analyze expression only. The full
13087            --  analysis can generate code, and if instance is a compilation
13088            --  unit we have to wait until the package instance is installed
13089            --  to have a proper place to insert this code.
13090
13091            --  String literals may be operators, but at this point we do not
13092            --  know whether the actual is a formal subprogram or a string.
13093
13094            if No (Act) then
13095               null;
13096
13097            elsif Nkind (Act) = N_Attribute_Reference then
13098               Analyze (Prefix (Act));
13099
13100            elsif Nkind (Act) = N_Explicit_Dereference then
13101               Analyze (Prefix (Act));
13102
13103            elsif Nkind (Act) = N_Allocator then
13104               declare
13105                  Expr : constant Node_Id := Expression (Act);
13106
13107               begin
13108                  if Nkind (Expr) = N_Subtype_Indication then
13109                     Analyze (Subtype_Mark (Expr));
13110
13111                     --  Analyze separately each discriminant constraint, when
13112                     --  given with a named association.
13113
13114                     declare
13115                        Constr : Node_Id;
13116
13117                     begin
13118                        Constr := First (Constraints (Constraint (Expr)));
13119                        while Present (Constr) loop
13120                           if Nkind (Constr) = N_Discriminant_Association then
13121                              Analyze (Expression (Constr));
13122                           else
13123                              Analyze (Constr);
13124                           end if;
13125
13126                           Next (Constr);
13127                        end loop;
13128                     end;
13129
13130                  else
13131                     Analyze (Expr);
13132                  end if;
13133               end;
13134
13135            elsif Nkind (Act) /= N_Operator_Symbol then
13136               Analyze (Act);
13137            end if;
13138
13139            if Errs /= Serious_Errors_Detected then
13140
13141               --  Do a minimal analysis of the generic, to prevent spurious
13142               --  warnings complaining about the generic being unreferenced,
13143               --  before abandoning the instantiation.
13144
13145               Analyze (Name (N));
13146
13147               if Is_Entity_Name (Name (N))
13148                 and then Etype (Name (N)) /= Any_Type
13149               then
13150                  Generate_Reference  (Entity (Name (N)), Name (N));
13151                  Set_Is_Instantiated (Entity (Name (N)));
13152               end if;
13153
13154               if Present (Cur) then
13155
13156                  --  For the case of a child instance hiding an outer homonym,
13157                  --  provide additional warning which might explain the error.
13158
13159                  Set_Is_Immediately_Visible (Cur, Vis);
13160                  Error_Msg_NE
13161                    ("& hides outer unit with the same name??",
13162                     N, Defining_Unit_Name (N));
13163               end if;
13164
13165               Abandon_Instantiation (Act);
13166            end if;
13167         end if;
13168
13169         Next (Assoc);
13170      end loop;
13171
13172      if Present (Cur) then
13173         Set_Is_Immediately_Visible (Cur, Vis);
13174      end if;
13175   end Preanalyze_Actuals;
13176
13177   -------------------
13178   -- Remove_Parent --
13179   -------------------
13180
13181   procedure Remove_Parent (In_Body : Boolean := False) is
13182      S : Entity_Id := Current_Scope;
13183      --  S is the scope containing the instantiation just completed. The scope
13184      --  stack contains the parent instances of the instantiation, followed by
13185      --  the original S.
13186
13187      Cur_P  : Entity_Id;
13188      E      : Entity_Id;
13189      P      : Entity_Id;
13190      Hidden : Elmt_Id;
13191
13192   begin
13193      --  After child instantiation is complete, remove from scope stack the
13194      --  extra copy of the current scope, and then remove parent instances.
13195
13196      if not In_Body then
13197         Pop_Scope;
13198
13199         while Current_Scope /= S loop
13200            P := Current_Scope;
13201            End_Package_Scope (Current_Scope);
13202
13203            if In_Open_Scopes (P) then
13204               E := First_Entity (P);
13205               while Present (E) loop
13206                  Set_Is_Immediately_Visible (E, True);
13207                  Next_Entity (E);
13208               end loop;
13209
13210               --  If instantiation is declared in a block, it is the enclosing
13211               --  scope that might be a parent instance. Note that only one
13212               --  block can be involved, because the parent instances have
13213               --  been installed within it.
13214
13215               if Ekind (P) = E_Block then
13216                  Cur_P := Scope (P);
13217               else
13218                  Cur_P := P;
13219               end if;
13220
13221               if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
13222                  --  We are within an instance of some sibling. Retain
13223                  --  visibility of parent, for proper subsequent cleanup, and
13224                  --  reinstall private declarations as well.
13225
13226                  Set_In_Private_Part (P);
13227                  Install_Private_Declarations (P);
13228               end if;
13229
13230            --  If the ultimate parent is a top-level unit recorded in
13231            --  Instance_Parent_Unit, then reset its visibility to what it was
13232            --  before instantiation. (It's not clear what the purpose is of
13233            --  testing whether Scope (P) is In_Open_Scopes, but that test was
13234            --  present before the ultimate parent test was added.???)
13235
13236            elsif not In_Open_Scopes (Scope (P))
13237              or else (P = Instance_Parent_Unit
13238                        and then not Parent_Unit_Visible)
13239            then
13240               Set_Is_Immediately_Visible (P, False);
13241
13242            --  If the current scope is itself an instantiation of a generic
13243            --  nested within P, and we are in the private part of body of this
13244            --  instantiation, restore the full views of P, that were removed
13245            --  in End_Package_Scope above. This obscure case can occur when a
13246            --  subunit of a generic contains an instance of a child unit of
13247            --  its generic parent unit.
13248
13249            elsif S = Current_Scope and then Is_Generic_Instance (S) then
13250               declare
13251                  Par : constant Entity_Id :=
13252                          Generic_Parent (Package_Specification (S));
13253               begin
13254                  if Present (Par)
13255                    and then P = Scope (Par)
13256                    and then (In_Package_Body (S) or else In_Private_Part (S))
13257                  then
13258                     Set_In_Private_Part (P);
13259                     Install_Private_Declarations (P);
13260                  end if;
13261               end;
13262            end if;
13263         end loop;
13264
13265         --  Reset visibility of entities in the enclosing scope
13266
13267         Set_Is_Hidden_Open_Scope (Current_Scope, False);
13268
13269         Hidden := First_Elmt (Hidden_Entities);
13270         while Present (Hidden) loop
13271            Set_Is_Immediately_Visible (Node (Hidden), True);
13272            Next_Elmt (Hidden);
13273         end loop;
13274
13275      else
13276         --  Each body is analyzed separately, and there is no context that
13277         --  needs preserving from one body instance to the next, so remove all
13278         --  parent scopes that have been installed.
13279
13280         while Present (S) loop
13281            End_Package_Scope (S);
13282            Set_Is_Immediately_Visible (S, False);
13283            S := Current_Scope;
13284            exit when S = Standard_Standard;
13285         end loop;
13286      end if;
13287   end Remove_Parent;
13288
13289   -----------------
13290   -- Restore_Env --
13291   -----------------
13292
13293   procedure Restore_Env is
13294      Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
13295
13296   begin
13297      if No (Current_Instantiated_Parent.Act_Id) then
13298         --  Restore environment after subprogram inlining
13299
13300         Restore_Private_Views (Empty);
13301      end if;
13302
13303      Current_Instantiated_Parent := Saved.Instantiated_Parent;
13304      Exchanged_Views             := Saved.Exchanged_Views;
13305      Hidden_Entities             := Saved.Hidden_Entities;
13306      Current_Sem_Unit            := Saved.Current_Sem_Unit;
13307      Parent_Unit_Visible         := Saved.Parent_Unit_Visible;
13308      Instance_Parent_Unit        := Saved.Instance_Parent_Unit;
13309
13310      Restore_Opt_Config_Switches (Saved.Switches);
13311
13312      Instance_Envs.Decrement_Last;
13313   end Restore_Env;
13314
13315   ---------------------------
13316   -- Restore_Private_Views --
13317   ---------------------------
13318
13319   procedure Restore_Private_Views
13320     (Pack_Id    : Entity_Id;
13321      Is_Package : Boolean := True)
13322   is
13323      M        : Elmt_Id;
13324      E        : Entity_Id;
13325      Typ      : Entity_Id;
13326      Dep_Elmt : Elmt_Id;
13327      Dep_Typ  : Node_Id;
13328
13329      procedure Restore_Nested_Formal (Formal : Entity_Id);
13330      --  Hide the generic formals of formal packages declared with box which
13331      --  were reachable in the current instantiation.
13332
13333      ---------------------------
13334      -- Restore_Nested_Formal --
13335      ---------------------------
13336
13337      procedure Restore_Nested_Formal (Formal : Entity_Id) is
13338         Ent : Entity_Id;
13339
13340      begin
13341         if Present (Renamed_Object (Formal))
13342           and then Denotes_Formal_Package (Renamed_Object (Formal), True)
13343         then
13344            return;
13345
13346         elsif Present (Associated_Formal_Package (Formal)) then
13347            Ent := First_Entity (Formal);
13348            while Present (Ent) loop
13349               exit when Ekind (Ent) = E_Package
13350                 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
13351
13352               Set_Is_Hidden (Ent);
13353               Set_Is_Potentially_Use_Visible (Ent, False);
13354
13355               --  If package, then recurse
13356
13357               if Ekind (Ent) = E_Package then
13358                  Restore_Nested_Formal (Ent);
13359               end if;
13360
13361               Next_Entity (Ent);
13362            end loop;
13363         end if;
13364      end Restore_Nested_Formal;
13365
13366   --  Start of processing for Restore_Private_Views
13367
13368   begin
13369      M := First_Elmt (Exchanged_Views);
13370      while Present (M) loop
13371         Typ := Node (M);
13372
13373         --  Subtypes of types whose views have been exchanged, and that are
13374         --  defined within the instance, were not on the Private_Dependents
13375         --  list on entry to the instance, so they have to be exchanged
13376         --  explicitly now, in order to remain consistent with the view of the
13377         --  parent type.
13378
13379         if Ekind_In (Typ, E_Private_Type,
13380                           E_Limited_Private_Type,
13381                           E_Record_Type_With_Private)
13382         then
13383            Dep_Elmt := First_Elmt (Private_Dependents (Typ));
13384            while Present (Dep_Elmt) loop
13385               Dep_Typ := Node (Dep_Elmt);
13386
13387               if Scope (Dep_Typ) = Pack_Id
13388                 and then Present (Full_View (Dep_Typ))
13389               then
13390                  Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
13391                  Exchange_Declarations (Dep_Typ);
13392               end if;
13393
13394               Next_Elmt (Dep_Elmt);
13395            end loop;
13396         end if;
13397
13398         Exchange_Declarations (Node (M));
13399         Next_Elmt (M);
13400      end loop;
13401
13402      if No (Pack_Id) then
13403         return;
13404      end if;
13405
13406      --  Make the generic formal parameters private, and make the formal types
13407      --  into subtypes of the actuals again.
13408
13409      E := First_Entity (Pack_Id);
13410      while Present (E) loop
13411         Set_Is_Hidden (E, True);
13412
13413         if Is_Type (E)
13414           and then Nkind (Parent (E)) = N_Subtype_Declaration
13415         then
13416            --  If the actual for E is itself a generic actual type from
13417            --  an enclosing instance, E is still a generic actual type
13418            --  outside of the current instance. This matter when resolving
13419            --  an overloaded call that may be ambiguous in the enclosing
13420            --  instance, when two of its actuals coincide.
13421
13422            if Is_Entity_Name (Subtype_Indication (Parent (E)))
13423              and then Is_Generic_Actual_Type
13424                         (Entity (Subtype_Indication (Parent (E))))
13425            then
13426               null;
13427            else
13428               Set_Is_Generic_Actual_Type (E, False);
13429            end if;
13430
13431            --  An unusual case of aliasing: the actual may also be directly
13432            --  visible in the generic, and be private there, while it is fully
13433            --  visible in the context of the instance. The internal subtype
13434            --  is private in the instance but has full visibility like its
13435            --  parent in the enclosing scope. This enforces the invariant that
13436            --  the privacy status of all private dependents of a type coincide
13437            --  with that of the parent type. This can only happen when a
13438            --  generic child unit is instantiated within a sibling.
13439
13440            if Is_Private_Type (E)
13441              and then not Is_Private_Type (Etype (E))
13442            then
13443               Exchange_Declarations (E);
13444            end if;
13445
13446         elsif Ekind (E) = E_Package then
13447
13448            --  The end of the renaming list is the renaming of the generic
13449            --  package itself. If the instance is a subprogram, all entities
13450            --  in the corresponding package are renamings. If this entity is
13451            --  a formal package, make its own formals private as well. The
13452            --  actual in this case is itself the renaming of an instantiation.
13453            --  If the entity is not a package renaming, it is the entity
13454            --  created to validate formal package actuals: ignore it.
13455
13456            --  If the actual is itself a formal package for the enclosing
13457            --  generic, or the actual for such a formal package, it remains
13458            --  visible on exit from the instance, and therefore nothing needs
13459            --  to be done either, except to keep it accessible.
13460
13461            if Is_Package and then Renamed_Object (E) = Pack_Id then
13462               exit;
13463
13464            elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
13465               null;
13466
13467            elsif
13468              Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
13469            then
13470               Set_Is_Hidden (E, False);
13471
13472            else
13473               declare
13474                  Act_P : constant Entity_Id := Renamed_Object (E);
13475                  Id    : Entity_Id;
13476
13477               begin
13478                  Id := First_Entity (Act_P);
13479                  while Present (Id)
13480                    and then Id /= First_Private_Entity (Act_P)
13481                  loop
13482                     exit when Ekind (Id) = E_Package
13483                                 and then Renamed_Object (Id) = Act_P;
13484
13485                     Set_Is_Hidden (Id, True);
13486                     Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
13487
13488                     if Ekind (Id) = E_Package then
13489                        Restore_Nested_Formal (Id);
13490                     end if;
13491
13492                     Next_Entity (Id);
13493                  end loop;
13494               end;
13495            end if;
13496         end if;
13497
13498         Next_Entity (E);
13499      end loop;
13500   end Restore_Private_Views;
13501
13502   --------------
13503   -- Save_Env --
13504   --------------
13505
13506   procedure Save_Env
13507     (Gen_Unit : Entity_Id;
13508      Act_Unit : Entity_Id)
13509   is
13510   begin
13511      Init_Env;
13512      Set_Instance_Env (Gen_Unit, Act_Unit);
13513   end Save_Env;
13514
13515   ----------------------------
13516   -- Save_Global_References --
13517   ----------------------------
13518
13519   procedure Save_Global_References (N : Node_Id) is
13520      Gen_Scope : Entity_Id;
13521      E         : Entity_Id;
13522      N2        : Node_Id;
13523
13524      function Is_Global (E : Entity_Id) return Boolean;
13525      --  Check whether entity is defined outside of generic unit. Examine the
13526      --  scope of an entity, and the scope of the scope, etc, until we find
13527      --  either Standard, in which case the entity is global, or the generic
13528      --  unit itself, which indicates that the entity is local. If the entity
13529      --  is the generic unit itself, as in the case of a recursive call, or
13530      --  the enclosing generic unit, if different from the current scope, then
13531      --  it is local as well, because it will be replaced at the point of
13532      --  instantiation. On the other hand, if it is a reference to a child
13533      --  unit of a common ancestor, which appears in an instantiation, it is
13534      --  global because it is used to denote a specific compilation unit at
13535      --  the time the instantiations will be analyzed.
13536
13537      procedure Reset_Entity (N : Node_Id);
13538      --  Save semantic information on global entity so that it is not resolved
13539      --  again at instantiation time.
13540
13541      procedure Save_Entity_Descendants (N : Node_Id);
13542      --  Apply Save_Global_References to the two syntactic descendants of
13543      --  non-terminal nodes that carry an Associated_Node and are processed
13544      --  through Reset_Entity. Once the global entity (if any) has been
13545      --  captured together with its type, only two syntactic descendants need
13546      --  to be traversed to complete the processing of the tree rooted at N.
13547      --  This applies to Selected_Components, Expanded_Names, and to Operator
13548      --  nodes. N can also be a character literal, identifier, or operator
13549      --  symbol node, but the call has no effect in these cases.
13550
13551      procedure Save_Global_Defaults (N1, N2 : Node_Id);
13552      --  Default actuals in nested instances must be handled specially
13553      --  because there is no link to them from the original tree. When an
13554      --  actual subprogram is given by a default, we add an explicit generic
13555      --  association for it in the instantiation node. When we save the
13556      --  global references on the name of the instance, we recover the list
13557      --  of generic associations, and add an explicit one to the original
13558      --  generic tree, through which a global actual can be preserved.
13559      --  Similarly, if a child unit is instantiated within a sibling, in the
13560      --  context of the parent, we must preserve the identifier of the parent
13561      --  so that it can be properly resolved in a subsequent instantiation.
13562
13563      procedure Save_Global_Descendant (D : Union_Id);
13564      --  Apply Save_Global_References recursively to the descendents of the
13565      --  current node.
13566
13567      procedure Save_References (N : Node_Id);
13568      --  This is the recursive procedure that does the work, once the
13569      --  enclosing generic scope has been established.
13570
13571      ---------------
13572      -- Is_Global --
13573      ---------------
13574
13575      function Is_Global (E : Entity_Id) return Boolean is
13576         Se : Entity_Id;
13577
13578         function Is_Instance_Node (Decl : Node_Id) return Boolean;
13579         --  Determine whether the parent node of a reference to a child unit
13580         --  denotes an instantiation or a formal package, in which case the
13581         --  reference to the child unit is global, even if it appears within
13582         --  the current scope (e.g. when the instance appears within the body
13583         --  of an ancestor).
13584
13585         ----------------------
13586         -- Is_Instance_Node --
13587         ----------------------
13588
13589         function Is_Instance_Node (Decl : Node_Id) return Boolean is
13590         begin
13591            return Nkind (Decl) in N_Generic_Instantiation
13592                     or else
13593                   Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13594         end Is_Instance_Node;
13595
13596      --  Start of processing for Is_Global
13597
13598      begin
13599         if E = Gen_Scope then
13600            return False;
13601
13602         elsif E = Standard_Standard then
13603            return True;
13604
13605         elsif Is_Child_Unit (E)
13606           and then (Is_Instance_Node (Parent (N2))
13607                      or else (Nkind (Parent (N2)) = N_Expanded_Name
13608                                and then N2 = Selector_Name (Parent (N2))
13609                                and then
13610                                  Is_Instance_Node (Parent (Parent (N2)))))
13611         then
13612            return True;
13613
13614         else
13615            Se := Scope (E);
13616            while Se /= Gen_Scope loop
13617               if Se = Standard_Standard then
13618                  return True;
13619               else
13620                  Se := Scope (Se);
13621               end if;
13622            end loop;
13623
13624            return False;
13625         end if;
13626      end Is_Global;
13627
13628      ------------------
13629      -- Reset_Entity --
13630      ------------------
13631
13632      procedure Reset_Entity (N : Node_Id) is
13633
13634         procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13635         --  If the type of N2 is global to the generic unit, save the type in
13636         --  the generic node. Just as we perform name capture for explicit
13637         --  references within the generic, we must capture the global types
13638         --  of local entities because they may participate in resolution in
13639         --  the instance.
13640
13641         function Top_Ancestor (E : Entity_Id) return Entity_Id;
13642         --  Find the ultimate ancestor of the current unit. If it is not a
13643         --  generic unit, then the name of the current unit in the prefix of
13644         --  an expanded name must be replaced with its generic homonym to
13645         --  ensure that it will be properly resolved in an instance.
13646
13647         ---------------------
13648         -- Set_Global_Type --
13649         ---------------------
13650
13651         procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13652            Typ : constant Entity_Id := Etype (N2);
13653
13654         begin
13655            Set_Etype (N, Typ);
13656
13657            if Entity (N) /= N2
13658              and then Has_Private_View (Entity (N))
13659            then
13660               --  If the entity of N is not the associated node, this is a
13661               --  nested generic and it has an associated node as well, whose
13662               --  type is already the full view (see below). Indicate that the
13663               --  original node has a private view.
13664
13665               Set_Has_Private_View (N);
13666            end if;
13667
13668            --  If not a private type, nothing else to do
13669
13670            if not Is_Private_Type (Typ) then
13671               if Is_Array_Type (Typ)
13672                 and then Is_Private_Type (Component_Type (Typ))
13673               then
13674                  Set_Has_Private_View (N);
13675               end if;
13676
13677            --  If it is a derivation of a private type in a context where no
13678            --  full view is needed, nothing to do either.
13679
13680            elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13681               null;
13682
13683            --  Otherwise mark the type for flipping and use the full view when
13684            --  available.
13685
13686            else
13687               Set_Has_Private_View (N);
13688
13689               if Present (Full_View (Typ)) then
13690                  Set_Etype (N2, Full_View (Typ));
13691               end if;
13692            end if;
13693         end Set_Global_Type;
13694
13695         ------------------
13696         -- Top_Ancestor --
13697         ------------------
13698
13699         function Top_Ancestor (E : Entity_Id) return Entity_Id is
13700            Par : Entity_Id;
13701
13702         begin
13703            Par := E;
13704            while Is_Child_Unit (Par) loop
13705               Par := Scope (Par);
13706            end loop;
13707
13708            return Par;
13709         end Top_Ancestor;
13710
13711      --  Start of processing for Reset_Entity
13712
13713      begin
13714         N2 := Get_Associated_Node (N);
13715         E := Entity (N2);
13716
13717         if Present (E) then
13718
13719            --  If the node is an entry call to an entry in an enclosing task,
13720            --  it is rewritten as a selected component. No global entity to
13721            --  preserve in this case, since the expansion will be redone in
13722            --  the instance.
13723
13724            if not Nkind_In (E, N_Defining_Identifier,
13725                                N_Defining_Character_Literal,
13726                                N_Defining_Operator_Symbol)
13727            then
13728               Set_Associated_Node (N, Empty);
13729               Set_Etype  (N, Empty);
13730               return;
13731            end if;
13732
13733            --  If the entity is an itype created as a subtype of an access
13734            --  type with a null exclusion restore source entity for proper
13735            --  visibility. The itype will be created anew in the instance.
13736
13737            if Is_Itype (E)
13738              and then Ekind (E) = E_Access_Subtype
13739              and then Is_Entity_Name (N)
13740              and then Chars (Etype (E)) = Chars (N)
13741            then
13742               E := Etype (E);
13743               Set_Entity (N2, E);
13744               Set_Etype  (N2, E);
13745            end if;
13746
13747            if Is_Global (E) then
13748
13749               --  If the entity is a package renaming that is the prefix of
13750               --  an expanded name, it has been rewritten as the renamed
13751               --  package, which is necessary semantically but complicates
13752               --  ASIS tree traversal, so we recover the original entity to
13753               --  expose the renaming. Take into account that the context may
13754               --  be a nested generic, that the original node may itself have
13755               --  an associated node that had better be an entity, and that
13756               --  the current node is still a selected component.
13757
13758               if Ekind (E) = E_Package
13759                 and then Nkind (N) = N_Selected_Component
13760                 and then Nkind (Parent (N)) = N_Expanded_Name
13761                 and then Present (Original_Node (N2))
13762                 and then Is_Entity_Name (Original_Node (N2))
13763                 and then Present (Entity (Original_Node (N2)))
13764               then
13765                  if Is_Global (Entity (Original_Node (N2))) then
13766                     N2 := Original_Node (N2);
13767                     Set_Associated_Node (N, N2);
13768                     Set_Global_Type (N, N2);
13769
13770                  else
13771                     --  Renaming is local, and will be resolved in instance
13772
13773                     Set_Associated_Node (N, Empty);
13774                     Set_Etype  (N, Empty);
13775                  end if;
13776
13777               else
13778                  Set_Global_Type (N, N2);
13779               end if;
13780
13781            elsif Nkind (N) = N_Op_Concat
13782              and then Is_Generic_Type (Etype (N2))
13783              and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13784                          or else
13785                        Base_Type (Etype (Left_Opnd (N2)))  = Etype (N2))
13786              and then Is_Intrinsic_Subprogram (E)
13787            then
13788               null;
13789
13790            else
13791               --  Entity is local. Mark generic node as unresolved.
13792               --  Note that now it does not have an entity.
13793
13794               Set_Associated_Node (N, Empty);
13795               Set_Etype  (N, Empty);
13796            end if;
13797
13798            if Nkind (Parent (N)) in N_Generic_Instantiation
13799              and then N = Name (Parent (N))
13800            then
13801               Save_Global_Defaults (Parent (N), Parent (N2));
13802            end if;
13803
13804         elsif Nkind (Parent (N)) = N_Selected_Component
13805           and then Nkind (Parent (N2)) = N_Expanded_Name
13806         then
13807            if Is_Global (Entity (Parent (N2))) then
13808               Change_Selected_Component_To_Expanded_Name (Parent (N));
13809               Set_Associated_Node (Parent (N), Parent (N2));
13810               Set_Global_Type (Parent (N), Parent (N2));
13811               Save_Entity_Descendants (N);
13812
13813            --  If this is a reference to the current generic entity, replace
13814            --  by the name of the generic homonym of the current package. This
13815            --  is because in an instantiation Par.P.Q will not resolve to the
13816            --  name of the instance, whose enclosing scope is not necessarily
13817            --  Par. We use the generic homonym rather that the name of the
13818            --  generic itself because it may be hidden by a local declaration.
13819
13820            elsif In_Open_Scopes (Entity (Parent (N2)))
13821              and then not
13822                Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13823            then
13824               if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13825                  Rewrite (Parent (N),
13826                    Make_Identifier (Sloc (N),
13827                      Chars =>
13828                        Chars (Generic_Homonym (Entity (Parent (N2))))));
13829               else
13830                  Rewrite (Parent (N),
13831                    Make_Identifier (Sloc (N),
13832                      Chars => Chars (Selector_Name (Parent (N2)))));
13833               end if;
13834            end if;
13835
13836            if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13837              and then Parent (N) = Name (Parent (Parent (N)))
13838            then
13839               Save_Global_Defaults
13840                 (Parent (Parent (N)), Parent (Parent ((N2))));
13841            end if;
13842
13843         --  A selected component may denote a static constant that has been
13844         --  folded. If the static constant is global to the generic, capture
13845         --  its value. Otherwise the folding will happen in any instantiation.
13846
13847         elsif Nkind (Parent (N)) = N_Selected_Component
13848           and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13849         then
13850            if Present (Entity (Original_Node (Parent (N2))))
13851              and then Is_Global (Entity (Original_Node (Parent (N2))))
13852            then
13853               Rewrite (Parent (N), New_Copy (Parent (N2)));
13854               Set_Analyzed (Parent (N), False);
13855
13856            else
13857               null;
13858            end if;
13859
13860         --  A selected component may be transformed into a parameterless
13861         --  function call. If the called entity is global, rewrite the node
13862         --  appropriately, i.e. as an extended name for the global entity.
13863
13864         elsif Nkind (Parent (N)) = N_Selected_Component
13865           and then Nkind (Parent (N2)) = N_Function_Call
13866           and then N = Selector_Name (Parent (N))
13867         then
13868            if No (Parameter_Associations (Parent (N2))) then
13869               if Is_Global (Entity (Name (Parent (N2)))) then
13870                  Change_Selected_Component_To_Expanded_Name (Parent (N));
13871                  Set_Associated_Node (Parent (N), Name (Parent (N2)));
13872                  Set_Global_Type (Parent (N), Name (Parent (N2)));
13873                  Save_Entity_Descendants (N);
13874
13875               else
13876                  Set_Is_Prefixed_Call (Parent (N));
13877                  Set_Associated_Node (N, Empty);
13878                  Set_Etype (N, Empty);
13879               end if;
13880
13881            --  In Ada 2005, X.F may be a call to a primitive operation,
13882            --  rewritten as F (X). This rewriting will be done again in an
13883            --  instance, so keep the original node. Global entities will be
13884            --  captured as for other constructs. Indicate that this must
13885            --  resolve as a call, to prevent accidental overloading in the
13886            --  instance, if both a component and a primitive operation appear
13887            --  as candidates.
13888
13889            else
13890               Set_Is_Prefixed_Call (Parent (N));
13891            end if;
13892
13893         --  Entity is local. Reset in generic unit, so that node is resolved
13894         --  anew at the point of instantiation.
13895
13896         else
13897            Set_Associated_Node (N, Empty);
13898            Set_Etype (N, Empty);
13899         end if;
13900      end Reset_Entity;
13901
13902      -----------------------------
13903      -- Save_Entity_Descendants --
13904      -----------------------------
13905
13906      procedure Save_Entity_Descendants (N : Node_Id) is
13907      begin
13908         case Nkind (N) is
13909            when N_Binary_Op =>
13910               Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13911               Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13912
13913            when N_Unary_Op =>
13914               Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13915
13916            when N_Expanded_Name | N_Selected_Component =>
13917               Save_Global_Descendant (Union_Id (Prefix (N)));
13918               Save_Global_Descendant (Union_Id (Selector_Name (N)));
13919
13920            when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13921               null;
13922
13923            when others =>
13924               raise Program_Error;
13925         end case;
13926      end Save_Entity_Descendants;
13927
13928      --------------------------
13929      -- Save_Global_Defaults --
13930      --------------------------
13931
13932      procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13933         Loc    : constant Source_Ptr := Sloc (N1);
13934         Assoc2 : constant List_Id    := Generic_Associations (N2);
13935         Gen_Id : constant Entity_Id  := Get_Generic_Entity (N2);
13936         Assoc1 : List_Id;
13937         Act1   : Node_Id;
13938         Act2   : Node_Id;
13939         Def    : Node_Id;
13940         Ndec   : Node_Id;
13941         Subp   : Entity_Id;
13942         Actual : Entity_Id;
13943
13944      begin
13945         Assoc1 := Generic_Associations (N1);
13946
13947         if Present (Assoc1) then
13948            Act1 := First (Assoc1);
13949         else
13950            Act1 := Empty;
13951            Set_Generic_Associations (N1, New_List);
13952            Assoc1 := Generic_Associations (N1);
13953         end if;
13954
13955         if Present (Assoc2) then
13956            Act2 := First (Assoc2);
13957         else
13958            return;
13959         end if;
13960
13961         while Present (Act1) and then Present (Act2) loop
13962            Next (Act1);
13963            Next (Act2);
13964         end loop;
13965
13966         --  Find the associations added for default subprograms
13967
13968         if Present (Act2) then
13969            while Nkind (Act2) /= N_Generic_Association
13970              or else No (Entity (Selector_Name (Act2)))
13971              or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13972            loop
13973               Next (Act2);
13974            end loop;
13975
13976            --  Add a similar association if the default is global. The
13977            --  renaming declaration for the actual has been analyzed, and
13978            --  its alias is the program it renames. Link the actual in the
13979            --  original generic tree with the node in the analyzed tree.
13980
13981            while Present (Act2) loop
13982               Subp := Entity (Selector_Name (Act2));
13983               Def  := Explicit_Generic_Actual_Parameter (Act2);
13984
13985               --  Following test is defence against rubbish errors
13986
13987               if No (Alias (Subp)) then
13988                  return;
13989               end if;
13990
13991               --  Retrieve the resolved actual from the renaming declaration
13992               --  created for the instantiated formal.
13993
13994               Actual := Entity (Name (Parent (Parent (Subp))));
13995               Set_Entity (Def, Actual);
13996               Set_Etype (Def, Etype (Actual));
13997
13998               if Is_Global (Actual) then
13999                  Ndec :=
14000                    Make_Generic_Association (Loc,
14001                      Selector_Name => New_Occurrence_Of (Subp, Loc),
14002                        Explicit_Generic_Actual_Parameter =>
14003                          New_Occurrence_Of (Actual, Loc));
14004
14005                  Set_Associated_Node
14006                    (Explicit_Generic_Actual_Parameter (Ndec), Def);
14007
14008                  Append (Ndec, Assoc1);
14009
14010               --  If there are other defaults, add a dummy association in case
14011               --  there are other defaulted formals with the same name.
14012
14013               elsif Present (Next (Act2)) then
14014                  Ndec :=
14015                    Make_Generic_Association (Loc,
14016                      Selector_Name => New_Occurrence_Of (Subp, Loc),
14017                        Explicit_Generic_Actual_Parameter => Empty);
14018
14019                  Append (Ndec, Assoc1);
14020               end if;
14021
14022               Next (Act2);
14023            end loop;
14024         end if;
14025
14026         if Nkind (Name (N1)) = N_Identifier
14027           and then Is_Child_Unit (Gen_Id)
14028           and then Is_Global (Gen_Id)
14029           and then Is_Generic_Unit (Scope (Gen_Id))
14030           and then In_Open_Scopes (Scope (Gen_Id))
14031         then
14032            --  This is an instantiation of a child unit within a sibling, so
14033            --  that the generic parent is in scope. An eventual instance must
14034            --  occur within the scope of an instance of the parent. Make name
14035            --  in instance into an expanded name, to preserve the identifier
14036            --  of the parent, so it can be resolved subsequently.
14037
14038            Rewrite (Name (N2),
14039              Make_Expanded_Name (Loc,
14040                Chars         => Chars (Gen_Id),
14041                Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
14042                Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
14043            Set_Entity (Name (N2), Gen_Id);
14044
14045            Rewrite (Name (N1),
14046               Make_Expanded_Name (Loc,
14047                Chars         => Chars (Gen_Id),
14048                Prefix        => New_Occurrence_Of (Scope (Gen_Id), Loc),
14049                Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
14050
14051            Set_Associated_Node (Name (N1), Name (N2));
14052            Set_Associated_Node (Prefix (Name (N1)), Empty);
14053            Set_Associated_Node
14054              (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
14055            Set_Etype (Name (N1), Etype (Gen_Id));
14056         end if;
14057
14058      end Save_Global_Defaults;
14059
14060      ----------------------------
14061      -- Save_Global_Descendant --
14062      ----------------------------
14063
14064      procedure Save_Global_Descendant (D : Union_Id) is
14065         N1 : Node_Id;
14066
14067      begin
14068         if D in Node_Range then
14069            if D = Union_Id (Empty) then
14070               null;
14071
14072            elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
14073               Save_References (Node_Id (D));
14074            end if;
14075
14076         elsif D in List_Range then
14077            if D = Union_Id (No_List) or else Is_Empty_List (List_Id (D)) then
14078               null;
14079
14080            else
14081               N1 := First (List_Id (D));
14082               while Present (N1) loop
14083                  Save_References (N1);
14084                  Next (N1);
14085               end loop;
14086            end if;
14087
14088         --  Element list or other non-node field, nothing to do
14089
14090         else
14091            null;
14092         end if;
14093      end Save_Global_Descendant;
14094
14095      ---------------------
14096      -- Save_References --
14097      ---------------------
14098
14099      --  This is the recursive procedure that does the work once the enclosing
14100      --  generic scope has been established. We have to treat specially a
14101      --  number of node rewritings that are required by semantic processing
14102      --  and which change the kind of nodes in the generic copy: typically
14103      --  constant-folding, replacing an operator node by a string literal, or
14104      --  a selected component by an expanded name. In each of those cases, the
14105      --  transformation is propagated to the generic unit.
14106
14107      procedure Save_References (N : Node_Id) is
14108         Loc : constant Source_Ptr := Sloc (N);
14109
14110      begin
14111         if N = Empty then
14112            null;
14113
14114         elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
14115            if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14116               Reset_Entity (N);
14117
14118            elsif Nkind (N) = N_Operator_Symbol
14119              and then Nkind (Get_Associated_Node (N)) = N_String_Literal
14120            then
14121               Change_Operator_Symbol_To_String_Literal (N);
14122            end if;
14123
14124         elsif Nkind (N) in N_Op then
14125            if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14126               if Nkind (N) = N_Op_Concat then
14127                  Set_Is_Component_Left_Opnd (N,
14128                    Is_Component_Left_Opnd (Get_Associated_Node (N)));
14129
14130                  Set_Is_Component_Right_Opnd (N,
14131                    Is_Component_Right_Opnd (Get_Associated_Node (N)));
14132               end if;
14133
14134               Reset_Entity (N);
14135
14136            else
14137               --  Node may be transformed into call to a user-defined operator
14138
14139               N2 := Get_Associated_Node (N);
14140
14141               if Nkind (N2) = N_Function_Call then
14142                  E := Entity (Name (N2));
14143
14144                  if Present (E)
14145                    and then Is_Global (E)
14146                  then
14147                     Set_Etype (N, Etype (N2));
14148                  else
14149                     Set_Associated_Node (N, Empty);
14150                     Set_Etype (N, Empty);
14151                  end if;
14152
14153               elsif Nkind_In (N2, N_Integer_Literal,
14154                                   N_Real_Literal,
14155                                   N_String_Literal)
14156               then
14157                  if Present (Original_Node (N2))
14158                    and then Nkind (Original_Node (N2)) = Nkind (N)
14159                  then
14160
14161                     --  Operation was constant-folded. Whenever possible,
14162                     --  recover semantic information from unfolded node,
14163                     --  for ASIS use.
14164
14165                     Set_Associated_Node (N, Original_Node (N2));
14166
14167                     if Nkind (N) = N_Op_Concat then
14168                        Set_Is_Component_Left_Opnd (N,
14169                          Is_Component_Left_Opnd  (Get_Associated_Node (N)));
14170                        Set_Is_Component_Right_Opnd (N,
14171                          Is_Component_Right_Opnd (Get_Associated_Node (N)));
14172                     end if;
14173
14174                     Reset_Entity (N);
14175
14176                  else
14177                     --  If original node is already modified, propagate
14178                     --  constant-folding to template.
14179
14180                     Rewrite (N, New_Copy (N2));
14181                     Set_Analyzed (N, False);
14182                  end if;
14183
14184               elsif Nkind (N2) = N_Identifier
14185                 and then Ekind (Entity (N2)) = E_Enumeration_Literal
14186               then
14187                  --  Same if call was folded into a literal, but in this case
14188                  --  retain the entity to avoid spurious ambiguities if it is
14189                  --  overloaded at the point of instantiation or inlining.
14190
14191                  Rewrite (N, New_Copy (N2));
14192                  Set_Analyzed (N, False);
14193               end if;
14194            end if;
14195
14196            --  Complete operands check if node has not been constant-folded
14197
14198            if Nkind (N) in N_Op then
14199               Save_Entity_Descendants (N);
14200            end if;
14201
14202         elsif Nkind (N) = N_Identifier then
14203            if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14204
14205               --  If this is a discriminant reference, always save it. It is
14206               --  used in the instance to find the corresponding discriminant
14207               --  positionally rather than by name.
14208
14209               Set_Original_Discriminant
14210                 (N, Original_Discriminant (Get_Associated_Node (N)));
14211               Reset_Entity (N);
14212
14213            else
14214               N2 := Get_Associated_Node (N);
14215
14216               if Nkind (N2) = N_Function_Call then
14217                  E := Entity (Name (N2));
14218
14219                  --  Name resolves to a call to parameterless function. If
14220                  --  original entity is global, mark node as resolved.
14221
14222                  if Present (E)
14223                    and then Is_Global (E)
14224                  then
14225                     Set_Etype (N, Etype (N2));
14226                  else
14227                     Set_Associated_Node (N, Empty);
14228                     Set_Etype (N, Empty);
14229                  end if;
14230
14231               elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
14232                 and then Is_Entity_Name (Original_Node (N2))
14233               then
14234                  --  Name resolves to named number that is constant-folded,
14235                  --  We must preserve the original name for ASIS use, and
14236                  --  undo the constant-folding, which will be repeated in
14237                  --  each instance.
14238
14239                  Set_Associated_Node (N, Original_Node (N2));
14240                  Reset_Entity (N);
14241
14242               elsif Nkind (N2) = N_String_Literal then
14243
14244                  --  Name resolves to string literal. Perform the same
14245                  --  replacement in generic.
14246
14247                  Rewrite (N, New_Copy (N2));
14248
14249               elsif Nkind (N2) = N_Explicit_Dereference then
14250
14251                  --  An identifier is rewritten as a dereference if it is the
14252                  --  prefix in an implicit dereference (call or attribute).
14253                  --  The analysis of an instantiation will expand the node
14254                  --  again, so we preserve the original tree but link it to
14255                  --  the resolved entity in case it is global.
14256
14257                  if Is_Entity_Name (Prefix (N2))
14258                    and then Present (Entity (Prefix (N2)))
14259                    and then Is_Global (Entity (Prefix (N2)))
14260                  then
14261                     Set_Associated_Node (N, Prefix (N2));
14262
14263                  elsif Nkind (Prefix (N2)) = N_Function_Call
14264                    and then Is_Global (Entity (Name (Prefix (N2))))
14265                  then
14266                     Rewrite (N,
14267                       Make_Explicit_Dereference (Loc,
14268                          Prefix => Make_Function_Call (Loc,
14269                            Name =>
14270                              New_Occurrence_Of
14271                                (Entity (Name (Prefix (N2))), Loc))));
14272
14273                  else
14274                     Set_Associated_Node (N, Empty);
14275                     Set_Etype (N, Empty);
14276                  end if;
14277
14278               --  The subtype mark of a nominally unconstrained object is
14279               --  rewritten as a subtype indication using the bounds of the
14280               --  expression. Recover the original subtype mark.
14281
14282               elsif Nkind (N2) = N_Subtype_Indication
14283                 and then Is_Entity_Name (Original_Node (N2))
14284               then
14285                  Set_Associated_Node (N, Original_Node (N2));
14286                  Reset_Entity (N);
14287
14288               else
14289                  null;
14290               end if;
14291            end if;
14292
14293         elsif Nkind (N) in N_Entity then
14294            null;
14295
14296         else
14297            declare
14298               Qual : Node_Id := Empty;
14299               Typ  : Entity_Id := Empty;
14300               Nam  : Node_Id;
14301
14302               use Atree.Unchecked_Access;
14303               --  This code section is part of implementing an untyped tree
14304               --  traversal, so it needs direct access to node fields.
14305
14306            begin
14307               if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
14308                  N2 := Get_Associated_Node (N);
14309
14310                  if No (N2) then
14311                     Typ := Empty;
14312
14313                  else
14314                     Typ := Etype (N2);
14315
14316                     --  In an instance within a generic, use the name of the
14317                     --  actual and not the original generic parameter. If the
14318                     --  actual is global in the current generic it must be
14319                     --  preserved for its instantiation.
14320
14321                     if Nkind (Parent (Typ)) = N_Subtype_Declaration
14322                       and then
14323                         Present (Generic_Parent_Type (Parent (Typ)))
14324                     then
14325                        Typ := Base_Type (Typ);
14326                        Set_Etype (N2, Typ);
14327                     end if;
14328                  end if;
14329
14330                  if No (N2) or else No (Typ) or else not Is_Global (Typ) then
14331                     Set_Associated_Node (N, Empty);
14332
14333                     --  If the aggregate is an actual in a call, it has been
14334                     --  resolved in the current context, to some local type.
14335                     --  The enclosing call may have been disambiguated by the
14336                     --  aggregate, and this disambiguation might fail at
14337                     --  instantiation time because the type to which the
14338                     --  aggregate did resolve is not preserved. In order to
14339                     --  preserve some of this information, we wrap the
14340                     --  aggregate in a qualified expression, using the id of
14341                     --  its type. For further disambiguation we qualify the
14342                     --  type name with its scope (if visible) because both
14343                     --  id's will have corresponding entities in an instance.
14344                     --  This resolves most of the problems with missing type
14345                     --  information on aggregates in instances.
14346
14347                     if Nkind (N2) = Nkind (N)
14348                       and then Nkind (Parent (N2)) in N_Subprogram_Call
14349                       and then Comes_From_Source (Typ)
14350                     then
14351                        if Is_Immediately_Visible (Scope (Typ)) then
14352                           Nam :=
14353                             Make_Selected_Component (Loc,
14354                               Prefix        =>
14355                                 Make_Identifier (Loc, Chars (Scope (Typ))),
14356                               Selector_Name =>
14357                                 Make_Identifier (Loc, Chars (Typ)));
14358                        else
14359                           Nam := Make_Identifier (Loc, Chars (Typ));
14360                        end if;
14361
14362                        Qual :=
14363                          Make_Qualified_Expression (Loc,
14364                            Subtype_Mark => Nam,
14365                            Expression   => Relocate_Node (N));
14366                     end if;
14367                  end if;
14368
14369                  Save_Global_Descendant (Field1 (N));
14370                  Save_Global_Descendant (Field2 (N));
14371                  Save_Global_Descendant (Field3 (N));
14372                  Save_Global_Descendant (Field5 (N));
14373
14374                  if Present (Qual) then
14375                     Rewrite (N, Qual);
14376                  end if;
14377
14378               --  All other cases than aggregates
14379
14380               else
14381                  Save_Global_Descendant (Field1 (N));
14382                  Save_Global_Descendant (Field2 (N));
14383                  Save_Global_Descendant (Field3 (N));
14384                  Save_Global_Descendant (Field4 (N));
14385                  Save_Global_Descendant (Field5 (N));
14386               end if;
14387            end;
14388         end if;
14389
14390         --  Save all global references found within the aspects of the related
14391         --  node. This is not done for generic subprograms because the aspects
14392         --  must be delayed and analyzed at the end of the declarative part.
14393         --  Only then can global references be saved. This action is performed
14394         --  by the analysis of the generic subprogram contract.
14395
14396         if Nkind (N) /= N_Generic_Subprogram_Declaration then
14397            Save_Global_References_In_Aspects (N);
14398         end if;
14399      end Save_References;
14400
14401   --  Start of processing for Save_Global_References
14402
14403   begin
14404      Gen_Scope := Current_Scope;
14405
14406      --  If the generic unit is a child unit, references to entities in the
14407      --  parent are treated as local, because they will be resolved anew in
14408      --  the context of the instance of the parent.
14409
14410      while Is_Child_Unit (Gen_Scope)
14411        and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
14412      loop
14413         Gen_Scope := Scope (Gen_Scope);
14414      end loop;
14415
14416      Save_References (N);
14417   end Save_Global_References;
14418
14419   ---------------------------------------
14420   -- Save_Global_References_In_Aspects --
14421   ---------------------------------------
14422
14423   procedure Save_Global_References_In_Aspects (N : Node_Id) is
14424      Asp  : Node_Id;
14425      Expr : Node_Id;
14426
14427   begin
14428      if Permits_Aspect_Specifications (N) and then Has_Aspects (N) then
14429         Asp := First (Aspect_Specifications (N));
14430         while Present (Asp) loop
14431            Expr := Expression (Asp);
14432
14433            if Present (Expr) then
14434               Save_Global_References (Expr);
14435            end if;
14436
14437            Next (Asp);
14438         end loop;
14439      end if;
14440   end Save_Global_References_In_Aspects;
14441
14442   --------------------------------------
14443   -- Set_Copied_Sloc_For_Inlined_Body --
14444   --------------------------------------
14445
14446   procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
14447   begin
14448      Create_Instantiation_Source (N, E, True, S_Adjustment);
14449   end Set_Copied_Sloc_For_Inlined_Body;
14450
14451   ---------------------
14452   -- Set_Instance_Of --
14453   ---------------------
14454
14455   procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
14456   begin
14457      Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
14458      Generic_Renamings_HTable.Set (Generic_Renamings.Last);
14459      Generic_Renamings.Increment_Last;
14460   end Set_Instance_Of;
14461
14462   --------------------
14463   -- Set_Next_Assoc --
14464   --------------------
14465
14466   procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
14467   begin
14468      Generic_Renamings.Table (E).Next_In_HTable := Next;
14469   end Set_Next_Assoc;
14470
14471   -------------------
14472   -- Start_Generic --
14473   -------------------
14474
14475   procedure Start_Generic is
14476   begin
14477      --  ??? More things could be factored out in this routine.
14478      --  Should probably be done at a later stage.
14479
14480      Generic_Flags.Append (Inside_A_Generic);
14481      Inside_A_Generic := True;
14482
14483      Expander_Mode_Save_And_Set (False);
14484   end Start_Generic;
14485
14486   ----------------------
14487   -- Set_Instance_Env --
14488   ----------------------
14489
14490   procedure Set_Instance_Env
14491     (Gen_Unit : Entity_Id;
14492      Act_Unit : Entity_Id)
14493   is
14494      Assertion_Status       : constant Boolean := Assertions_Enabled;
14495      Save_SPARK_Mode        : constant SPARK_Mode_Type := SPARK_Mode;
14496      Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
14497
14498   begin
14499      --  Regardless of the current mode, predefined units are analyzed in the
14500      --  most current Ada mode, and earlier version Ada checks do not apply
14501      --  to predefined units. Nothing needs to be done for non-internal units.
14502      --  These are always analyzed in the current mode.
14503
14504      if Is_Internal_File_Name
14505           (Fname              => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
14506            Renamings_Included => True)
14507      then
14508         Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
14509
14510         --  In Ada2012 we may want to enable assertions in an instance of a
14511         --  predefined unit, in which case we need to preserve the current
14512         --  setting for the Assertions_Enabled flag. This will become more
14513         --  critical when pre/postconditions are added to predefined units,
14514         --  as is already the case for some numeric libraries.
14515
14516         if Ada_Version >= Ada_2012 then
14517            Assertions_Enabled := Assertion_Status;
14518         end if;
14519
14520         --  SPARK_Mode for an instance is the one applicable at the point of
14521         --  instantiation.
14522
14523         SPARK_Mode := Save_SPARK_Mode;
14524         SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
14525
14526         --  Make sure dynamic elaboration checks are off in SPARK Mode
14527
14528         if SPARK_Mode = On then
14529            Dynamic_Elaboration_Checks := False;
14530         end if;
14531      end if;
14532
14533      Current_Instantiated_Parent :=
14534        (Gen_Id         => Gen_Unit,
14535         Act_Id         => Act_Unit,
14536         Next_In_HTable => Assoc_Null);
14537   end Set_Instance_Env;
14538
14539   -----------------
14540   -- Switch_View --
14541   -----------------
14542
14543   procedure Switch_View (T : Entity_Id) is
14544      BT        : constant Entity_Id := Base_Type (T);
14545      Priv_Elmt : Elmt_Id := No_Elmt;
14546      Priv_Sub  : Entity_Id;
14547
14548   begin
14549      --  T may be private but its base type may have been exchanged through
14550      --  some other occurrence, in which case there is nothing to switch
14551      --  besides T itself. Note that a private dependent subtype of a private
14552      --  type might not have been switched even if the base type has been,
14553      --  because of the last branch of Check_Private_View (see comment there).
14554
14555      if not Is_Private_Type (BT) then
14556         Prepend_Elmt (Full_View (T), Exchanged_Views);
14557         Exchange_Declarations (T);
14558         return;
14559      end if;
14560
14561      Priv_Elmt := First_Elmt (Private_Dependents (BT));
14562
14563      if Present (Full_View (BT)) then
14564         Prepend_Elmt (Full_View (BT), Exchanged_Views);
14565         Exchange_Declarations (BT);
14566      end if;
14567
14568      while Present (Priv_Elmt) loop
14569         Priv_Sub := (Node (Priv_Elmt));
14570
14571         --  We avoid flipping the subtype if the Etype of its full view is
14572         --  private because this would result in a malformed subtype. This
14573         --  occurs when the Etype of the subtype full view is the full view of
14574         --  the base type (and since the base types were just switched, the
14575         --  subtype is pointing to the wrong view). This is currently the case
14576         --  for tagged record types, access types (maybe more?) and needs to
14577         --  be resolved. ???
14578
14579         if Present (Full_View (Priv_Sub))
14580           and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14581         then
14582            Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14583            Exchange_Declarations (Priv_Sub);
14584         end if;
14585
14586         Next_Elmt (Priv_Elmt);
14587      end loop;
14588   end Switch_View;
14589
14590   -----------------
14591   -- True_Parent --
14592   -----------------
14593
14594   function True_Parent (N : Node_Id) return Node_Id is
14595   begin
14596      if Nkind (Parent (N)) = N_Subunit then
14597         return Parent (Corresponding_Stub (Parent (N)));
14598      else
14599         return Parent (N);
14600      end if;
14601   end True_Parent;
14602
14603   -----------------------------
14604   -- Valid_Default_Attribute --
14605   -----------------------------
14606
14607   procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14608      Attr_Id : constant Attribute_Id :=
14609                  Get_Attribute_Id (Attribute_Name (Def));
14610      T       : constant Entity_Id := Entity (Prefix (Def));
14611      Is_Fun  : constant Boolean := (Ekind (Nam) = E_Function);
14612      F       : Entity_Id;
14613      Num_F   : Int;
14614      OK      : Boolean;
14615
14616   begin
14617      if No (T) or else T = Any_Id then
14618         return;
14619      end if;
14620
14621      Num_F := 0;
14622      F := First_Formal (Nam);
14623      while Present (F) loop
14624         Num_F := Num_F + 1;
14625         Next_Formal (F);
14626      end loop;
14627
14628      case Attr_Id is
14629         when Attribute_Adjacent |  Attribute_Ceiling   | Attribute_Copy_Sign |
14630              Attribute_Floor    |  Attribute_Fraction  | Attribute_Machine   |
14631              Attribute_Model    |  Attribute_Remainder | Attribute_Rounding  |
14632              Attribute_Unbiased_Rounding  =>
14633            OK := Is_Fun
14634                    and then Num_F = 1
14635                    and then Is_Floating_Point_Type (T);
14636
14637         when Attribute_Image    | Attribute_Pred       | Attribute_Succ |
14638              Attribute_Value    | Attribute_Wide_Image |
14639              Attribute_Wide_Value  =>
14640            OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14641
14642         when Attribute_Max      |  Attribute_Min  =>
14643            OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14644
14645         when Attribute_Input =>
14646            OK := (Is_Fun and then Num_F = 1);
14647
14648         when Attribute_Output | Attribute_Read | Attribute_Write =>
14649            OK := (not Is_Fun and then Num_F = 2);
14650
14651         when others =>
14652            OK := False;
14653      end case;
14654
14655      if not OK then
14656         Error_Msg_N
14657           ("attribute reference has wrong profile for subprogram", Def);
14658      end if;
14659   end Valid_Default_Attribute;
14660
14661end Sem_Ch12;
14662