1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT COMPILER COMPONENTS                         --
4--                                                                          --
5--                                  S E M                                   --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 1992-2013, Free Software Foundation, Inc.         --
10--                                                                          --
11-- GNAT is free software;  you can  redistribute it  and/or modify it under --
12-- terms of the  GNU General Public License as published  by the Free Soft- --
13-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16-- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
17-- for  more details.  You should have  received  a copy of the GNU General --
18-- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
19-- http://www.gnu.org/licenses for a complete copy of the license.          --
20--                                                                          --
21-- GNAT was originally developed  by the GNAT team at  New York University. --
22-- Extensive contributions were provided by Ada Core Technologies Inc.      --
23--                                                                          --
24------------------------------------------------------------------------------
25
26--------------------------------------
27-- Semantic Analysis: General Model --
28--------------------------------------
29
30--  Semantic processing involves 3 phases which are highly intertwined
31--  (i.e. mutually recursive):
32
33--    Analysis     implements the bulk of semantic analysis such as
34--                 name analysis and type resolution for declarations,
35--                 instructions and expressions.  The main routine
36--                 driving this process is procedure Analyze given below.
37--                 This analysis phase is really a bottom up pass that is
38--                 achieved during the recursive traversal performed by the
39--                 Analyze_... procedures implemented in the sem_* packages.
40--                 For expressions this phase determines unambiguous types
41--                 and collects sets of possible types where the
42--                 interpretation is potentially ambiguous.
43
44--    Resolution   is carried out only for expressions to finish type
45--                 resolution that was initiated but not necessarily
46--                 completed during analysis (because of overloading
47--                 ambiguities). Specifically, after completing the bottom
48--                 up pass carried out during analysis for expressions, the
49--                 Resolve routine (see the spec of sem_res for more info)
50--                 is called to perform a top down resolution with
51--                 recursive calls to itself to resolve operands.
52
53--    Expansion    if we are not generating code this phase is a no-op.
54--                 otherwise this phase expands, i.e. transforms, original
55--                 declaration, expressions or instructions into simpler
56--                 structures that can be handled by the back-end. This
57--                 phase is also in charge of generating code which is
58--                 implicit in the original source (for instance for
59--                 default initializations, controlled types, etc.)
60--                 There are two separate instances where expansion is
61--                 invoked. For declarations and instructions, expansion is
62--                 invoked just after analysis since no resolution needs
63--                 to be performed. For expressions, expansion is done just
64--                 after resolution. In both cases expansion is done from the
65--                 bottom up just before the end of Analyze for instructions
66--                 and declarations or the call to Resolve for expressions.
67--                 The main routine driving expansion is Expand.
68--                 See the spec of Expander for more details.
69
70--  To summarize, in normal code generation mode we recursively traverse the
71--  abstract syntax tree top-down performing semantic analysis bottom
72--  up. For instructions and declarations, before the call to the Analyze
73--  routine completes we perform expansion since at that point we have all
74--  semantic information needed. For expression nodes, after the call to
75--  Analysis terminates we invoke the Resolve routine to transmit top-down
76--  the type that was gathered by Analyze which will resolve possible
77--  ambiguities in the expression. Just before the call to Resolve
78--  terminates, the expression can be expanded since all the semantic
79--  information is available at that point.
80
81--  If we are not generating code then the expansion phase is a no-op
82
83--  When generating code there are a number of exceptions to the basic
84--  Analysis-Resolution-Expansion model for expressions. The most prominent
85--  examples are the handling of default expressions and aggregates.
86
87-----------------------------------------------------------------------
88-- Handling of Default and Per-Object Expressions (Spec-Expressions) --
89-----------------------------------------------------------------------
90
91--  The default expressions in component declarations and in procedure
92--  specifications (but not the ones in object declarations) are quite tricky
93--  to handle. The problem is that some processing is required at the point
94--  where the expression appears:
95
96--    visibility analysis (including user defined operators)
97--    freezing of static expressions
98
99--  but other processing must be deferred until the enclosing entity (record or
100--  procedure specification) is frozen:
101
102--    freezing of any other types in the expression expansion
103--    generation of code
104
105--  A similar situation occurs with the argument of priority and interrupt
106--  priority pragmas that appear in task and protected definition specs and
107--  other cases of per-object expressions (see RM 3.8(18)).
108
109--  Another similar case is the conditions in precondition and postcondition
110--  pragmas that appear with subprogram specifications rather than in the body.
111
112--  Collectively we call these Spec_Expressions. The routine that performs the
113--  special analysis is called Analyze_Spec_Expression.
114
115--  Expansion has to be deferred since you can't generate code for expressions
116--  that reference types that have not been frozen yet. As an example, consider
117--  the following:
118
119--      type x is delta 0.5 range -10.0 .. +10.0;
120--      ...
121--      type q is record
122--        xx : x := y * z;
123--      end record;
124
125--      for x'small use 0.25
126
127--  The expander is in charge of dealing with fixed-point, and of course the
128--  small declaration, which is not too late, since the declaration of type q
129--  does *not* freeze type x, definitely affects the expanded code.
130
131--  Another reason that we cannot expand early is that expansion can generate
132--  range checks. These range checks need to be inserted not at the point of
133--  definition but at the point of use. The whole point here is that the value
134--  of the expression cannot be obtained at the point of declaration, only at
135--  the point of use.
136
137--  Generally our model is to combine analysis resolution and expansion, but
138--  this is the one case where this model falls down. Here is how we patch
139--  it up without causing too much distortion to our basic model.
140
141--  A switch (In_Spec_Expression) is set to show that we are in the initial
142--  occurrence of a default expression. The analyzer is then called on this
143--  expression with the switch set true. Analysis and resolution proceed almost
144--  as usual, except that Freeze_Expression will not freeze non-static
145--  expressions if this switch is set, and the call to Expand at the end of
146--  resolution is skipped. This also skips the code that normally sets the
147--  Analyzed flag to True. The result is that when we are done the tree is
148--  still marked as unanalyzed, but all types for static expressions are frozen
149--  as required, and all entities of variables have been recorded. We then turn
150--  off the switch, and later on reanalyze the expression with the switch off.
151--  The effect is that this second analysis freezes the rest of the types as
152--  required, and generates code but visibility analysis is not repeated since
153--  all the entities are marked.
154
155--  The second analysis (the one that generates code) is in the context
156--  where the code is required. For a record field default, this is in the
157--  initialization procedure for the record and for a subprogram default
158--  parameter, it is at the point the subprogram is frozen. For a priority or
159--  storage size pragma it is in the context of the Init_Proc for the task or
160--  protected object. For a pre/postcondition pragma it is in the body when
161--  code for the pragma is generated.
162
163------------------
164-- Pre-Analysis --
165------------------
166
167--  For certain kind of expressions, such as aggregates, we need to defer
168--  expansion of the aggregate and its inner expressions after the whole
169--  set of expressions appearing inside the aggregate have been analyzed.
170--  Consider, for instance the following example:
171--
172--     (1 .. 100 => new Thing (Function_Call))
173--
174--  The normal Analysis-Resolution-Expansion mechanism where expansion of the
175--  children is performed before expansion of the parent does not work if the
176--  code generated for the children by the expander needs to be evaluated
177--  repeatedly (for instance in the above aggregate "new Thing (Function_Call)"
178--  needs to be called 100 times.)
179
180--  The reason why this mechanism does not work is that the expanded code for
181--  the children is typically inserted above the parent and thus when the
182--  father gets expanded no re-evaluation takes place. For instance in the case
183--  of aggregates if "new Thing (Function_Call)" is expanded before of the
184--  aggregate the expanded code will be placed outside of the aggregate and
185--  when expanding the aggregate the loop from 1 to 100 will not surround the
186--  expanded code for "new Thing (Function_Call)".
187
188--  To remedy this situation we introduce a new flag which signals whether we
189--  want a full analysis (i.e. expansion is enabled) or a pre-analysis which
190--  performs Analysis and Resolution but no expansion.
191
192--  After the complete pre-analysis of an expression has been carried out we
193--  can transform the expression and then carry out the full three stage
194--  (Analyze-Resolve-Expand) cycle on the transformed expression top-down so
195--  that the expansion of inner expressions happens inside the newly generated
196--  node for the parent expression.
197
198--  Note that the difference between processing of default expressions and
199--  pre-analysis of other expressions is that we do carry out freezing in
200--  the latter but not in the former (except for static scalar expressions).
201--  The routine that performs preanalysis and corresponding resolution is
202--  called Preanalyze_And_Resolve and is in Sem_Res.
203
204with Alloc;
205with Einfo;  use Einfo;
206with Opt;    use Opt;
207with Table;
208with Types;  use Types;
209
210package Sem is
211
212   -----------------------------
213   -- Semantic Analysis Flags --
214   -----------------------------
215
216   Full_Analysis : Boolean := True;
217   --  Switch to indicate if we are doing a full analysis or a pre-analysis.
218   --  In normal analysis mode (Analysis-Expansion for instructions or
219   --  declarations) or (Analysis-Resolution-Expansion for expressions) this
220   --  flag is set. Note that if we are not generating code the expansion phase
221   --  merely sets the Analyzed flag to True in this case. If we are in
222   --  Pre-Analysis mode (see above) this flag is set to False then the
223   --  expansion phase is skipped.
224   --
225   --  When this flag is False the flag Expander_Active is also False (the
226   --  Expander_Active flag defined in the spec of package Expander tells you
227   --  whether expansion is currently enabled). You should really regard this
228   --  as a read only flag.
229
230   In_Spec_Expression : Boolean := False;
231   --  Switch to indicate that we are in a spec-expression, as described
232   --  above. Note that this must be recursively saved on a Semantics call
233   --  since it is possible for the analysis of an expression to result in a
234   --  recursive call (e.g. to get the entity for System.Address as part of the
235   --  processing of an Address attribute reference). When this switch is True
236   --  then Full_Analysis above must be False. You should really regard this as
237   --  a read only flag.
238
239   In_Deleted_Code : Boolean := False;
240   --  If the condition in an if-statement is statically known, the branch
241   --  that is not taken is analyzed with expansion disabled, and the tree
242   --  is deleted after analysis. Itypes generated in deleted code must be
243   --  frozen from start, because the tree on which they depend will not
244   --  be available at the freeze point.
245
246   In_Assertion_Expr : Nat := 0;
247   --  This is set non-zero if we are within the expression of an assertion
248   --  pragma or aspect. It is a counter which is incremented at the start
249   --  of expanding such an expression, and decremented on completion of
250   --  expanding that expression. Probably a boolean would be good enough,
251   --  since we think that such expressions cannot nest, but that might not
252   --  be true in the future (e.g. if let expressions are added to Ada) so
253   --  we prepare for that future possibility by making it a counter.
254
255   In_Inlined_Body : Boolean := False;
256   --  Switch to indicate that we are analyzing and resolving an inlined body.
257   --  Type checking is disabled in this context, because types are known to be
258   --  compatible. This avoids problems with private types whose full view is
259   --  derived from private types.
260
261   Inside_A_Generic : Boolean := False;
262   --  This flag is set if we are processing a generic specification, generic
263   --  definition, or generic body. When this flag is True the Expander_Active
264   --  flag is False to disable any code expansion (see package Expander). Only
265   --  the generic processing can modify the status of this flag, any other
266   --  client should regard it as read-only.
267   --  Probably should be called Inside_A_Generic_Template ???
268
269   Inside_Freezing_Actions : Nat := 0;
270   --  Flag indicating whether we are within a call to Expand_N_Freeze_Actions.
271   --  Non-zero means we are inside (it is actually a level counter to deal
272   --  with nested calls). Used to avoid traversing the tree each time a
273   --  subprogram call is processed to know if we must not clear all constant
274   --  indications from entities in the current scope. Only the expansion of
275   --  freezing nodes can modify the status of this flag, any other client
276   --  should regard it as read-only.
277
278   Unloaded_Subunits : Boolean := False;
279   --  This flag is set True if we have subunits that are not loaded. This
280   --  occurs when the main unit is a subunit, and contains lower level
281   --  subunits that are not loaded. We use this flag to suppress warnings
282   --  about unused variables, since these warnings are unreliable in this
283   --  case. We could perhaps do a more accurate job and retain some of the
284   --  warnings, but it is quite a tricky job.
285
286   -----------------------------------
287   -- Handling of Check Suppression --
288   -----------------------------------
289
290   --  There are two kinds of suppress checks: scope based suppress checks,
291   --  and entity based suppress checks.
292
293   --  Scope based suppress checks for the predefined checks (from initial
294   --  command line arguments, or from Suppress pragmas not including an entity
295   --  name) are recorded in the Sem.Scope_Suppress variable, and all that
296   --  is necessary is to save the state of this variable on scope entry, and
297   --  restore it on scope exit. This mechanism allows for fast checking of the
298   --  scope suppress state without needing complex data structures.
299
300   --  Entity based checks, from Suppress/Unsuppress pragmas giving an
301   --  Entity_Id and scope based checks for non-predefined checks (introduced
302   --  using pragma Check_Name), are handled as follows. If a suppress or
303   --  unsuppress pragma is encountered for a given entity, then the flag
304   --  Checks_May_Be_Suppressed is set in the entity and an entry is made in
305   --  either the Local_Entity_Suppress stack (case of pragma that appears in
306   --  other than a package spec), or in the Global_Entity_Suppress stack (case
307   --  of pragma that appears in a package spec, which is by the rule of RM
308   --  11.5(7) applicable throughout the life of the entity). Similarly, a
309   --  Suppress/Unsuppress pragma for a non-predefined check which does not
310   --  specify an entity is also stored in one of these stacks.
311
312   --  If the Checks_May_Be_Suppressed flag is set in an entity then the
313   --  procedure is to search first the local and then the global suppress
314   --  stacks (we search these in reverse order, top element first). The only
315   --  other point is that we have to make sure that we have proper nested
316   --  interaction between such specific pragmas and locally applied general
317   --  pragmas applying to all entities. This is achieved by including in the
318   --  Local_Entity_Suppress table dummy entries with an empty Entity field
319   --  that are applicable to all entities. A similar search is needed for any
320   --  non-predefined check even if no specific entity is involved.
321
322   Scope_Suppress : Suppress_Record;
323   --  This variable contains the current scope based settings of the suppress
324   --  switches. It is initialized from Suppress_Options in Gnat1drv, and then
325   --  modified by pragma Suppress. On entry to each scope, the current setting
326   --  is saved on the scope stack, and then restored on exit from the scope.
327   --  This record may be rapidly checked to determine the current status of
328   --  a check if no specific entity is involved or if the specific entity
329   --  involved is one for which no specific Suppress/Unsuppress pragma has
330   --  been set (as indicated by the Checks_May_Be_Suppressed flag being set).
331
332   --  This scheme is a little complex, but serves the purpose of enabling
333   --  a very rapid check in the common case where no entity specific pragma
334   --  applies, and gives the right result when such pragmas are used even
335   --  in complex cases of nested Suppress and Unsuppress pragmas.
336
337   --  The Local_Entity_Suppress and Global_Entity_Suppress stacks are handled
338   --  using dynamic allocation and linked lists. We do not often use this
339   --  approach in the compiler (preferring to use extensible tables instead).
340   --  The reason we do it here is that scope stack entries save a pointer to
341   --  the current local stack top, which is also saved and restored on scope
342   --  exit. Furthermore for processing of generics we save pointers to the
343   --  top of the stack, so that the local stack is actually a tree of stacks
344   --  rather than a single stack, a structure that is easy to represent using
345   --  linked lists, but impossible to represent using a single table. Note
346   --  that because of the generic issue, we never release entries in these
347   --  stacks, but that's no big deal, since we are unlikely to have a huge
348   --  number of Suppress/Unsuppress entries in a single compilation.
349
350   type Suppress_Stack_Entry;
351   type Suppress_Stack_Entry_Ptr is access all Suppress_Stack_Entry;
352
353   type Suppress_Stack_Entry is record
354      Entity : Entity_Id;
355      --  Entity to which the check applies, or Empty for a check that has
356      --  no entity name (and thus applies to all entities).
357
358      Check : Check_Id;
359      --  Check which is set (can be All_Checks for the All_Checks case)
360
361      Suppress : Boolean;
362      --  Set True for Suppress, and False for Unsuppress
363
364      Prev : Suppress_Stack_Entry_Ptr;
365      --  Pointer to previous entry on stack
366
367      Next : Suppress_Stack_Entry_Ptr;
368      --  All allocated Suppress_Stack_Entry records are chained together in
369      --  a linked list whose head is Suppress_Stack_Entries, and the Next
370      --  field is used as a forward pointer (null ends the list). This is
371      --  used to free all entries in Sem.Init (which will be important if
372      --  we ever setup the compiler to be reused).
373   end record;
374
375   Suppress_Stack_Entries : Suppress_Stack_Entry_Ptr := null;
376   --  Pointer to linked list of records (see comments for Next above)
377
378   Local_Suppress_Stack_Top : Suppress_Stack_Entry_Ptr;
379   --  Pointer to top element of local suppress stack. This is the entry that
380   --  is saved and restored in the scope stack, and also saved for generic
381   --  body expansion.
382
383   Global_Suppress_Stack_Top : Suppress_Stack_Entry_Ptr;
384   --  Pointer to top element of global suppress stack
385
386   procedure Push_Local_Suppress_Stack_Entry
387     (Entity   : Entity_Id;
388      Check    : Check_Id;
389      Suppress : Boolean);
390   --  Push a new entry on to the top of the local suppress stack, updating
391   --  the value in Local_Suppress_Stack_Top;
392
393   procedure Push_Global_Suppress_Stack_Entry
394     (Entity   : Entity_Id;
395      Check    : Check_Id;
396      Suppress : Boolean);
397   --  Push a new entry on to the top of the global suppress stack, updating
398   --  the value in Global_Suppress_Stack_Top;
399
400   -----------------
401   -- Scope Stack --
402   -----------------
403
404   --  The scope stack indicates the declarative regions that are currently
405   --  being processed (analyzed and/or expanded). The scope stack is one of
406   --  the basic visibility structures in the compiler: entities that are
407   --  declared in a scope that is currently on the scope stack are immediately
408   --  visible (leaving aside issues of hiding and overloading).
409
410   --  Initially, the scope stack only contains an entry for package Standard.
411   --  When a compilation unit, subprogram unit, block or declarative region
412   --  is being processed, the corresponding entity is pushed on the scope
413   --  stack. It is removed after the processing step is completed. A given
414   --  entity can be placed several times on the scope stack, for example
415   --  when processing derived type declarations, freeze nodes, etc. The top
416   --  of the scope stack is the innermost scope currently being processed.
417   --  It is obtained through function Current_Scope. After a compilation unit
418   --  has been processed, the scope stack must contain only Standard.
419   --  The predicate In_Open_Scopes specifies whether a scope is currently
420   --  on the scope stack.
421
422   --  This model is complicated by the need to compile units on the fly, in
423   --  the middle of the compilation of other units. This arises when compiling
424   --  instantiations, and when compiling run-time packages obtained through
425   --  rtsfind. Given that the scope stack is a single static and global
426   --  structure (not originally designed for the recursive processing required
427   --  by rtsfind for example) additional machinery is needed to indicate what
428   --  is currently being compiled. As a result, the scope stack holds several
429   --  contiguous sections that correspond to the compilation of a given
430   --  compilation unit. These sections are separated by distinct occurrences
431   --  of package Standard. The currently active section of the scope stack
432   --  goes from the current scope to the first (innermost) occurrence of
433   --  Standard, which is additionally marked with flag Is_Active_Stack_Base.
434   --  The basic visibility routine (Find_Direct_Name, in Sem_Ch8) uses this
435   --  contiguous section of the scope stack to determine whether a given
436   --  entity is or is not visible at a point. In_Open_Scopes only examines
437   --  the currently active section of the scope stack.
438
439   --  Similar complications arise when processing child instances. These
440   --  must be compiled in the context of parent instances, and therefore the
441   --  parents must be pushed on the stack before compiling the child, and
442   --  removed afterwards. Routines Save_Scope_Stack and Restore_Scope_Stack
443   --  are used to set/reset the visibility of entities declared in scopes
444   --  that are currently on the scope stack, and are used when compiling
445   --  instance bodies on the fly.
446
447   --  It is clear in retrospect that all semantic processing and visibility
448   --  structures should have been fully recursive. The rtsfind mechanism,
449   --  and the complexities brought about by subunits and by generic child
450   --  units and their instantiations, have led to a hybrid model that carries
451   --  more state than one would wish.
452
453   type Scope_Stack_Entry is record
454      Entity : Entity_Id;
455      --  Entity representing the scope
456
457      Last_Subprogram_Name : String_Ptr;
458      --  Pointer to name of last subprogram body in this scope. Used for
459      --  testing proper alpha ordering of subprogram bodies in scope.
460
461      Save_Scope_Suppress : Suppress_Record;
462      --  Save contents of Scope_Suppress on entry
463
464      Save_Local_Suppress_Stack_Top : Suppress_Stack_Entry_Ptr;
465      --  Save contents of Local_Suppress_Stack on entry to restore on exit
466
467      Save_Check_Policy_List : Node_Id;
468      --  Save contents of Check_Policy_List on entry to restore on exit. The
469      --  Check_Policy pragmas are chained with Check_Policy_List pointing to
470      --  the most recent entry. This list is searched starting here, so that
471      --  the search finds the most recent appicable entry. When we restore
472      --  Check_Policy_List on exit from the scope, the effect is to remove
473      --  all entries set in the scope being exited.
474
475      Save_Default_Storage_Pool : Node_Id;
476      --  Save contents of Default_Storage_Pool on entry to restore on exit
477
478      Save_SPARK_Mode : SPARK_Mode_Type;
479      --  Setting of SPARK_Mode on entry to restore on exit
480
481      Save_SPARK_Mode_Pragma : Node_Id;
482      --  Setting of SPARK_Mode_Pragma on entry to restore on exit
483
484      Is_Transient : Boolean;
485      --  Marks transient scopes (see Exp_Ch7 body for details)
486
487      Previous_Visibility : Boolean;
488      --  Used when installing the parent(s) of the current compilation unit.
489      --  The parent may already be visible because of an ongoing compilation,
490      --  and the proper visibility must be restored on exit. The flag is
491      --  typically needed when the context of a child unit requires
492      --  compilation of a sibling. In other cases the flag is set to False.
493      --  See Sem_Ch10 (Install_Parents, Remove_Parents).
494
495      Node_To_Be_Wrapped : Node_Id;
496      --  Only used in transient scopes. Records the node which will
497      --  be wrapped by the transient block.
498
499      Actions_To_Be_Wrapped_Before : List_Id;
500      Actions_To_Be_Wrapped_After  : List_Id;
501      --  Actions that have to be inserted at the start or at the end of a
502      --  transient block. Used to temporarily hold these actions until the
503      --  block is created, at which time the actions are moved to the block.
504
505      Pending_Freeze_Actions : List_Id;
506      --  Used to collect freeze entity nodes and associated actions that are
507      --  generated in an inner context but need to be analyzed outside, such
508      --  as records and initialization procedures. On exit from the scope,
509      --  this list of actions is inserted before the scope construct and
510      --  analyzed to generate the corresponding freeze processing and
511      --  elaboration of other associated actions.
512
513      First_Use_Clause : Node_Id;
514      --  Head of list of Use_Clauses in current scope. The list is built when
515      --  the declarations in the scope are processed. The list is traversed
516      --  on scope exit to undo the effect of the use clauses.
517
518      Component_Alignment_Default : Component_Alignment_Kind;
519      --  Component alignment to be applied to any record or array types that
520      --  are declared for which a specific component alignment pragma does not
521      --  set the alignment.
522
523      Is_Active_Stack_Base : Boolean;
524      --  Set to true only when entering the scope for Standard_Standard from
525      --  from within procedure Semantics. Indicates the base of the current
526      --  active set of scopes. Needed by In_Open_Scopes to handle cases where
527      --  Standard_Standard can be pushed anew on the scope stack to start a
528      --  new active section (see comment above).
529
530   end record;
531
532   package Scope_Stack is new Table.Table (
533     Table_Component_Type => Scope_Stack_Entry,
534     Table_Index_Type     => Int,
535     Table_Low_Bound      => 0,
536     Table_Initial        => Alloc.Scope_Stack_Initial,
537     Table_Increment      => Alloc.Scope_Stack_Increment,
538     Table_Name           => "Sem.Scope_Stack");
539
540   -----------------
541   -- Subprograms --
542   -----------------
543
544   procedure Initialize;
545   --  Initialize internal tables
546
547   procedure Lock;
548   --  Lock internal tables before calling back end
549
550   procedure Semantics (Comp_Unit : Node_Id);
551   --  This procedure is called to perform semantic analysis on the specified
552   --  node which is the N_Compilation_Unit node for the unit.
553
554   procedure Analyze (N : Node_Id);
555   procedure Analyze (N : Node_Id; Suppress : Check_Id);
556   --  This is the recursive procedure that is applied to individual nodes of
557   --  the tree, starting at the top level node (compilation unit node) and
558   --  then moving down the tree in a top down traversal. It calls individual
559   --  routines with names Analyze_xxx to analyze node xxx. Each of these
560   --  routines is responsible for calling Analyze on the components of the
561   --  subtree.
562   --
563   --  Note: In the case of expression components (nodes whose Nkind is in
564   --  N_Subexpr), the call to Analyze does not complete the semantic analysis
565   --  of the node, since the type resolution cannot be completed until the
566   --  complete context is analyzed. The completion of the type analysis occurs
567   --  in the corresponding Resolve routine (see Sem_Res).
568   --
569   --  Note: for integer and real literals, the analyzer sets the flag to
570   --  indicate that the result is a static expression. If the expander
571   --  generates a literal that does NOT correspond to a static expression,
572   --  e.g. by folding an expression whose value is known at compile time,
573   --  but is not technically static, then the caller should reset the
574   --  Is_Static_Expression flag after analyzing but before resolving.
575   --
576   --  If the Suppress argument is present, then the analysis is done
577   --  with the specified check suppressed (can be All_Checks to suppress
578   --  all checks).
579
580   procedure Analyze_List (L : List_Id);
581   procedure Analyze_List (L : List_Id; Suppress : Check_Id);
582   --  Analyzes each element of a list. If the Suppress argument is present,
583   --  then the analysis is done with the specified check suppressed (can
584   --  be All_Checks to suppress all checks).
585
586   procedure Copy_Suppress_Status
587     (C    : Check_Id;
588      From : Entity_Id;
589      To   : Entity_Id);
590   --  If From is an entity for which check C is explicitly suppressed
591   --  then also explicitly suppress the corresponding check in To.
592
593   procedure Insert_List_After_And_Analyze
594     (N : Node_Id; L : List_Id);
595   procedure Insert_List_After_And_Analyze
596     (N : Node_Id; L : List_Id; Suppress : Check_Id);
597   --  Inserts list L after node N using Nlists.Insert_List_After, and then,
598   --  after this insertion is complete, analyzes all the nodes in the list,
599   --  including any additional nodes generated by this analysis. If the list
600   --  is empty or No_List, the call has no effect. If the Suppress argument is
601   --  present, then the analysis is done with the specified check suppressed
602   --  (can be All_Checks to suppress all checks).
603
604   procedure Insert_List_Before_And_Analyze
605     (N : Node_Id; L : List_Id);
606   procedure Insert_List_Before_And_Analyze
607     (N : Node_Id; L : List_Id; Suppress : Check_Id);
608   --  Inserts list L before node N using Nlists.Insert_List_Before, and then,
609   --  after this insertion is complete, analyzes all the nodes in the list,
610   --  including any additional nodes generated by this analysis. If the list
611   --  is empty or No_List, the call has no effect. If the Suppress argument is
612   --  present, then the analysis is done with the specified check suppressed
613   --  (can be All_Checks to suppress all checks).
614
615   procedure Insert_After_And_Analyze
616     (N : Node_Id; M : Node_Id);
617   procedure Insert_After_And_Analyze
618     (N : Node_Id; M : Node_Id; Suppress : Check_Id);
619   --  Inserts node M after node N and then after the insertion is complete,
620   --  analyzes the inserted node and all nodes that are generated by
621   --  this analysis. If the node is empty, the call has no effect. If the
622   --  Suppress argument is present, then the analysis is done with the
623   --  specified check suppressed (can be All_Checks to suppress all checks).
624
625   procedure Insert_Before_And_Analyze
626     (N : Node_Id; M : Node_Id);
627   procedure Insert_Before_And_Analyze
628     (N : Node_Id; M : Node_Id; Suppress : Check_Id);
629   --  Inserts node M before node N and then after the insertion is complete,
630   --  analyzes the inserted node and all nodes that could be generated by
631   --  this analysis. If the node is empty, the call has no effect. If the
632   --  Suppress argument is present, then the analysis is done with the
633   --  specified check suppressed (can be All_Checks to suppress all checks).
634
635   function External_Ref_In_Generic (E : Entity_Id) return Boolean;
636   --  Return True if we are in the context of a generic and E is
637   --  external (more global) to it.
638
639   procedure Enter_Generic_Scope (S : Entity_Id);
640   --  Shall be called each time a Generic subprogram or package scope is
641   --  entered. S is the entity of the scope.
642   --  ??? At the moment, only called for package specs because this mechanism
643   --  is only used for avoiding freezing of external references in generics
644   --  and this can only be an issue if the outer generic scope is a package
645   --  spec (otherwise all external entities are already frozen)
646
647   procedure Exit_Generic_Scope  (S : Entity_Id);
648   --  Shall be called each time a Generic subprogram or package scope is
649   --  exited. S is the entity of the scope.
650   --  ??? At the moment, only called for package specs exit.
651
652   function Explicit_Suppress (E : Entity_Id; C : Check_Id) return Boolean;
653   --  This function returns True if an explicit pragma Suppress for check C
654   --  is present in the package defining E.
655
656   procedure Preanalyze (N : Node_Id);
657   --  Performs a pre-analysis of node N. During pre-analysis no expansion is
658   --  carried out for N or its children. For more info on pre-analysis read
659   --  the spec of Sem.
660
661   generic
662      with procedure Action (Item : Node_Id);
663   procedure Walk_Library_Items;
664   --  Primarily for use by CodePeer. Must be called after semantic analysis
665   --  (and expansion) are complete. Walks each relevant library item, calling
666   --  Action for each, in an order such that one will not run across forward
667   --  references. Each Item passed to Action is the declaration or body of
668   --  a library unit, including generics and renamings. The first item is
669   --  the N_Package_Declaration node for package Standard. Bodies are not
670   --  included, except for the main unit itself, which always comes last.
671   --
672   --  Item is never a subunit
673   --
674   --  Item is never an instantiation. Instead, the instance declaration is
675   --  passed, and (if the instantiation is the main unit), the instance body.
676
677   ------------------------
678   -- Debugging Routines --
679   ------------------------
680
681   function ss (Index : Int) return Scope_Stack_Entry;
682   pragma Export (Ada, ss);
683   --  "ss" = "scope stack"; returns the Index'th entry in the Scope_Stack
684
685   function sst return Scope_Stack_Entry;
686   pragma Export (Ada, sst);
687   --  "sst" = "scope stack top"; same as ss(Scope_Stack.Last)
688
689end Sem;
690