c++: contracts fixes
[official-gcc.git] / gcc / ada / sinfo.ads
blobc41b0f24742d9d576b12192ebb5c7892c85e8ef5
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S I N F O --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1992-2022, 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 ------------------------------------------------------------------------------
26 -- This package documents the structure of the abstract syntax tree. The Atree
27 -- package provides a basic tree structure. Sinfo describes how this structure
28 -- is used to represent the syntax of an Ada program.
30 -- The grammar in the RM is followed very closely in the tree design, and is
31 -- repeated as part of this source file.
33 -- The tree contains not only the full syntactic representation of the
34 -- program, but also the results of semantic analysis. In particular, the
35 -- nodes for defining identifiers, defining character literals, and defining
36 -- operator symbols, collectively referred to as entities, represent what
37 -- would normally be regarded as the symbol table information. In addition a
38 -- number of the tree nodes contain semantic information.
40 -- See the spec of Gen_IL.Gen for instructions on making changes to this file.
41 -- Note that the official definition of what nodes have what fields is in
42 -- Gen_IL.Gen.Gen_Nodes; if there is a discrepancy between that and the
43 -- comments here, Gen_IL.Gen.Gen_Nodes wins.
45 pragma Warnings (Off); -- with/use clauses for children
46 with Namet; use Namet;
47 with Types; use Types;
48 with Uintp; use Uintp;
49 with Urealp; use Urealp;
50 pragma Warnings (On);
52 package Sinfo is
54 ----------------------------------------
55 -- Definitions of fields in tree node --
56 ----------------------------------------
58 -- The following fields are common to all nodes:
60 -- Nkind Indicates the kind of the node. This field is present
61 -- in all nodes.
63 -- Sloc Location (Source_Ptr) of the corresponding token
64 -- in the Source buffer. The individual node definitions
65 -- show which token is referenced by this pointer.
67 -- In_List A flag used to indicate if the node is a member
68 -- of a node list (see package Nlists).
70 -- Rewrite_Ins A flag set if a node is marked as a rewrite inserted
71 -- node as a result of a call to Mark_Rewrite_Insertion.
73 -- Small_Paren_Count
74 -- A 2-bit count used in subexpression nodes to indicate
75 -- the level of parentheses. The settings are 0,1,2 and
76 -- 3 for many. If the value is 3, then an auxiliary table
77 -- is used to indicate the real value, which is computed by
78 -- Paren_Count. Set to zero for nonsubexpression nodes.
80 -- Note: the required parentheses surrounding conditional
81 -- and quantified expressions count as a level of parens
82 -- for this purpose, so e.g. in X := (if A then B else C);
83 -- Paren_Count for the right side will be 1.
85 -- Comes_From_Check_Or_Contract
86 -- This flag is present in all N_If_Statement nodes and
87 -- gets set when an N_If_Statement is generated as part of
88 -- the expansion of a Check, Assert, or contract-related
89 -- pragma.
91 -- Comes_From_Source
92 -- This flag is present in all nodes. It is set if the
93 -- node is built by the scanner or parser, and clear if
94 -- the node is built by the analyzer or expander. It
95 -- indicates that the node corresponds to a construct
96 -- that appears in the original source program.
98 -- Analyzed This flag is present in all nodes. It is set when
99 -- a node is analyzed, and is used to avoid analyzing
100 -- the same node twice. Analysis includes expansion if
101 -- expansion is active, so in this case if the flag is
102 -- set it means the node has been analyzed and expanded.
104 -- Error_Posted This flag is present in all nodes. It is set when
105 -- an error message is posted which is associated with
106 -- the flagged node. This is used to avoid posting more
107 -- than one message on the same node.
109 -- Link For a node, points to the Parent. For a list, points
110 -- to the list header. Note that in the latter case, a
111 -- client cannot modify the link field. This field is
112 -- private to the Atree package (but is also modified
113 -- by the Nlists package).
115 -- The following additional fields are common to all entities (that is,
116 -- nodes whose Nkind is in N_Entity):
118 -- Ekind Entity type.
120 -- Convention Entity convention (Convention_Id value)
122 --------------------------------
123 -- Implicit Nodes in the Tree --
124 --------------------------------
126 -- Generally the structure of the tree very closely follows the grammar as
127 -- defined in the RM. However, certain nodes are omitted to save space and
128 -- simplify semantic processing. Two general classes of such omitted nodes
129 -- are as follows:
131 -- If the only possibilities for a non-terminal are one or more other
132 -- non-terminals (i.e. the rule is a "skinny" rule), then usually the
133 -- corresponding node is omitted from the tree, and the target construct
134 -- appears directly. For example, a real type definition is either
135 -- floating point definition or a fixed point definition. No explicit node
136 -- appears for real type definition. Instead either the floating point
137 -- definition or fixed point definition appears directly.
139 -- If a non-terminal corresponds to a list of some other non-terminal
140 -- (possibly with separating punctuation), then usually it is omitted from
141 -- the tree, and a list of components appears instead. For example,
142 -- sequence of statements does not appear explicitly in the tree. Instead
143 -- a list of statements appears directly.
145 -- Some additional cases of omitted nodes occur and are documented
146 -- individually. In particular, many nodes are omitted in the tree
147 -- generated for an expression.
149 -------------------------------------------
150 -- Handling of Defining Identifier Lists --
151 -------------------------------------------
153 -- In several declarative forms in the syntax, lists of defining
154 -- identifiers appear (object declarations, component declarations, number
155 -- declarations etc.)
157 -- The semantics of such statements are equivalent to a series of identical
158 -- declarations of single defining identifiers (except that conformance
159 -- checks require the same grouping of identifiers in the parameter case).
161 -- To simplify semantic processing, the parser breaks down such multiple
162 -- declaration cases into sequences of single declarations, duplicating
163 -- type and initialization information as required. The flags More_Ids and
164 -- Prev_Ids are used to record the original form of the source in the case
165 -- where the original source used a list of names, More_Ids being set on
166 -- all but the last name and Prev_Ids being set on all but the first name.
167 -- These flags are used to reconstruct the original source (e.g. in the
168 -- Sprint package), and also are included in the conformance checks, but
169 -- otherwise have no semantic significance.
171 -- Note: the reason that we use More_Ids and Prev_Ids rather than
172 -- First_Name and Last_Name flags is so that the flags are off in the
173 -- normal one identifier case, which minimizes tree print output.
175 -----------------------
176 -- Use of Node Lists --
177 -----------------------
179 -- With a few exceptions, if a construction of the form {non-terminal}
180 -- appears in the tree, lists are used in the corresponding tree node (see
181 -- package Nlists for handling of node lists). In this case a field of the
182 -- parent node points to a list of nodes for the non-terminal. The field
183 -- name for such fields has a plural name which always ends in "s". For
184 -- example, a case statement has a field Alternatives pointing to list of
185 -- case statement alternative nodes.
187 -- Only fields pointing to lists have names ending in "s", so generally the
188 -- structure is strongly typed, fields not ending in s point to single
189 -- nodes, and fields ending in s point to lists.
191 -- The following example shows how a traversal of a list is written. We
192 -- suppose here that Stmt points to a N_Case_Statement node which has a
193 -- list field called Alternatives:
195 -- Alt := First (Alternatives (Stmt));
196 -- while Present (Alt) loop
197 -- ..
198 -- -- processing for case statement alternative Alt
199 -- ..
200 -- Alt := Next (Alt);
201 -- end loop;
203 -- The Present function tests for Empty, which in this case signals the end
204 -- of the list. First returns Empty immediately if the list is empty.
205 -- Present is defined in Atree; First and Next are defined in Nlists.
207 -- The exceptions to this rule occur with {DEFINING_IDENTIFIERS} in all
208 -- contexts, which is handled as described in the previous section, and
209 -- with {,library_unit_NAME} in the N_With_Clause node, which is handled
210 -- using the First_Name and Last_Name flags, as further detailed in the
211 -- description of the N_With_Clause node.
213 -------------
214 -- Pragmas --
215 -------------
217 -- Pragmas can appear in many different context, but are not included in
218 -- the grammar. Still they must appear in the tree, so they can be properly
219 -- processed.
221 -- Two approaches are used. In some cases, an extra field is defined in an
222 -- appropriate node that contains a list of pragmas appearing in the
223 -- expected context. For example pragmas can appear before an
224 -- Accept_Alternative in a Selective_Accept_Statement, and these pragmas
225 -- appear in the Pragmas_Before field of the N_Accept_Alternative node.
227 -- The other approach is to simply allow pragmas to appear in syntactic
228 -- lists where the grammar (of course) does not include the possibility.
229 -- For example, the Variants field of an N_Variant_Part node points to a
230 -- list that can contain both N_Pragma and N_Variant nodes.
232 -- To make processing easier in the latter case, the Nlists package
233 -- provides a set of routines (First_Non_Pragma, Last_Non_Pragma,
234 -- Next_Non_Pragma, Prev_Non_Pragma) that allow such lists to be handled
235 -- ignoring all pragmas.
237 -- In the case of the variants list, we can either write:
239 -- Variant := First (Variants (N));
240 -- while Present (Variant) loop
241 -- ...
242 -- Variant := Next (Variant);
243 -- end loop;
245 -- or
247 -- Variant := First_Non_Pragma (Variants (N));
248 -- while Present (Variant) loop
249 -- ...
250 -- Variant := Next_Non_Pragma (Variant);
251 -- end loop;
253 -- In the first form of the loop, Variant can either be an N_Pragma or an
254 -- N_Variant node. In the second form, Variant can only be N_Variant since
255 -- all pragmas are skipped.
257 ---------------------
258 -- Optional Fields --
259 ---------------------
261 -- Fields which correspond to a section of the syntax enclosed in square
262 -- brackets are generally omitted (and the corresponding field set to Empty
263 -- for a node, or No_List for a list). The documentation of such fields
264 -- notes these cases. One exception to this rule occurs in the case of
265 -- possibly empty statement sequences (such as the sequence of statements
266 -- in an entry call alternative). Such cases appear in the syntax rules as
267 -- [SEQUENCE_OF_STATEMENTS] and the fields corresponding to such optional
268 -- statement sequences always contain an empty list (not No_List) if no
269 -- statements are present.
271 -- Note: the utility program that constructs the body and spec of the Nmake
272 -- package relies on the format of the comments to determine if a field
273 -- should have a default value in the corresponding make routine. The rule
274 -- is that if the first line of the description of the field contains the
275 -- string "(set to xxx if", then a default value of xxx is provided for
276 -- this field in the corresponding Make_yyy routine.
278 -----------------------------------
279 -- Note on Body/Spec Terminology --
280 -----------------------------------
282 -- In informal discussions about Ada, it is customary to refer to package
283 -- and subprogram specs and bodies. However, this is not technically
284 -- correct, what is normally referred to as a spec or specification is in
285 -- fact a package declaration or subprogram declaration. We are careful in
286 -- GNAT to use the correct terminology and in particular, the full word
287 -- specification is never used as an incorrect substitute for declaration.
288 -- The structure and terminology used in the tree also reflects the grammar
289 -- and thus uses declaration and specification in the technically correct
290 -- manner.
292 -- However, there are contexts in which the informal terminology is useful.
293 -- We have the word "body" to refer to the Interp_Etype declared by the
294 -- declaration of a unit body, and in some contexts we need similar term to
295 -- refer to the entity declared by the package or subprogram declaration,
296 -- and simply using declaration can be confusing since the body also has a
297 -- declaration.
299 -- An example of such a context is the link between the package body and
300 -- its declaration. With_Declaration is confusing, since the package body
301 -- itself is a declaration.
303 -- To deal with this problem, we reserve the informal term Spec, i.e. the
304 -- popular abbreviation used in this context, to refer to the entity
305 -- declared by the package or subprogram declaration. So in the above
306 -- example case, the field in the body is called With_Spec.
308 -- Another important context for the use of the word Spec is in error
309 -- messages, where a hyper-correct use of declaration would be confusing to
310 -- a typical Ada programmer, and even for an expert programmer can cause
311 -- confusion since the body has a declaration as well.
313 -- So, to summarize:
315 -- Declaration always refers to the syntactic entity that is called
316 -- a declaration. In particular, subprogram declaration
317 -- and package declaration are used to describe the
318 -- syntactic entity that includes the semicolon.
320 -- Specification always refers to the syntactic entity that is called
321 -- a specification. In particular, the terms procedure
322 -- specification, function specification, package
323 -- specification, subprogram specification always refer
324 -- to the syntactic entity that has no semicolon.
326 -- Spec is an informal term, used to refer to the entity
327 -- that is declared by a task declaration, protected
328 -- declaration, generic declaration, subprogram
329 -- declaration or package declaration.
331 -- This convention is followed throughout the GNAT documentation
332 -- both internal and external, and in all error message text.
334 ------------------------
335 -- Internal Use Nodes --
336 ------------------------
338 -- These are Node_Kind settings used in the internal implementation which
339 -- are not logically part of the specification.
341 -- N_Unused_At_Start
342 -- Completely unused entry at the start of the enumeration type. This
343 -- is inserted so that no legitimate value is zero, which helps to get
344 -- better debugging behavior, since zero is a likely uninitialized value).
346 -- N_Unused_At_End
347 -- Completely unused entry at the end of the enumeration type. This is
348 -- handy so that arrays with Node_Kind as the index type have an extra
349 -- entry at the end (see for example the use of the Pchar_Pos_Array in
350 -- Treepr, where the extra entry provides the limit value when dealing with
351 -- the last used entry in the array).
353 -----------------------------------------
354 -- Note on the settings of Sloc fields --
355 -----------------------------------------
357 -- The Sloc field of nodes that come from the source is set by the parser.
358 -- For internal nodes, and nodes generated during expansion the Sloc is
359 -- usually set in the call to the constructor for the node. In general the
360 -- Sloc value chosen for an internal node is the Sloc of the source node
361 -- whose processing is responsible for the expansion. For example, the Sloc
362 -- of an inherited primitive operation is the Sloc of the corresponding
363 -- derived type declaration.
365 -- For the nodes of a generic instantiation, the Sloc value is encoded to
366 -- represent both the original Sloc in the generic unit, and the Sloc of
367 -- the instantiation itself. See Sinput.ads for details.
369 -- Subprogram instances create two callable entities: one is the visible
370 -- subprogram instance, and the other is an anonymous subprogram nested
371 -- within a wrapper package that contains the renamings for the actuals.
372 -- Both of these entities have the Sloc of the defining entity in the
373 -- instantiation node. This simplified for instance in the past some ASIS
374 -- queries.
376 -----------------------
377 -- Field Definitions --
378 -----------------------
380 -- In the following node definitions, all fields, both syntactic and
381 -- semantic, are documented. The one exception is in the case of entities
382 -- (defining identifiers, character literals, and operator symbols), where
383 -- the usage of the fields depends on the entity kind. Entity fields are
384 -- fully documented in the separate package Einfo.
386 -- In the node definitions, three common sets of fields are abbreviated to
387 -- save both space in the documentation, and also space in the string
388 -- (defined in Tree_Print_Strings) used to print trees. The following
389 -- abbreviations are used:
391 -- "plus fields for binary operator"
392 -- Chars Name_Id for the operator
393 -- Left_Opnd left operand expression
394 -- Right_Opnd right operand expression
395 -- Entity defining entity for operator
396 -- Associated_Node for generic processing
397 -- Do_Overflow_Check set if overflow check needed
398 -- Has_Private_View set in generic units.
400 -- "plus fields for unary operator"
401 -- Chars Name_Id for the operator
402 -- Right_Opnd right operand expression
403 -- Entity defining entity for operator
404 -- Associated_Node for generic processing
405 -- Do_Overflow_Check set if overflow check needed
406 -- Has_Private_View set in generic units.
408 -- "plus fields for expression"
409 -- Paren_Count number of parentheses levels
410 -- Etype type of the expression
411 -- Is_Overloaded >1 type interpretation exists
412 -- Is_Static_Expression set for static expression
413 -- Raises_Constraint_Error evaluation raises CE
414 -- Must_Not_Freeze set if must not freeze
415 -- Do_Range_Check set if a range check needed
416 -- Has_Dynamic_Length_Check set if length check inserted
417 -- Assignment_OK set if modification is OK
418 -- Is_Controlling_Actual set for controlling argument
420 -- Note: see under (EXPRESSION) for further details on the use of
421 -- the Paren_Count field to record the number of parentheses levels.
423 -- Node_Kind is the type used in the Nkind field to indicate the node kind.
424 -- The actual definition of this type is given later (the reason for this
425 -- is that we want the descriptions ordered by logical chapter in the RM,
426 -- but the type definition is reordered to facilitate the definition of
427 -- some subtype ranges. The individual descriptions of the nodes show how
428 -- the various fields are used in each node kind, as well as providing
429 -- logical names for the fields. Functions and procedures are provided for
430 -- accessing and setting these fields using these logical names.
432 -----------------------
433 -- Gigi Restrictions --
434 -----------------------
436 -- The tree passed to Gigi is more restricted than the general tree form.
437 -- For example, as a result of expansion, most of the tasking nodes can
438 -- never appear. For each node to which either a complete or partial
439 -- restriction applies, a note entitled "Gigi restriction" appears which
440 -- documents the restriction.
442 -- Note that most of these restrictions apply only to trees generated when
443 -- code is being generated, since they involve expander actions that
444 -- destroy the tree.
446 ----------------
447 -- Ghost Mode --
448 ----------------
450 -- The SPARK RM 6.9 defines two classes of constructs - Ghost entities and
451 -- Ghost statements. The intent of the feature is to treat Ghost constructs
452 -- as non-existent when Ghost assertion policy Ignore is in effect.
454 -- The corresponding nodes which map to Ghost constructs are:
456 -- Ghost entities
457 -- Declaration nodes
458 -- N_Package_Body
459 -- N_Subprogram_Body
461 -- Ghost statements
462 -- N_Assignment_Statement
463 -- N_Procedure_Call_Statement
464 -- N_Pragma
466 -- In addition, the compiler treats instantiations as Ghost entities
468 -- To achieve the removal of ignored Ghost constructs, the compiler relies
469 -- on global variables Ghost_Mode and Ignored_Ghost_Region, which comprise
470 -- a mechanism called "Ghost regions".
472 -- The values of Ghost_Mode are as follows:
474 -- 1. Check - All static semantics as defined in SPARK RM 6.9 are in
475 -- effect. The Ghost region has mode Check.
477 -- 2. Ignore - Same as Check, ignored Ghost code is not present in ALI
478 -- files, object files, and the final executable. The Ghost region
479 -- has mode Ignore.
481 -- 3. None - No Ghost region is in effect
483 -- The value of Ignored_Ghost_Region captures the node which initiates an
484 -- ignored Ghost region.
486 -- A Ghost region is a compiler operating mode, similar to Check_Syntax,
487 -- however a region is much more finely grained and depends on the policy
488 -- in effect. The region starts prior to the analysis of a Ghost construct
489 -- and ends immediately after its expansion. The region is established as
490 -- follows:
492 -- 1. Declarations - Prior to analysis, if the declaration is subject to
493 -- pragma Ghost.
495 -- 2. Renaming declarations - Same as 1) or when the renamed entity is
496 -- Ghost.
498 -- 3. Completing declarations - Same as 1) or when the declaration is
499 -- partially analyzed and the declaration completes a Ghost entity.
501 -- 4. N_Package_Body, N_Subprogram_Body - Same as 1) or when the body is
502 -- partially analyzed and completes a Ghost entity.
504 -- 5. N_Assignment_Statement - After the left hand side is analyzed and
505 -- references a Ghost entity.
507 -- 6. N_Procedure_Call_Statement - After the name is analyzed and denotes
508 -- a Ghost procedure.
510 -- 7. N_Pragma - During analysis, when the related entity is Ghost or the
511 -- pragma encloses a Ghost entity.
513 -- 8. Instantiations - Save as 1) or when the instantiation is partially
514 -- analyzed and the generic template is Ghost.
516 -- The following routines install a new Ghost region:
518 -- Install_Ghost_Region
519 -- Mark_And_Set_Ghost_xxx
520 -- Set_Ghost_Mode
522 -- The following routine ends a Ghost region:
524 -- Restore_Ghost_Region
526 -- A region may be reinstalled similarly to scopes for decoupled expansion
527 -- such as the generation of dispatch tables or the creation of a predicate
528 -- function.
530 -- If the mode of a Ghost region is Ignore, any newly created nodes as well
531 -- as source entities are marked as ignored Ghost. In addition, the marking
532 -- process signals all enclosing scopes that an ignored Ghost node resides
533 -- within. The compilation unit where the node resides is also added to an
534 -- auxiliary table for post processing.
536 -- After the analysis and expansion of all compilation units takes place
537 -- as well as the instantiation of all inlined [generic] bodies, the GNAT
538 -- driver initiates a separate pass which removes all ignored Ghost nodes
539 -- from all units stored in the auxiliary table.
541 --------------------
542 -- GNATprove Mode --
543 --------------------
545 -- When a file is compiled in GNATprove mode (-gnatd.F), a very light
546 -- expansion is performed and the analysis must generate a tree in a
547 -- form that meets additional requirements.
549 -- This light expansion does two transformations of the tree that cannot
550 -- be postponed till after semantic analysis:
552 -- 1. Replace object renamings by renamed object. This requires the
553 -- introduction of temporaries at the point of the renaming, which
554 -- must be properly analyzed.
556 -- 2. Fully qualify entity names. This is needed to generate suitable
557 -- local effects and call-graphs in ALI files, with the completely
558 -- qualified names (in particular the suffix to distinguish homonyms).
560 -- The tree after this light expansion should be fully analyzed
561 -- semantically, which sometimes requires the insertion of semantic
562 -- preanalysis, for example for subprogram contracts and pragma
563 -- check/assert. In particular, all expressions must have their proper
564 -- type, and semantic links should be set between tree nodes (partial to
565 -- full view, etc.). Some kinds of nodes should be either absent, or can be
566 -- ignored by the formal verification backend:
568 -- N_Object_Renaming_Declaration: can be ignored safely
569 -- N_Expression_Function: absent (rewritten)
570 -- N_Expression_With_Actions: absent (not generated)
572 -- SPARK cross-references are generated from the regular cross-references
573 -- (used for browsing and code understanding) and additional references
574 -- collected during semantic analysis, in particular on all dereferences.
575 -- These SPARK cross-references are output in a separate section of ALI
576 -- files, as described in spark_xrefs.adb. They are the basis for the
577 -- computation of data dependences in GNATprove. This implies that all
578 -- cross-references should be generated in this mode, even those that would
579 -- not make sense from a user point-of-view, and that cross-references that
580 -- do not lead to data dependences for subprograms can be safely ignored.
582 -- GNATprove relies on the following front end behaviors:
584 -- 1. The first declarations in the list of visible declarations of
585 -- a package declaration for a generic instance, up to the first
586 -- declaration which comes from source, should correspond to
587 -- the "mappings nodes" between formal and actual generic parameters.
589 -- 2. In addition pragma Debug statements are removed from the tree
590 -- (rewritten to NULL stmt), since they should be ignored in formal
591 -- verification.
593 -- 3. An error is also issued for missing subunits, similar to the
594 -- warning issued when generating code, to avoid formal verification
595 -- of a partial unit.
597 -- 4. Unconstrained types are not replaced by constrained types whose
598 -- bounds are generated from an expression: Expand_Subtype_From_Expr
599 -- should be a no-op.
601 -- 5. Errors (instead of warnings) are issued on compile-time-known
602 -- constraint errors even though such cases do not correspond to
603 -- illegalities in the Ada RM (this is simply another case where
604 -- GNATprove implements a subset of the full language).
606 -- However, there are a few exceptions to this rule for cases where
607 -- we want to allow the GNATprove analysis to proceed (e.g. range
608 -- checks on empty ranges, which typically appear in deactivated
609 -- code in a particular configuration).
611 -- 6. Subtypes should match in the AST, even after a generic is
612 -- instantiated. In particular, GNATprove relies on the fact that,
613 -- on a selected component, the type of the selected component is
614 -- the type of the corresponding component in the prefix of the
615 -- selected component.
617 -- Note that, in some cases, we know that this rule is broken by the
618 -- frontend. In particular, if the selected component is a packed
619 -- array depending on a discriminant of a unconstrained formal object
620 -- parameter of a generic.
622 ----------------
623 -- SPARK Mode --
624 ----------------
626 -- The SPARK RM 1.6.5 defines a mode of operation called "SPARK mode" which
627 -- starts a scope where the SPARK language semantics are either On, Off, or
628 -- Auto, where Auto leaves the choice to the tools. A SPARK mode may be
629 -- specified by means of an aspect or a pragma.
631 -- The following entities may be subject to a SPARK mode. Entities marked
632 -- with * may possess two different SPARK modes.
634 -- E_Entry
635 -- E_Entry_Family
636 -- E_Function
637 -- E_Generic_Function
638 -- E_Generic_Package *
639 -- E_Generic_Procedure
640 -- E_Operator
641 -- E_Package *
642 -- E_Package_Body *
643 -- E_Procedure
644 -- E_Protected_Body
645 -- E_Protected_Subtype
646 -- E_Protected_Type *
647 -- E_Subprogram_Body
648 -- E_Task_Body
649 -- E_Task_Subtype
650 -- E_Task_Type *
651 -- E_Variable
653 -- In order to manage SPARK scopes, the compiler relies on global variables
654 -- SPARK_Mode and SPARK_Mode_Pragma and a mechanism called "SPARK regions."
655 -- Routines Install_SPARK_Mode and Set_SPARK_Mode create a new SPARK region
656 -- and routine Restore_SPARK_Mode ends a SPARK region. A region may be
657 -- reinstalled similarly to scopes.
659 -----------------------
660 -- Check Flag Fields --
661 -----------------------
663 -- The following flag fields appear in expression nodes:
665 -- Do_Division_Check
666 -- Do_Overflow_Check
667 -- Do_Range_Check
669 -- These three flags are always set by the front end during semantic
670 -- analysis, on expression nodes that may trigger the corresponding
671 -- check. The front end then inserts or not the check during expansion. In
672 -- particular, these flags should also be correctly set in GNATprove mode.
673 -- As a special case, the front end does not insert a Do_Division_Check
674 -- flag on float exponentiation expressions, for the case where the value
675 -- is 0.0 and the exponent is negative, although this case does lead to a
676 -- division check failure. As another special case, the front end does not
677 -- insert a Do_Range_Check on an allocator where the designated type is
678 -- scalar, and the designated type is more constrained than the type of the
679 -- initialized allocator value or the type of the default value for an
680 -- uninitialized allocator.
682 -- Note that the expander always takes care of the Do_Range_Check case, so
683 -- this flag will never be set in the expanded tree passed to the back end.
684 -- For the other two flags, the check can be generated either by the back
685 -- end or by the front end, depending on the setting of a target parameter.
687 -- Note that this accounts for all nodes that trigger the corresponding
688 -- checks, except for range checks on subtype_indications, which may be
689 -- required to check that a range_constraint is compatible with the given
690 -- subtype (RM 3.2.2(11)).
692 -- The following flag fields appear in various nodes:
694 -- Do_Discriminant_Check
695 -- Do_Length_Check
696 -- Do_Storage_Check
698 -- These flags are used in some specific cases by the front end, either
699 -- during semantic analysis or during expansion, and cannot be expected
700 -- to be set on all nodes that trigger the corresponding check.
702 ------------------------
703 -- Common Flag Fields --
704 ------------------------
706 -- The following flag fields appear in all nodes:
708 -- Analyzed
709 -- This flag is used to indicate that a node (and all its children) have
710 -- been analyzed. It is used to avoid reanalysis of a node that has
711 -- already been analyzed, both for efficiency and functional correctness
712 -- reasons.
714 -- Comes_From_Source
715 -- This flag is set if the node comes directly from an explicit construct
716 -- in the source. It is normally on for any nodes built by the scanner or
717 -- parser from the source program, with the exception that in a few cases
718 -- the parser adds nodes to normalize the representation (in particular,
719 -- a null statement is added to a package body if there is no begin/end
720 -- initialization section).
722 -- Most nodes inserted by the analyzer or expander are not considered
723 -- as coming from source, so the flag is off for such nodes. In a few
724 -- cases, the expander constructs nodes closely equivalent to nodes
725 -- from the source program (e.g. the allocator built for build-in-place
726 -- case), and the Comes_From_Source flag is deliberately set.
728 -- Error_Posted
729 -- This flag is used to avoid multiple error messages being posted on or
730 -- referring to the same node. This flag is set if an error message
731 -- refers to a node or is posted on its source location, and has the
732 -- effect of inhibiting further messages involving this same node.
734 -----------------------
735 -- Modify_Tree_For_C --
736 -----------------------
738 -- If the flag Opt.Modify_Tree_For_C is set True, then the tree is modified
739 -- in ways that help match the semantics better with C, easing the task of
740 -- interfacing to C code generators (other than GCC, where the work is done
741 -- in gigi, and there is no point in changing that), and also making life
742 -- easier for Cprint in generating C source code.
744 -- The current modifications implemented are as follows:
746 -- N_Op_Rotate_Left, N_Op_Rotate_Right, N_Shift_Right_Arithmetic nodes
747 -- are eliminated from the tree (since these operations do not exist in
748 -- C), and the operations are rewritten in terms of logical shifts and
749 -- other logical operations that do exist in C. See Exp_Ch4 expansion
750 -- routines for these operators for details of the transformations made.
752 -- The right operand of N_Op_Shift_Right and N_Op_Shift_Left is always
753 -- less than the word size (since other values are not well-defined in
754 -- C). This is done using an explicit test if necessary.
756 -- Min and Max attributes are expanded into equivalent if expressions,
757 -- dealing properly with side effect issues.
759 -- Mod for signed integer types is expanded into equivalent expressions
760 -- using Rem (which is % in C) and other C-available operators.
762 -- Functions returning bounded arrays are transformed into procedures
763 -- with an extra out parameter, and the calls updated accordingly.
765 -- Aggregates are only kept unexpanded for object declarations, otherwise
766 -- they are systematically expanded into loops (for arrays) and
767 -- individual assignments (for records).
769 -- Unconstrained array types are handled by means of fat pointers.
771 -- Postconditions are inlined by the frontend since their body may have
772 -- references to itypes defined in the enclosing subprogram.
774 ------------------------------------
775 -- Description of Semantic Fields --
776 ------------------------------------
778 -- The meaning of the syntactic fields is generally clear from their names
779 -- without any further description, since the names are chosen to
780 -- correspond very closely to the syntax in the reference manual. This
781 -- section describes the usage of the semantic fields, which are used to
782 -- contain additional information determined during semantic analysis.
784 -- Accept_Handler_Records
785 -- This field is present only in an N_Accept_Alternative node. It is used
786 -- to temporarily hold the exception handler records from an accept
787 -- statement in a selective accept. These exception handlers will
788 -- eventually be placed in the Handler_Records list of the procedure
789 -- built for this accept (see Expand_N_Selective_Accept procedure in
790 -- Exp_Ch9 for further details).
792 -- Access_Types_To_Process
793 -- Present in N_Freeze_Entity nodes for Incomplete or private types.
794 -- Contains the list of access types which may require specific treatment
795 -- when the nature of the type completion is completely known. An example
796 -- of such treatment is the generation of the associated_final_chain.
798 -- Actions
799 -- This field contains a sequence of actions that are associated with the
800 -- node holding the field. See the individual node types for details of
801 -- how this field is used, as well as the description of the specific use
802 -- for a particular node type.
804 -- Activation_Chain_Entity
805 -- This is used in tree nodes representing task activators (blocks,
806 -- subprogram bodies, package declarations, and task bodies). It is
807 -- initially Empty, and then gets set to point to the entity for the
808 -- declared Activation_Chain variable when the first task is declared.
809 -- When tasks are declared in the corresponding declarative region this
810 -- entity is located by name (its name is always _Chain) and the declared
811 -- tasks are added to the chain. Note that N_Extended_Return_Statement
812 -- does not have this attribute, although it does have an activation
813 -- chain. This chain is used to store the tasks temporarily, and is not
814 -- used for activating them. On successful completion of the return
815 -- statement, the tasks are moved to the caller's chain, and the caller
816 -- activates them.
818 -- Acts_As_Spec
819 -- A flag set in the N_Subprogram_Body node for a subprogram body which
820 -- is acting as its own spec. In the case of a library-level subprogram
821 -- the flag is set as well on the parent compilation unit node.
823 -- Actual_Designated_Subtype
824 -- Present in N_Free_Statement and N_Explicit_Dereference nodes. If gigi
825 -- needs to know the dynamic constrained subtype of the designated
826 -- object, this attribute is set to that subtype. This is done for
827 -- N_Free_Statements for access-to-classwide types and access-to-
828 -- unconstrained packed array types. For N_Explicit_Dereference,
829 -- this is done in two circumstances: 1) when the designated type is
830 -- an unconstrained packed array and the dereference is the prefix of
831 -- a 'Size attribute reference, or 2) when the dereference node is
832 -- created for the expansion of an allocator with a subtype_indication
833 -- and the designated subtype is an unconstrained discriminated type.
835 -- Address_Warning_Posted
836 -- Present in N_Attribute_Definition nodes. Set to indicate that we have
837 -- posted a warning for the address clause regarding size or alignment
838 -- issues. Used to inhibit multiple redundant messages.
840 -- Aggregate_Bounds
841 -- Present in array N_Aggregate nodes. If the bounds of the aggregate are
842 -- known at compile time, this field points to an N_Range node with those
843 -- bounds. Otherwise Empty.
845 -- Alloc_For_BIP_Return
846 -- Present in N_Allocator nodes. True if the allocator is one of those
847 -- generated for a build-in-place return statement.
849 -- All_Others
850 -- Present in an N_Others_Choice node. This flag is set for an others
851 -- exception where all exceptions are to be caught, even those that are
852 -- not normally handled (in particular the tasking abort signal). This
853 -- is used for translation of the at end handler into a normal exception
854 -- handler.
856 -- Aspect_On_Partial_View
857 -- Present on an N_Aspect_Specification node. For an aspect that applies
858 -- to a type entity, indicates whether the specification appears on the
859 -- partial view of a private type or extension. Undefined for aspects
860 -- that apply to other entities.
862 -- Aspect_Rep_Item
863 -- Present in N_Aspect_Specification nodes. Points to the corresponding
864 -- pragma/attribute definition node used to process the aspect.
866 -- Assignment_OK
867 -- This flag is set in a subexpression node for an object, indicating
868 -- that the associated object can be modified, even if this would not
869 -- normally be permissible (either by direct assignment, or by being
870 -- passed as an out or in-out parameter). This is used by the expander
871 -- for a number of purposes, including initialization of constants and
872 -- limited type objects (such as tasks), setting discriminant fields,
873 -- setting tag values, etc. N_Object_Declaration nodes also have this
874 -- flag defined. Here it is used to indicate that an initialization
875 -- expression is valid, even where it would normally not be allowed
876 -- (e.g. where the type involved is limited). It is also used to stop
877 -- a Force_Evaluation call for an unchecked conversion, but this usage
878 -- is unclear and not documented ???
880 -- Associated_Node
881 -- Present in nodes that can denote an entity: identifiers, character
882 -- literals, operator symbols, expanded names, operator nodes, and
883 -- attribute reference nodes (all these nodes have an Entity field).
884 -- This field is also present in N_Aggregate, N_Selected_Component, and
885 -- N_Extension_Aggregate nodes. This field is used in generic processing
886 -- to create links between the generic template and the generic copy.
887 -- See Sem_Ch12.Get_Associated_Node for full details. Note that this
888 -- field overlaps Entity, which is fine, since, as explained in Sem_Ch12,
889 -- the normal function of Entity is not required at the point where the
890 -- Associated_Node is set. Note also, that in generic templates, this
891 -- means that the Entity field does not necessarily point to an Entity.
892 -- Since the back end is expected to ignore generic templates, this is
893 -- harmless.
895 -- Atomic_Sync_Required
896 -- This flag is set on a node for which atomic synchronization is
897 -- required for the corresponding reference or modification.
899 -- At_End_Proc
900 -- This field is present in N_Handled_Sequence_Of_Statements,
901 -- N_Package_Body, N_Subprogram_Body, N_Task_Body, N_Block_Statement,
902 -- and N_Entry_Body.
903 -- It contains an identifier reference for the cleanup procedure to be
904 -- called. See description of N_Handled_Sequence_Of_Statements node
905 -- for further details.
907 -- Backwards_OK
908 -- A flag present in the N_Assignment_Statement node. It is used only
909 -- if the type being assigned is an array type, and is set if analysis
910 -- determines that it is definitely safe to do the copy backwards, i.e.
911 -- starting at the highest addressed element. This is the case if either
912 -- the operands do not overlap, or they may overlap, but if they do,
913 -- then the left operand is at a higher address than the right operand.
915 -- Note: If neither of the flags Forwards_OK or Backwards_OK is set, it
916 -- means that the front end could not determine that either direction is
917 -- definitely safe, and a runtime check may be required if the backend
918 -- cannot figure it out. If both flags Forwards_OK and Backwards_OK are
919 -- set, it means that the front end can assure no overlap of operands.
921 -- Body_To_Inline
922 -- Present in subprogram declarations. Denotes analyzed but unexpanded
923 -- body of subprogram, to be used when inlining calls. Present when the
924 -- subprogram has an Inline pragma and inlining is enabled. If the
925 -- declaration is completed by a renaming_as_body, and the renamed entity
926 -- is a subprogram, the Body_To_Inline is the name of that entity, which
927 -- is used directly in later calls to the original subprogram.
929 -- Body_Required
930 -- A flag that appears in the N_Compilation_Unit node indicating that
931 -- the corresponding unit requires a body. For the package case, this
932 -- indicates that a completion is required. In Ada 95, if the flag is not
933 -- set for the package case, then a body may not be present. In Ada 83,
934 -- if the flag is not set for the package case, then body is optional.
935 -- For a subprogram declaration, the flag is set except in the case where
936 -- a pragma Import or Interface applies, in which case no body is
937 -- permitted (in Ada 83 or Ada 95).
939 -- Cleanup_Actions
940 -- Present in block statements created for transient blocks, contains
941 -- additional cleanup actions carried over from the transient scope.
943 -- Check_Address_Alignment
944 -- A flag present in N_Attribute_Definition clause for a 'Address
945 -- attribute definition. This flag is set if a dynamic check should be
946 -- generated at the freeze point for the entity to which this address
947 -- clause applies. The reason that we need this flag is that we want to
948 -- check for range checks being suppressed at the point where the
949 -- attribute definition clause is given, rather than testing this at the
950 -- freeze point.
952 -- Comes_From_Extended_Return_Statement
953 -- Present in N_Simple_Return_Statement nodes. True if this node was
954 -- constructed as part of the N_Extended_Return_Statement expansion.
956 -- Compile_Time_Known_Aggregate
957 -- Present in N_Aggregate nodes. Set for aggregates which can be fully
958 -- evaluated at compile time without raising constraint error. Such
959 -- aggregates can be passed as is to the back end without any expansion.
960 -- See Exp_Aggr for specific conditions under which this flag gets set.
962 -- Componentwise_Assignment
963 -- Present in N_Assignment_Statement nodes. Set for a record assignment
964 -- where all that needs doing is to expand it into component-by-component
965 -- assignments. This is used internally for the case of tagged types with
966 -- rep clauses, where we need to avoid recursion (we don't want to try to
967 -- generate a call to the primitive operation, because this is the case
968 -- where we are compiling the primitive operation). Note that when we are
969 -- expanding component assignments in this case, we never assign the _tag
970 -- field, but we recursively assign components of the parent type.
972 -- Condition_Actions
973 -- This field appears in else-if nodes and in the iteration scheme node
974 -- for while loops. This field is only used during semantic processing to
975 -- temporarily hold actions inserted into the tree. In the tree passed
976 -- to gigi, the condition actions field is always set to No_List. For
977 -- details on how this field is used, see the routine Insert_Actions in
978 -- package Exp_Util, and also the expansion routines for the relevant
979 -- nodes.
981 -- Context_Pending
982 -- This field appears in Compilation_Unit nodes, to indicate that the
983 -- context of the unit is being compiled. Used to detect circularities
984 -- that are not otherwise detected by the loading mechanism. Such
985 -- circularities can occur in the presence of limited and non-limited
986 -- with_clauses that mention the same units.
988 -- Controlling_Argument
989 -- This field is set in procedure and function call nodes if the call
990 -- is a dispatching call (it is Empty for a non-dispatching call). It
991 -- indicates the source of the call's controlling tag. For procedure
992 -- calls, the Controlling_Argument is one of the actuals. For function
993 -- that has a dispatching result, it is an entity in the context of the
994 -- call that can provide a tag, or else it is the tag of the root type
995 -- of the class. It can also specify a tag directly rather than being a
996 -- tagged object. The latter is needed by the implementations of AI-239
997 -- and AI-260.
999 -- Conversion_OK
1000 -- A flag set on type conversion nodes to indicate that the conversion
1001 -- is to be considered as being valid, even though it is the case that
1002 -- the conversion is not valid Ada. This is used for attributes Enum_Rep,
1003 -- Pos, Val, Fixed_Value and Integer_Value, for internal conversions done
1004 -- for fixed-point operations, and for certain conversions for calls to
1005 -- initialization procedures. If Conversion_OK is set, then Etype must be
1006 -- set (the analyzer assumes that Etype has been set). For the case of
1007 -- fixed-point operands, it also indicates that the conversion is to be
1008 -- direct conversion of the underlying integer result, with no regard to
1009 -- the small operand.
1011 -- Corresponding_Aspect
1012 -- Present in N_Pragma node. Used to point back to the source aspect from
1013 -- the corresponding pragma. This field is Empty for source pragmas.
1015 -- Corresponding_Body
1016 -- This field is set in subprogram declarations, package declarations,
1017 -- entry declarations of protected types, and in generic units. It points
1018 -- to the defining entity for the corresponding body (NOT the node for
1019 -- the body itself).
1021 -- Corresponding_Entry_Body
1022 -- Defined in N_Subprogram_Body. Set for subprogram bodies that implement
1023 -- a protected type entry; points to the body for the entry.
1025 -- Corresponding_Formal_Spec
1026 -- This field is set in subprogram renaming declarations, where it points
1027 -- to the defining entity for a formal subprogram in the case where the
1028 -- renaming corresponds to a generic formal subprogram association in an
1029 -- instantiation. The field is Empty if the renaming does not correspond
1030 -- to such a formal association.
1032 -- Corresponding_Generic_Association
1033 -- This field is defined for object declarations and object renaming
1034 -- declarations. It is set for the declarations within an instance that
1035 -- map generic formals to their actuals. If set, the field points either
1036 -- to a copy of a default expression for an actual of mode IN or to a
1037 -- generic_association which is the original parent of the expression or
1038 -- name appearing in the declaration. This simplifies GNATprove queries.
1040 -- Corresponding_Integer_Value
1041 -- This field is set in real literals of fixed-point types (it is not
1042 -- used for floating-point types). It contains the integer value used
1043 -- to represent the fixed-point value. It is also set on the universal
1044 -- real literals used to represent bounds of fixed-point base types
1045 -- and their first named subtypes.
1047 -- Corresponding_Spec
1048 -- This field is set in subprogram, package, task, and protected body
1049 -- nodes, where it points to the defining entity in the corresponding
1050 -- spec. The attribute is also set in N_With_Clause nodes where it points
1051 -- to the defining entity for the with'ed spec, and in a subprogram
1052 -- renaming declaration when it is a Renaming_As_Body. The field is Empty
1053 -- if there is no corresponding spec, as in the case of a subprogram body
1054 -- that serves as its own spec.
1056 -- In Ada 2012, Corresponding_Spec is set on expression functions that
1057 -- complete a subprogram declaration.
1059 -- Corresponding_Spec_Of_Stub
1060 -- This field is present in subprogram, package, task, and protected body
1061 -- stubs where it points to the corresponding spec of the stub. Due to
1062 -- clashes in the structure of nodes, we cannot use Corresponding_Spec.
1064 -- Corresponding_Stub
1065 -- This field is present in an N_Subunit node. It holds the node in
1066 -- the parent unit that is the stub declaration for the subunit. It is
1067 -- set when analysis of the stub forces loading of the proper body. If
1068 -- expansion of the proper body creates new declarative nodes, they are
1069 -- inserted at the point of the corresponding_stub.
1071 -- Dcheck_Function
1072 -- This field is present in an N_Variant node, It references the entity
1073 -- for the discriminant checking function for the variant.
1075 -- Default_Expression
1076 -- This field is Empty if there is no default expression. If there is a
1077 -- simple default expression (one with no side effects), then this field
1078 -- simply contains a copy of the Expression field (both point to the tree
1079 -- for the default expression). Default_Expression is used for
1080 -- conformance checking.
1082 -- Default_Storage_Pool
1083 -- This field is present in N_Compilation_Unit_Aux nodes. It is set to a
1084 -- copy of Opt.Default_Pool at the end of the compilation unit. See
1085 -- package Opt for details. This is used for inheriting the
1086 -- Default_Storage_Pool in child units.
1088 -- Discr_Check_Funcs_Built
1089 -- This flag is present in N_Full_Type_Declaration nodes. It is set when
1090 -- discriminant checking functions are constructed. The purpose is to
1091 -- avoid attempting to set these functions more than once.
1093 -- Do_Discriminant_Check
1094 -- This flag is set on N_Selected_Component nodes to indicate that a
1095 -- discriminant check is required using the discriminant check routine
1096 -- associated with the selector. The actual check is generated by the
1097 -- expander when processing selected components. In the case of
1098 -- Unchecked_Union, the flag is also set, but no discriminant check
1099 -- routine is associated with the selector, and the expander does not
1100 -- generate a check. This flag is also present in assignment statements
1101 -- (and set if the assignment requires a discriminant check), and in type
1102 -- conversion nodes (and set if the conversion requires a check).
1104 -- Do_Division_Check
1105 -- This flag is set on a division operator (/ mod rem) to indicate that
1106 -- a zero divide check is required. The actual check is either dealt with
1107 -- by the back end if Backend_Divide_Checks is set to true, or by the
1108 -- front end itself if it is set to false.
1110 -- Do_Length_Check
1111 -- This flag is set in an N_Assignment_Statement, N_Op_And, N_Op_Or,
1112 -- N_Op_Xor, or N_Type_Conversion node to indicate that a length check
1113 -- is required. It is not determined who deals with this flag (???).
1115 -- Do_Overflow_Check
1116 -- This flag is set on an operator where an overflow check is required on
1117 -- the operation. The actual check is either dealt with by the back end
1118 -- if Backend_Overflow_Checks is set to true, or by the front end itself
1119 -- if it is set to false. The other cases where this flag is used is on a
1120 -- Type_Conversion node as well on if and case expression nodes.
1121 -- For a type conversion, it means that the conversion is from one base
1122 -- type to another, and the value may not fit in the target base type.
1123 -- See also the description of Do_Range_Check for this case. This flag is
1124 -- also set on if and case expression nodes if we are operating in either
1125 -- MINIMIZED or ELIMINATED overflow checking mode (to make sure that we
1126 -- properly process overflow checking for dependent expressions).
1128 -- Do_Range_Check
1129 -- This flag is set on an expression which appears in a context where a
1130 -- range check is required. The target type is clear from the context.
1131 -- The contexts in which this flag can appear are the following:
1133 -- Right side of an assignment. In this case the target type is taken
1134 -- from the left side of the assignment, which is referenced by the
1135 -- Name of the N_Assignment_Statement node.
1137 -- Subscript expressions in an indexed component. In this case the
1138 -- target type is determined from the type of the array, which is
1139 -- referenced by the Prefix of the N_Indexed_Component node.
1141 -- Argument expression for a parameter, appearing either directly in
1142 -- the Parameter_Associations list of a call or as the Expression of an
1143 -- N_Parameter_Association node that appears in this list. In either
1144 -- case, the check is against the type of the formal. Note that the
1145 -- flag is relevant only in IN and IN OUT parameters, and will be
1146 -- ignored for OUT parameters, where no check is required in the call,
1147 -- and if a check is required on the return, it is generated explicitly
1148 -- with a type conversion.
1150 -- Initialization expression for the initial value in an object
1151 -- declaration. In this case the Do_Range_Check flag is set on
1152 -- the initialization expression, and the check is against the
1153 -- range of the type of the object being declared. This includes the
1154 -- cases of expressions providing default discriminant values, and
1155 -- expressions used to initialize record components.
1157 -- The expression of a type conversion. In this case the range check is
1158 -- against the target type of the conversion. See also the use of
1159 -- Do_Overflow_Check on a type conversion. The distinction is that the
1160 -- overflow check protects against a value that is outside the range of
1161 -- the target base type, whereas a range check checks that the
1162 -- resulting value (which is a value of the base type of the target
1163 -- type), satisfies the range constraint of the target type.
1165 -- Note: when a range check is required in contexts other than those
1166 -- listed above (e.g. in a return statement), an additional type
1167 -- conversion node is introduced to represent the required check.
1169 -- Do_Storage_Check
1170 -- This flag is set in an N_Allocator node to indicate that a storage
1171 -- check is required for the allocation, or in an N_Subprogram_Body node
1172 -- to indicate that a stack check is required in the subprogram prologue.
1173 -- The N_Allocator case is handled by the routine that expands the call
1174 -- to the runtime routine. The N_Subprogram_Body case is handled by the
1175 -- backend, and all the semantics does is set the flag.
1177 -- Elaborate_Present
1178 -- This flag is set in the N_With_Clause node to indicate that pragma
1179 -- Elaborate pragma appears for the with'ed units.
1181 -- Elaborate_All_Desirable
1182 -- This flag is set in the N_With_Clause mode to indicate that the static
1183 -- elaboration processing has determined that an Elaborate_All pragma is
1184 -- desirable for correct elaboration for this unit.
1186 -- Elaborate_All_Present
1187 -- This flag is set in the N_With_Clause node to indicate that a
1188 -- pragma Elaborate_All pragma appears for the with'ed units.
1190 -- Elaborate_Desirable
1191 -- This flag is set in the N_With_Clause mode to indicate that the static
1192 -- elaboration processing has determined that an Elaborate pragma is
1193 -- desirable for correct elaboration for this unit.
1195 -- Else_Actions
1196 -- This field is present in if expression nodes. During code
1197 -- expansion we use the Insert_Actions procedure (in Exp_Util) to insert
1198 -- actions at an appropriate place in the tree to get elaborated at the
1199 -- right time. For if expressions, we have to be sure that the actions
1200 -- for the Else branch are only elaborated if the condition is False.
1201 -- The Else_Actions field is used as a temporary parking place for
1202 -- these actions. The final tree is always rewritten to eliminate the
1203 -- need for this field, so in the tree passed to Gigi, this field is
1204 -- always set to No_List.
1206 -- Enclosing_Variant
1207 -- This field is present in the N_Variant node and identifies the Node_Id
1208 -- corresponding to the immediately enclosing variant when the variant is
1209 -- nested, and N_Empty otherwise. Set during semantic processing of the
1210 -- variant part of a record type.
1212 -- Entity
1213 -- Appears in all direct names (identifiers, character literals, and
1214 -- operator symbols), as well as expanded names, and attributes that
1215 -- denote entities, such as 'Class. Points to entity for corresponding
1216 -- defining occurrence. Set after name resolution. For identifiers in a
1217 -- WITH list, the corresponding defining occurrence is in a separately
1218 -- compiled file, and Entity must be set by the library Load procedure.
1220 -- Note: During name resolution, the value in Entity may be temporarily
1221 -- incorrect (e.g. during overload resolution, Entity is initially set to
1222 -- the first possible correct interpretation, and then later modified if
1223 -- necessary to contain the correct value after resolution).
1225 -- Note: This field overlaps Associated_Node, which is used during
1226 -- generic processing (see Sem_Ch12 for details). Note also that in
1227 -- generic templates, this means that the Entity field does not always
1228 -- point to an Entity. Since the back end is expected to ignore generic
1229 -- templates, this is harmless.
1231 -- Note: This field also appears in N_Attribute_Definition_Clause nodes.
1232 -- It is used only for stream attributes definition clauses. In this
1233 -- case, it denotes a (possibly dummy) subprogram entity that is declared
1234 -- conceptually at the point of the clause. Thus the visibility of the
1235 -- attribute definition clause (in the sense of 8.3(23) as amended by
1236 -- AI-195) can be checked by testing the visibility of that subprogram.
1238 -- Note: Normally the Entity field of an identifier points to the entity
1239 -- for the corresponding defining identifier, and hence the Chars field
1240 -- of an identifier will match the Chars field of the entity. However,
1241 -- there is no requirement that these match, and there are obscure cases
1242 -- of generated code where they do not match.
1244 -- Note: Ada 2012 aspect specifications require additional links between
1245 -- identifiers and various attributes. These attributes can be of
1246 -- arbitrary types, and the entity field of identifiers that denote
1247 -- aspects must be used to store arbitrary expressions for later semantic
1248 -- checks. See section on aspect specifications for details.
1250 -- Entity_Or_Associated_Node
1251 -- A synonym for both Entity and Associated_Node. Used by convention in
1252 -- the code when referencing this field in cases where it is not known
1253 -- whether the field contains an Entity or an Associated_Node.
1255 -- Etype
1256 -- Appears in all expression nodes, all direct names, and all entities.
1257 -- Points to the entity for the related type. Set after type resolution.
1258 -- Normally this is the actual subtype of the expression. However, in
1259 -- certain contexts such as the right side of an assignment, subscripts,
1260 -- arguments to calls, returned value in a function, initial value etc.
1261 -- it is the desired target type. In the event that this is different
1262 -- from the actual type, the Do_Range_Check flag will be set if a range
1263 -- check is required. Note: if the Is_Overloaded flag is set, then Etype
1264 -- points to an essentially arbitrary choice from the possible set of
1265 -- types.
1267 -- Exception_Junk
1268 -- This flag is set in a various nodes appearing in a statement sequence
1269 -- to indicate that the corresponding node is an artifact of the
1270 -- generated code for exception handling, and should be ignored when
1271 -- analyzing the control flow of the relevant sequence of statements
1272 -- (e.g. to check that it does not end with a bad return statement).
1274 -- Exception_Label
1275 -- Appears in N_Push_xxx_Label nodes. Points to the entity of the label
1276 -- to be used for transforming the corresponding exception into a goto,
1277 -- or contains Empty, if this exception is not to be transformed. Also
1278 -- appears in N_Exception_Handler nodes, where, if set, it indicates
1279 -- that there may be a local raise for the handler, so that expansion
1280 -- to allow a goto is required (and this field contains the label for
1281 -- this goto). See Exp_Ch11.Expand_Local_Exception_Handlers for details.
1283 -- Expansion_Delayed
1284 -- Set on aggregates and extension aggregates that need a top-down rather
1285 -- than bottom-up expansion. Typically aggregate expansion happens bottom
1286 -- up. For nested aggregates the expansion is delayed until the enclosing
1287 -- aggregate itself is expanded, e.g. in the context of a declaration. To
1288 -- delay it we set this flag. This is done to avoid creating a temporary
1289 -- for each level of a nested aggregate, and also to prevent the
1290 -- premature generation of constraint checks. This is also a requirement
1291 -- if we want to generate the proper attachment to the internal
1292 -- finalization lists (for record with controlled components). Top down
1293 -- expansion of aggregates is also used for in-place array aggregate
1294 -- assignment or initialization. When the full context is known, the
1295 -- target of the assignment or initialization is used to generate the
1296 -- left-hand side of individual assignment to each subcomponent.
1298 -- Expression_Copy
1299 -- Present in N_Pragma_Argument_Association nodes. Contains a copy of the
1300 -- original expression. This field is best used to store pragma-dependent
1301 -- modifications performed on the original expression such as replacement
1302 -- of the current type instance or substitutions of primitives.
1304 -- First_Inlined_Subprogram
1305 -- Present in the N_Compilation_Unit node for the main program. Points
1306 -- to a chain of entities for subprograms that are to be inlined. The
1307 -- Next_Inlined_Subprogram field of these entities is used as a link
1308 -- pointer with Empty marking the end of the list. This field is Empty
1309 -- if there are no inlined subprograms or inlining is not active.
1311 -- First_Named_Actual
1312 -- Present in procedure call statement and function call nodes, and also
1313 -- in Intrinsic nodes. Set during semantic analysis to point to the first
1314 -- named parameter where parameters are ordered by declaration order (as
1315 -- opposed to the actual order in the call which may be different due to
1316 -- named associations). Note: this field points to the explicit actual
1317 -- parameter itself, not the N_Parameter_Association node (its parent).
1319 -- First_Subtype_Link
1320 -- Present in N_Freeze_Entity node for an anonymous base type that is
1321 -- implicitly created by the declaration of a first subtype. It points
1322 -- to the entity for the first subtype.
1324 -- Float_Truncate
1325 -- A flag present in type conversion nodes. This is used for float to
1326 -- integer conversions where truncation is required rather than rounding.
1328 -- Forwards_OK
1329 -- A flag present in the N_Assignment_Statement node. It is used only
1330 -- if the type being assigned is an array type, and is set if analysis
1331 -- determines that it is definitely safe to do the copy forwards, i.e.
1332 -- starting at the lowest addressed element. This is the case if either
1333 -- the operands do not overlap, or they may overlap, but if they do,
1334 -- then the left operand is at a lower address than the right operand.
1336 -- Note: If neither of the flags Forwards_OK or Backwards_OK is set, it
1337 -- means that the front end could not determine that either direction is
1338 -- definitely safe, and a runtime check may be required if the backend
1339 -- cannot figure it out. If both flags Forwards_OK and Backwards_OK are
1340 -- set, it means that the front end can assure no overlap of operands.
1342 -- From_Aspect_Specification
1343 -- Processing of aspect specifications typically results in insertion in
1344 -- the tree of corresponding pragma or attribute definition clause nodes.
1345 -- These generated nodes have the From_Aspect_Specification flag set to
1346 -- indicate that they came from aspect specifications originally.
1348 -- From_At_Mod
1349 -- This flag is set on the attribute definition clause node that is
1350 -- generated by a transformation of an at mod phrase in a record
1351 -- representation clause. This is used to give slightly different (Ada 83
1352 -- compatible) semantics to such a clause, namely it is used to specify a
1353 -- minimum acceptable alignment for the base type and all subtypes. In
1354 -- Ada 95 terms, the actual alignment of the base type and all subtypes
1355 -- must be a multiple of the given value, and the representation clause
1356 -- is considered to be type specific instead of subtype specific.
1358 -- From_Conditional_Expression
1359 -- This flag is set on if and case statements generated by the expansion
1360 -- of if and case expressions respectively. The flag is used to suppress
1361 -- any finalization of controlled objects found within these statements.
1363 -- From_Default
1364 -- This flag is set on the subprogram renaming declaration created in an
1365 -- instance for a formal subprogram, when the formal is declared with a
1366 -- box, and there is no explicit actual. If the flag is present, the
1367 -- declaration is treated as an implicit reference to the formal in the
1368 -- ali file.
1370 -- Generalized_Indexing
1371 -- Present in N_Indexed_Component nodes. Set for Indexed_Component nodes
1372 -- that are Ada 2012 container indexing operations. The value of the
1373 -- attribute is a function call (possibly dereferenced) that corresponds
1374 -- to the proper expansion of the source indexing operation. Before
1375 -- expansion, the source node is rewritten as the resolved generalized
1376 -- indexing.
1378 -- Generic_Parent
1379 -- Generic_Parent is defined on declaration nodes that are instances. The
1380 -- value of Generic_Parent is the generic entity from which the instance
1381 -- is obtained.
1383 -- Generic_Parent_Type
1384 -- Generic_Parent_Type is defined on Subtype_Declaration nodes for the
1385 -- actuals of formal private and derived types. Within the instance, the
1386 -- operations on the actual are those inherited from the parent. For a
1387 -- formal private type, the parent type is the generic type itself. The
1388 -- Generic_Parent_Type is also used in an instance to determine whether a
1389 -- private operation overrides an inherited one.
1391 -- Handler_List_Entry
1392 -- This field is present in N_Object_Declaration nodes. It is set only
1393 -- for the Handler_Record entry generated for an exception in zero cost
1394 -- exception handling mode. It references the corresponding item in the
1395 -- handler list, and is used to delete this entry if the corresponding
1396 -- handler is deleted during optimization. For further details on why
1397 -- this is required, see Exp_Ch11.Remove_Handler_Entries.
1399 -- Has_Dereference_Action
1400 -- This flag is present in N_Explicit_Dereference nodes. It is set to
1401 -- indicate that the expansion has aready produced a call to primitive
1402 -- Dereference of a System.Checked_Pools.Checked_Pool implementation.
1403 -- Such dereference actions are produced for debugging purposes.
1405 -- Has_Dynamic_Length_Check
1406 -- This flag is present in all expression nodes. It is set to indicate
1407 -- that one of the routines in unit Checks has generated a length check
1408 -- action which has been inserted at the flagged node. This is used to
1409 -- avoid the generation of duplicate checks.
1411 -- Has_Local_Raise
1412 -- Present in exception handler nodes. Set if the handler can be entered
1413 -- via a local raise that gets transformed to a goto statement. This will
1414 -- always be set if Local_Raise_Statements is non-empty, but can also be
1415 -- set as a result of generation of N_Raise_xxx nodes, or flags set in
1416 -- nodes requiring generation of back end checks.
1418 -- Has_No_Elaboration_Code
1419 -- A flag that appears in the N_Compilation_Unit node to indicate whether
1420 -- or not elaboration code is present for this unit. It is initially set
1421 -- true for subprogram specs and bodies and for all generic units and
1422 -- false for non-generic package specs and bodies. Gigi may set the flag
1423 -- in the non-generic package case if it determines that no elaboration
1424 -- code is generated. Note that this flag is not related to the
1425 -- Is_Preelaborated status, there can be preelaborated packages that
1426 -- generate elaboration code, and non-preelaborated packages which do
1427 -- not generate elaboration code.
1429 -- Has_Pragma_Suppress_All
1430 -- This flag is set in an N_Compilation_Unit node if the Suppress_All
1431 -- pragma appears anywhere in the unit. This accommodates the rather
1432 -- strange placement rules of other compilers (DEC permits it at the
1433 -- end of a unit, and Rational allows it as a program unit pragma). We
1434 -- allow it anywhere at all, and consider it equivalent to a pragma
1435 -- Suppress (All_Checks) appearing at the start of the configuration
1436 -- pragmas for the unit.
1438 -- Has_Private_View
1439 -- A flag present in generic nodes that have an entity, to indicate that
1440 -- the node has a private type. Used to exchange private and full
1441 -- declarations if the visibility at instantiation is different from the
1442 -- visibility at generic definition.
1444 -- Has_Relative_Deadline_Pragma
1445 -- A flag present in N_Subprogram_Body and N_Task_Definition nodes to
1446 -- flag the presence of a pragma Relative_Deadline.
1448 -- Has_Self_Reference
1449 -- Present in N_Aggregate and N_Extension_Aggregate. Indicates that one
1450 -- of the expressions contains an access attribute reference to the
1451 -- enclosing type. Such a self-reference can only appear in default-
1452 -- initialized aggregate for a record type.
1454 -- Has_SP_Choice
1455 -- Present in all nodes containing a Discrete_Choices field (N_Variant,
1456 -- N_Case_Expression_Alternative, N_Case_Statement_Alternative). Set to
1457 -- True if the Discrete_Choices list has at least one occurrence of a
1458 -- statically predicated subtype.
1460 -- Has_Storage_Size_Pragma
1461 -- A flag present in an N_Task_Definition node to flag the presence of a
1462 -- Storage_Size pragma.
1464 -- Has_Target_Names
1465 -- Present in assignment statements. Indicates that the RHS contains
1466 -- target names (see AI12-0125-3) and must be expanded accordingly.
1468 -- Has_Wide_Character
1469 -- Present in string literals, set if any wide character (i.e. character
1470 -- code outside the Character range but within Wide_Character range)
1471 -- appears in the string. Used to implement pragma preference rules.
1473 -- Has_Wide_Wide_Character
1474 -- Present in string literals, set if any wide character (i.e. character
1475 -- code outside the Wide_Character range) appears in the string. Used to
1476 -- implement pragma preference rules.
1478 -- Header_Size_Added
1479 -- Present in N_Attribute_Reference nodes, set only for attribute
1480 -- Max_Size_In_Storage_Elements. The flag indicates that the size of the
1481 -- hidden list header used by the runtime finalization support has been
1482 -- added to the size of the prefix. The flag also prevents the infinite
1483 -- expansion of the same attribute in the said context.
1485 -- Hidden_By_Use_Clause
1486 -- An entity list present in use clauses that appear within
1487 -- instantiations. For the resolution of local entities, entities
1488 -- introduced by these use clauses have priority over global ones,
1489 -- and outer entities must be explicitly hidden/restored on exit.
1491 -- Implicit_With
1492 -- Present in N_With_Clause nodes. The flag indicates that the clause
1493 -- does not comes from source and introduces an implicit dependency on
1494 -- a particular unit. Such implicit with clauses are generated by:
1496 -- * ABE mechanism - The static elaboration model of both the default
1497 -- and the legacy ABE mechanism use with clauses to encode implicit
1498 -- Elaborate[_All] pragmas.
1500 -- * Analysis - A with clause for child unit A.B.C is equivalent to
1501 -- a series of clauses that with A, A.B, and A.B.C. Manipulation of
1502 -- contexts utilizes implicit with clauses to emulate the visibility
1503 -- of a particular unit.
1505 -- * RTSfind - The compiler generates code which references entities
1506 -- from the runtime.
1508 -- Import_Interface_Present
1509 -- This flag is set in an Interface or Import pragma if a matching
1510 -- pragma of the other kind is also present. This is used to avoid
1511 -- generating some unwanted error messages.
1513 -- Includes_Infinities
1514 -- This flag is present in N_Range nodes. It is set for the range of
1515 -- unconstrained float types defined in Standard, which include not only
1516 -- the given range of values, but also legitimately can include infinite
1517 -- values. This flag is false for any float type for which an explicit
1518 -- range is given by the programmer, even if that range is identical to
1519 -- the range for Float.
1521 -- Incomplete_View
1522 -- Present in full type declarations that are completions of incomplete
1523 -- type declarations. Denotes the corresponding incomplete view declared
1524 -- by the incomplete declaration.
1526 -- Inherited_Discriminant
1527 -- This flag is present in N_Component_Association nodes. It indicates
1528 -- that a given component association in an extension aggregate is the
1529 -- value obtained from a constraint on an ancestor. Used to prevent
1530 -- double expansion when the aggregate has expansion delayed.
1532 -- Instance_Spec
1533 -- This field is present in generic instantiation nodes, and also in
1534 -- formal package declaration nodes (formal package declarations are
1535 -- treated in a manner very similar to package instantiations). It points
1536 -- to the node for the spec of the instance, inserted as part of the
1537 -- semantic processing for instantiations in Sem_Ch12.
1539 -- Is_Abort_Block
1540 -- Present in N_Block_Statement nodes. True if the block protects a list
1541 -- of statements with an Abort_Defer / Abort_Undefer_Direct pair.
1543 -- Is_Accessibility_Actual
1544 -- Present in N_Parameter_Association nodes. True if the parameter is
1545 -- an extra actual that carries the accessibility level of the actual
1546 -- for an access parameter, in a function that dispatches on result and
1547 -- is called in a dispatching context. Used to prevent a formal/actual
1548 -- mismatch when the call is rewritten as a dispatching call.
1550 -- Is_Analyzed_Pragma
1551 -- Present in N_Pragma nodes. Set for delayed pragmas that require a two
1552 -- step analysis. The initial step is performed by routine Analyze_Pragma
1553 -- and verifies the overall legality of the pragma. The second step takes
1554 -- place in the various Analyze_xxx_In_Decl_Part routines which perform
1555 -- full analysis. The flag prevents the reanalysis of a delayed pragma.
1557 -- Is_Asynchronous_Call_Block
1558 -- A flag set in a Block_Statement node to indicate that it is the
1559 -- expansion of an asynchronous entry call. Such a block needs cleanup
1560 -- handler to assure that the call is cancelled.
1562 -- Is_Boolean_Aspect
1563 -- Present in N_Aspect_Specification node. Set if the aspect is for a
1564 -- boolean aspect (i.e. Aspect_Id is in Boolean_Aspect subtype).
1566 -- Is_Checked
1567 -- Present in N_Aspect_Specification and N_Pragma nodes. Set for an
1568 -- assertion aspect or pragma, or check pragma for an assertion, that
1569 -- is to be checked at run time. If either Is_Checked or Is_Ignored
1570 -- is set (they cannot both be set), then this means that the status of
1571 -- the pragma has been checked at the appropriate point and should not
1572 -- be further modified (in some cases these flags are copied when a
1573 -- pragma is rewritten).
1575 -- Is_Checked_Ghost_Pragma
1576 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1577 -- related to a checked Ghost entity or encloses a checked Ghost entity.
1578 -- This flag has no relation to Is_Checked.
1580 -- Is_Component_Left_Opnd
1581 -- Is_Component_Right_Opnd
1582 -- Present in concatenation nodes, to indicate that the corresponding
1583 -- operand is of the component type of the result. Used in resolving
1584 -- concatenation nodes in instances.
1586 -- Is_Controlling_Actual
1587 -- This flag is set on an expression that is a controlling argument in
1588 -- a dispatching call. It is off in all other cases. See Sem_Disp for
1589 -- details of its use.
1591 -- Is_Declaration_Level_Node
1592 -- Present in call marker and instantiation nodes. Set when the constuct
1593 -- appears within the declarations of a block statement, an entry body,
1594 -- a subprogram body, or a task body. The flag aids the ABE Processing
1595 -- phase to catch certain forms of guaranteed ABEs.
1597 -- Is_Delayed_Aspect
1598 -- Present in N_Pragma and N_Attribute_Definition_Clause nodes which
1599 -- come from aspect specifications, where the evaluation of the aspect
1600 -- must be delayed to the freeze point. This flag is also set True in
1601 -- the corresponding N_Aspect_Specification node.
1603 -- Is_Disabled
1604 -- A flag set in an N_Aspect_Specification or N_Pragma node if there was
1605 -- a Check_Policy or Assertion_Policy (or in the case of a Debug_Pragma)
1606 -- a Debug_Policy pragma that resulted in totally disabling the flagged
1607 -- aspect or policy as a result of using the GNAT-defined policy DISABLE.
1608 -- If this flag is set, the aspect or policy is not analyzed for semantic
1609 -- correctness, so any expressions etc will not be marked as analyzed.
1611 -- Is_Dispatching_Call
1612 -- Present in call marker nodes. Set when the related call which prompted
1613 -- the creation of the marker is dispatching.
1615 -- Is_Dynamic_Coextension
1616 -- Present in allocator nodes, to indicate that this is an allocator
1617 -- for an access discriminant of a dynamically allocated object. The
1618 -- coextension must be deallocated and finalized at the same time as
1619 -- the enclosing object. The partner flag Is_Static_Coextension must
1620 -- be cleared before setting this flag to True.
1622 -- Is_Effective_Use_Clause
1623 -- Present in both N_Use_Type_Clause and N_Use_Package_Clause to indicate
1624 -- a use clause is "used" in the current source.
1626 -- Is_Elaboration_Checks_OK_Node
1627 -- Present in the following nodes:
1629 -- assignment statement
1630 -- attribute reference
1631 -- call marker
1632 -- entry call statement
1633 -- expanded name
1634 -- function call
1635 -- function instantiation
1636 -- identifier
1637 -- package instantiation
1638 -- procedure call statement
1639 -- procedure instantiation
1640 -- requeue statement
1641 -- variable reference marker
1643 -- Set when the node appears within a context which allows the generation
1644 -- of run-time ABE checks. This flag determines whether the ABE
1645 -- Processing phase generates conditional ABE checks and guaranteed ABE
1646 -- failures.
1648 -- Is_Elaboration_Code
1649 -- Present in assignment statements. Set for an assignment which updates
1650 -- the elaboration flag of a package or subprogram when the corresponding
1651 -- body is successfully elaborated.
1653 -- Is_Elaboration_Warnings_OK_Node
1654 -- Present in the following nodes:
1656 -- attribute reference
1657 -- call marker
1658 -- entry call statement
1659 -- expanded name
1660 -- function call
1661 -- function instantiation
1662 -- identifier
1663 -- package instantiation
1664 -- procedure call statement
1665 -- procedure instantiation
1666 -- requeue statement
1667 -- variable reference marker
1669 -- Set when the node appears within a context where elaboration warnings
1670 -- are enabled. This flag determines whether the ABE processing phase
1671 -- generates diagnostics on various elaboration issues.
1673 -- Is_Entry_Barrier_Function
1674 -- This flag is set on N_Subprogram_Declaration and N_Subprogram_Body
1675 -- nodes which emulate the barrier function of a protected entry body.
1676 -- The flag is used when checking for incorrect use of Current_Task.
1678 -- Is_Enum_Array_Aggregate
1679 -- A flag set on an aggregate created internally while building the
1680 -- images tables for enumerations.
1682 -- Is_Expanded_Build_In_Place_Call
1683 -- This flag is set in an N_Function_Call node to indicate that the extra
1684 -- actuals to support a build-in-place style of call have been added to
1685 -- the call.
1687 -- Is_Expanded_Contract
1688 -- Present in N_Contract nodes. Set if the contract has already undergone
1689 -- expansion activities.
1691 -- Is_Finalization_Wrapper
1692 -- This flag is present in N_Block_Statement nodes. It is set when the
1693 -- block acts as a wrapper of a handled construct which has controlled
1694 -- objects. The wrapper prevents interference between exception handlers
1695 -- and At_End handlers.
1697 -- Is_Generic_Contract_Pragma
1698 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1699 -- a source construct, applies to a generic unit or its body, and denotes
1700 -- one of the following contract-related annotations:
1701 -- Abstract_State
1702 -- Contract_Cases
1703 -- Depends
1704 -- Extensions_Visible
1705 -- Global
1706 -- Initial_Condition
1707 -- Initializes
1708 -- Post
1709 -- Post_Class
1710 -- Postcondition
1711 -- Pre
1712 -- Pre_Class
1713 -- Precondition
1714 -- Refined_Depends
1715 -- Refined_Global
1716 -- Refined_Post
1717 -- Refined_State
1718 -- Test_Case
1720 -- Is_Homogeneous_Aggregate
1721 -- A flag set on an Ada 2022 aggregate that uses square brackets as
1722 -- delimiters, and thus denotes an array or container aggregate, or
1723 -- the prefix of a reduction attribute.
1725 -- Is_Ignored
1726 -- A flag set in an N_Aspect_Specification or N_Pragma node if there was
1727 -- a Check_Policy or Assertion_Policy (or in the case of a Debug_Pragma)
1728 -- a Debug_Policy pragma that specified a policy of IGNORE, DISABLE, or
1729 -- OFF, for the pragma/aspect. If there was a Policy pragma specifying
1730 -- a Policy of ON or CHECK, then this flag is reset. If no Policy pragma
1731 -- gives a policy for the aspect or pragma, then there are two cases. For
1732 -- an assertion aspect or pragma (one of the assertion kinds allowed in
1733 -- an Assertion_Policy pragma), then Is_Ignored is set if assertions are
1734 -- ignored because of the absence of a -gnata switch. For any other
1735 -- aspects or pragmas, the flag is off. If this flag is set, the
1736 -- aspect/pragma is fully analyzed and checked for other syntactic
1737 -- and semantic errors, but it does not have any semantic effect.
1739 -- Is_Ignored_Ghost_Pragma
1740 -- This flag is present in N_Pragma nodes. It is set when the pragma is
1741 -- related to an ignored Ghost entity or encloses ignored Ghost entity.
1742 -- This flag has no relation to Is_Ignored.
1744 -- Is_In_Discriminant_Check
1745 -- This flag is present in a selected component, and is used to indicate
1746 -- that the reference occurs within a discriminant check. The
1747 -- significance is that optimizations based on assuming that the
1748 -- discriminant check has a correct value cannot be performed in this
1749 -- case (or the discriminant check may be optimized away).
1751 -- Is_Inherited_Pragma
1752 -- This flag is set in an N_Pragma node that appears in a N_Contract node
1753 -- to indicate that the pragma has been inherited from a parent context.
1755 -- Is_Initialization_Block
1756 -- Defined in block nodes. Set when the block statement was created by
1757 -- the finalization machinery to wrap initialization statements. This
1758 -- flag aids the ABE Processing phase to suppress the diagnostics of
1759 -- finalization actions in initialization contexts.
1761 -- Is_Known_Guaranteed_ABE
1762 -- NOTE: this flag is shared between the legacy ABE mechanism and the
1763 -- default ABE mechanism.
1765 -- Present in the following nodes:
1767 -- call marker
1768 -- formal package declaration
1769 -- function call
1770 -- function instantiation
1771 -- package instantiation
1772 -- procedure call statement
1773 -- procedure instantiation
1775 -- Set when the elaboration or evaluation of the scenario results in
1776 -- a guaranteed ABE. The flag is used to suppress the instantiation of
1777 -- generic bodies because gigi cannot handle certain forms of premature
1778 -- instantiation, as well as to prevent the reexamination of the node by
1779 -- the ABE Processing phase.
1781 -- Is_Machine_Number
1782 -- This flag is set in an N_Real_Literal node to indicate that the value
1783 -- is a machine number. This avoids some unnecessary cases of converting
1784 -- real literals to machine numbers.
1786 -- Is_Null_Loop
1787 -- This flag is set in an N_Loop_Statement node if the corresponding loop
1788 -- can be determined to be null at compile time. This is used to remove
1789 -- the loop entirely at expansion time.
1791 -- Is_Overloaded
1792 -- A flag present in all expression nodes. Used temporarily during
1793 -- overloading determination. The setting of this flag is not relevant
1794 -- once overloading analysis is complete.
1796 -- Is_Parenthesis_Aggregate
1797 -- A flag set on an aggregate that uses parentheses as delimiters
1799 -- Is_Power_Of_2_For_Shift
1800 -- A flag present only in N_Op_Expon nodes. It is set when the
1801 -- exponentiation is of the form 2 ** N, where the type of N is an
1802 -- unsigned integral subtype whose size does not exceed the size of
1803 -- Standard_Integer (i.e. a type that can be safely converted to
1804 -- Natural), and the exponentiation appears as the right operand of an
1805 -- integer multiplication or an integer division where the dividend is
1806 -- unsigned. It is also required that overflow checking is off for both
1807 -- the exponentiation and the multiply/divide node. If this set of
1808 -- conditions holds, and the flag is set, then the division or
1809 -- multiplication can be (and is) converted to a shift.
1811 -- Is_Preelaborable_Call
1812 -- Present in call marker nodes. Set when the related call is non-static
1813 -- but preelaborable.
1815 -- Is_Prefixed_Call
1816 -- This flag is set in a selected component within a generic unit, if
1817 -- it resolves to a prefixed call to a primitive operation. The flag
1818 -- is used to prevent accidental overloadings in an instance, when a
1819 -- primitive operation and a private record component may be homographs.
1821 -- Is_Protected_Subprogram_Body
1822 -- A flag set in a Subprogram_Body block to indicate that it is the
1823 -- implementation of a protected subprogram. Such a body needs cleanup
1824 -- handler to make sure that the associated protected object is unlocked
1825 -- when the subprogram completes.
1827 -- Is_Qualified_Universal_Literal
1828 -- Present in N_Qualified_Expression nodes. Set when the qualification is
1829 -- converting a universal literal to a specific type. Such qualifiers aid
1830 -- the resolution of accidental overloading of binary or unary operators
1831 -- which may occur in instances.
1833 -- Is_Read
1834 -- Present in variable reference markers. Set when the original variable
1835 -- reference constitutes a read of the variable.
1837 -- Is_Source_Call
1838 -- Present in call marker nodes. Set when the related call came from
1839 -- source.
1841 -- Is_SPARK_Mode_On_Node
1842 -- Present in the following nodes:
1844 -- assignment statement
1845 -- attribute reference
1846 -- call marker
1847 -- entry call statement
1848 -- expanded name
1849 -- function call
1850 -- function instantiation
1851 -- identifier
1852 -- package instantiation
1853 -- procedure call statement
1854 -- procedure instantiation
1855 -- requeue statement
1856 -- variable reference marker
1858 -- Set when the node appears within a context subject to SPARK_Mode On.
1859 -- This flag determines when the SPARK model of elaboration be activated
1860 -- by the ABE Processing phase.
1862 -- Is_Static_Coextension
1863 -- Present in N_Allocator nodes. Set if the allocator is a coextension
1864 -- of an object allocated on the stack rather than the heap. The partner
1865 -- flag Is_Dynamic_Coextension must be cleared before setting this flag
1866 -- to True.
1868 -- Is_Static_Expression
1869 -- Indicates that an expression is a static expression according to the
1870 -- rules in RM-4.9. See Sem_Eval for details.
1872 -- Is_Subprogram_Descriptor
1873 -- Present in N_Object_Declaration, and set only for the object
1874 -- declaration generated for a subprogram descriptor in fast exception
1875 -- mode. See Exp_Ch11 for details of use.
1877 -- Is_Task_Allocation_Block
1878 -- A flag set in a Block_Statement node to indicate that it is the
1879 -- expansion of a task allocator, or the allocator of an object
1880 -- containing tasks. Such a block requires a cleanup handler to call
1881 -- Expunge_Unactivated_Tasks to complete any tasks that have been
1882 -- allocated but not activated when the allocator completes abnormally.
1884 -- Is_Task_Body_Procedure
1885 -- This flag is set on N_Subprogram_Declaration and N_Subprogram_Body
1886 -- nodes which emulate the body of a task unit.
1888 -- Is_Task_Master
1889 -- A flag set in a Subprogram_Body, Block_Statement, or Task_Body node to
1890 -- indicate that the construct is a task master (i.e. has declared tasks
1891 -- or declares an access to a task type).
1893 -- Is_Write
1894 -- Present in variable reference markers. Set when the original variable
1895 -- reference constitutes a write of the variable.
1897 -- Itype
1898 -- Used in N_Itype_Reference node to reference an itype for which it is
1899 -- important to ensure that it is defined. See description of this node
1900 -- for further details.
1902 -- Kill_Range_Check
1903 -- Used in an N_Unchecked_Type_Conversion node to indicate that the
1904 -- result should not be subjected to range checks. This is used for the
1905 -- implementation of Normalize_Scalars.
1907 -- Label_Construct
1908 -- Used in an N_Implicit_Label_Declaration node. Refers to an N_Label,
1909 -- N_Block_Statement or N_Loop_Statement node to which the label
1910 -- declaration applies. The field is left empty for the special labels
1911 -- generated as part of expanding raise statements with a local exception
1912 -- handler.
1914 -- Library_Unit
1915 -- In a stub node, Library_Unit points to the compilation unit node of
1916 -- the corresponding subunit.
1918 -- In a with clause node, Library_Unit points to the spec of the with'ed
1919 -- unit.
1921 -- In a compilation unit node, the usage depends on the unit type:
1923 -- For a library unit body, Library_Unit points to the compilation unit
1924 -- node of the corresponding spec, unless it's a subprogram body with
1925 -- Acts_As_Spec set, in which case it points to itself.
1927 -- For a spec, Library_Unit points to the compilation unit node of the
1928 -- corresponding body, if present. The body will be present if the spec
1929 -- is or contains generics that we needed to instantiate. Similarly, the
1930 -- body will be present if we needed it for inlining purposes. Thus, if
1931 -- we have a spec/body pair, both of which are present, they point to
1932 -- each other via Library_Unit.
1934 -- For a subunit, Library_Unit points to the compilation unit node of
1935 -- the parent body.
1936 -- ??? not (always) true, in (at least some, maybe all?) cases it points
1937 -- to the corresponding spec for the parent body.
1939 -- Note that this field is not used to hold the parent pointer for child
1940 -- unit (which might in any case need to use it for some other purpose as
1941 -- described above). Instead for a child unit, implicit with's are
1942 -- generated for all parents.
1944 -- Local_Raise_Statements
1945 -- This field is present in exception handler nodes. It is set to
1946 -- No_Elist in the normal case. If there is at least one raise statement
1947 -- which can potentially be handled as a local raise, then this field
1948 -- points to a list of raise nodes, which are calls to a routine to raise
1949 -- an exception. These are raise nodes which can be optimized into gotos
1950 -- if the handler turns out to meet the conditions which permit this
1951 -- transformation. Note that this does NOT include instances of the
1952 -- N_Raise_xxx_Error nodes since the transformation of these nodes is
1953 -- handled by the back end (using the N_Push/N_Pop mechanism).
1955 -- Loop_Actions
1956 -- A list present in Component_Association nodes in array aggregates.
1957 -- Used to collect actions that must be executed within the loop because
1958 -- they may need to be evaluated anew each time through.
1960 -- Limited_View_Installed
1961 -- Present in With_Clauses and in package specifications. If set on
1962 -- with_clause, it indicates that this clause has created the current
1963 -- limited view of the designated package. On a package specification, it
1964 -- indicates that the limited view has already been created because the
1965 -- package is mentioned in a limited_with_clause in the closure of the
1966 -- unit being compiled.
1968 -- Local_Raise_Not_OK
1969 -- Present in N_Exception_Handler nodes. Set if the handler contains
1970 -- a construct (reraise statement, or call to subprogram in package
1971 -- GNAT.Current_Exception) that makes the handler unsuitable as a target
1972 -- for a local raise (one that could otherwise be converted to a goto).
1974 -- Must_Be_Byte_Aligned
1975 -- This flag is present in N_Attribute_Reference nodes. It can be set
1976 -- only for the Address and Unrestricted_Access attributes. If set it
1977 -- means that the object for which the address/access is given must be on
1978 -- a byte (more accurately a storage unit) boundary. If necessary, a copy
1979 -- of the object is to be made before taking the address (this copy is in
1980 -- the current scope on the stack frame). This is used for certain cases
1981 -- of code generated by the expander that passes parameters by address.
1983 -- The reason the copy is not made by the front end is that the back end
1984 -- has more information about type layout and may be able to (but is not
1985 -- guaranteed to) prevent making unnecessary copies.
1987 -- Must_Not_Freeze
1988 -- A flag present in all expression nodes. Normally expressions cause
1989 -- freezing as described in the RM. If this flag is set, then this is
1990 -- inhibited. This is used by the analyzer and expander to label nodes
1991 -- that are created by semantic analysis or expansion and which must not
1992 -- cause freezing even though they normally would. This flag is also
1993 -- present in an N_Subtype_Indication node, since we also use these in
1994 -- calls to Freeze_Expression.
1996 -- Next_Entity
1997 -- Present in defining identifiers, defining character literals, and
1998 -- defining operator symbols (i.e. in all entities). The entities of a
1999 -- scope are chained, and this field is used as the forward pointer for
2000 -- this list. See Einfo for further details.
2002 -- Next_Exit_Statement
2003 -- Present in N_Exit_Statement nodes. The exit statements for a loop are
2004 -- chained (in reverse order of appearance) from the First_Exit_Statement
2005 -- field of the E_Loop entity for the loop. Next_Exit_Statement points to
2006 -- the next entry on this chain (Empty = end of list).
2008 -- Next_Implicit_With
2009 -- Present in N_With_Clause. Part of a chain of with_clauses generated
2010 -- in rtsfind to indicate implicit dependencies on predefined units. Used
2011 -- to prevent multiple with_clauses for the same unit in a given context.
2012 -- A postorder traversal of the tree whose nodes are units and whose
2013 -- links are with_clauses defines the order in which CodePeer must
2014 -- examine a compiled unit and its full context. This ordering ensures
2015 -- that any subprogram call is examined after the subprogram declaration
2016 -- has been seen.
2018 -- Next_Named_Actual
2019 -- Present in parameter association nodes. Set during semantic analysis
2020 -- to point to the next named parameter, where parameters are ordered by
2021 -- declaration order (as opposed to the actual order in the call, which
2022 -- may be different due to named associations). Not that this field
2023 -- points to the explicit actual parameter itself, not to the
2024 -- N_Parameter_Association node (its parent).
2026 -- Next_Pragma
2027 -- Present in N_Pragma nodes. Used to create a linked list of pragma
2028 -- nodes. Currently used for two purposes:
2030 -- Create a list of linked Check_Policy pragmas. The head of this list
2031 -- is stored in Opt.Check_Policy_List (which has further details).
2033 -- Used by processing for Pre/Postcondition pragmas to store a list of
2034 -- pragmas associated with the spec of a subprogram (see Sem_Prag for
2035 -- details).
2037 -- Used by processing for pragma SPARK_Mode to store multiple pragmas
2038 -- the apply to the same construct. These are visible/private mode for
2039 -- a package spec and declarative/statement mode for package body.
2041 -- Next_Rep_Item
2042 -- Present in pragma nodes, attribute definition nodes, enumeration rep
2043 -- clauses, record rep clauses, aspect specification and null statement
2044 -- nodes. Used to link representation items that apply to an entity. See
2045 -- full description of First_Rep_Item field in Einfo for further details.
2047 -- Next_Use_Clause
2048 -- While use clauses are active during semantic processing, they are
2049 -- chained from the scope stack entry, using Next_Use_Clause as a link
2050 -- pointer, with Empty marking the end of the list. The head pointer is
2051 -- in the scope stack entry (First_Use_Clause). At the end of semantic
2052 -- processing (i.e. when Gigi sees the tree, the contents of this field
2053 -- is undefined and should not be read).
2055 -- No_Ctrl_Actions
2056 -- Present in N_Assignment_Statement to indicate that no Finalize nor
2057 -- Adjust should take place on this assignment even though the RHS is
2058 -- controlled. Also indicates that the primitive _assign should not be
2059 -- used for a tagged assignment. This is used in init procs and aggregate
2060 -- expansions where the generated assignments are initializations, not
2061 -- real assignments.
2063 -- No_Elaboration_Check
2064 -- NOTE: this flag is relevant only for the legacy ABE mechanism and
2065 -- should not be used outside of that context.
2067 -- Present in N_Function_Call and N_Procedure_Call_Statement. Indicates
2068 -- that no elaboration check is needed on the call, because it appears in
2069 -- the context of a local Suppress pragma. This is used on calls within
2070 -- task bodies, where the actual elaboration checks are applied after
2071 -- analysis, when the local scope stack is not present.
2073 -- No_Entities_Ref_In_Spec
2074 -- Present in N_With_Clause nodes. Set if the with clause is on the
2075 -- package or subprogram spec where the main unit is the corresponding
2076 -- body, and no entities of the with'ed unit are referenced by the spec
2077 -- (an entity may still be referenced in the body, so this flag is used
2078 -- to generate the proper message (see Sem_Util.Check_Unused_Withs for
2079 -- full details).
2081 -- No_Initialization
2082 -- Present in N_Object_Declaration and N_Allocator to indicate that the
2083 -- object must not be initialized (by Initialize or call to an init
2084 -- proc). This is needed for controlled aggregates. When the Object
2085 -- declaration has an expression, this flag means that this expression
2086 -- should not be taken into account (needed for in place initialization
2087 -- with aggregates, and for object with an address clause, which are
2088 -- initialized with an assignment at freeze time).
2090 -- No_Minimize_Eliminate
2091 -- This flag is present in membership operator nodes (N_In/N_Not_In).
2092 -- It is used to indicate that processing for extended overflow checking
2093 -- modes is not required (this is used to prevent infinite recursion).
2095 -- No_Side_Effect_Removal
2096 -- Present in N_Function_Call nodes. Set when a function call does not
2097 -- require side effect removal. This attribute suppresses the generation
2098 -- of a temporary to capture the result of the function which eventually
2099 -- replaces the function call.
2101 -- No_Truncation
2102 -- Present in N_Unchecked_Type_Conversion node. This flag has an effect
2103 -- only if the RM_Size of the source is greater than the RM_Size of the
2104 -- target for scalar operands. Normally in such a case we truncate some
2105 -- higher order bits of the source, and then sign/zero extend the result
2106 -- to form the output value. But if this flag is set, then we do not do
2107 -- any truncation, so for example, if an 8 bit input is converted to 5
2108 -- bit result which is in fact stored in 8 bits, then the high order
2109 -- three bits of the target result will be copied from the source. This
2110 -- is used for properly setting out of range values for use by pragmas
2111 -- Initialize_Scalars and Normalize_Scalars.
2113 -- Null_Excluding_Subtype
2114 -- Present in N_Access_To_Object_Definition. Indicates that the subtype
2115 -- indication carries a null-exclusion indicator, which is distinct from
2116 -- the null-exclusion indicator that may precede the access keyword.
2118 -- Original_Discriminant
2119 -- Present in identifiers. Used in references to discriminants that
2120 -- appear in generic units. Because the names of the discriminants may be
2121 -- different in an instance, we use this field to recover the position of
2122 -- the discriminant in the original type, and replace it with the
2123 -- discriminant at the same position in the instantiated type.
2125 -- Original_Entity
2126 -- Present in numeric literals. Used to denote the named number that has
2127 -- been constant-folded into the given literal. If literal is from
2128 -- source, or the result of some other constant-folding operation, then
2129 -- Original_Entity is empty. This field is needed to handle properly
2130 -- named numbers in generic units, where the Associated_Node field
2131 -- interferes with the Entity field, making it impossible to preserve the
2132 -- original entity at the point of instantiation.
2134 -- Others_Discrete_Choices
2135 -- When a case statement or variant is analyzed, the semantic checks
2136 -- determine the actual list of choices that correspond to an others
2137 -- choice. This list is materialized for later use by the expander and
2138 -- the Others_Discrete_Choices field of an N_Others_Choice node points to
2139 -- this materialized list of choices, which is in standard format for a
2140 -- list of discrete choices, except that of course it cannot contain an
2141 -- N_Others_Choice entry.
2143 -- Parent_Spec
2144 -- For a library unit that is a child unit spec (package or subprogram
2145 -- declaration, generic declaration or instantiation, or library level
2146 -- rename) this field points to the compilation unit node for the parent
2147 -- package specification. This field is Empty for library bodies (the
2148 -- parent spec in this case can be found from the corresponding spec).
2150 -- Parent_With
2151 -- Present in N_With_Clause nodes. The flag indicates that the clause
2152 -- was generated for an ancestor unit to provide proper visibility. A
2153 -- with clause for child unit A.B.C produces two implicit parent with
2154 -- clauses for A and A.B.
2156 -- Premature_Use
2157 -- Present in N_Incomplete_Type_Declaration node. Used for improved
2158 -- error diagnostics: if there is a premature usage of an incomplete
2159 -- type, a subsequently generated error message indicates the position
2160 -- of its full declaration.
2162 -- Present_Expr
2163 -- Present in an N_Variant node. This has a meaningful value only after
2164 -- Gigi has back annotated the tree with representation information. At
2165 -- this point, it contains a reference to a gcc expression that depends
2166 -- on the values of one or more discriminants. Given a set of
2167 -- discriminant values, this expression evaluates to False (zero) if
2168 -- variant is not present, and True (non-zero) if it is present. See
2169 -- unit Repinfo for further details on gigi back annotation. This field
2170 -- is used during back-annotation processing (for -gnatR -gnatc) to
2171 -- determine if a field is present or not.
2173 -- Prev_Use_Clause
2174 -- Present in both N_Use_Package_Clause and N_Use_Type_Clause. Used in
2175 -- detection of ineffective use clauses by allowing a chain of related
2176 -- clauses together to avoid traversing the current scope stack.
2178 -- Print_In_Hex
2179 -- Set on an N_Integer_Literal node to indicate that the value should be
2180 -- printed in hexadecimal in the sprint listing. Has no effect on
2181 -- legality or semantics of program, only on the displayed output. This
2182 -- is used to clarify output from the packed array cases.
2184 -- Procedure_To_Call
2185 -- Present in N_Allocator, N_Free_Statement, N_Simple_Return_Statement,
2186 -- and N_Extended_Return_Statement nodes. References the entity for the
2187 -- declaration of the procedure to be called to accomplish the required
2188 -- operation (i.e. for the Allocate procedure in the case of N_Allocator
2189 -- and N_Simple_Return_Statement and N_Extended_Return_Statement (for
2190 -- allocating the return value), and for the Deallocate procedure in the
2191 -- case of N_Free_Statement.
2193 -- Raises_Constraint_Error
2194 -- Set on an expression whose evaluation will definitely fail constraint
2195 -- error check. See Sem_Eval for details.
2197 -- Redundant_Use
2198 -- Present in nodes that can appear as an operand in a use clause or use
2199 -- type clause (identifiers, expanded names, attribute references). Set
2200 -- to indicate that a use is redundant (and therefore need not be undone
2201 -- on scope exit).
2203 -- Renaming_Exception
2204 -- Present in N_Exception_Declaration node. Used to point back to the
2205 -- exception renaming for an exception declared within a subprogram.
2206 -- What happens is that an exception declared in a subprogram is moved
2207 -- to the library level with a unique name, and the original exception
2208 -- becomes a renaming. This link from the library level exception to the
2209 -- renaming declaration allows registering of the proper exception name.
2211 -- Return_Statement_Entity
2212 -- Present in N_Simple_Return_Statement and N_Extended_Return_Statement.
2213 -- Points to an E_Return_Statement representing the return statement.
2215 -- Return_Object_Declarations
2216 -- Present in N_Extended_Return_Statement. Points to a list initially
2217 -- containing a single N_Object_Declaration representing the return
2218 -- object. We use a list (instead of just a pointer to the object decl)
2219 -- because Analyze wants to insert extra actions on this list, before the
2220 -- N_Object_Declaration, which always remains last on the list.
2222 -- Rounded_Result
2223 -- Present in N_Type_Conversion, N_Op_Divide, and N_Op_Multiply nodes.
2224 -- Used in the fixed-point cases to indicate that the result must be
2225 -- rounded as a result of the use of the 'Round attribute. Also used for
2226 -- integer N_Op_Divide nodes to indicate that the result should be
2227 -- rounded to the nearest integer (breaking ties away from zero), rather
2228 -- than truncated towards zero as usual. These rounded integer operations
2229 -- are the result of expansion of rounded fixed-point divide, conversion
2230 -- and multiplication operations.
2232 -- Save_Invocation_Graph_Of_Body
2233 -- Present in compilation unit nodes. Set when the elaboration mechanism
2234 -- must record all invocation constructs and invocation relations within
2235 -- the body of the compilation unit.
2237 -- SCIL_Entity
2238 -- Present in SCIL nodes. References the specific tagged type associated
2239 -- with the SCIL node (for an N_SCIL_Dispatching_Call node, this is
2240 -- the controlling type of the call; for an N_SCIL_Membership_Test node
2241 -- generated as part of testing membership in T'Class, this is T; for an
2242 -- N_SCIL_Dispatch_Table_Tag_Init node, this is the type being declared).
2244 -- SCIL_Controlling_Tag
2245 -- Present in N_SCIL_Dispatching_Call nodes. References the controlling
2246 -- tag of a dispatching call. This is usually an N_Selected_Component
2247 -- node (for a _tag component), but may be an N_Object_Declaration or
2248 -- N_Parameter_Specification node in some cases (e.g., for a call to
2249 -- a classwide streaming operation or a call to an instance of
2250 -- Ada.Tags.Generic_Dispatching_Constructor).
2252 -- SCIL_Tag_Value
2253 -- Present in N_SCIL_Membership_Test nodes. Used to reference the tag
2254 -- of the value that is being tested.
2256 -- SCIL_Target_Prim
2257 -- Present in N_SCIL_Dispatching_Call nodes. References the primitive
2258 -- operation named (statically) in a dispatching call.
2260 -- Scope
2261 -- Present in defining identifiers, defining character literals, and
2262 -- defining operator symbols (i.e. in all entities). The entities of a
2263 -- scope all use this field to reference the corresponding scope entity.
2264 -- See Einfo for further details.
2266 -- Shift_Count_OK
2267 -- A flag present in shift nodes to indicate that the shift count is
2268 -- known to be in range, i.e. is in the range from zero to word length
2269 -- minus one. If this flag is not set, then the shift count may be
2270 -- outside this range, i.e. larger than the word length, and the code
2271 -- must ensure that such shift counts give the appropriate result.
2273 -- Source_Type
2274 -- Used in an N_Validate_Unchecked_Conversion node to point to the
2275 -- source type entity for the unchecked conversion instantiation
2276 -- which gigi must do size validation for.
2278 -- Split_PPC
2279 -- When a Pre or Post aspect specification is processed, it is broken
2280 -- into AND THEN sections. The leftmost section has Split_PPC set to
2281 -- False, indicating that it is the original specification (e.g. for
2282 -- posting errors). For other sections, Split_PPC is set to True.
2283 -- This flag is set in both the N_Aspect_Specification node itself,
2284 -- and in the pragma which is generated from this node.
2286 -- Storage_Pool
2287 -- Present in N_Allocator, N_Free_Statement, N_Simple_Return_Statement,
2288 -- and N_Extended_Return_Statement nodes. References the entity for the
2289 -- storage pool to be used for the allocate or free call or for the
2290 -- allocation of the returned value from function. Empty indicates that
2291 -- the global default pool is to be used. Note that in the case
2292 -- of a return statement, this field is set only if the function returns
2293 -- value of a type whose size is not known at compile time on the
2294 -- secondary stack.
2296 -- Suppress_Assignment_Checks
2297 -- Used in generated N_Assignment_Statement nodes to suppress predicate
2298 -- and range checks in cases where the generated code knows that the
2299 -- value being assigned is in range and satisfies any predicate. Also
2300 -- can be set in N_Object_Declaration nodes, to similarly suppress any
2301 -- checks on the initializing value. In assignment statements it also
2302 -- suppresses access checks in the generated code for out- and in-out
2303 -- parameters in entry calls, as well as length checks.
2305 -- Suppress_Loop_Warnings
2306 -- Used in N_Loop_Statement node to indicate that warnings within the
2307 -- body of the loop should be suppressed. This is set when the range
2308 -- of a FOR loop is known to be null, or is probably null (loop would
2309 -- only execute if invalid values are present).
2311 -- Target
2312 -- Present in call and variable reference marker nodes. References the
2313 -- entity of the original entity, operator, or subprogram being invoked,
2314 -- or the original variable being read or written.
2316 -- Target_Type
2317 -- Used in an N_Validate_Unchecked_Conversion node to point to the target
2318 -- type entity for the unchecked conversion instantiation which gigi must
2319 -- do size validation for.
2321 -- Then_Actions
2322 -- This field is present in if expression nodes. During code expansion
2323 -- we use the Insert_Actions procedure (in Exp_Util) to insert actions
2324 -- at an appropriate place in the tree to get elaborated at the right
2325 -- time. For if expressions, we have to be sure that the actions for
2326 -- for the Then branch are only elaborated if the condition is True.
2327 -- The Then_Actions field is used as a temporary parking place for
2328 -- these actions. The final tree is always rewritten to eliminate the
2329 -- need for this field, so in the tree passed to Gigi, this field is
2330 -- always set to No_List.
2332 -- TSS_Elist
2333 -- Present in N_Freeze_Entity nodes. Holds an element list containing
2334 -- entries for each TSS (type support subprogram) associated with the
2335 -- frozen type. The elements of the list are the entities for the
2336 -- subprograms (see package Exp_TSS for further details). Set to No_Elist
2337 -- if there are no type support subprograms for the type or if the freeze
2338 -- node is not for a type.
2340 -- Uneval_Old_Accept
2341 -- Present in N_Pragma nodes. Set True if Opt.Uneval_Old is set to 'A'
2342 -- (accept) at the point where the pragma is encountered (including the
2343 -- case of a pragma generated from an aspect specification). It is this
2344 -- setting that is relevant, rather than the setting at the point where
2345 -- a contract is finally analyzed after the delay till the freeze point.
2347 -- Uneval_Old_Warn
2348 -- Present in N_Pragma nodes. Set True if Opt.Uneval_Old is set to 'W'
2349 -- (warn) at the point where the pragma is encountered (including the
2350 -- case of a pragma generated from an aspect specification). It is this
2351 -- setting that is relevant, rather than the setting at the point where
2352 -- a contract is finally analyzed after the delay till the freeze point.
2354 -- Unreferenced_In_Spec
2355 -- Present in N_With_Clause nodes. Set if the with clause is on the
2356 -- package or subprogram spec where the main unit is the corresponding
2357 -- body, and is not referenced by the spec (it may still be referenced by
2358 -- the body, so this flag is used to generate the proper message (see
2359 -- Sem_Util.Check_Unused_Withs for details)
2361 -- Uninitialized_Variable
2362 -- Present in N_Formal_Private_Type_Definition and in N_Private_
2363 -- Extension_Declarations. Indicates that a variable in a generic unit
2364 -- whose type is a formal private or derived type is read without being
2365 -- initialized. Used to warn if the corresponding actual type is not
2366 -- a fully initialized type.
2368 -- Used_Operations
2369 -- Present in N_Use_Type_Clause nodes. Holds the list of operations that
2370 -- are made potentially use-visible by the clause. Simplifies processing
2371 -- on exit from the scope of the use_type_clause, in particular in the
2372 -- case of Use_All_Type, when those operations several scopes.
2374 -- Was_Attribute_Reference
2375 -- Present in N_Subprogram_Body. Set to True if the original source is an
2376 -- attribute reference which is an actual in a generic instantiation. The
2377 -- instantiation prologue renames these attributes, and expansion later
2378 -- converts them into subprogram bodies.
2380 -- Was_Expression_Function
2381 -- Present in N_Subprogram_Body. True if the original source had an
2382 -- N_Expression_Function, which was converted to the N_Subprogram_Body
2383 -- by Analyze_Expression_Function.
2385 -- Was_Originally_Stub
2386 -- This flag is set in the node for a proper body that replaces stub.
2387 -- During the analysis procedure, stubs in some situations get rewritten
2388 -- by the corresponding bodies, and we set this flag to remember that
2389 -- this happened. Note that it is not good enough to rely on the use of
2390 -- Original_Node here because of the case of nested instantiations where
2391 -- the substituted node can be copied.
2393 --------------------------------------------------
2394 -- Note on Use of End_Label and End_Span Fields --
2395 --------------------------------------------------
2397 -- Several constructs have end lines:
2399 -- Loop Statement end loop [loop_IDENTIFIER];
2400 -- Package Specification end [[PARENT_UNIT_NAME .] IDENTIFIER]
2401 -- Task Definition end [task_IDENTIFIER]
2402 -- Protected Definition end [protected_IDENTIFIER]
2403 -- Protected Body end [protected_IDENTIFIER]
2405 -- Block Statement end [block_IDENTIFIER];
2406 -- Subprogram Body end [DESIGNATOR];
2407 -- Package Body end [[PARENT_UNIT_NAME .] IDENTIFIER];
2408 -- Task Body end [task_IDENTIFIER];
2409 -- Accept Statement end [entry_IDENTIFIER]];
2410 -- Entry Body end [entry_IDENTIFIER];
2412 -- If Statement end if;
2413 -- Case Statement end case;
2415 -- Record Definition end record;
2416 -- Enumeration Definition );
2418 -- The End_Label and End_Span fields are used to mark the locations of
2419 -- these lines, and also keep track of the label in the case where a label
2420 -- is present.
2422 -- For the first group above, the End_Label field of the corresponding node
2423 -- is used to point to the label identifier. In the case where there is no
2424 -- label in the source, the parser supplies a dummy identifier (with
2425 -- Comes_From_Source set to False), and the Sloc of this dummy identifier
2426 -- marks the location of the token following the END token.
2428 -- For the second group, the use of End_Label is similar, but the End_Label
2429 -- is found in the N_Handled_Sequence_Of_Statements node. This is done
2430 -- simply because in some cases there is no room in the parent node.
2432 -- For the third group, there is never any label, and instead of using
2433 -- End_Label, we use the End_Span field which gives the location of the
2434 -- token following END, relative to the starting Sloc of the construct,
2435 -- i.e. add Sloc (Node) + End_Span (Node) to get the Sloc of the IF or CASE
2436 -- following the End_Label.
2438 -- The record definition case is handled specially, we treat it as though
2439 -- it required an optional label which is never present, and so the parser
2440 -- always builds a dummy identifier with Comes From Source set False. The
2441 -- reason we do this, rather than using End_Span in this case, is that we
2442 -- want to generate a cross-ref entry for the end of a record, since it
2443 -- represents a scope for name declaration purposes.
2445 -- The enumeration definition case is handled in an exactly similar manner,
2446 -- building a dummy identifier to get a cross-reference.
2448 -- Note: the reason we store the difference as a Uint, instead of storing
2449 -- the Source_Ptr value directly, is that Source_Ptr values cannot be
2450 -- distinguished from other types of values, and we count on all general
2451 -- use fields being self describing. To make things easier for clients,
2452 -- note that we provide function End_Location, and procedure
2453 -- Set_End_Location to allow access to the logical value (which is the
2454 -- Source_Ptr value for the end token).
2456 ---------------------
2457 -- Syntactic Nodes --
2458 ---------------------
2460 ---------------------
2461 -- 2.3 Identifier --
2462 ---------------------
2464 -- IDENTIFIER ::= IDENTIFIER_LETTER {[UNDERLINE] LETTER_OR_DIGIT}
2465 -- LETTER_OR_DIGIT ::= IDENTIFIER_LETTER | DIGIT
2467 -- An IDENTIFIER shall not be a reserved word
2469 -- In the Ada grammar identifiers are the bottom level tokens which have
2470 -- very few semantics. Actual program identifiers are direct names. If
2471 -- we were being 100% honest with the grammar, then we would have a node
2472 -- called N_Direct_Name which would point to an identifier. However,
2473 -- that's too many extra nodes, so we just use the N_Identifier node
2474 -- directly as a direct name, and it contains the expression fields and
2475 -- Entity field that correspond to its use as a direct name. In those
2476 -- few cases where identifiers appear in contexts where they are not
2477 -- direct names (pragmas, pragma argument associations, attribute
2478 -- references and attribute definition clauses), the Chars field of the
2479 -- node contains the Name_Id for the identifier name.
2481 -- Note: in GNAT, a reserved word can be treated as an identifier in two
2482 -- cases. First, an incorrect use of a reserved word as an identifier is
2483 -- diagnosed and then treated as a normal identifier. Second, an
2484 -- attribute designator of the form of a reserved word (access, delta,
2485 -- digits, range) is treated as an identifier.
2487 -- Note: The set of letters that is permitted in an identifier depends
2488 -- on the character set in use. See package Csets for full details.
2490 -- N_Identifier
2491 -- Sloc points to identifier
2492 -- Chars contains the Name_Id for the identifier
2493 -- Entity
2494 -- Associated_Node
2495 -- Original_Discriminant
2496 -- Is_Elaboration_Checks_OK_Node
2497 -- Is_SPARK_Mode_On_Node
2498 -- Is_Elaboration_Warnings_OK_Node
2499 -- Has_Private_View (set in generic units)
2500 -- Redundant_Use
2501 -- Atomic_Sync_Required
2502 -- plus fields for expression
2504 --------------------------
2505 -- 2.4 Numeric Literal --
2506 --------------------------
2508 -- NUMERIC_LITERAL ::= DECIMAL_LITERAL | BASED_LITERAL
2510 ----------------------------
2511 -- 2.4.1 Decimal Literal --
2512 ----------------------------
2514 -- DECIMAL_LITERAL ::= NUMERAL [.NUMERAL] [EXPONENT]
2516 -- NUMERAL ::= DIGIT {[UNDERLINE] DIGIT}
2518 -- EXPONENT ::= E [+] NUMERAL | E - NUMERAL
2520 -- Decimal literals appear in the tree as either integer literal nodes
2521 -- or real literal nodes, depending on whether a period is present.
2523 -- Note: literal nodes appear as a result of direct use of literals
2524 -- in the source program, and also as the result of evaluating
2525 -- expressions at compile time. In the latter case, it is possible
2526 -- to construct real literals that have no syntactic representation
2527 -- using the standard literal format. Such literals are listed by
2528 -- Sprint using the notation [numerator / denominator].
2530 -- Note: the value of an integer literal node created by the front end
2531 -- is never outside the range of values of the base type. However, it
2532 -- can be the case that the created value is outside the range of the
2533 -- particular subtype. This happens in the case of integer overflows
2534 -- with checks suppressed.
2536 -- N_Integer_Literal
2537 -- Sloc points to literal
2538 -- Original_Entity If not Empty, holds Named_Number that
2539 -- has been constant-folded into its literal value.
2540 -- Intval contains integer value of literal
2541 -- Print_In_Hex
2542 -- plus fields for expression
2544 -- N_Real_Literal
2545 -- Sloc points to literal
2546 -- Original_Entity If not Empty, holds Named_Number that
2547 -- has been constant-folded into its literal value.
2548 -- Realval contains real value of literal
2549 -- Corresponding_Integer_Value
2550 -- Is_Machine_Number
2551 -- plus fields for expression
2553 --------------------------
2554 -- 2.4.2 Based Literal --
2555 --------------------------
2557 -- BASED_LITERAL ::=
2558 -- BASE # BASED_NUMERAL [.BASED_NUMERAL] # [EXPONENT]
2560 -- BASE ::= NUMERAL
2562 -- BASED_NUMERAL ::=
2563 -- EXTENDED_DIGIT {[UNDERLINE] EXTENDED_DIGIT}
2565 -- EXTENDED_DIGIT ::= DIGIT | A | B | C | D | E | F
2567 -- Based literals appear in the tree as either integer literal nodes
2568 -- or real literal nodes, depending on whether a period is present.
2570 ----------------------------
2571 -- 2.5 Character Literal --
2572 ----------------------------
2574 -- CHARACTER_LITERAL ::= ' GRAPHIC_CHARACTER '
2576 -- N_Character_Literal
2577 -- Sloc points to literal
2578 -- Chars contains the Name_Id for the identifier
2579 -- Char_Literal_Value contains the literal value
2580 -- Entity
2581 -- Associated_Node
2582 -- Has_Private_View (set in generic units)
2583 -- plus fields for expression
2585 -- Note: the Entity field will be missing (set to Empty) for character
2586 -- literals whose type is Standard.Wide_Character or Standard.Character
2587 -- or a type derived from one of these two. In this case the character
2588 -- literal stands for its own coding. The reason we take this irregular
2589 -- short cut is to avoid the need to build lots of junk defining
2590 -- character literal nodes.
2592 -------------------------
2593 -- 2.6 String Literal --
2594 -------------------------
2596 -- STRING LITERAL ::= "{STRING_ELEMENT}"
2598 -- A STRING_ELEMENT is either a pair of quotation marks ("), or a
2599 -- single GRAPHIC_CHARACTER other than a quotation mark.
2601 -- Is_Folded_In_Parser is True if the parser created this literal by
2602 -- folding a sequence of "&" operators. For example, if the source code
2603 -- says "aaa" & "bbb" & "ccc", and this produces "aaabbbccc", the flag
2604 -- is set. This flag is needed because the parser doesn't know about
2605 -- visibility, so the folded result might be wrong, and semantic
2606 -- analysis needs to check for that.
2608 -- N_String_Literal
2609 -- Sloc points to literal
2610 -- Strval contains Id of string value
2611 -- Has_Wide_Character
2612 -- Has_Wide_Wide_Character
2613 -- Is_Folded_In_Parser
2614 -- plus fields for expression
2616 ------------------
2617 -- 2.7 Comment --
2618 ------------------
2620 -- A COMMENT starts with two adjacent hyphens and extends up to the
2621 -- end of the line. A COMMENT may appear on any line of a program.
2623 -- Comments are skipped by the scanner and do not appear in the tree.
2624 -- It is possible to reconstruct the position of comments with respect
2625 -- to the elements of the tree by using the source position (Sloc)
2626 -- pointers that appear in every tree node.
2628 -----------------
2629 -- 2.8 Pragma --
2630 -----------------
2632 -- PRAGMA ::= pragma IDENTIFIER
2633 -- [(PRAGMA_ARGUMENT_ASSOCIATION {, PRAGMA_ARGUMENT_ASSOCIATION})];
2635 -- Note that a pragma may appear in the tree anywhere a declaration
2636 -- or a statement may appear, as well as in some other situations
2637 -- which are explicitly documented.
2639 -- N_Pragma
2640 -- Sloc points to PRAGMA
2641 -- Next_Pragma
2642 -- Pragma_Argument_Associations (set to No_List if none)
2643 -- Corresponding_Aspect (set to Empty if not present)
2644 -- Pragma_Identifier
2645 -- Next_Rep_Item
2646 -- Is_Generic_Contract_Pragma
2647 -- Is_Checked_Ghost_Pragma
2648 -- Is_Inherited_Pragma
2649 -- Is_Analyzed_Pragma
2650 -- Class_Present set if from Aspect with 'Class
2651 -- Uneval_Old_Accept
2652 -- Is_Ignored_Ghost_Pragma
2653 -- Is_Ignored
2654 -- Is_Checked
2655 -- From_Aspect_Specification
2656 -- Is_Delayed_Aspect
2657 -- Is_Disabled
2658 -- Import_Interface_Present
2659 -- Split_PPC set if corresponding aspect had Split_PPC set
2660 -- Uneval_Old_Warn
2662 -- Note: we should have a section on what pragmas are passed on to
2663 -- the back end to be processed. This section should note that pragma
2664 -- Psect_Object is always converted to Common_Object, but there are
2665 -- undoubtedly many other similar notes required ???
2667 -- Note: utility functions Pragma_Name_Unmapped and Pragma_Name may be
2668 -- applied to pragma nodes to obtain the Chars or its mapped version.
2670 -- Note: if From_Aspect_Specification is set, then Sloc points to the
2671 -- aspect name, as does the Pragma_Identifier. In this case if the
2672 -- pragma has a local name argument (such as pragma Inline), it is
2673 -- resolved to point to the specific entity affected by the pragma.
2675 --------------------------------------
2676 -- 2.8 Pragma Argument Association --
2677 --------------------------------------
2679 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
2680 -- [pragma_argument_IDENTIFIER =>] NAME
2681 -- | [pragma_argument_IDENTIFIER =>] EXPRESSION
2683 -- In Ada 2012, there are two more possibilities:
2685 -- PRAGMA_ARGUMENT_ASSOCIATION ::=
2686 -- [pragma_argument_ASPECT_MARK =>] NAME
2687 -- | [pragma_argument_ASPECT_MARK =>] EXPRESSION
2689 -- where the interesting allowed cases (which do not fit the syntax of
2690 -- the first alternative above) are
2692 -- ASPECT_MARK => Pre'Class |
2693 -- Post'Class |
2694 -- Type_Invariant'Class |
2695 -- Invariant'Class
2697 -- We allow this special usage in all Ada modes, but it would be a
2698 -- pain to allow these aspects to pervade the pragma syntax, and the
2699 -- representation of pragma nodes internally. So what we do is to
2700 -- replace these ASPECT_MARK forms with identifiers whose name is one
2701 -- of the special internal names _Pre, _Post, or _Type_Invariant.
2703 -- We do a similar replacement of these Aspect_Mark forms in the
2704 -- Expression of a pragma argument association for the cases of
2705 -- the first arguments of any Check pragmas and Check_Policy pragmas
2707 -- N_Pragma_Argument_Association
2708 -- Sloc points to first token in association
2709 -- Chars (set to No_Name if no pragma argument identifier)
2710 -- Expression_Copy
2711 -- Expression
2713 ------------------------
2714 -- 2.9 Reserved Word --
2715 ------------------------
2717 -- Reserved words are parsed by the scanner, and returned as the
2718 -- corresponding token types (e.g. PACKAGE is returned as Tok_Package)
2720 ----------------------------
2721 -- 3.1 Basic Declaration --
2722 ----------------------------
2724 -- BASIC_DECLARATION ::=
2725 -- TYPE_DECLARATION | SUBTYPE_DECLARATION
2726 -- | OBJECT_DECLARATION | NUMBER_DECLARATION
2727 -- | SUBPROGRAM_DECLARATION | ABSTRACT_SUBPROGRAM_DECLARATION
2728 -- | PACKAGE_DECLARATION | RENAMING_DECLARATION
2729 -- | EXCEPTION_DECLARATION | GENERIC_DECLARATION
2730 -- | GENERIC_INSTANTIATION
2732 -- Basic declaration also includes IMPLICIT_LABEL_DECLARATION
2733 -- see further description in section on semantic nodes.
2735 -- Also, in the tree that is constructed, a pragma may appear
2736 -- anywhere that a declaration may appear.
2738 ------------------------------
2739 -- 3.1 Defining Identifier --
2740 ------------------------------
2742 -- DEFINING_IDENTIFIER ::= IDENTIFIER
2744 -- A defining identifier is an entity, which has additional fields
2745 -- depending on the setting of the Ekind field. These additional
2746 -- fields are defined (and access subprograms declared) in package
2747 -- Einfo.
2749 -- Note: N_Defining_Identifier is an extended node whose fields are
2750 -- deliberately laid out to match the layout of fields in an ordinary
2751 -- N_Identifier node allowing for easy alteration of an identifier
2752 -- node into a defining identifier node. For details, see procedure
2753 -- Sinfo.CN.Change_Identifier_To_Defining_Identifier.
2755 -- N_Defining_Identifier
2756 -- Sloc points to identifier
2757 -- Chars contains the Name_Id for the identifier
2758 -- Next_Entity
2759 -- Scope
2760 -- Etype
2762 -----------------------------
2763 -- 3.2.1 Type Declaration --
2764 -----------------------------
2766 -- TYPE_DECLARATION ::=
2767 -- FULL_TYPE_DECLARATION
2768 -- | INCOMPLETE_TYPE_DECLARATION
2769 -- | PRIVATE_TYPE_DECLARATION
2770 -- | PRIVATE_EXTENSION_DECLARATION
2772 ----------------------------------
2773 -- 3.2.1 Full Type Declaration --
2774 ----------------------------------
2776 -- FULL_TYPE_DECLARATION ::=
2777 -- type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
2778 -- is TYPE_DEFINITION
2779 -- [ASPECT_SPECIFICATIONS];
2780 -- | TASK_TYPE_DECLARATION
2781 -- | PROTECTED_TYPE_DECLARATION
2783 -- The full type declaration node is used only for the first case. The
2784 -- second case (concurrent type declaration), is represented directly
2785 -- by a task type declaration or a protected type declaration.
2787 -- N_Full_Type_Declaration
2788 -- Sloc points to TYPE
2789 -- Defining_Identifier
2790 -- Incomplete_View
2791 -- Discriminant_Specifications (set to No_List if none)
2792 -- Type_Definition
2793 -- Discr_Check_Funcs_Built
2795 ----------------------------
2796 -- 3.2.1 Type Definition --
2797 ----------------------------
2799 -- TYPE_DEFINITION ::=
2800 -- ENUMERATION_TYPE_DEFINITION | INTEGER_TYPE_DEFINITION
2801 -- | REAL_TYPE_DEFINITION | ARRAY_TYPE_DEFINITION
2802 -- | RECORD_TYPE_DEFINITION | ACCESS_TYPE_DEFINITION
2803 -- | DERIVED_TYPE_DEFINITION | INTERFACE_TYPE_DEFINITION
2805 --------------------------------
2806 -- 3.2.2 Subtype Declaration --
2807 --------------------------------
2809 -- SUBTYPE_DECLARATION ::=
2810 -- subtype DEFINING_IDENTIFIER is [NULL_EXCLUSION] SUBTYPE_INDICATION
2811 -- [ASPECT_SPECIFICATIONS];
2813 -- The subtype indication field is set to Empty for subtypes
2814 -- declared in package Standard (Positive, Natural).
2816 -- N_Subtype_Declaration
2817 -- Sloc points to SUBTYPE
2818 -- Defining_Identifier
2819 -- Null_Exclusion_Present
2820 -- Subtype_Indication
2821 -- Generic_Parent_Type (for actual of formal private or derived type)
2822 -- Exception_Junk
2824 -------------------------------
2825 -- 3.2.2 Subtype Indication --
2826 -------------------------------
2828 -- SUBTYPE_INDICATION ::= SUBTYPE_MARK [CONSTRAINT]
2830 -- Note: if no constraint is present, the subtype indication appears
2831 -- directly in the tree as a subtype mark. The N_Subtype_Indication
2832 -- node is used only if a constraint is present.
2834 -- Note: [For Ada 2005 (AI-231)]: Because Ada 2005 extends this rule
2835 -- with the null-exclusion part (see AI-231), we had to introduce a new
2836 -- attribute in all the parents of subtype_indication nodes to indicate
2837 -- if the null-exclusion is present.
2839 -- Note: the reason that this node has expression fields is that a
2840 -- subtype indication can appear as an operand of a membership test.
2842 -- N_Subtype_Indication
2843 -- Sloc points to first token of subtype mark
2844 -- Subtype_Mark
2845 -- Constraint
2846 -- Etype
2847 -- Must_Not_Freeze
2849 -- Note: Depending on context, the Etype is either the entity of the
2850 -- Subtype_Mark field, or it is an itype constructed to reify the
2851 -- subtype indication. In particular, such itypes are created for a
2852 -- subtype indication that appears in an array type declaration. This
2853 -- simplifies constraint checking in indexed components.
2855 -- For subtype indications that appear in scalar type and subtype
2856 -- declarations, the Etype is the entity of the subtype mark.
2858 -------------------------
2859 -- 3.2.2 Subtype Mark --
2860 -------------------------
2862 -- SUBTYPE_MARK ::= subtype_NAME
2864 -----------------------
2865 -- 3.2.2 Constraint --
2866 -----------------------
2868 -- CONSTRAINT ::= SCALAR_CONSTRAINT | COMPOSITE_CONSTRAINT
2870 ------------------------------
2871 -- 3.2.2 Scalar Constraint --
2872 ------------------------------
2874 -- SCALAR_CONSTRAINT ::=
2875 -- RANGE_CONSTRAINT | DIGITS_CONSTRAINT | DELTA_CONSTRAINT
2877 ---------------------------------
2878 -- 3.2.2 Composite Constraint --
2879 ---------------------------------
2881 -- COMPOSITE_CONSTRAINT ::=
2882 -- INDEX_CONSTRAINT | DISCRIMINANT_CONSTRAINT
2884 -------------------------------
2885 -- 3.3.1 Object Declaration --
2886 -------------------------------
2888 -- OBJECT_DECLARATION ::=
2889 -- DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2890 -- [NULL_EXCLUSION] SUBTYPE_INDICATION [:= EXPRESSION]
2891 -- [ASPECT_SPECIFICATIONS];
2892 -- | DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2893 -- ACCESS_DEFINITION [:= EXPRESSION]
2894 -- [ASPECT_SPECIFICATIONS];
2895 -- | DEFINING_IDENTIFIER_LIST : [aliased] [constant]
2896 -- ARRAY_TYPE_DEFINITION [:= EXPRESSION]
2897 -- [ASPECT_SPECIFICATIONS];
2898 -- | SINGLE_TASK_DECLARATION
2899 -- | SINGLE_PROTECTED_DECLARATION
2901 -- Note: aliased is not permitted in Ada 83 mode
2903 -- The N_Object_Declaration node is only for the first three cases.
2904 -- Single task declaration is handled by P_Task (9.1)
2905 -- Single protected declaration is handled by P_protected (9.5)
2907 -- Although the syntax allows multiple identifiers in the list, the
2908 -- semantics is as though successive declarations were given with
2909 -- identical type definition and expression components. To simplify
2910 -- semantic processing, the parser represents a multiple declaration
2911 -- case as a sequence of single declarations, using the More_Ids and
2912 -- Prev_Ids flags to preserve the original source form as described
2913 -- in the section on "Handling of Defining Identifier Lists".
2915 -- The flag Has_Init_Expression is set if an initializing expression
2916 -- is present. Normally it is set if and only if Expression contains
2917 -- a non-empty value, but there is an exception to this. When the
2918 -- initializing expression is an aggregate which requires explicit
2919 -- assignments, the Expression field gets set to Empty, but this flag
2920 -- is still set, so we don't forget we had an initializing expression.
2922 -- Note: if a range check is required for the initialization
2923 -- expression then the Do_Range_Check flag is set in the Expression,
2924 -- with the check being done against the type given by the object
2925 -- definition, which is also the Etype of the defining identifier.
2927 -- Note: the contents of the Expression field must be ignored (i.e.
2928 -- treated as though it were Empty) if No_Initialization is set True.
2930 -- Note: the back end places some restrictions on the form of the
2931 -- Expression field. If the object being declared is Atomic, then
2932 -- the Expression may not have the form of an aggregate (since this
2933 -- might cause the back end to generate separate assignments). In this
2934 -- case the front end must generate an extra temporary and initialize
2935 -- this temporary as required (the temporary itself is not atomic).
2937 -- Note: there is no node kind for object definition. Instead, the
2938 -- corresponding field holds a subtype indication, an array type
2939 -- definition, or (Ada 2005, AI-406) an access definition.
2941 -- N_Object_Declaration
2942 -- Sloc points to first identifier
2943 -- Defining_Identifier
2944 -- Aliased_Present
2945 -- Constant_Present set if CONSTANT appears
2946 -- Null_Exclusion_Present
2947 -- Object_Definition subtype indic./array type def./access def.
2948 -- Expression (set to Empty if not present)
2949 -- Handler_List_Entry
2950 -- Corresponding_Generic_Association
2951 -- More_Ids (set to False if no more identifiers in list)
2952 -- Prev_Ids (set to False if no previous identifiers in list)
2953 -- No_Initialization
2954 -- Assignment_OK
2955 -- Exception_Junk
2956 -- Is_Subprogram_Descriptor
2957 -- Has_Init_Expression
2958 -- Suppress_Assignment_Checks
2960 -------------------------------------
2961 -- 3.3.1 Defining Identifier List --
2962 -------------------------------------
2964 -- DEFINING_IDENTIFIER_LIST ::=
2965 -- DEFINING_IDENTIFIER {, DEFINING_IDENTIFIER}
2967 -------------------------------
2968 -- 3.3.2 Number Declaration --
2969 -------------------------------
2971 -- NUMBER_DECLARATION ::=
2972 -- DEFINING_IDENTIFIER_LIST : constant := static_EXPRESSION;
2974 -- Although the syntax allows multiple identifiers in the list, the
2975 -- semantics is as though successive declarations were given with
2976 -- identical expressions. To simplify semantic processing, the parser
2977 -- represents a multiple declaration case as a sequence of single
2978 -- declarations, using the More_Ids and Prev_Ids flags to preserve
2979 -- the original source form as described in the section on "Handling
2980 -- of Defining Identifier Lists".
2982 -- N_Number_Declaration
2983 -- Sloc points to first identifier
2984 -- Defining_Identifier
2985 -- Expression
2986 -- More_Ids (set to False if no more identifiers in list)
2987 -- Prev_Ids (set to False if no previous identifiers in list)
2989 ----------------------------------
2990 -- 3.4 Derived Type Definition --
2991 ----------------------------------
2993 -- DERIVED_TYPE_DEFINITION ::=
2994 -- [abstract] [limited] new [NULL_EXCLUSION] parent_SUBTYPE_INDICATION
2995 -- [[and INTERFACE_LIST] RECORD_EXTENSION_PART]
2997 -- Note: ABSTRACT, LIMITED, and record extension part are not permitted
2998 -- in Ada 83 mode.
3000 -- Note: a record extension part is required if ABSTRACT is present
3002 -- N_Derived_Type_Definition
3003 -- Sloc points to NEW
3004 -- Abstract_Present
3005 -- Null_Exclusion_Present (set to False if not present)
3006 -- Subtype_Indication
3007 -- Record_Extension_Part (set to Empty if not present)
3008 -- Limited_Present
3009 -- Task_Present set in task interfaces
3010 -- Protected_Present set in protected interfaces
3011 -- Synchronized_Present set in interfaces
3012 -- Interface_List (set to No_List if none)
3013 -- Interface_Present set in abstract interfaces
3015 -- Note: Task_Present, Protected_Present, Synchronized_Present,
3016 -- Interface_List, and Interface_Present are used for abstract
3017 -- interfaces (see comments for INTERFACE_TYPE_DEFINITION).
3019 ---------------------------
3020 -- 3.5 Range Constraint --
3021 ---------------------------
3023 -- RANGE_CONSTRAINT ::= range RANGE
3025 -- N_Range_Constraint
3026 -- Sloc points to RANGE
3027 -- Range_Expression
3029 ----------------
3030 -- 3.5 Range --
3031 ----------------
3033 -- RANGE ::=
3034 -- RANGE_ATTRIBUTE_REFERENCE
3035 -- | SIMPLE_EXPRESSION .. SIMPLE_EXPRESSION
3037 -- Note: the case of a range given as a range attribute reference
3038 -- appears directly in the tree as an attribute reference.
3040 -- Note: the field name for a reference to a range is Range_Expression
3041 -- rather than Range, because range is a reserved keyword in Ada.
3043 -- Note: the reason that this node has expression fields is that a
3044 -- range can appear as an operand of a membership test. The Etype
3045 -- field is the type of the range (we do NOT construct an implicit
3046 -- subtype to represent the range exactly).
3048 -- N_Range
3049 -- Sloc points to ..
3050 -- Low_Bound
3051 -- High_Bound
3052 -- Includes_Infinities
3053 -- plus fields for expression
3055 -- Note: if the range appears in a context, such as a subtype
3056 -- declaration, where range checks are required on one or both of
3057 -- the expression fields, then type conversion nodes are inserted
3058 -- to represent the required checks.
3060 ----------------------------------------
3061 -- 3.5.1 Enumeration Type Definition --
3062 ----------------------------------------
3064 -- ENUMERATION_TYPE_DEFINITION ::=
3065 -- (ENUMERATION_LITERAL_SPECIFICATION
3066 -- {, ENUMERATION_LITERAL_SPECIFICATION})
3068 -- Note: the Literals field in the node described below is null for
3069 -- the case of the standard types CHARACTER and WIDE_CHARACTER, for
3070 -- which special processing handles these types as special cases.
3072 -- N_Enumeration_Type_Definition
3073 -- Sloc points to left parenthesis
3074 -- Literals (Empty for CHARACTER or WIDE_CHARACTER)
3075 -- End_Label (set to Empty if internally generated record)
3077 ----------------------------------------------
3078 -- 3.5.1 Enumeration Literal Specification --
3079 ----------------------------------------------
3081 -- ENUMERATION_LITERAL_SPECIFICATION ::=
3082 -- DEFINING_IDENTIFIER | DEFINING_CHARACTER_LITERAL
3084 ---------------------------------------
3085 -- 3.5.1 Defining Character Literal --
3086 ---------------------------------------
3088 -- DEFINING_CHARACTER_LITERAL ::= CHARACTER_LITERAL
3090 -- A defining character literal is an entity, which has additional
3091 -- fields depending on the setting of the Ekind field. These
3092 -- additional fields are defined (and access subprograms declared)
3093 -- in package Einfo.
3095 -- Note: N_Defining_Character_Literal is an extended node whose fields
3096 -- are deliberately laid out to match layout of fields in an ordinary
3097 -- N_Character_Literal node, allowing for easy alteration of a character
3098 -- literal node into a defining character literal node. For details, see
3099 -- Sinfo.CN.Change_Character_Literal_To_Defining_Character_Literal.
3101 -- N_Defining_Character_Literal
3102 -- Sloc points to literal
3103 -- Chars contains the Name_Id for the identifier
3104 -- Next_Entity
3105 -- Scope
3106 -- Etype
3108 ------------------------------------
3109 -- 3.5.4 Integer Type Definition --
3110 ------------------------------------
3112 -- Note: there is an error in this rule in the latest version of the
3113 -- grammar, so we have retained the old rule pending clarification.
3115 -- INTEGER_TYPE_DEFINITION ::=
3116 -- SIGNED_INTEGER_TYPE_DEFINITION
3117 -- | MODULAR_TYPE_DEFINITION
3119 -------------------------------------------
3120 -- 3.5.4 Signed Integer Type Definition --
3121 -------------------------------------------
3123 -- SIGNED_INTEGER_TYPE_DEFINITION ::=
3124 -- range static_SIMPLE_EXPRESSION .. static_SIMPLE_EXPRESSION
3126 -- Note: the Low_Bound and High_Bound fields are set to Empty
3127 -- for integer types defined in package Standard.
3129 -- N_Signed_Integer_Type_Definition
3130 -- Sloc points to RANGE
3131 -- Low_Bound
3132 -- High_Bound
3134 ------------------------------------
3135 -- 3.5.4 Modular Type Definition --
3136 ------------------------------------
3138 -- MODULAR_TYPE_DEFINITION ::= mod static_EXPRESSION
3140 -- N_Modular_Type_Definition
3141 -- Sloc points to MOD
3142 -- Expression
3144 ---------------------------------
3145 -- 3.5.6 Real Type Definition --
3146 ---------------------------------
3148 -- REAL_TYPE_DEFINITION ::=
3149 -- FLOATING_POINT_DEFINITION | FIXED_POINT_DEFINITION
3151 --------------------------------------
3152 -- 3.5.7 Floating Point Definition --
3153 --------------------------------------
3155 -- FLOATING_POINT_DEFINITION ::=
3156 -- digits static_SIMPLE_EXPRESSION [REAL_RANGE_SPECIFICATION]
3158 -- Note: The Digits_Expression and Real_Range_Specifications fields
3159 -- are set to Empty for floating-point types declared in Standard.
3161 -- N_Floating_Point_Definition
3162 -- Sloc points to DIGITS
3163 -- Digits_Expression
3164 -- Real_Range_Specification (set to Empty if not present)
3166 -------------------------------------
3167 -- 3.5.7 Real Range Specification --
3168 -------------------------------------
3170 -- REAL_RANGE_SPECIFICATION ::=
3171 -- range static_SIMPLE_EXPRESSION .. static_SIMPLE_EXPRESSION
3173 -- N_Real_Range_Specification
3174 -- Sloc points to RANGE
3175 -- Low_Bound
3176 -- High_Bound
3178 -----------------------------------
3179 -- 3.5.9 Fixed Point Definition --
3180 -----------------------------------
3182 -- FIXED_POINT_DEFINITION ::=
3183 -- ORDINARY_FIXED_POINT_DEFINITION | DECIMAL_FIXED_POINT_DEFINITION
3185 --------------------------------------------
3186 -- 3.5.9 Ordinary Fixed Point Definition --
3187 --------------------------------------------
3189 -- ORDINARY_FIXED_POINT_DEFINITION ::=
3190 -- delta static_EXPRESSION REAL_RANGE_SPECIFICATION
3192 -- Note: In Ada 83, the EXPRESSION must be a SIMPLE_EXPRESSION
3194 -- N_Ordinary_Fixed_Point_Definition
3195 -- Sloc points to DELTA
3196 -- Delta_Expression
3197 -- Real_Range_Specification
3199 -------------------------------------------
3200 -- 3.5.9 Decimal Fixed Point Definition --
3201 -------------------------------------------
3203 -- DECIMAL_FIXED_POINT_DEFINITION ::=
3204 -- delta static_EXPRESSION
3205 -- digits static_EXPRESSION [REAL_RANGE_SPECIFICATION]
3207 -- Note: decimal types are not permitted in Ada 83 mode
3209 -- N_Decimal_Fixed_Point_Definition
3210 -- Sloc points to DELTA
3211 -- Delta_Expression
3212 -- Digits_Expression
3213 -- Real_Range_Specification (set to Empty if not present)
3215 ------------------------------
3216 -- 3.5.9 Digits Constraint --
3217 ------------------------------
3219 -- DIGITS_CONSTRAINT ::=
3220 -- digits static_EXPRESSION [RANGE_CONSTRAINT]
3222 -- Note: in Ada 83, the EXPRESSION must be a SIMPLE_EXPRESSION
3223 -- Note: in Ada 95, reduced accuracy subtypes are obsolescent
3225 -- N_Digits_Constraint
3226 -- Sloc points to DIGITS
3227 -- Digits_Expression
3228 -- Range_Constraint (set to Empty if not present)
3230 --------------------------------
3231 -- 3.6 Array Type Definition --
3232 --------------------------------
3234 -- ARRAY_TYPE_DEFINITION ::=
3235 -- UNCONSTRAINED_ARRAY_DEFINITION | CONSTRAINED_ARRAY_DEFINITION
3237 -----------------------------------------
3238 -- 3.6 Unconstrained Array Definition --
3239 -----------------------------------------
3241 -- UNCONSTRAINED_ARRAY_DEFINITION ::=
3242 -- array (INDEX_SUBTYPE_DEFINITION {, INDEX_SUBTYPE_DEFINITION}) of
3243 -- COMPONENT_DEFINITION
3245 -- Note: dimensionality of array is indicated by number of entries in
3246 -- the Subtype_Marks list, which has one entry for each dimension.
3248 -- N_Unconstrained_Array_Definition
3249 -- Sloc points to ARRAY
3250 -- Subtype_Marks
3251 -- Component_Definition
3253 -----------------------------------
3254 -- 3.6 Index Subtype Definition --
3255 -----------------------------------
3257 -- INDEX_SUBTYPE_DEFINITION ::= SUBTYPE_MARK range <>
3259 -- There is no explicit node in the tree for an index subtype
3260 -- definition since the N_Unconstrained_Array_Definition node
3261 -- incorporates the type marks which appear in this context.
3263 ---------------------------------------
3264 -- 3.6 Constrained Array Definition --
3265 ---------------------------------------
3267 -- CONSTRAINED_ARRAY_DEFINITION ::=
3268 -- array (DISCRETE_SUBTYPE_DEFINITION
3269 -- {, DISCRETE_SUBTYPE_DEFINITION})
3270 -- of COMPONENT_DEFINITION
3272 -- Note: dimensionality of array is indicated by number of entries
3273 -- in the Discrete_Subtype_Definitions list, which has one entry
3274 -- for each dimension.
3276 -- N_Constrained_Array_Definition
3277 -- Sloc points to ARRAY
3278 -- Discrete_Subtype_Definitions
3279 -- Component_Definition
3281 -- Note: although the language allows the full syntax for discrete
3282 -- subtype definitions (i.e. a discrete subtype indication or a range),
3283 -- in the generated tree, we always rewrite these as N_Range nodes.
3285 --------------------------------------
3286 -- 3.6 Discrete Subtype Definition --
3287 --------------------------------------
3289 -- DISCRETE_SUBTYPE_DEFINITION ::=
3290 -- discrete_SUBTYPE_INDICATION | RANGE
3292 -------------------------------
3293 -- 3.6 Component Definition --
3294 -------------------------------
3296 -- COMPONENT_DEFINITION ::=
3297 -- [aliased] [NULL_EXCLUSION] SUBTYPE_INDICATION | ACCESS_DEFINITION
3299 -- Note: although the syntax does not permit a component definition to
3300 -- be an anonymous array (and the parser will diagnose such an attempt
3301 -- with an appropriate message), it is possible for anonymous arrays
3302 -- to appear as component definitions. The semantics and back end handle
3303 -- this case properly, and the expander in fact generates such cases.
3304 -- Access_Definition is an optional field that gives support to
3305 -- Ada 2005 (AI-230). The parser generates nodes that have either the
3306 -- Subtype_Indication field or else the Access_Definition field.
3308 -- N_Component_Definition
3309 -- Sloc points to ALIASED, ACCESS, or to first token of subtype mark
3310 -- Aliased_Present
3311 -- Null_Exclusion_Present
3312 -- Subtype_Indication (set to Empty if not present)
3313 -- Access_Definition (set to Empty if not present)
3315 -----------------------------
3316 -- 3.6.1 Index Constraint --
3317 -----------------------------
3319 -- INDEX_CONSTRAINT ::= (DISCRETE_RANGE {, DISCRETE_RANGE})
3321 -- It is not in general possible to distinguish between discriminant
3322 -- constraints and index constraints at parse time, since a simple
3323 -- name could be either the subtype mark of a discrete range, or an
3324 -- expression in a discriminant association with no name. Either
3325 -- entry appears simply as the name, and the semantic parse must
3326 -- distinguish between the two cases. Thus we use a common tree
3327 -- node format for both of these constraint types.
3329 -- See Discriminant_Constraint for format of node
3331 ---------------------------
3332 -- 3.6.1 Discrete Range --
3333 ---------------------------
3335 -- DISCRETE_RANGE ::= discrete_SUBTYPE_INDICATION | RANGE
3337 ----------------------------
3338 -- 3.7 Discriminant Part --
3339 ----------------------------
3341 -- DISCRIMINANT_PART ::=
3342 -- UNKNOWN_DISCRIMINANT_PART | KNOWN_DISCRIMINANT_PART
3344 ------------------------------------
3345 -- 3.7 Unknown Discriminant Part --
3346 ------------------------------------
3348 -- UNKNOWN_DISCRIMINANT_PART ::= (<>)
3350 -- Note: unknown discriminant parts are not permitted in Ada 83 mode
3352 -- There is no explicit node in the tree for an unknown discriminant
3353 -- part. Instead the Unknown_Discriminants_Present flag is set in the
3354 -- parent node.
3356 ----------------------------------
3357 -- 3.7 Known Discriminant Part --
3358 ----------------------------------
3360 -- KNOWN_DISCRIMINANT_PART ::=
3361 -- (DISCRIMINANT_SPECIFICATION {; DISCRIMINANT_SPECIFICATION})
3363 -------------------------------------
3364 -- 3.7 Discriminant Specification --
3365 -------------------------------------
3367 -- DISCRIMINANT_SPECIFICATION ::=
3368 -- DEFINING_IDENTIFIER_LIST : [NULL_EXCLUSION] SUBTYPE_MARK
3369 -- [:= DEFAULT_EXPRESSION]
3370 -- | DEFINING_IDENTIFIER_LIST : ACCESS_DEFINITION
3371 -- [:= DEFAULT_EXPRESSION]
3373 -- Although the syntax allows multiple identifiers in the list, the
3374 -- semantics is as though successive specifications were given with
3375 -- identical type definition and expression components. To simplify
3376 -- semantic processing, the parser represents a multiple declaration
3377 -- case as a sequence of single specifications, using the More_Ids and
3378 -- Prev_Ids flags to preserve the original source form as described
3379 -- in the section on "Handling of Defining Identifier Lists".
3381 -- N_Discriminant_Specification
3382 -- Sloc points to first identifier
3383 -- Defining_Identifier
3384 -- Null_Exclusion_Present
3385 -- Discriminant_Type subtype mark or access parameter definition
3386 -- Expression (set to Empty if no default expression)
3387 -- More_Ids (set to False if no more identifiers in list)
3388 -- Prev_Ids (set to False if no previous identifiers in list)
3390 -----------------------------
3391 -- 3.7 Default Expression --
3392 -----------------------------
3394 -- DEFAULT_EXPRESSION ::= EXPRESSION
3396 ------------------------------------
3397 -- 3.7.1 Discriminant Constraint --
3398 ------------------------------------
3400 -- DISCRIMINANT_CONSTRAINT ::=
3401 -- (DISCRIMINANT_ASSOCIATION {, DISCRIMINANT_ASSOCIATION})
3403 -- It is not in general possible to distinguish between discriminant
3404 -- constraints and index constraints at parse time, since a simple
3405 -- name could be either the subtype mark of a discrete range, or an
3406 -- expression in a discriminant association with no name. Either
3407 -- entry appears simply as the name, and the semantic parse must
3408 -- distinguish between the two cases. Thus we use a common tree
3409 -- node format for both of these constraint types.
3411 -- N_Index_Or_Discriminant_Constraint
3412 -- Sloc points to left paren
3413 -- Constraints points to list of discrete ranges or
3414 -- discriminant associations
3416 -------------------------------------
3417 -- 3.7.1 Discriminant Association --
3418 -------------------------------------
3420 -- DISCRIMINANT_ASSOCIATION ::=
3421 -- [discriminant_SELECTOR_NAME
3422 -- {| discriminant_SELECTOR_NAME} =>] EXPRESSION
3424 -- Note: a discriminant association that has no selector name list
3425 -- appears directly as an expression in the tree.
3427 -- N_Discriminant_Association
3428 -- Sloc points to first token of discriminant association
3429 -- Selector_Names (always non-empty, since if no selector
3430 -- names are present, this node is not used, see comment above)
3431 -- Expression
3433 ---------------------------------
3434 -- 3.8 Record Type Definition --
3435 ---------------------------------
3437 -- RECORD_TYPE_DEFINITION ::=
3438 -- [[abstract] tagged] [limited] RECORD_DEFINITION
3440 -- Note: ABSTRACT, TAGGED, LIMITED are not permitted in Ada 83 mode
3442 -- There is no explicit node in the tree for a record type definition.
3443 -- Instead the flags for Tagged_Present and Limited_Present appear in
3444 -- the N_Record_Definition node for a record definition appearing in
3445 -- the context of a record type definition.
3447 ----------------------------
3448 -- 3.8 Record Definition --
3449 ----------------------------
3451 -- RECORD_DEFINITION ::=
3452 -- record
3453 -- COMPONENT_LIST
3454 -- end record
3455 -- | null record
3457 -- Note: the Abstract_Present, Tagged_Present, and Limited_Present
3458 -- flags appear only for a record definition appearing in a record
3459 -- type definition.
3461 -- Note: the NULL RECORD case is not permitted in Ada 83
3463 -- N_Record_Definition
3464 -- Sloc points to RECORD or NULL
3465 -- End_Label (set to Empty if internally generated record)
3466 -- Abstract_Present
3467 -- Tagged_Present
3468 -- Limited_Present
3469 -- Component_List empty in null record case
3470 -- Null_Present set in null record case
3471 -- Task_Present set in task interfaces
3472 -- Protected_Present set in protected interfaces
3473 -- Synchronized_Present set in interfaces
3474 -- Interface_Present set in abstract interfaces
3475 -- Interface_List (set to No_List if none)
3477 -- Note: Task_Present, Protected_Present, Synchronized _Present,
3478 -- Interface_List and Interface_Present are used for abstract
3479 -- interfaces (see comments for INTERFACE_TYPE_DEFINITION).
3481 -------------------------
3482 -- 3.8 Component List --
3483 -------------------------
3485 -- COMPONENT_LIST ::=
3486 -- COMPONENT_ITEM {COMPONENT_ITEM}
3487 -- | {COMPONENT_ITEM} VARIANT_PART
3488 -- | null;
3490 -- N_Component_List
3491 -- Sloc points to first token of component list
3492 -- Component_Items
3493 -- Variant_Part (set to Empty if no variant part)
3494 -- Null_Present
3496 -------------------------
3497 -- 3.8 Component Item --
3498 -------------------------
3500 -- COMPONENT_ITEM ::= COMPONENT_DECLARATION | REPRESENTATION_CLAUSE
3502 -- Note: A component item can also be a pragma, and in the tree
3503 -- that is obtained after semantic processing, a component item
3504 -- can be an N_Null node resulting from a non-recognized pragma.
3506 --------------------------------
3507 -- 3.8 Component Declaration --
3508 --------------------------------
3510 -- COMPONENT_DECLARATION ::=
3511 -- DEFINING_IDENTIFIER_LIST : COMPONENT_DEFINITION
3512 -- [:= DEFAULT_EXPRESSION]
3513 -- [ASPECT_SPECIFICATIONS];
3515 -- Note: although the syntax does not permit a component definition to
3516 -- be an anonymous array (and the parser will diagnose such an attempt
3517 -- with an appropriate message), it is possible for anonymous arrays
3518 -- to appear as component definitions. The semantics and back end handle
3519 -- this case properly, and the expander in fact generates such cases.
3521 -- Although the syntax allows multiple identifiers in the list, the
3522 -- semantics is as though successive declarations were given with the
3523 -- same component definition and expression components. To simplify
3524 -- semantic processing, the parser represents a multiple declaration
3525 -- case as a sequence of single declarations, using the More_Ids and
3526 -- Prev_Ids flags to preserve the original source form as described
3527 -- in the section on "Handling of Defining Identifier Lists".
3529 -- N_Component_Declaration
3530 -- Sloc points to first identifier
3531 -- Defining_Identifier
3532 -- Component_Definition
3533 -- Expression (set to Empty if no default expression)
3534 -- More_Ids (set to False if no more identifiers in list)
3535 -- Prev_Ids (set to False if no previous identifiers in list)
3537 -------------------------
3538 -- 3.8.1 Variant Part --
3539 -------------------------
3541 -- VARIANT_PART ::=
3542 -- case discriminant_DIRECT_NAME is
3543 -- VARIANT {VARIANT}
3544 -- end case;
3546 -- Note: the variants list can contain pragmas as well as variants.
3547 -- In a properly formed program there is at least one variant.
3549 -- N_Variant_Part
3550 -- Sloc points to CASE
3551 -- Name
3552 -- Variants
3554 --------------------
3555 -- 3.8.1 Variant --
3556 --------------------
3558 -- VARIANT ::=
3559 -- when DISCRETE_CHOICE_LIST =>
3560 -- COMPONENT_LIST
3562 -- N_Variant
3563 -- Sloc points to WHEN
3564 -- Discrete_Choices
3565 -- Component_List
3566 -- Enclosing_Variant
3567 -- Present_Expr
3568 -- Dcheck_Function
3569 -- Has_SP_Choice
3571 -- Note: in the list of Discrete_Choices, the tree passed to the back
3572 -- end does not have choice entries corresponding to names of statically
3573 -- predicated subtypes. Such entries are always expanded out to the list
3574 -- of equivalent values or ranges.
3576 ---------------------------------
3577 -- 3.8.1 Discrete Choice List --
3578 ---------------------------------
3580 -- DISCRETE_CHOICE_LIST ::= DISCRETE_CHOICE {| DISCRETE_CHOICE}
3582 ----------------------------
3583 -- 3.8.1 Discrete Choice --
3584 ----------------------------
3586 -- DISCRETE_CHOICE ::= EXPRESSION | DISCRETE_RANGE | others
3588 -- Note: in Ada 83 mode, the expression must be a simple expression
3590 -- The only choice that appears explicitly is the OTHERS choice, as
3591 -- defined here. Other cases of discrete choice (expression and
3592 -- discrete range) appear directly. This production is also used
3593 -- for the OTHERS possibility of an exception choice.
3595 -- Note: in accordance with the syntax, the parser does not check that
3596 -- OTHERS appears at the end on its own in a choice list context. This
3597 -- is a semantic check.
3599 -- N_Others_Choice
3600 -- Sloc points to OTHERS
3601 -- Others_Discrete_Choices
3602 -- All_Others
3604 ----------------------------------
3605 -- 3.9.1 Record Extension Part --
3606 ----------------------------------
3608 -- RECORD_EXTENSION_PART ::= with RECORD_DEFINITION
3610 -- Note: record extension parts are not permitted in Ada 83 mode
3612 --------------------------------------
3613 -- 3.9.4 Interface Type Definition --
3614 --------------------------------------
3616 -- INTERFACE_TYPE_DEFINITION ::=
3617 -- [limited | task | protected | synchronized]
3618 -- interface [interface_list]
3620 -- Note: Interfaces are implemented with N_Record_Definition and
3621 -- N_Derived_Type_Definition nodes because most of the support
3622 -- for the analysis of abstract types has been reused to
3623 -- analyze abstract interfaces.
3625 ----------------------------------
3626 -- 3.10 Access Type Definition --
3627 ----------------------------------
3629 -- ACCESS_TYPE_DEFINITION ::=
3630 -- ACCESS_TO_OBJECT_DEFINITION
3631 -- | ACCESS_TO_SUBPROGRAM_DEFINITION
3633 --------------------------
3634 -- 3.10 Null Exclusion --
3635 --------------------------
3637 -- NULL_EXCLUSION ::= not null
3639 ---------------------------------------
3640 -- 3.10 Access To Object Definition --
3641 ---------------------------------------
3643 -- ACCESS_TO_OBJECT_DEFINITION ::=
3644 -- [NULL_EXCLUSION] access [GENERAL_ACCESS_MODIFIER]
3645 -- SUBTYPE_INDICATION
3647 -- N_Access_To_Object_Definition
3648 -- Sloc points to ACCESS
3649 -- All_Present
3650 -- Null_Exclusion_Present
3651 -- Null_Excluding_Subtype
3652 -- Subtype_Indication
3653 -- Constant_Present
3655 -----------------------------------
3656 -- 3.10 General Access Modifier --
3657 -----------------------------------
3659 -- GENERAL_ACCESS_MODIFIER ::= all | constant
3661 -- Note: general access modifiers are not permitted in Ada 83 mode
3663 -- There is no explicit node in the tree for general access modifier.
3664 -- Instead the All_Present or Constant_Present flags are set in the
3665 -- parent node.
3667 -------------------------------------------
3668 -- 3.10 Access To Subprogram Definition --
3669 -------------------------------------------
3671 -- ACCESS_TO_SUBPROGRAM_DEFINITION
3672 -- [NULL_EXCLUSION] access [protected] procedure PARAMETER_PROFILE
3673 -- | [NULL_EXCLUSION] access [protected] function
3674 -- PARAMETER_AND_RESULT_PROFILE
3676 -- Note: access to subprograms are not permitted in Ada 83 mode
3678 -- N_Access_Function_Definition
3679 -- Sloc points to ACCESS
3680 -- Null_Exclusion_Present
3681 -- Null_Exclusion_In_Return_Present
3682 -- Protected_Present
3683 -- Parameter_Specifications (set to No_List if no formal part)
3684 -- Result_Definition result subtype (subtype mark or access def)
3686 -- N_Access_Procedure_Definition
3687 -- Sloc points to ACCESS
3688 -- Null_Exclusion_Present
3689 -- Protected_Present
3690 -- Parameter_Specifications (set to No_List if no formal part)
3692 -----------------------------
3693 -- 3.10 Access Definition --
3694 -----------------------------
3696 -- ACCESS_DEFINITION ::=
3697 -- [NULL_EXCLUSION] access [GENERAL_ACCESS_MODIFIER] SUBTYPE_MARK
3698 -- | ACCESS_TO_SUBPROGRAM_DEFINITION
3700 -- Note: access to subprograms are an Ada 2005 (AI-254) extension
3702 -- N_Access_Definition
3703 -- Sloc points to ACCESS
3704 -- Null_Exclusion_Present
3705 -- All_Present
3706 -- Constant_Present
3707 -- Subtype_Mark
3708 -- Access_To_Subprogram_Definition (set to Empty if not present)
3710 -----------------------------------------
3711 -- 3.10.1 Incomplete Type Declaration --
3712 -----------------------------------------
3714 -- INCOMPLETE_TYPE_DECLARATION ::=
3715 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART] [IS TAGGED];
3717 -- N_Incomplete_Type_Declaration
3718 -- Sloc points to TYPE
3719 -- Defining_Identifier
3720 -- Discriminant_Specifications (set to No_List if no
3721 -- discriminant part, or if the discriminant part is an
3722 -- unknown discriminant part)
3723 -- Premature_Use used for improved diagnostics.
3724 -- Unknown_Discriminants_Present set if (<>) discriminant
3725 -- Tagged_Present
3727 ----------------------------
3728 -- 3.11 Declarative Part --
3729 ----------------------------
3731 -- DECLARATIVE_PART ::= {DECLARATIVE_ITEM}
3733 -- Note: although the parser enforces the syntactic requirement that
3734 -- a declarative part can contain only declarations, the semantic
3735 -- processing may add statements to the list of actions in a
3736 -- declarative part, so the code generator should be prepared
3737 -- to accept a statement in this position.
3739 ----------------------------
3740 -- 3.11 Declarative Item --
3741 ----------------------------
3743 -- DECLARATIVE_ITEM ::= BASIC_DECLARATIVE_ITEM | BODY
3745 ----------------------------------
3746 -- 3.11 Basic Declarative Item --
3747 ----------------------------------
3749 -- BASIC_DECLARATIVE_ITEM ::=
3750 -- BASIC_DECLARATION | REPRESENTATION_CLAUSE | USE_CLAUSE
3752 ----------------
3753 -- 3.11 Body --
3754 ----------------
3756 -- BODY ::= PROPER_BODY | BODY_STUB
3758 -----------------------
3759 -- 3.11 Proper Body --
3760 -----------------------
3762 -- PROPER_BODY ::=
3763 -- SUBPROGRAM_BODY | PACKAGE_BODY | TASK_BODY | PROTECTED_BODY
3765 ---------------
3766 -- 4.1 Name --
3767 ---------------
3769 -- NAME ::=
3770 -- DIRECT_NAME | EXPLICIT_DEREFERENCE
3771 -- | INDEXED_COMPONENT | SLICE
3772 -- | SELECTED_COMPONENT | ATTRIBUTE_REFERENCE
3773 -- | TYPE_CONVERSION | FUNCTION_CALL
3774 -- | CHARACTER_LITERAL
3776 ----------------------
3777 -- 4.1 Direct Name --
3778 ----------------------
3780 -- DIRECT_NAME ::= IDENTIFIER | OPERATOR_SYMBOL
3782 -----------------
3783 -- 4.1 Prefix --
3784 -----------------
3786 -- PREFIX ::= NAME | IMPLICIT_DEREFERENCE
3788 -------------------------------
3789 -- 4.1 Explicit Dereference --
3790 -------------------------------
3792 -- EXPLICIT_DEREFERENCE ::= NAME . all
3794 -- N_Explicit_Dereference
3795 -- Sloc points to ALL
3796 -- Prefix
3797 -- Actual_Designated_Subtype
3798 -- Has_Dereference_Action
3799 -- Atomic_Sync_Required
3800 -- plus fields for expression
3802 -------------------------------
3803 -- 4.1 Implicit Dereference --
3804 -------------------------------
3806 -- IMPLICIT_DEREFERENCE ::= NAME
3808 ------------------------------
3809 -- 4.1.1 Indexed Component --
3810 ------------------------------
3812 -- INDEXED_COMPONENT ::= PREFIX (EXPRESSION {, EXPRESSION})
3814 -- Note: the parser may generate this node in some situations where it
3815 -- should be a function call. The semantic pass must correct this
3816 -- misidentification (which is inevitable at the parser level).
3818 -- N_Indexed_Component
3819 -- Sloc contains a copy of the Sloc value of the Prefix
3820 -- Prefix
3821 -- Expressions
3822 -- Generalized_Indexing
3823 -- Atomic_Sync_Required
3824 -- plus fields for expression
3826 -- Note: if any of the subscripts requires a range check, then the
3827 -- Do_Range_Check flag is set on the corresponding expression, with
3828 -- the index type being determined from the type of the Prefix, which
3829 -- references the array being indexed.
3831 -- Note: in a fully analyzed and expanded indexed component node, and
3832 -- hence in any such node that gigi sees, if the prefix is an access
3833 -- type, then an explicit dereference operation has been inserted.
3835 ------------------
3836 -- 4.1.2 Slice --
3837 ------------------
3839 -- SLICE ::= PREFIX (DISCRETE_RANGE)
3841 -- Note: an implicit subtype is created to describe the resulting
3842 -- type, so that the bounds of this type are the bounds of the slice.
3844 -- N_Slice
3845 -- Sloc points to first token of prefix
3846 -- Prefix
3847 -- Discrete_Range
3848 -- plus fields for expression
3850 -------------------------------
3851 -- 4.1.3 Selected Component --
3852 -------------------------------
3854 -- SELECTED_COMPONENT ::= PREFIX . SELECTOR_NAME
3856 -- Note: selected components that are semantically expanded names get
3857 -- changed during semantic processing into the separate N_Expanded_Name
3858 -- node. See description of this node in the section on semantic nodes.
3860 -- N_Selected_Component
3861 -- Sloc points to the period
3862 -- Prefix
3863 -- Selector_Name
3864 -- Associated_Node
3865 -- Do_Discriminant_Check
3866 -- Is_In_Discriminant_Check
3867 -- Atomic_Sync_Required
3868 -- Is_Prefixed_Call
3869 -- plus fields for expression
3871 --------------------------
3872 -- 4.1.3 Selector Name --
3873 --------------------------
3875 -- SELECTOR_NAME ::= IDENTIFIER | CHARACTER_LITERAL | OPERATOR_SYMBOL
3877 --------------------------------
3878 -- 4.1.4 Attribute Reference --
3879 --------------------------------
3881 -- ATTRIBUTE_REFERENCE ::= PREFIX ' ATTRIBUTE_DESIGNATOR
3883 -- Note: the syntax is quite ambiguous at this point. Consider:
3885 -- A'Length (X) X is part of the attribute designator
3886 -- A'Pos (X) X is an explicit actual parameter of function A'Pos
3887 -- A'Class (X) X is the expression of a type conversion
3889 -- It would be possible for the parser to distinguish these cases
3890 -- by looking at the attribute identifier. However, that would mean
3891 -- more work in introducing new implementation defined attributes,
3892 -- and also it would mean that special processing for attributes
3893 -- would be scattered around, instead of being centralized in the
3894 -- semantic routine that handles an N_Attribute_Reference node.
3895 -- Consequently, the parser in all the above cases stores the
3896 -- expression (X in these examples) as a single element list in
3897 -- in the Expressions field of the N_Attribute_Reference node.
3899 -- Similarly, for attributes like Max which take two arguments,
3900 -- we store the two arguments as a two element list in the
3901 -- Expressions field. Of course it is clear at parse time that
3902 -- this case is really a function call with an attribute as the
3903 -- prefix, but it turns out to be convenient to handle the two
3904 -- argument case in a similar manner to the one argument case,
3905 -- and indeed in general the parser will accept any number of
3906 -- expressions in this position and store them as a list in the
3907 -- attribute reference node. This allows for future addition of
3908 -- attributes that take more than two arguments.
3910 -- Note: named associates are not permitted in function calls where
3911 -- the function is an attribute (see RM 6.4(3)) so it is legitimate
3912 -- to skip the normal subprogram argument processing.
3914 -- Note: for the attributes whose designators are technically keywords,
3915 -- i.e. digits, access, delta, range, the Attribute_Name field contains
3916 -- the corresponding name, even though no identifier is involved.
3918 -- Note: the generated code may contain stream attributes applied to
3919 -- limited types for which no stream routines exist officially. In such
3920 -- case, the result is to use the stream attribute for the underlying
3921 -- full type, or in the case of a protected type, the components
3922 -- (including any discriminants) are merely streamed in order.
3924 -- See Exp_Attr for a complete description of which attributes are
3925 -- passed onto Gigi, and which are handled entirely by the front end.
3927 -- Gigi restriction: For the Pos attribute, the prefix cannot be
3928 -- a non-standard enumeration type or a nonzero/zero semantics
3929 -- boolean type, so the value is simply the stored representation.
3931 -- Gigi requirement: For the Mechanism_Code attribute, if the prefix
3932 -- references a subprogram that is a renaming, then the front end must
3933 -- rewrite the attribute to refer directly to the renamed entity.
3935 -- Note: syntactically the prefix of an attribute reference must be a
3936 -- name, and this (somewhat artificial) requirement is enforced by the
3937 -- parser. However, for many attributes, such as 'Valid, it is quite
3938 -- reasonable to apply the attribute to any value, and hence to any
3939 -- expression. Internally in the tree, the prefix is an expression which
3940 -- does not have to be a name, and this is handled fine by the semantic
3941 -- analysis and expansion, and back ends. This arises for the case of
3942 -- attribute references built by the expander (e.g. 'Valid for the case
3943 -- of an implicit validity check).
3945 -- Note: In generated code, the Address and Unrestricted_Access
3946 -- attributes can be applied to any expression, and the meaning is
3947 -- to create an object containing the value (the object is in the
3948 -- current stack frame), and pass the address of this value. If the
3949 -- Must_Be_Byte_Aligned flag is set, then the object whose address
3950 -- is taken must be on a byte (storage unit) boundary, and if it is
3951 -- not (or may not be), then the generated code must create a copy
3952 -- that is byte aligned, and pass the address of this copy.
3954 -- N_Attribute_Reference
3955 -- Sloc points to apostrophe
3956 -- Prefix (general expression, see note above)
3957 -- Attribute_Name identifier name from attribute designator
3958 -- Expressions (set to No_List if no associated expressions)
3959 -- Entity used if the attribute yields a type
3960 -- Associated_Node
3961 -- Is_Elaboration_Checks_OK_Node
3962 -- Is_SPARK_Mode_On_Node
3963 -- Is_Elaboration_Warnings_OK_Node
3964 -- Header_Size_Added
3965 -- Redundant_Use
3966 -- Must_Be_Byte_Aligned
3967 -- plus fields for expression
3969 -- Note: in Modify_Tree_For_C mode, Max and Min attributes are expanded
3970 -- into equivalent if expressions, properly taking care of side effects.
3972 ---------------------------------
3973 -- 4.1.4 Attribute Designator --
3974 ---------------------------------
3976 -- ATTRIBUTE_DESIGNATOR ::=
3977 -- IDENTIFIER [(static_EXPRESSION)]
3978 -- | access | delta | digits
3980 -- There is no explicit node in the tree for an attribute designator.
3981 -- Instead the Attribute_Name and Expressions fields of the parent
3982 -- node (N_Attribute_Reference node) hold the information.
3984 -- Note: if ACCESS, DELTA, or DIGITS appears in an attribute
3985 -- designator, then they are treated as identifiers internally
3986 -- rather than the keywords of the same name.
3988 --------------------------------------
3989 -- 4.1.4 Range Attribute Reference --
3990 --------------------------------------
3992 -- RANGE_ATTRIBUTE_REFERENCE ::= PREFIX ' RANGE_ATTRIBUTE_DESIGNATOR
3994 -- A range attribute reference is represented in the tree using the
3995 -- normal N_Attribute_Reference node.
3997 ---------------------------------------
3998 -- 4.1.4 Range Attribute Designator --
3999 ---------------------------------------
4001 -- RANGE_ATTRIBUTE_DESIGNATOR ::= Range [(static_EXPRESSION)]
4003 -- A range attribute designator is represented in the tree using the
4004 -- normal N_Attribute_Reference node.
4006 --------------------
4007 -- 4.3 Aggregate --
4008 --------------------
4010 -- AGGREGATE ::=
4011 -- RECORD_AGGREGATE | EXTENSION_AGGREGATE | ARRAY_AGGREGATE
4013 -----------------------------
4014 -- 4.3.1 Record Aggregate --
4015 -----------------------------
4017 -- RECORD_AGGREGATE ::= (RECORD_COMPONENT_ASSOCIATION_LIST)
4019 -- N_Aggregate
4020 -- Sloc points to left parenthesis
4021 -- Expressions (set to No_List if none or null record case)
4022 -- Component_Associations (set to No_List if none)
4023 -- Null_Record_Present
4024 -- Aggregate_Bounds
4025 -- Associated_Node
4026 -- Compile_Time_Known_Aggregate
4027 -- Expansion_Delayed
4028 -- Has_Self_Reference
4029 -- Is_Enum_Array_Aggregate
4030 -- Is_Homogeneous_Aggregate
4031 -- Is_Parenthesis_Aggregate
4032 -- plus fields for expression
4034 -- Note: this structure is used for both record and array aggregates
4035 -- since the two cases are not separable by the parser. The parser
4036 -- makes no attempt to enforce consistency here, so it is up to the
4037 -- semantic phase to make sure that the aggregate is consistent (i.e.
4038 -- that it is not a "half-and-half" case that mixes record and array
4039 -- syntax). In particular, for a record aggregate, the expressions
4040 -- field will be set if there are positional associations.
4042 -- Note: N_Aggregate is not used for all aggregates; in particular,
4043 -- there is a separate node kind for extension aggregates.
4045 -- Note: gigi/gcc can handle array aggregates correctly providing that
4046 -- they are entirely positional, and the array subtype involved has a
4047 -- known at compile time length and is not bit packed, or a convention
4048 -- Fortran array with more than one dimension. If these conditions
4049 -- are not met, then the front end must translate the aggregate into
4050 -- an appropriate set of assignments into a temporary.
4052 -- Note: for the record aggregate case, gigi/gcc can handle most cases
4053 -- of record aggregates, including those for packed, and rep-claused
4054 -- records, and also variant records, providing that there are no
4055 -- variable length fields whose size is not known at compile time,
4056 -- and providing that the aggregate is presented in fully named form.
4058 -- The other situation in which array aggregates and record aggregates
4059 -- cannot be passed to the back end is if assignment to one or more
4060 -- components itself needs expansion, e.g. in the case of an assignment
4061 -- of an object of a controlled type. In such cases, the front end
4062 -- must expand the aggregate to a series of assignments, and apply
4063 -- the required expansion to the individual assignment statements.
4065 ----------------------------------------------
4066 -- 4.3.1 Record Component Association List --
4067 ----------------------------------------------
4069 -- RECORD_COMPONENT_ASSOCIATION_LIST ::=
4070 -- RECORD_COMPONENT_ASSOCIATION {, RECORD_COMPONENT_ASSOCIATION}
4071 -- | null record
4073 -- There is no explicit node in the tree for a record component
4074 -- association list. Instead the Null_Record_Present flag is set in
4075 -- the parent node for the NULL RECORD case.
4077 ------------------------------------------------------
4078 -- 4.3.1 Record Component Association (also 4.3.3) --
4079 ------------------------------------------------------
4081 -- RECORD_COMPONENT_ASSOCIATION ::=
4082 -- [COMPONENT_CHOICE_LIST =>] EXPRESSION
4084 -- N_Component_Association
4085 -- Sloc points to first selector name
4086 -- Choices
4087 -- Expression (empty if Box_Present)
4088 -- Loop_Actions
4089 -- Box_Present
4090 -- Inherited_Discriminant
4091 -- Binding_Chars
4093 -- Note: this structure is used for both record component associations
4094 -- and array component associations, since the two cases aren't always
4095 -- separable by the parser. The choices list may represent either a
4096 -- list of selector names in the record aggregate case, or a list of
4097 -- discrete choices in the array aggregate case or an N_Others_Choice
4098 -- node (which appears as a singleton list). Box_Present gives support
4099 -- to Ada 2005 (AI-287). Binding_Chars is only set if GNAT extensions
4100 -- are enabled and the given component association occurs within a
4101 -- choice_expression; in this case, it is the Name_Id, if any, specified
4102 -- via either of two syntactic forms: "Foo => Bar is Abc" or
4103 -- "Foo => <Abc>".
4105 ----------------------------------
4106 -- 4.3.1 Component Choice List --
4107 ----------------------------------
4109 -- COMPONENT_CHOICE_LIST ::=
4110 -- component_SELECTOR_NAME {| component_SELECTOR_NAME}
4111 -- | others
4113 -- The entries of a component choice list appear in the Choices list of
4114 -- the associated N_Component_Association, as either selector names, or
4115 -- as an N_Others_Choice node.
4117 --------------------------------
4118 -- 4.3.2 Extension Aggregate --
4119 --------------------------------
4121 -- EXTENSION_AGGREGATE ::=
4122 -- (ANCESTOR_PART with RECORD_COMPONENT_ASSOCIATION_LIST)
4124 -- Note: extension aggregates are not permitted in Ada 83 mode
4126 -- N_Extension_Aggregate
4127 -- Sloc points to left parenthesis
4128 -- Ancestor_Part
4129 -- Associated_Node
4130 -- Expressions (set to No_List if none or null record case)
4131 -- Component_Associations (set to No_List if none)
4132 -- Null_Record_Present
4133 -- Expansion_Delayed
4134 -- Has_Self_Reference
4135 -- plus fields for expression
4137 --------------------------
4138 -- 4.3.2 Ancestor Part --
4139 --------------------------
4141 -- ANCESTOR_PART ::= EXPRESSION | SUBTYPE_MARK
4143 ----------------------------
4144 -- 4.3.3 Array Aggregate --
4145 ----------------------------
4147 -- ARRAY_AGGREGATE ::=
4148 -- POSITIONAL_ARRAY_AGGREGATE | NAMED_ARRAY_AGGREGATE
4150 ---------------------------------------
4151 -- 4.3.3 Positional Array Aggregate --
4152 ---------------------------------------
4154 -- POSITIONAL_ARRAY_AGGREGATE ::=
4155 -- (EXPRESSION, EXPRESSION {, EXPRESSION})
4156 -- | (EXPRESSION {, EXPRESSION}, others => EXPRESSION)
4158 -- See Record_Aggregate (4.3.1) for node structure
4160 ----------------------------------
4161 -- 4.3.3 Named Array Aggregate --
4162 ----------------------------------
4164 -- NAMED_ARRAY_AGGREGATE ::=
4165 -- (ARRAY_COMPONENT_ASSOCIATION {, ARRAY_COMPONENT_ASSOCIATION})
4167 -- See Record_Aggregate (4.3.1) for node structure
4169 ----------------------------------------
4170 -- 4.3.3 Array Component Association --
4171 ----------------------------------------
4173 -- ARRAY_COMPONENT_ASSOCIATION ::=
4174 -- DISCRETE_CHOICE_LIST => EXPRESSION
4175 -- | ITERATED_COMPONENT_ASSOCIATION
4177 -- See Record_Component_Association (4.3.1) for node structure
4178 -- The iterated_component_association is introduced into the
4179 -- Corrigendum of Ada_2012 by AI12-061.
4181 ------------------------------------------
4182 -- 4.3.3 Iterated component Association --
4183 ------------------------------------------
4185 -- ITERATED_COMPONENT_ASSOCIATION ::=
4186 -- for DEFINING_IDENTIFIER in DISCRETE_CHOICE_LIST => EXPRESSION
4187 -- for ITERATOR_SPECIFICATION => EXPRESSION
4189 -- At most one of (Defining_Identifier, Iterator_Specification)
4190 -- is present at a time, in which case the other one is empty.
4192 -- N_Iterated_Component_Association
4193 -- Sloc points to FOR
4194 -- Defining_Identifier
4195 -- Iterator_Specification
4196 -- Expression
4197 -- Discrete_Choices
4198 -- Loop_Actions
4199 -- Box_Present
4201 -- Note that Box_Present is always False, but it is intentionally added
4202 -- for completeness.
4204 ----------------------------
4205 -- 4.3.4 Delta Aggregate --
4206 ----------------------------
4208 -- N_Delta_Aggregate
4209 -- Sloc points to left parenthesis
4210 -- Expression
4211 -- Component_Associations
4212 -- Etype
4214 ---------------------------------
4215 -- 3.4.5 Container_Aggregates --
4216 ---------------------------------
4218 -- ITERATED_ELEMENT_ASSOCIATION ::=
4219 -- for LOOP_PARAMETER_SPECIFICATION[ use KEY_EXPRESSION] => EXPRESSION
4220 -- | for ITERATOR_SPECIFICATION[ use KEY_EXPRESSION] => EXPRESSION
4222 -- N_Iterated_Element_Association
4223 -- Key_Expression
4224 -- Iterator_Specification
4225 -- Expression
4226 -- Loop_Parameter_Specification
4227 -- Loop_Actions
4228 -- Box_Present
4230 -- Exactly one of Iterator_Specification or Loop_Parameter_
4231 -- specification is present. If the Key_Expression is absent,
4232 -- the construct is parsed as an Iterated_Component_Association,
4233 -- and legality checks are performed during semantic analysis.
4235 -- Both iterated associations are Ada 2022 features that are
4236 -- expanded during aggregate construction, and do not appear in
4237 -- expanded code.
4239 --------------------------------------------------
4240 -- 4.4 Expression/Relation/Term/Factor/Primary --
4241 --------------------------------------------------
4243 -- EXPRESSION ::=
4244 -- RELATION {LOGICAL_OPERATOR RELATION}
4246 -- CHOICE_EXPRESSION ::=
4247 -- CHOICE_RELATION {LOGICAL_OPERATOR CHOICE_RELATION}
4249 -- CHOICE_RELATION ::=
4250 -- SIMPLE_EXPRESSION [RELATIONAL_OPERATOR SIMPLE_EXPRESSION]
4252 -- RELATION ::=
4253 -- SIMPLE_EXPRESSION [not] in MEMBERSHIP_CHOICE_LIST
4254 -- | RAISE_EXPRESSION
4256 -- MEMBERSHIP_CHOICE_LIST ::=
4257 -- MEMBERSHIP_CHOICE {'|' MEMBERSHIP CHOICE}
4259 -- MEMBERSHIP_CHOICE ::=
4260 -- CHOICE_EXPRESSION | RANGE | SUBTYPE_MARK
4262 -- LOGICAL_OPERATOR ::= and | and then | or | or else | xor
4264 -- SIMPLE_EXPRESSION ::=
4265 -- [UNARY_ADDING_OPERATOR] TERM {BINARY_ADDING_OPERATOR TERM}
4267 -- TERM ::= FACTOR {MULTIPLYING_OPERATOR FACTOR}
4269 -- FACTOR ::= PRIMARY [** PRIMARY] | abs PRIMARY | not PRIMARY
4271 -- No nodes are generated for any of these constructs. Instead, the
4272 -- node for the operator appears directly. When we refer to an
4273 -- expression in this description, we mean any of the possible
4274 -- constituent components of an expression (e.g. identifier is
4275 -- an example of an expression).
4277 -- Note: the above syntax is that Ada 2012 syntax which restricts
4278 -- choice relations to simple expressions to avoid ambiguities in
4279 -- some contexts with set membership notation. It has been decided
4280 -- that in retrospect, the Ada 95 change allowing general expressions
4281 -- in this context was a mistake, so we have reverted to the above
4282 -- syntax in Ada 95 and Ada 2005 modes (the restriction to simple
4283 -- expressions was there in Ada 83 from the start).
4285 ------------------
4286 -- 4.4 Primary --
4287 ------------------
4289 -- PRIMARY ::=
4290 -- NUMERIC_LITERAL | null
4291 -- | STRING_LITERAL | AGGREGATE
4292 -- | NAME | QUALIFIED_EXPRESSION
4293 -- | ALLOCATOR | (EXPRESSION)
4295 -- Usually there is no explicit node in the tree for primary. Instead
4296 -- the constituent (e.g. AGGREGATE) appears directly. There are two
4297 -- exceptions. First, there is an explicit node for a null primary.
4299 -- N_Null
4300 -- Sloc points to NULL
4301 -- plus fields for expression
4303 -- Second, the case of (EXPRESSION) is handled specially. Ada requires
4304 -- that the parser keep track of which subexpressions are enclosed
4305 -- in parentheses, and how many levels of parentheses are used. This
4306 -- information is required for optimization purposes, and also for
4307 -- some semantic checks (e.g. (((1))) in a procedure spec does not
4308 -- conform with ((((1)))) in the body).
4310 -- The parentheses are recorded by keeping a Paren_Count field in every
4311 -- subexpression node (it is actually present in all nodes, but only
4312 -- used in subexpression nodes). This count records the number of
4313 -- levels of parentheses. If the number of levels in the source exceeds
4314 -- the maximum accommodated by this count, then the count is simply left
4315 -- at the maximum value. This means that there are some pathological
4316 -- cases of failure to detect conformance failures (e.g. an expression
4317 -- with 500 levels of parens will conform with one with 501 levels),
4318 -- but we do not need to lose sleep over this.
4320 -- Historical note: in versions of GNAT prior to 1.75, there was a node
4321 -- type N_Parenthesized_Expression used to accurately record unlimited
4322 -- numbers of levels of parentheses. However, it turned out to be a
4323 -- real nuisance to have to take into account the possible presence of
4324 -- this node during semantic analysis, since basically parentheses have
4325 -- zero relevance to semantic analysis.
4327 -- Note: the level of parentheses always present in things like
4328 -- aggregates does not count, only the parentheses in the primary
4329 -- (EXPRESSION) affect the setting of the Paren_Count field.
4331 -- 2nd Note: the contents of the Expression field must be ignored (i.e.
4332 -- treated as though it were Empty) if No_Initialization is set True.
4334 --------------------------------------
4335 -- 4.5 Short-Circuit Control Forms --
4336 --------------------------------------
4338 -- EXPRESSION ::=
4339 -- RELATION {and then RELATION} | RELATION {or else RELATION}
4341 -- Gigi restriction: For both these control forms, the operand and
4342 -- result types are always Standard.Boolean. The expander inserts the
4343 -- required conversion operations where needed to ensure this is the
4344 -- case.
4346 -- N_And_Then
4347 -- Sloc points to AND of AND THEN
4348 -- Left_Opnd
4349 -- Right_Opnd
4350 -- Actions
4351 -- plus fields for expression
4353 -- N_Or_Else
4354 -- Sloc points to OR of OR ELSE
4355 -- Left_Opnd
4356 -- Right_Opnd
4357 -- Actions
4358 -- plus fields for expression
4360 -- Note: The Actions field is used to hold actions associated with
4361 -- the right hand operand. These have to be treated specially since
4362 -- they are not unconditionally executed. See Insert_Actions for a
4363 -- more detailed description of how these actions are handled.
4365 ---------------------------
4366 -- 4.5 Membership Tests --
4367 ---------------------------
4369 -- RELATION ::=
4370 -- SIMPLE_EXPRESSION [not] in MEMBERSHIP_CHOICE_LIST
4372 -- MEMBERSHIP_CHOICE_LIST ::=
4373 -- MEMBERSHIP_CHOICE {'|' MEMBERSHIP CHOICE}
4375 -- MEMBERSHIP_CHOICE ::=
4376 -- CHOICE_EXPRESSION | RANGE | SUBTYPE_MARK
4378 -- Note: although the grammar above allows only a range or a subtype
4379 -- mark, the parser in fact will accept any simple expression in place
4380 -- of a subtype mark. This means that the semantic analyzer must be able
4381 -- to deal with, and diagnose a simple expression other than a name for
4382 -- the right operand. This simplifies error recovery in the parser.
4384 -- The Alternatives field below is present only if there is more than
4385 -- one Membership_Choice present (which is legitimate only in Ada 2012
4386 -- mode) in which case Right_Opnd is Empty, and Alternatives contains
4387 -- the list of choices. In the tree passed to the back end, Alternatives
4388 -- is always No_List, and Right_Opnd is set (i.e. the expansion circuit
4389 -- expands out the complex set membership case using simple membership
4390 -- and equality operations).
4392 -- Should we rename Alternatives here to Membership_Choices ???
4394 -- N_In
4395 -- Sloc points to IN
4396 -- Left_Opnd
4397 -- Right_Opnd
4398 -- Alternatives (set to No_List if only one set alternative)
4399 -- No_Minimize_Eliminate
4400 -- plus fields for expression
4402 -- N_Not_In
4403 -- Sloc points to NOT of NOT IN
4404 -- Left_Opnd
4405 -- Right_Opnd
4406 -- Alternatives (set to No_List if only one set alternative)
4407 -- No_Minimize_Eliminate
4408 -- plus fields for expression
4410 --------------------
4411 -- 4.5 Operators --
4412 --------------------
4414 -- LOGICAL_OPERATOR ::= and | or | xor
4416 -- RELATIONAL_OPERATOR ::= = | /= | < | <= | > | >=
4418 -- BINARY_ADDING_OPERATOR ::= + | - | &
4420 -- UNARY_ADDING_OPERATOR ::= + | -
4422 -- MULTIPLYING_OPERATOR ::= * | / | mod | rem
4424 -- HIGHEST_PRECEDENCE_OPERATOR ::= ** | abs | not
4426 -- Gigi restriction: Gigi will never be given * / mod rem nodes with
4427 -- fixed-point operands. All handling of smalls for multiplication and
4428 -- division is handled by the front end (mod and rem result only from
4429 -- expansion). Gigi thus never needs to worry about small values (for
4430 -- other operators operating on fixed-point, e.g. addition, the small
4431 -- value does not have any semantic effect anyway, these are always
4432 -- integer operations).
4434 -- Gigi restriction: For all operators taking Boolean operands, the
4435 -- type is always Standard.Boolean. The expander inserts the required
4436 -- conversion operations where needed to ensure this is the case.
4438 -- N_Op_And
4439 -- Sloc points to AND
4440 -- Do_Length_Check
4441 -- plus fields for binary operator
4442 -- plus fields for expression
4444 -- N_Op_Or
4445 -- Sloc points to OR
4446 -- Do_Length_Check
4447 -- plus fields for binary operator
4448 -- plus fields for expression
4450 -- N_Op_Xor
4451 -- Sloc points to XOR
4452 -- Do_Length_Check
4453 -- plus fields for binary operator
4454 -- plus fields for expression
4456 -- N_Op_Eq
4457 -- Sloc points to =
4458 -- plus fields for binary operator
4459 -- plus fields for expression
4461 -- N_Op_Ne
4462 -- Sloc points to /=
4463 -- plus fields for binary operator
4464 -- plus fields for expression
4466 -- N_Op_Lt
4467 -- Sloc points to <
4468 -- plus fields for binary operator
4469 -- plus fields for expression
4471 -- N_Op_Le
4472 -- Sloc points to <=
4473 -- plus fields for binary operator
4474 -- plus fields for expression
4476 -- N_Op_Gt
4477 -- Sloc points to >
4478 -- plus fields for binary operator
4479 -- plus fields for expression
4481 -- N_Op_Ge
4482 -- Sloc points to >=
4483 -- plus fields for binary operator
4484 -- plus fields for expression
4486 -- N_Op_Add
4487 -- Sloc points to + (binary)
4488 -- plus fields for binary operator
4489 -- plus fields for expression
4491 -- N_Op_Subtract
4492 -- Sloc points to - (binary)
4493 -- plus fields for binary operator
4494 -- plus fields for expression
4496 -- N_Op_Concat
4497 -- Sloc points to &
4498 -- Is_Component_Left_Opnd
4499 -- Is_Component_Right_Opnd
4500 -- plus fields for binary operator
4501 -- plus fields for expression
4503 -- N_Op_Multiply
4504 -- Sloc points to *
4505 -- Rounded_Result
4506 -- plus fields for binary operator
4507 -- plus fields for expression
4509 -- N_Op_Divide
4510 -- Sloc points to /
4511 -- Do_Division_Check
4512 -- Rounded_Result
4513 -- plus fields for binary operator
4514 -- plus fields for expression
4516 -- N_Op_Mod
4517 -- Sloc points to MOD
4518 -- Do_Division_Check
4519 -- plus fields for binary operator
4520 -- plus fields for expression
4522 -- N_Op_Rem
4523 -- Sloc points to REM
4524 -- Do_Division_Check
4525 -- plus fields for binary operator
4526 -- plus fields for expression
4528 -- N_Op_Expon
4529 -- Sloc points to **
4530 -- Is_Power_Of_2_For_Shift
4531 -- plus fields for binary operator
4532 -- plus fields for expression
4534 -- N_Op_Plus
4535 -- Sloc points to + (unary)
4536 -- plus fields for unary operator
4537 -- plus fields for expression
4539 -- N_Op_Minus
4540 -- Sloc points to - (unary)
4541 -- plus fields for unary operator
4542 -- plus fields for expression
4544 -- N_Op_Abs
4545 -- Sloc points to ABS
4546 -- plus fields for unary operator
4547 -- plus fields for expression
4549 -- N_Op_Not
4550 -- Sloc points to NOT
4551 -- plus fields for unary operator
4552 -- plus fields for expression
4554 -- See also shift operators in section B.2
4556 -- Note on fixed-point operations passed to Gigi: For adding operators,
4557 -- the semantics is to treat these simply as integer operations, with
4558 -- the small values being ignored (the bounds are already stored in
4559 -- units of small, so that constraint checking works as usual). For the
4560 -- case of multiply/divide/rem/mod operations, Gigi will never see them.
4562 -- Note on equality/inequality tests for records. In the expanded tree,
4563 -- record comparisons are always expanded to be a series of component
4564 -- comparisons, so the back end will never see an equality or inequality
4565 -- operation with operands of a record type.
4567 -- Note on overflow handling: When the overflow checking mode is set to
4568 -- MINIMIZED or ELIMINATED, nodes for signed arithmetic operations may
4569 -- be modified to use a larger type for the operands and result. In
4570 -- the case where the computed range exceeds that of Long_Long_Integer,
4571 -- and we are running in ELIMINATED mode, the operator node will be
4572 -- changed to be a call to the appropriate routine in System.Bignums.
4574 -- Note: In Modify_Tree_For_C mode, we do not generate an N_Op_Mod node
4575 -- for signed integer types (since there is no equivalent operator in
4576 -- C). Instead we rewrite such an operation in terms of REM (which is
4577 -- % in C) and other C-available operators.
4579 ------------------------------------
4580 -- 4.5.7 Conditional Expressions --
4581 ------------------------------------
4583 -- CONDITIONAL_EXPRESSION ::= IF_EXPRESSION | CASE_EXPRESSION
4585 --------------------------
4586 -- 4.5.7 If Expression --
4587 --------------------------
4589 -- IF_EXPRESSION ::=
4590 -- if CONDITION then DEPENDENT_EXPRESSION
4591 -- {elsif CONDITION then DEPENDENT_EXPRESSION}
4592 -- [else DEPENDENT_EXPRESSION]
4594 -- DEPENDENT_EXPRESSION ::= EXPRESSION
4596 -- Note: if we have (IF x1 THEN x2 ELSIF x3 THEN x4 ELSE x5) then it
4597 -- is represented as (IF x1 THEN x2 ELSE (IF x3 THEN x4 ELSE x5)) and
4598 -- the Is_Elsif flag is set on the inner if expression.
4600 -- N_If_Expression
4601 -- Sloc points to IF or ELSIF keyword
4602 -- Expressions
4603 -- Then_Actions
4604 -- Else_Actions
4605 -- Is_Elsif (set if comes from ELSIF)
4606 -- Do_Overflow_Check
4607 -- plus fields for expression
4609 -- Expressions here is a three-element list, whose first element is the
4610 -- condition, the second element is the dependent expression after THEN
4611 -- and the third element is the dependent expression after the ELSE
4612 -- (explicitly set to True if missing).
4614 -- Note: the Then_Actions and Else_Actions fields are always set to
4615 -- No_List in the tree passed to the back end. These are used only
4616 -- for temporary processing purposes in the expander. Even though they
4617 -- are semantic fields, their parent pointers are set because analysis
4618 -- of actions nodes in those lists may generate additional actions that
4619 -- need to know their insertion point (for example for the creation of
4620 -- transient scopes).
4622 -- Note: in the tree passed to the back end, if the result type is
4623 -- an unconstrained array, the if expression can only appears in the
4624 -- initializing expression of an object declaration (this avoids the
4625 -- back end having to create a variable length temporary on the fly).
4627 ----------------------------
4628 -- 4.5.7 Case Expression --
4629 ----------------------------
4631 -- CASE_EXPRESSION ::=
4632 -- case SELECTING_EXPRESSION is
4633 -- CASE_EXPRESSION_ALTERNATIVE
4634 -- {,CASE_EXPRESSION_ALTERNATIVE}
4636 -- Note that the Alternatives cannot include pragmas (this contrasts
4637 -- with the situation of case statements where pragmas are allowed).
4639 -- N_Case_Expression
4640 -- Sloc points to CASE
4641 -- Expression (the selecting expression)
4642 -- Alternatives (the case expression alternatives)
4643 -- Etype
4644 -- Do_Overflow_Check
4646 ----------------------------------------
4647 -- 4.5.7 Case Expression Alternative --
4648 ----------------------------------------
4650 -- CASE_EXPRESSION_ALTERNATIVE ::=
4651 -- when DISCRETE_CHOICE_LIST =>
4652 -- DEPENDENT_EXPRESSION
4654 -- N_Case_Expression_Alternative
4655 -- Sloc points to WHEN
4656 -- Actions
4657 -- Discrete_Choices
4658 -- Expression
4659 -- Has_SP_Choice
4661 -- Note: The Actions field temporarily holds any actions associated with
4662 -- evaluation of the Expression. During expansion of the case expression
4663 -- these actions are wrapped into an N_Expression_With_Actions node
4664 -- replacing the original expression.
4666 -- Note: this node never appears in the tree passed to the back end,
4667 -- since the expander converts case expressions into case statements.
4669 ---------------------------------
4670 -- 4.5.8 Quantified Expression --
4671 ---------------------------------
4673 -- QUANTIFIED_EXPRESSION ::=
4674 -- for QUANTIFIER LOOP_PARAMETER_SPECIFICATION => PREDICATE
4675 -- | for QUANTIFIER ITERATOR_SPECIFICATION => PREDICATE
4677 -- QUANTIFIER ::= all | some
4679 -- At most one of (Iterator_Specification, Loop_Parameter_Specification)
4680 -- is present at a time, in which case the other one is empty.
4682 -- N_Quantified_Expression
4683 -- Sloc points to FOR
4684 -- Iterator_Specification
4685 -- Loop_Parameter_Specification
4686 -- Condition
4687 -- All_Present
4689 --------------------------
4690 -- 4.6 Type Conversion --
4691 --------------------------
4693 -- TYPE_CONVERSION ::=
4694 -- SUBTYPE_MARK (EXPRESSION) | SUBTYPE_MARK (NAME)
4696 -- In the (NAME) case, the name is stored as the expression
4698 -- Note: the parser never generates a type conversion node, since it
4699 -- looks like an indexed component which is generated by preference.
4700 -- The semantic pass must correct this misidentification.
4702 -- Gigi handles conversions that involve no change in the root type,
4703 -- and also all conversions from integer to floating-point types.
4704 -- Conversions from floating-point to integer are only handled in
4705 -- the case where Float_Truncate flag set. Other conversions from
4706 -- floating-point to integer (involving rounding) and all conversions
4707 -- involving fixed-point types are handled by the expander, unless the
4708 -- Conversion_OK flag is set.
4710 -- Sprint syntax if Float_Truncate set: X^(Y)
4711 -- Sprint syntax if Conversion_OK set X?(Y)
4712 -- Sprint syntax if both flags set X?^(Y)
4714 -- Note: If either the operand or result type is fixed-point, Gigi will
4715 -- only see a type conversion node with Conversion_OK set. The front end
4716 -- takes care of all handling of small's for fixed-point conversions.
4718 -- N_Type_Conversion
4719 -- Sloc points to first token of subtype mark
4720 -- Subtype_Mark
4721 -- Expression
4722 -- Do_Discriminant_Check
4723 -- Do_Length_Check
4724 -- Float_Truncate
4725 -- Conversion_OK
4726 -- Do_Overflow_Check
4727 -- Rounded_Result
4728 -- plus fields for expression
4730 -- Note: if a range check is required, then the Do_Range_Check flag
4731 -- is set in the Expression with the check being done against the
4732 -- target type range (after the base type conversion, if any).
4734 -------------------------------
4735 -- 4.7 Qualified Expression --
4736 -------------------------------
4738 -- QUALIFIED_EXPRESSION ::=
4739 -- SUBTYPE_MARK ' (EXPRESSION) | SUBTYPE_MARK ' AGGREGATE
4741 -- Note: the parentheses in the (EXPRESSION) case are deemed to enclose
4742 -- the expression, so the Expression field of this node always points
4743 -- to a parenthesized expression in this case (i.e. Paren_Count will
4744 -- always be non-zero for the referenced expression if it is not an
4745 -- aggregate).
4747 -- N_Qualified_Expression
4748 -- Sloc points to apostrophe
4749 -- Subtype_Mark
4750 -- Expression expression or aggregate
4751 -- Is_Qualified_Universal_Literal
4752 -- plus fields for expression
4754 --------------------
4755 -- 4.8 Allocator --
4756 --------------------
4758 -- ALLOCATOR ::=
4759 -- new [SUBPOOL_SPECIFICATION] SUBTYPE_INDICATION
4760 -- | new [SUBPOOL_SPECIFICATION] QUALIFIED_EXPRESSION
4762 -- SUBPOOL_SPECIFICATION ::= (subpool_handle_NAME)
4764 -- Sprint syntax (when storage pool present)
4765 -- new xxx (storage_pool = pool)
4766 -- or
4767 -- new (subpool) xxx (storage_pool = pool)
4769 -- N_Allocator
4770 -- Sloc points to NEW
4771 -- Expression subtype indication or qualified expression
4772 -- Subpool_Handle_Name (set to Empty if not present)
4773 -- Storage_Pool
4774 -- Procedure_To_Call
4775 -- Alloc_For_BIP_Return
4776 -- Null_Exclusion_Present
4777 -- No_Initialization
4778 -- Is_Static_Coextension
4779 -- Do_Storage_Check
4780 -- Is_Dynamic_Coextension
4781 -- plus fields for expression
4783 -- Note: like all nodes, the N_Allocator has the Comes_From_Source flag.
4784 -- This flag has a special function in conjunction with the restriction
4785 -- No_Implicit_Heap_Allocations, which will be triggered if this flag
4786 -- is not set. This means that if a source allocator is replaced with
4787 -- a constructed allocator, the Comes_From_Source flag should be copied
4788 -- to the newly created allocator.
4790 ---------------------------------
4791 -- 5.1 Sequence Of Statements --
4792 ---------------------------------
4794 -- SEQUENCE_OF_STATEMENTS ::= STATEMENT {STATEMENT}
4796 -- Note: Although the parser will not accept a declaration as a
4797 -- statement, the semantic analyzer may insert declarations (e.g.
4798 -- declarations of implicit types needed for execution of other
4799 -- statements) into a sequence of statements, so the code generator
4800 -- should be prepared to accept a declaration where a statement is
4801 -- expected. Note also that pragmas can appear as statements.
4803 --------------------
4804 -- 5.1 Statement --
4805 --------------------
4807 -- STATEMENT ::=
4808 -- {LABEL} SIMPLE_STATEMENT | {LABEL} COMPOUND_STATEMENT
4810 -- There is no explicit node in the tree for a statement. Instead, the
4811 -- individual statement appears directly. Labels are treated as a
4812 -- kind of statement, i.e. they are linked into a statement list at
4813 -- the point they appear, so the labeled statement appears following
4814 -- the label or labels in the statement list.
4816 ---------------------------
4817 -- 5.1 Simple Statement --
4818 ---------------------------
4820 -- SIMPLE_STATEMENT ::= NULL_STATEMENT
4821 -- | ASSIGNMENT_STATEMENT | EXIT_STATEMENT
4822 -- | GOTO_STATEMENT | PROCEDURE_CALL_STATEMENT
4823 -- | SIMPLE_RETURN_STATEMENT | ENTRY_CALL_STATEMENT
4824 -- | REQUEUE_STATEMENT | DELAY_STATEMENT
4825 -- | ABORT_STATEMENT | RAISE_STATEMENT
4826 -- | CODE_STATEMENT
4828 -----------------------------
4829 -- 5.1 Compound Statement --
4830 -----------------------------
4832 -- COMPOUND_STATEMENT ::=
4833 -- IF_STATEMENT | CASE_STATEMENT
4834 -- | LOOP_STATEMENT | BLOCK_STATEMENT
4835 -- | EXTENDED_RETURN_STATEMENT
4836 -- | ACCEPT_STATEMENT | SELECT_STATEMENT
4838 -------------------------
4839 -- 5.1 Null Statement --
4840 -------------------------
4842 -- NULL_STATEMENT ::= null;
4844 -- N_Null_Statement
4845 -- Sloc points to NULL
4846 -- Next_Rep_Item
4848 ----------------
4849 -- 5.1 Label --
4850 ----------------
4852 -- LABEL ::= <<label_STATEMENT_IDENTIFIER>>
4854 -- Note that the occurrence of a label is not a defining identifier,
4855 -- but rather a referencing occurrence. The defining occurrence is
4856 -- in the implicit label declaration which occurs in the innermost
4857 -- enclosing block.
4859 -- N_Label
4860 -- Sloc points to <<
4861 -- Identifier direct name of statement identifier
4862 -- Exception_Junk
4864 -- Note: Before Ada 2012, a label is always followed by a statement,
4865 -- and this is true in the tree even in Ada 2012 mode (the parser
4866 -- inserts a null statement marked with Comes_From_Source False).
4868 -------------------------------
4869 -- 5.1 Statement Identifier --
4870 -------------------------------
4872 -- STATEMENT_IDENTIFIER ::= DIRECT_NAME
4874 -- The IDENTIFIER of a STATEMENT_IDENTIFIER shall be an identifier
4875 -- (not an OPERATOR_SYMBOL)
4877 -------------------------------
4878 -- 5.2 Assignment Statement --
4879 -------------------------------
4881 -- ASSIGNMENT_STATEMENT ::=
4882 -- variable_NAME := EXPRESSION;
4884 -- N_Assignment_Statement
4885 -- Sloc points to :=
4886 -- Name
4887 -- Expression
4888 -- Is_Elaboration_Checks_OK_Node
4889 -- Is_SPARK_Mode_On_Node
4890 -- Do_Discriminant_Check
4891 -- Do_Length_Check
4892 -- Forwards_OK
4893 -- Backwards_OK
4894 -- No_Ctrl_Actions
4895 -- Has_Target_Names
4896 -- Is_Elaboration_Code
4897 -- Componentwise_Assignment
4898 -- Suppress_Assignment_Checks
4900 -- Note: if a range check is required, then the Do_Range_Check flag
4901 -- is set in the Expression (right hand side), with the check being
4902 -- done against the type of the Name (left hand side).
4904 -- Note: the back end places some restrictions on the form of the
4905 -- Expression field. If the object being assigned to is Atomic, then
4906 -- the Expression may not have the form of an aggregate (since this
4907 -- might cause the back end to generate separate assignments). In this
4908 -- case the front end must generate an extra temporary and initialize
4909 -- this temporary as required (the temporary itself is not atomic).
4911 ------------------
4912 -- Target_Name --
4913 ------------------
4915 -- N_Target_Name
4916 -- Sloc points to @
4917 -- Etype
4919 -- Note (Ada 2022): node is used during analysis as a placeholder for
4920 -- the value of the LHS of the enclosing assignment statement. Node is
4921 -- eventually rewritten together with enclosing assignment, and backends
4922 -- are not aware of it.
4924 -----------------------
4925 -- 5.3 If Statement --
4926 -----------------------
4928 -- IF_STATEMENT ::=
4929 -- if CONDITION then
4930 -- SEQUENCE_OF_STATEMENTS
4931 -- {elsif CONDITION then
4932 -- SEQUENCE_OF_STATEMENTS}
4933 -- [else
4934 -- SEQUENCE_OF_STATEMENTS]
4935 -- end if;
4937 -- Gigi restriction: This expander ensures that the type of the
4938 -- Condition fields is always Standard.Boolean, even if the type
4939 -- in the source is some non-standard boolean type.
4941 -- N_If_Statement
4942 -- Sloc points to IF
4943 -- Condition
4944 -- Then_Statements
4945 -- Elsif_Parts (set to No_List if none present)
4946 -- Else_Statements (set to No_List if no else part present)
4947 -- End_Span (set to Uint_0 if expander generated)
4948 -- From_Conditional_Expression
4950 -- N_Elsif_Part
4951 -- Sloc points to ELSIF
4952 -- Condition
4953 -- Then_Statements
4954 -- Condition_Actions
4956 --------------------
4957 -- 5.3 Condition --
4958 --------------------
4960 -- CONDITION ::= boolean_EXPRESSION
4962 -------------------------
4963 -- 5.4 Case Statement --
4964 -------------------------
4966 -- CASE_STATEMENT ::=
4967 -- case EXPRESSION is
4968 -- CASE_STATEMENT_ALTERNATIVE
4969 -- {CASE_STATEMENT_ALTERNATIVE}
4970 -- end case;
4972 -- Note: the Alternatives can contain pragmas. These only occur at
4973 -- the start of the list, since any pragmas occurring after the first
4974 -- alternative are absorbed into the corresponding statement sequence.
4976 -- N_Case_Statement
4977 -- Sloc points to CASE
4978 -- Expression
4979 -- Alternatives
4980 -- End_Span (set to Uint_0 if expander generated)
4981 -- From_Conditional_Expression
4983 -- Note: Before Ada 2012, a pragma in a statement sequence is always
4984 -- followed by a statement, and this is true in the tree even in Ada
4985 -- 2012 mode (the parser inserts a null statement marked with the flag
4986 -- Comes_From_Source False).
4988 -------------------------------------
4989 -- 5.4 Case Statement Alternative --
4990 -------------------------------------
4992 -- CASE_STATEMENT_ALTERNATIVE ::=
4993 -- when DISCRETE_CHOICE_LIST =>
4994 -- SEQUENCE_OF_STATEMENTS
4996 -- N_Case_Statement_Alternative
4997 -- Sloc points to WHEN
4998 -- Discrete_Choices
4999 -- Statements
5000 -- Has_SP_Choice
5001 -- Multidefined_Bindings
5003 -- Note: in the list of Discrete_Choices, the tree passed to the back
5004 -- end does not have choice entries corresponding to names of statically
5005 -- predicated subtypes. Such entries are always expanded out to the list
5006 -- of equivalent values or ranges. Multidefined_Bindings is True iff
5007 -- more than one choice is present and each choice contains
5008 -- at least one component association having a non-null Binding_Chars
5009 -- attribute; this can only occur if GNAT extensions are enabled
5010 -- and the type of the case selector is composite.
5012 -------------------------
5013 -- 5.5 Loop Statement --
5014 -------------------------
5016 -- LOOP_STATEMENT ::=
5017 -- [loop_STATEMENT_IDENTIFIER :]
5018 -- [ITERATION_SCHEME] loop
5019 -- SEQUENCE_OF_STATEMENTS
5020 -- end loop [loop_IDENTIFIER];
5022 -- Note: The occurrence of a loop label is not a defining identifier
5023 -- but rather a referencing occurrence. The defining occurrence is in
5024 -- the implicit label declaration which occurs in the innermost
5025 -- enclosing block.
5027 -- Note: there is always a loop statement identifier present in the
5028 -- tree, even if none was given in the source. In the case where no loop
5029 -- identifier is given in the source, the parser creates a name of the
5030 -- form _Loop_n, where n is a decimal integer (the two underlines ensure
5031 -- that the loop names created in this manner do not conflict with any
5032 -- user defined identifiers), and the flag Has_Created_Identifier is set
5033 -- to True. The only exception to the rule that all loop statement nodes
5034 -- have identifiers occurs for loops constructed by the expander, and
5035 -- the semantic analyzer will create and supply dummy loop identifiers
5036 -- in these cases.
5038 -- N_Loop_Statement
5039 -- Sloc points to LOOP
5040 -- Identifier loop identifier (set to Empty if no identifier)
5041 -- Iteration_Scheme (set to Empty if no iteration scheme)
5042 -- Statements
5043 -- End_Label
5044 -- Has_Created_Identifier
5045 -- Is_Null_Loop
5046 -- Suppress_Loop_Warnings
5048 -- Note: the parser fills in the Identifier field if there is an
5049 -- explicit loop identifier. Otherwise the parser leaves this field
5050 -- set to Empty, and then the semantic processing for a loop statement
5051 -- creates an identifier, setting the Has_Created_Identifier flag to
5052 -- True. So after semantic analysis, the Identifier is always set,
5053 -- referencing an identifier whose entity has an Ekind of E_Loop.
5055 ---------------------------
5056 -- 5.5 Iteration Scheme --
5057 ---------------------------
5059 -- ITERATION_SCHEME ::=
5060 -- while CONDITION
5061 -- | for LOOP_PARAMETER_SPECIFICATION
5062 -- | for ITERATOR_SPECIFICATION
5064 -- At most one of (Iterator_Specification, Loop_Parameter_Specification)
5065 -- is present at a time, in which case the other one is empty. Both are
5066 -- empty in the case of a WHILE loop.
5068 -- Gigi restriction: The expander ensures that the type of the Condition
5069 -- field is always Standard.Boolean, even if the type in the source is
5070 -- some non-standard boolean type.
5072 -- N_Iteration_Scheme
5073 -- Sloc points to WHILE or FOR
5074 -- Condition (set to Empty if FOR case)
5075 -- Condition_Actions
5076 -- Iterator_Specification (set to Empty if WHILE case)
5077 -- Loop_Parameter_Specification (set to Empty if WHILE case)
5079 ---------------------------------------
5080 -- 5.5 Loop Parameter Specification --
5081 ---------------------------------------
5083 -- LOOP_PARAMETER_SPECIFICATION ::=
5084 -- DEFINING_IDENTIFIER in [reverse] DISCRETE_SUBTYPE_DEFINITION
5085 -- [Iterator_Filter]
5087 -- Note: the optional Iterator_Filter is an Ada 2022 construct.
5089 -- N_Loop_Parameter_Specification
5090 -- Sloc points to first identifier
5091 -- Defining_Identifier
5092 -- Reverse_Present
5093 -- Iterator_Filter (set to Empty if not present)
5094 -- Discrete_Subtype_Definition
5096 -----------------------------------
5097 -- 5.5.1 Iterator Specification --
5098 -----------------------------------
5100 -- ITERATOR_SPECIFICATION ::=
5101 -- DEFINING_IDENTIFIER in [reverse] NAME
5102 -- | DEFINING_IDENTIFIER [: SUBTYPE_INDICATION] of [reverse] NAME
5104 -- N_Iterator_Specification
5105 -- Sloc points to defining identifier
5106 -- Defining_Identifier
5107 -- Name
5108 -- Reverse_Present
5109 -- Of_Present
5110 -- Iterator_Filter (set to Empty if not present)
5111 -- Subtype_Indication
5113 -- Note: The Of_Present flag distinguishes the two forms
5115 --------------------------
5116 -- 5.6 Block Statement --
5117 --------------------------
5119 -- BLOCK_STATEMENT ::=
5120 -- [block_STATEMENT_IDENTIFIER:]
5121 -- [declare
5122 -- DECLARATIVE_PART]
5123 -- begin
5124 -- HANDLED_SEQUENCE_OF_STATEMENTS
5125 -- end [block_IDENTIFIER];
5127 -- Note that the occurrence of a block identifier is not a defining
5128 -- identifier, but rather a referencing occurrence. The defining
5129 -- occurrence is an E_Block entity declared by the implicit label
5130 -- declaration which occurs in the innermost enclosing block statement
5131 -- or body; the block identifier denotes that E_Block.
5133 -- For block statements that come from source code, there is always a
5134 -- block statement identifier present in the tree, denoting an E_Block.
5135 -- In the case where no block identifier is given in the source,
5136 -- the parser creates a name of the form B_n, where n is a decimal
5137 -- integer, and the flag Has_Created_Identifier is set to True. Blocks
5138 -- constructed by the expander usually have no identifier, and no
5139 -- corresponding entity.
5141 -- Note: the block statement created for an extended return statement
5142 -- has an entity, and this entity is an E_Return_Statement, rather than
5143 -- the usual E_Block.
5145 -- Note: Exception_Junk is set for the wrapping blocks created during
5146 -- local raise optimization (Exp_Ch11.Expand_Local_Exception_Handlers).
5148 -- Note: from a control flow viewpoint, a block statement defines an
5149 -- extended basic block, i.e. the entry of the block dominates every
5150 -- statement in the sequence. When generating new statements with
5151 -- exception handlers in the expander at the end of a sequence that
5152 -- comes from source code, it can be necessary to wrap them all in a
5153 -- block statement in order to expose the implicit control flow to
5154 -- gigi and thus prevent it from issuing bogus control flow warnings.
5156 -- N_Block_Statement
5157 -- Sloc points to DECLARE or BEGIN
5158 -- Identifier block direct name (set to Empty if not present)
5159 -- Declarations (set to No_List if no DECLARE part)
5160 -- Handled_Statement_Sequence
5161 -- Activation_Chain_Entity
5162 -- Cleanup_Actions
5163 -- Has_Created_Identifier
5164 -- Is_Asynchronous_Call_Block
5165 -- Is_Task_Allocation_Block
5166 -- Exception_Junk
5167 -- Is_Abort_Block
5168 -- Is_Finalization_Wrapper
5169 -- Is_Initialization_Block
5170 -- Is_Task_Master
5171 -- At_End_Proc (set to Empty if no clean up procedure)
5173 -------------------------
5174 -- 5.7 Exit Statement --
5175 -------------------------
5177 -- EXIT_STATEMENT ::= exit [loop_NAME] [when CONDITION];
5179 -- Gigi restriction: The expander ensures that the type of the Condition
5180 -- field is always Standard.Boolean, even if the type in the source is
5181 -- some non-standard boolean type.
5183 -- N_Exit_Statement
5184 -- Sloc points to EXIT
5185 -- Name (set to Empty if no loop name present)
5186 -- Condition (set to Empty if no WHEN part present)
5187 -- Next_Exit_Statement : Next exit on chain
5189 -------------------------
5190 -- 5.9 Goto Statement --
5191 -------------------------
5193 -- GOTO_STATEMENT ::= goto label_NAME;
5195 -- N_Goto_Statement
5196 -- Sloc points to GOTO
5197 -- Name
5198 -- Exception_Junk
5200 ---------------------------------
5201 -- 6.1 Subprogram Declaration --
5202 ---------------------------------
5204 -- SUBPROGRAM_DECLARATION ::=
5205 -- SUBPROGRAM_SPECIFICATION
5206 -- [ASPECT_SPECIFICATIONS];
5208 -- N_Subprogram_Declaration
5209 -- Sloc points to FUNCTION or PROCEDURE
5210 -- Specification
5211 -- Body_To_Inline
5212 -- Corresponding_Body
5213 -- Parent_Spec
5214 -- Is_Entry_Barrier_Function
5215 -- Is_Task_Body_Procedure
5217 ------------------------------------------
5218 -- 6.1 Abstract Subprogram Declaration --
5219 ------------------------------------------
5221 -- ABSTRACT_SUBPROGRAM_DECLARATION ::=
5222 -- SUBPROGRAM_SPECIFICATION is abstract
5223 -- [ASPECT_SPECIFICATIONS];
5225 -- N_Abstract_Subprogram_Declaration
5226 -- Sloc points to ABSTRACT
5227 -- Specification
5229 -----------------------------------
5230 -- 6.1 Subprogram Specification --
5231 -----------------------------------
5233 -- SUBPROGRAM_SPECIFICATION ::=
5234 -- [[not] overriding]
5235 -- procedure DEFINING_PROGRAM_UNIT_NAME PARAMETER_PROFILE
5236 -- | [[not] overriding]
5237 -- function DEFINING_DESIGNATOR PARAMETER_AND_RESULT_PROFILE
5239 -- Note: there are no separate nodes for the profiles, instead the
5240 -- information appears directly in the following nodes.
5242 -- N_Function_Specification
5243 -- Sloc points to FUNCTION
5244 -- Defining_Unit_Name (the designator)
5245 -- Parameter_Specifications (set to No_List if no formal part)
5246 -- Null_Exclusion_Present
5247 -- Result_Definition for result subtype
5248 -- Generic_Parent
5249 -- Must_Override set if overriding indicator present
5250 -- Must_Not_Override set if not_overriding indicator present
5252 -- N_Procedure_Specification
5253 -- Sloc points to PROCEDURE
5254 -- Defining_Unit_Name
5255 -- Null_Statement NULL statement for body, if Null_Present
5256 -- Parameter_Specifications (set to No_List if no formal part)
5257 -- Generic_Parent
5258 -- Null_Present set for null procedure case (Ada 2005 feature)
5259 -- Must_Override set if overriding indicator present
5260 -- Must_Not_Override set if not_overriding indicator present
5262 -- Note: overriding indicator is an Ada 2005 feature
5264 ---------------------
5265 -- 6.1 Designator --
5266 ---------------------
5268 -- DESIGNATOR ::=
5269 -- [PARENT_UNIT_NAME .] IDENTIFIER | OPERATOR_SYMBOL
5271 -- Designators that are simply identifiers or operator symbols appear
5272 -- directly in the tree in this form. The following node is used only
5273 -- in the case where the designator has a parent unit name component.
5275 -- N_Designator
5276 -- Sloc points to period
5277 -- Name holds the parent unit name
5278 -- Identifier
5280 -- Note: Name is always non-Empty, since this node is only used for the
5281 -- case where a parent library unit package name is present.
5283 -- Note that the identifier can also be an operator symbol here
5285 ------------------------------
5286 -- 6.1 Defining Designator --
5287 ------------------------------
5289 -- DEFINING_DESIGNATOR ::=
5290 -- DEFINING_PROGRAM_UNIT_NAME | DEFINING_OPERATOR_SYMBOL
5292 -------------------------------------
5293 -- 6.1 Defining Program Unit Name --
5294 -------------------------------------
5296 -- DEFINING_PROGRAM_UNIT_NAME ::=
5297 -- [PARENT_UNIT_NAME .] DEFINING_IDENTIFIER
5299 -- The parent unit name is present only in the case of a child unit name
5300 -- (permissible only for Ada 95 for a library level unit, i.e. a unit
5301 -- at scope level one). If no such name is present, the defining program
5302 -- unit name is represented simply as the defining identifier. In the
5303 -- child unit case, the following node is used to represent the child
5304 -- unit name.
5306 -- N_Defining_Program_Unit_Name
5307 -- Sloc points to period
5308 -- Name holds the parent unit name
5309 -- Defining_Identifier
5311 -- Note: Name is always non-Empty, since this node is only used for the
5312 -- case where a parent unit name is present.
5314 --------------------------
5315 -- 6.1 Operator Symbol --
5316 --------------------------
5318 -- OPERATOR_SYMBOL ::= STRING_LITERAL
5320 -- Note: the fields of the N_Operator_Symbol node are laid out to match
5321 -- the corresponding fields of an N_Character_Literal node. This allows
5322 -- easy conversion of the operator symbol node into a character literal
5323 -- node in the case where a string constant of the form of an operator
5324 -- symbol is scanned out as such, but turns out semantically to be a
5325 -- string literal that is not an operator. For details see Sinfo.CN.
5326 -- Change_Operator_Symbol_To_String_Literal.
5328 -- N_Operator_Symbol
5329 -- Sloc points to literal
5330 -- Chars contains the Name_Id for the operator symbol
5331 -- Strval Id of string value. This is used if the operator
5332 -- symbol turns out to be a normal string after all.
5333 -- Entity
5334 -- Associated_Node Note this is shared with Entity
5335 -- Etype
5336 -- Has_Private_View (set in generic units)
5338 -- Note: the Strval field may be set to No_String for generated
5339 -- operator symbols that are known not to be string literals
5340 -- semantically.
5342 -----------------------------------
5343 -- 6.1 Defining Operator Symbol --
5344 -----------------------------------
5346 -- DEFINING_OPERATOR_SYMBOL ::= OPERATOR_SYMBOL
5348 -- A defining operator symbol is an entity, which has additional
5349 -- fields depending on the setting of the Ekind field. These
5350 -- additional fields are defined (and access subprograms declared)
5351 -- in package Einfo.
5353 -- Note: N_Defining_Operator_Symbol is an extended node whose fields
5354 -- are deliberately laid out to match the layout of fields in an
5355 -- ordinary N_Operator_Symbol node allowing for easy alteration of
5356 -- an operator symbol node into a defining operator symbol node.
5357 -- See Sinfo.CN.Change_Operator_Symbol_To_Defining_Operator_Symbol
5358 -- for further details.
5360 -- N_Defining_Operator_Symbol
5361 -- Sloc points to literal
5362 -- Chars contains the Name_Id for the operator symbol
5363 -- Next_Entity
5364 -- Scope
5365 -- Etype
5367 ----------------------------
5368 -- 6.1 Parameter Profile --
5369 ----------------------------
5371 -- PARAMETER_PROFILE ::= [FORMAL_PART]
5373 ---------------------------------------
5374 -- 6.1 Parameter and Result Profile --
5375 ---------------------------------------
5377 -- PARAMETER_AND_RESULT_PROFILE ::=
5378 -- [FORMAL_PART] return [NULL_EXCLUSION] SUBTYPE_MARK
5379 -- | [FORMAL_PART] return ACCESS_DEFINITION
5381 -- There is no explicit node in the tree for a parameter and result
5382 -- profile. Instead the information appears directly in the parent.
5384 ----------------------
5385 -- 6.1 Formal Part --
5386 ----------------------
5388 -- FORMAL_PART ::=
5389 -- (PARAMETER_SPECIFICATION {; PARAMETER_SPECIFICATION})
5391 ----------------------------------
5392 -- 6.1 Parameter Specification --
5393 ----------------------------------
5395 -- PARAMETER_SPECIFICATION ::=
5396 -- DEFINING_IDENTIFIER_LIST : [ALIASED] MODE [NULL_EXCLUSION]
5397 -- SUBTYPE_MARK [:= DEFAULT_EXPRESSION] [ASPECT_SPECIFICATIONS]
5398 -- | DEFINING_IDENTIFIER_LIST : ACCESS_DEFINITION
5399 -- [:= DEFAULT_EXPRESSION] [ASPECT_SPECIFICATIONS]
5401 -- Although the syntax allows multiple identifiers in the list, the
5402 -- semantics is as though successive specifications were given with
5403 -- identical type definition and expression components. To simplify
5404 -- semantic processing, the parser represents a multiple declaration
5405 -- case as a sequence of single Specifications, using the More_Ids and
5406 -- Prev_Ids flags to preserve the original source form as described
5407 -- in the section on "Handling of Defining Identifier Lists".
5409 -- ALIASED can only be present in Ada 2012 mode
5411 -- N_Parameter_Specification
5412 -- Sloc points to first identifier
5413 -- Defining_Identifier
5414 -- Aliased_Present
5415 -- In_Present
5416 -- Out_Present
5417 -- Null_Exclusion_Present
5418 -- Parameter_Type subtype mark or access definition
5419 -- Expression (set to Empty if no default expression present)
5420 -- More_Ids (set to False if no more identifiers in list)
5421 -- Prev_Ids (set to False if no previous identifiers in list)
5422 -- Default_Expression
5424 ---------------
5425 -- 6.1 Mode --
5426 ---------------
5428 -- MODE ::= [in] | in out | out
5430 -- There is no explicit node in the tree for the Mode. Instead the
5431 -- In_Present and Out_Present flags are set in the parent node to
5432 -- record the presence of keywords specifying the mode.
5434 --------------------------
5435 -- 6.3 Subprogram Body --
5436 --------------------------
5438 -- SUBPROGRAM_BODY ::=
5439 -- SUBPROGRAM_SPECIFICATION [ASPECT_SPECIFICATIONS] is
5440 -- DECLARATIVE_PART
5441 -- begin
5442 -- HANDLED_SEQUENCE_OF_STATEMENTS
5443 -- end [DESIGNATOR];
5445 -- N_Subprogram_Body
5446 -- Sloc points to FUNCTION or PROCEDURE
5447 -- Specification
5448 -- Declarations
5449 -- Handled_Statement_Sequence
5450 -- Activation_Chain_Entity
5451 -- Corresponding_Spec
5452 -- Acts_As_Spec
5453 -- Bad_Is_Detected used only by parser
5454 -- Do_Storage_Check
5455 -- Has_Relative_Deadline_Pragma
5456 -- Is_Entry_Barrier_Function
5457 -- Is_Protected_Subprogram_Body
5458 -- Is_Task_Body_Procedure
5459 -- Is_Task_Master
5460 -- Was_Attribute_Reference
5461 -- Was_Expression_Function
5462 -- Was_Originally_Stub
5464 -----------------------------------
5465 -- 6.4 Procedure Call Statement --
5466 -----------------------------------
5468 -- PROCEDURE_CALL_STATEMENT ::=
5469 -- procedure_NAME; | procedure_PREFIX ACTUAL_PARAMETER_PART;
5471 -- Note: the reason that a procedure call has expression fields is that
5472 -- it semantically resembles an expression, e.g. overloading is allowed
5473 -- and a type is concocted for semantic processing purposes. Certain of
5474 -- these fields, such as Parens are not relevant, but it is easier to
5475 -- just supply all of them together.
5477 -- N_Procedure_Call_Statement
5478 -- Sloc points to first token of name or prefix
5479 -- Name stores name or prefix
5480 -- Parameter_Associations (set to No_List if no
5481 -- actual parameter part)
5482 -- First_Named_Actual
5483 -- Controlling_Argument (set to Empty if not dispatching)
5484 -- Is_Elaboration_Checks_OK_Node
5485 -- Is_SPARK_Mode_On_Node
5486 -- Is_Elaboration_Warnings_OK_Node
5487 -- No_Elaboration_Check
5488 -- Is_Known_Guaranteed_ABE
5489 -- plus fields for expression
5491 -- If any IN parameter requires a range check, then the corresponding
5492 -- argument expression has the Do_Range_Check flag set, and the range
5493 -- check is done against the formal type. Note that this argument
5494 -- expression may appear directly in the Parameter_Associations list,
5495 -- or may be a descendant of an N_Parameter_Association node that
5496 -- appears in this list.
5498 ------------------------
5499 -- 6.4 Function Call --
5500 ------------------------
5502 -- FUNCTION_CALL ::=
5503 -- function_NAME | function_PREFIX ACTUAL_PARAMETER_PART
5505 -- Note: the parser may generate an indexed component node or simply
5506 -- a name node instead of a function call node. The semantic pass must
5507 -- correct this misidentification.
5509 -- N_Function_Call
5510 -- Sloc points to first token of name or prefix
5511 -- Name stores name or prefix
5512 -- Parameter_Associations (set to No_List if no
5513 -- actual parameter part)
5514 -- First_Named_Actual
5515 -- Controlling_Argument (set to Empty if not dispatching)
5516 -- Is_Elaboration_Checks_OK_Node
5517 -- Is_SPARK_Mode_On_Node
5518 -- Is_Elaboration_Warnings_OK_Node
5519 -- No_Elaboration_Check
5520 -- Is_Expanded_Build_In_Place_Call
5521 -- No_Side_Effect_Removal
5522 -- Is_Known_Guaranteed_ABE
5523 -- plus fields for expression
5525 --------------------------------
5526 -- 6.4 Actual Parameter Part --
5527 --------------------------------
5529 -- ACTUAL_PARAMETER_PART ::=
5530 -- (PARAMETER_ASSOCIATION {,PARAMETER_ASSOCIATION})
5532 --------------------------------
5533 -- 6.4 Parameter Association --
5534 --------------------------------
5536 -- PARAMETER_ASSOCIATION ::=
5537 -- [formal_parameter_SELECTOR_NAME =>] EXPLICIT_ACTUAL_PARAMETER
5539 -- Note: the N_Parameter_Association node is built only if a formal
5540 -- parameter selector name is present, otherwise the parameter
5541 -- association appears in the tree simply as the node for the
5542 -- explicit actual parameter.
5544 -- N_Parameter_Association
5545 -- Sloc points to formal parameter
5546 -- Selector_Name (always non-Empty)
5547 -- Explicit_Actual_Parameter
5548 -- Next_Named_Actual
5549 -- Is_Accessibility_Actual
5551 ---------------------------
5552 -- 6.4 Actual Parameter --
5553 ---------------------------
5555 -- EXPLICIT_ACTUAL_PARAMETER ::=
5556 -- EXPRESSION | variable_NAME | REDUCTION_EXPRESSION_PARAMETER
5558 ---------------------------
5559 -- 6.5 Return Statement --
5560 ---------------------------
5562 -- SIMPLE_RETURN_STATEMENT ::= return [EXPRESSION];
5564 -- EXTENDED_RETURN_STATEMENT ::=
5565 -- return DEFINING_IDENTIFIER : [aliased] RETURN_SUBTYPE_INDICATION
5566 -- [:= EXPRESSION] [do
5567 -- HANDLED_SEQUENCE_OF_STATEMENTS
5568 -- end return];
5570 -- RETURN_SUBTYPE_INDICATION ::= SUBTYPE_INDICATION | ACCESS_DEFINITION
5572 -- The term "return statement" is defined in 6.5 to mean either a
5573 -- SIMPLE_RETURN_STATEMENT or an EXTENDED_RETURN_STATEMENT. We avoid
5574 -- the use of this term, since it used to mean something else in earlier
5575 -- versions of Ada.
5577 -- N_Simple_Return_Statement
5578 -- Sloc points to RETURN
5579 -- Return_Statement_Entity
5580 -- Expression (set to Empty if no expression present)
5581 -- Storage_Pool
5582 -- Procedure_To_Call
5583 -- Comes_From_Extended_Return_Statement
5585 -- Note: Return_Statement_Entity points to an E_Return_Statement
5587 -- If a range check is required, then Do_Range_Check is set on the
5588 -- Expression. The check is against the return subtype of the function.
5590 -- N_Extended_Return_Statement
5591 -- Sloc points to RETURN
5592 -- Return_Statement_Entity
5593 -- Return_Object_Declarations
5594 -- Handled_Statement_Sequence (set to Empty if not present)
5595 -- Storage_Pool
5596 -- Procedure_To_Call
5598 -- Note: Return_Statement_Entity points to an E_Return_Statement.
5600 -- Note that Return_Object_Declarations is a list containing the
5601 -- N_Object_Declaration -- see comment on this field above.
5603 -- The declared object will have Is_Return_Object = True.
5605 -- There is no such syntactic category as return_object_declaration
5606 -- in the RM. Return_Object_Declarations represents this portion of
5607 -- the syntax for EXTENDED_RETURN_STATEMENT:
5608 -- DEFINING_IDENTIFIER : [aliased] RETURN_SUBTYPE_INDICATION
5609 -- [:= EXPRESSION]
5611 -- There are two entities associated with an extended_return_statement:
5612 -- the Return_Statement_Entity represents the statement itself,
5613 -- and the Defining_Identifier of the Object_Declaration in
5614 -- Return_Object_Declarations represents the object being
5615 -- returned. N_Simple_Return_Statement has only the former.
5617 ------------------------------
5618 -- 6.8 Expression Function --
5619 ------------------------------
5621 -- EXPRESSION_FUNCTION ::=
5622 -- FUNCTION SPECIFICATION IS (EXPRESSION)
5623 -- [ASPECT_SPECIFICATIONS];
5625 -- N_Expression_Function
5626 -- Sloc points to FUNCTION
5627 -- Specification
5628 -- Expression
5629 -- Corresponding_Spec
5631 ------------------------------
5632 -- 7.1 Package Declaration --
5633 ------------------------------
5635 -- PACKAGE_DECLARATION ::=
5636 -- PACKAGE_SPECIFICATION;
5638 -- Note: the activation chain entity for a package spec is used for
5639 -- all tasks declared in the package spec, or in the package body.
5641 -- N_Package_Declaration
5642 -- Sloc points to PACKAGE
5643 -- Specification
5644 -- Corresponding_Body
5645 -- Parent_Spec
5646 -- Activation_Chain_Entity
5648 --------------------------------
5649 -- 7.1 Package Specification --
5650 --------------------------------
5652 -- PACKAGE_SPECIFICATION ::=
5653 -- package DEFINING_PROGRAM_UNIT_NAME
5654 -- [ASPECT_SPECIFICATIONS]
5655 -- is
5656 -- {BASIC_DECLARATIVE_ITEM}
5657 -- [private
5658 -- {BASIC_DECLARATIVE_ITEM}]
5659 -- end [[PARENT_UNIT_NAME .] IDENTIFIER]
5661 -- N_Package_Specification
5662 -- Sloc points to PACKAGE
5663 -- Defining_Unit_Name
5664 -- Visible_Declarations
5665 -- Private_Declarations (set to No_List if no private
5666 -- part present)
5667 -- End_Label
5668 -- Generic_Parent
5669 -- Limited_View_Installed
5671 -----------------------
5672 -- 7.1 Package Body --
5673 -----------------------
5675 -- PACKAGE_BODY ::=
5676 -- package body DEFINING_PROGRAM_UNIT_NAME
5677 -- [ASPECT_SPECIFICATIONS]
5678 -- is
5679 -- DECLARATIVE_PART
5680 -- [begin
5681 -- HANDLED_SEQUENCE_OF_STATEMENTS]
5682 -- end [[PARENT_UNIT_NAME .] IDENTIFIER];
5684 -- N_Package_Body
5685 -- Sloc points to PACKAGE
5686 -- Defining_Unit_Name
5687 -- Declarations
5688 -- Handled_Statement_Sequence (set to Empty if no HSS present)
5689 -- Corresponding_Spec
5690 -- Was_Originally_Stub
5691 -- At_End_Proc (set to Empty if no clean up procedure)
5693 -- Note: if a source level package does not contain a handled sequence
5694 -- of statements, then the parser supplies a dummy one with a null
5695 -- sequence of statements. Comes_From_Source will be False in this
5696 -- constructed sequence. The reason we need this is for the End_Label
5697 -- field in the HSS.
5699 -----------------------------------
5700 -- 7.4 Private Type Declaration --
5701 -----------------------------------
5703 -- PRIVATE_TYPE_DECLARATION ::=
5704 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART]
5705 -- is [[abstract] tagged] [limited] private
5706 -- [ASPECT_SPECIFICATIONS];
5708 -- Note: TAGGED is not permitted in Ada 83 mode
5710 -- N_Private_Type_Declaration
5711 -- Sloc points to TYPE
5712 -- Defining_Identifier
5713 -- Discriminant_Specifications (set to No_List if no
5714 -- discriminant part)
5715 -- Unknown_Discriminants_Present set if (<>) discriminant
5716 -- Abstract_Present
5717 -- Tagged_Present
5718 -- Limited_Present
5720 ----------------------------------------
5721 -- 7.4 Private Extension Declaration --
5722 ----------------------------------------
5724 -- PRIVATE_EXTENSION_DECLARATION ::=
5725 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART] is
5726 -- [abstract] [limited | synchronized]
5727 -- new ancestor_SUBTYPE_INDICATION [and INTERFACE_LIST]
5728 -- with private [ASPECT_SPECIFICATIONS];
5730 -- Note: LIMITED, and private extension declarations are not allowed
5731 -- in Ada 83 mode.
5733 -- N_Private_Extension_Declaration
5734 -- Sloc points to TYPE
5735 -- Defining_Identifier
5736 -- Uninitialized_Variable
5737 -- Discriminant_Specifications (set to No_List if no
5738 -- discriminant part)
5739 -- Unknown_Discriminants_Present set if (<>) discriminant
5740 -- Abstract_Present
5741 -- Limited_Present
5742 -- Synchronized_Present
5743 -- Subtype_Indication
5744 -- Interface_List (set to No_List if none)
5746 ---------------------
5747 -- 8.4 Use Clause --
5748 ---------------------
5750 -- USE_CLAUSE ::= USE_PACKAGE_CLAUSE | USE_TYPE_CLAUSE
5752 -----------------------------
5753 -- 8.4 Use Package Clause --
5754 -----------------------------
5756 -- USE_PACKAGE_CLAUSE ::= use package_NAME {, package_NAME};
5758 -- N_Use_Package_Clause
5759 -- Sloc points to USE
5760 -- Prev_Use_Clause
5761 -- Name
5762 -- Next_Use_Clause
5763 -- Associated_Node
5764 -- Hidden_By_Use_Clause
5765 -- Is_Effective_Use_Clause
5766 -- More_Ids (set to False if no more identifiers in list)
5767 -- Prev_Ids (set to False if no previous identifiers in list)
5769 --------------------------
5770 -- 8.4 Use Type Clause --
5771 --------------------------
5773 -- USE_TYPE_CLAUSE ::= use [ALL] type SUBTYPE_MARK {, SUBTYPE_MARK};
5775 -- Note: use type clause is not permitted in Ada 83 mode
5777 -- Note: the ALL keyword can appear only in Ada 2012 mode
5779 -- N_Use_Type_Clause
5780 -- Sloc points to USE
5781 -- Prev_Use_Clause
5782 -- Used_Operations
5783 -- Next_Use_Clause
5784 -- Subtype_Mark
5785 -- Hidden_By_Use_Clause
5786 -- Is_Effective_Use_Clause
5787 -- More_Ids (set to False if no more identifiers in list)
5788 -- Prev_Ids (set to False if no previous identifiers in list)
5789 -- All_Present
5791 -------------------------------
5792 -- 8.5 Renaming Declaration --
5793 -------------------------------
5795 -- RENAMING_DECLARATION ::=
5796 -- OBJECT_RENAMING_DECLARATION
5797 -- | EXCEPTION_RENAMING_DECLARATION
5798 -- | PACKAGE_RENAMING_DECLARATION
5799 -- | SUBPROGRAM_RENAMING_DECLARATION
5800 -- | GENERIC_RENAMING_DECLARATION
5802 --------------------------------------
5803 -- 8.5 Object Renaming Declaration --
5804 --------------------------------------
5806 -- OBJECT_RENAMING_DECLARATION ::=
5807 -- DEFINING_IDENTIFIER :
5808 -- [NULL_EXCLUSION] SUBTYPE_MARK renames object_NAME
5809 -- [ASPECT_SPECIFICATIONS];
5810 -- | DEFINING_IDENTIFIER :
5811 -- ACCESS_DEFINITION renames object_NAME
5812 -- [ASPECT_SPECIFICATIONS];
5814 -- Note: Access_Definition is an optional field that gives support to
5815 -- Ada 2005 (AI-230). The parser generates nodes that have either the
5816 -- Subtype_Indication field or else the Access_Definition field.
5818 -- N_Object_Renaming_Declaration
5819 -- Sloc points to first identifier
5820 -- Defining_Identifier
5821 -- Null_Exclusion_Present (set to False if not present)
5822 -- Subtype_Mark (set to Empty if not present)
5823 -- Access_Definition (set to Empty if not present)
5824 -- Name
5825 -- Corresponding_Generic_Association
5827 -----------------------------------------
5828 -- 8.5 Exception Renaming Declaration --
5829 -----------------------------------------
5831 -- EXCEPTION_RENAMING_DECLARATION ::=
5832 -- DEFINING_IDENTIFIER : exception renames exception_NAME
5833 -- [ASPECT_SPECIFICATIONS];
5835 -- N_Exception_Renaming_Declaration
5836 -- Sloc points to first identifier
5837 -- Defining_Identifier
5838 -- Name
5840 ---------------------------------------
5841 -- 8.5 Package Renaming Declaration --
5842 ---------------------------------------
5844 -- PACKAGE_RENAMING_DECLARATION ::=
5845 -- package DEFINING_PROGRAM_UNIT_NAME renames package_NAME
5846 -- [ASPECT_SPECIFICATIONS];
5848 -- N_Package_Renaming_Declaration
5849 -- Sloc points to PACKAGE
5850 -- Defining_Unit_Name
5851 -- Name
5852 -- Parent_Spec
5854 ------------------------------------------
5855 -- 8.5 Subprogram Renaming Declaration --
5856 ------------------------------------------
5858 -- SUBPROGRAM_RENAMING_DECLARATION ::=
5859 -- SUBPROGRAM_SPECIFICATION renames callable_entity_NAME
5860 -- [ASPECT_SPECIFICATIONS];
5862 -- N_Subprogram_Renaming_Declaration
5863 -- Sloc points to RENAMES
5864 -- Specification
5865 -- Name
5866 -- Parent_Spec
5867 -- Corresponding_Spec
5868 -- Corresponding_Formal_Spec
5869 -- From_Default
5871 -----------------------------------------
5872 -- 8.5.5 Generic Renaming Declaration --
5873 -----------------------------------------
5875 -- GENERIC_RENAMING_DECLARATION ::=
5876 -- generic package DEFINING_PROGRAM_UNIT_NAME
5877 -- renames generic_package_NAME
5878 -- [ASPECT_SPECIFICATIONS];
5879 -- | generic procedure DEFINING_PROGRAM_UNIT_NAME
5880 -- renames generic_procedure_NAME
5881 -- [ASPECT_SPECIFICATIONS];
5882 -- | generic function DEFINING_PROGRAM_UNIT_NAME
5883 -- renames generic_function_NAME
5884 -- [ASPECT_SPECIFICATIONS];
5886 -- N_Generic_Package_Renaming_Declaration
5887 -- Sloc points to GENERIC
5888 -- Defining_Unit_Name
5889 -- Name
5890 -- Parent_Spec
5892 -- N_Generic_Procedure_Renaming_Declaration
5893 -- Sloc points to GENERIC
5894 -- Defining_Unit_Name
5895 -- Name
5896 -- Parent_Spec
5898 -- N_Generic_Function_Renaming_Declaration
5899 -- Sloc points to GENERIC
5900 -- Defining_Unit_Name
5901 -- Name
5902 -- Parent_Spec
5904 --------------------------------
5905 -- 9.1 Task Type Declaration --
5906 --------------------------------
5908 -- TASK_TYPE_DECLARATION ::=
5909 -- task type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
5910 -- [ASPECT_SPECIFICATIONS]
5911 -- [is [new INTERFACE_LIST with] TASK_DEFINITION];
5913 -- N_Task_Type_Declaration
5914 -- Sloc points to TASK
5915 -- Defining_Identifier
5916 -- Discriminant_Specifications (set to No_List if no
5917 -- discriminant part)
5918 -- Interface_List (set to No_List if none)
5919 -- Task_Definition (set to Empty if not present)
5920 -- Corresponding_Body
5922 ----------------------------------
5923 -- 9.1 Single Task Declaration --
5924 ----------------------------------
5926 -- SINGLE_TASK_DECLARATION ::=
5927 -- task DEFINING_IDENTIFIER
5928 -- [ASPECT_SPECIFICATIONS]
5929 -- [is [new INTERFACE_LIST with] TASK_DEFINITION];
5931 -- N_Single_Task_Declaration
5932 -- Sloc points to TASK
5933 -- Defining_Identifier
5934 -- Interface_List (set to No_List if none)
5935 -- Task_Definition (set to Empty if not present)
5937 --------------------------
5938 -- 9.1 Task Definition --
5939 --------------------------
5941 -- TASK_DEFINITION ::=
5942 -- {TASK_ITEM}
5943 -- [private
5944 -- {TASK_ITEM}]
5945 -- end [task_IDENTIFIER]
5947 -- Note: as a result of semantic analysis, the list of task items can
5948 -- include implicit type declarations resulting from entry families.
5950 -- N_Task_Definition
5951 -- Sloc points to first token of task definition
5952 -- Visible_Declarations
5953 -- Private_Declarations (set to No_List if no private part)
5954 -- End_Label
5955 -- Has_Storage_Size_Pragma
5956 -- Has_Relative_Deadline_Pragma
5958 --------------------
5959 -- 9.1 Task Item --
5960 --------------------
5962 -- TASK_ITEM ::= ENTRY_DECLARATION | REPRESENTATION_CLAUSE
5964 --------------------
5965 -- 9.1 Task Body --
5966 --------------------
5968 -- TASK_BODY ::=
5969 -- task body task_DEFINING_IDENTIFIER
5970 -- [ASPECT_SPECIFICATIONS]
5971 -- is
5972 -- DECLARATIVE_PART
5973 -- begin
5974 -- HANDLED_SEQUENCE_OF_STATEMENTS
5975 -- end [task_IDENTIFIER];
5977 -- Gigi restriction: This node never appears
5979 -- N_Task_Body
5980 -- Sloc points to TASK
5981 -- Defining_Identifier
5982 -- Declarations
5983 -- Handled_Statement_Sequence
5984 -- Is_Task_Master
5985 -- Activation_Chain_Entity
5986 -- Corresponding_Spec
5987 -- Was_Originally_Stub
5989 -------------------------------------
5990 -- 9.4 Protected Type Declaration --
5991 -------------------------------------
5993 -- PROTECTED_TYPE_DECLARATION ::=
5994 -- protected type DEFINING_IDENTIFIER [KNOWN_DISCRIMINANT_PART]
5995 -- [ASPECT_SPECIFICATIONS]
5996 -- is [new INTERFACE_LIST with] PROTECTED_DEFINITION;
5998 -- Note: protected type declarations are not permitted in Ada 83 mode
6000 -- N_Protected_Type_Declaration
6001 -- Sloc points to PROTECTED
6002 -- Defining_Identifier
6003 -- Discriminant_Specifications (set to No_List if no
6004 -- discriminant part)
6005 -- Interface_List (set to No_List if none)
6006 -- Protected_Definition
6007 -- Corresponding_Body
6009 ---------------------------------------
6010 -- 9.4 Single Protected Declaration --
6011 ---------------------------------------
6013 -- SINGLE_PROTECTED_DECLARATION ::=
6014 -- protected DEFINING_IDENTIFIER
6015 -- [ASPECT_SPECIFICATIONS]
6016 -- is [new INTERFACE_LIST with] PROTECTED_DEFINITION;
6018 -- Note: single protected declarations are not allowed in Ada 83 mode
6020 -- N_Single_Protected_Declaration
6021 -- Sloc points to PROTECTED
6022 -- Defining_Identifier
6023 -- Interface_List (set to No_List if none)
6024 -- Protected_Definition
6026 -------------------------------
6027 -- 9.4 Protected Definition --
6028 -------------------------------
6030 -- PROTECTED_DEFINITION ::=
6031 -- {PROTECTED_OPERATION_DECLARATION}
6032 -- [private
6033 -- {PROTECTED_ELEMENT_DECLARATION}]
6034 -- end [protected_IDENTIFIER]
6036 -- N_Protected_Definition
6037 -- Sloc points to first token of protected definition
6038 -- Visible_Declarations
6039 -- Private_Declarations (set to No_List if no private part)
6040 -- End_Label
6042 ------------------------------------------
6043 -- 9.4 Protected Operation Declaration --
6044 ------------------------------------------
6046 -- PROTECTED_OPERATION_DECLARATION ::=
6047 -- SUBPROGRAM_DECLARATION
6048 -- | ENTRY_DECLARATION
6049 -- | REPRESENTATION_CLAUSE
6051 ----------------------------------------
6052 -- 9.4 Protected Element Declaration --
6053 ----------------------------------------
6055 -- PROTECTED_ELEMENT_DECLARATION ::=
6056 -- PROTECTED_OPERATION_DECLARATION | COMPONENT_DECLARATION
6058 -------------------------
6059 -- 9.4 Protected Body --
6060 -------------------------
6062 -- PROTECTED_BODY ::=
6063 -- protected body DEFINING_IDENTIFIER
6064 -- [ASPECT_SPECIFICATIONS];
6065 -- is
6066 -- {PROTECTED_OPERATION_ITEM}
6067 -- end [protected_IDENTIFIER];
6069 -- Note: protected bodies are not allowed in Ada 83 mode
6071 -- Gigi restriction: This node never appears
6073 -- N_Protected_Body
6074 -- Sloc points to PROTECTED
6075 -- Defining_Identifier
6076 -- Declarations protected operation items (and pragmas)
6077 -- End_Label
6078 -- Corresponding_Spec
6079 -- Was_Originally_Stub
6081 -----------------------------------
6082 -- 9.4 Protected Operation Item --
6083 -----------------------------------
6085 -- PROTECTED_OPERATION_ITEM ::=
6086 -- SUBPROGRAM_DECLARATION
6087 -- | SUBPROGRAM_BODY
6088 -- | ENTRY_BODY
6089 -- | REPRESENTATION_CLAUSE
6091 ------------------------------
6092 -- 9.5.2 Entry Declaration --
6093 ------------------------------
6095 -- ENTRY_DECLARATION ::=
6096 -- [[not] overriding]
6097 -- entry DEFINING_IDENTIFIER
6098 -- [(DISCRETE_SUBTYPE_DEFINITION)] PARAMETER_PROFILE
6099 -- [ASPECT_SPECIFICATIONS];
6101 -- N_Entry_Declaration
6102 -- Sloc points to ENTRY
6103 -- Defining_Identifier
6104 -- Discrete_Subtype_Definition (set to Empty if not present)
6105 -- Parameter_Specifications (set to No_List if no formal part)
6106 -- Corresponding_Body
6107 -- Must_Override set if overriding indicator present
6108 -- Must_Not_Override set if not_overriding indicator present
6110 -- Note: overriding indicator is an Ada 2005 feature
6112 -----------------------------
6113 -- 9.5.2 Accept statement --
6114 -----------------------------
6116 -- ACCEPT_STATEMENT ::=
6117 -- accept entry_DIRECT_NAME
6118 -- [(ENTRY_INDEX)] PARAMETER_PROFILE [do
6119 -- HANDLED_SEQUENCE_OF_STATEMENTS
6120 -- end [entry_IDENTIFIER]];
6122 -- Gigi restriction: This node never appears
6124 -- Note: there are no explicit declarations allowed in an accept
6125 -- statement. However, the implicit declarations for any statement
6126 -- identifiers (labels and block/loop identifiers) are declarations
6127 -- that belong logically to the accept statement, and that is why
6128 -- there is a Declarations field in this node.
6130 -- N_Accept_Statement
6131 -- Sloc points to ACCEPT
6132 -- Entry_Direct_Name
6133 -- Entry_Index (set to Empty if not present)
6134 -- Parameter_Specifications (set to No_List if no formal part)
6135 -- Handled_Statement_Sequence
6136 -- Declarations (set to No_List if no declarations)
6138 ------------------------
6139 -- 9.5.2 Entry Index --
6140 ------------------------
6142 -- ENTRY_INDEX ::= EXPRESSION
6144 -----------------------
6145 -- 9.5.2 Entry Body --
6146 -----------------------
6148 -- ENTRY_BODY ::=
6149 -- entry DEFINING_IDENTIFIER ENTRY_BODY_FORMAL_PART ENTRY_BARRIER is
6150 -- DECLARATIVE_PART
6151 -- begin
6152 -- HANDLED_SEQUENCE_OF_STATEMENTS
6153 -- end [entry_IDENTIFIER];
6155 -- ENTRY_BARRIER ::= when CONDITION
6157 -- Note: we store the CONDITION of the ENTRY_BARRIER in the node for
6158 -- the ENTRY_BODY_FORMAL_PART to avoid the N_Entry_Body node getting
6159 -- too full (it would otherwise have too many fields)
6161 -- Gigi restriction: This node never appears
6163 -- N_Entry_Body
6164 -- Sloc points to ENTRY
6165 -- Defining_Identifier
6166 -- Entry_Body_Formal_Part
6167 -- Declarations
6168 -- Handled_Statement_Sequence
6169 -- Activation_Chain_Entity
6170 -- At_End_Proc (set to Empty if no clean up procedure)
6172 -----------------------------------
6173 -- 9.5.2 Entry Body Formal Part --
6174 -----------------------------------
6176 -- ENTRY_BODY_FORMAL_PART ::=
6177 -- [(ENTRY_INDEX_SPECIFICATION)] PARAMETER_PROFILE
6179 -- Note that an entry body formal part node is present even if it is
6180 -- empty. This reflects the grammar, in which it is the components of
6181 -- the entry body formal part that are optional, not the entry body
6182 -- formal part itself. Also this means that the barrier condition
6183 -- always has somewhere to be stored.
6185 -- Gigi restriction: This node never appears
6187 -- N_Entry_Body_Formal_Part
6188 -- Sloc points to first token
6189 -- Entry_Index_Specification (set to Empty if not present)
6190 -- Parameter_Specifications (set to No_List if no formal part)
6191 -- Condition from entry barrier of entry body
6193 --------------------------
6194 -- 9.5.2 Entry Barrier --
6195 --------------------------
6197 -- ENTRY_BARRIER ::= when CONDITION
6199 --------------------------------------
6200 -- 9.5.2 Entry Index Specification --
6201 --------------------------------------
6203 -- ENTRY_INDEX_SPECIFICATION ::=
6204 -- for DEFINING_IDENTIFIER in DISCRETE_SUBTYPE_DEFINITION
6206 -- Gigi restriction: This node never appears
6208 -- N_Entry_Index_Specification
6209 -- Sloc points to FOR
6210 -- Defining_Identifier
6211 -- Discrete_Subtype_Definition
6213 ---------------------------------
6214 -- 9.5.3 Entry Call Statement --
6215 ---------------------------------
6217 -- ENTRY_CALL_STATEMENT ::= entry_NAME [ACTUAL_PARAMETER_PART];
6219 -- The parser may generate a procedure call for this construct. The
6220 -- semantic pass must correct this misidentification where needed.
6222 -- Gigi restriction: This node never appears
6224 -- N_Entry_Call_Statement
6225 -- Sloc points to first token of name
6226 -- Name
6227 -- Parameter_Associations (set to No_List if no
6228 -- actual parameter part)
6229 -- First_Named_Actual
6230 -- Is_Elaboration_Checks_OK_Node
6231 -- Is_SPARK_Mode_On_Node
6232 -- Is_Elaboration_Warnings_OK_Node
6234 ------------------------------
6235 -- 9.5.4 Requeue Statement --
6236 ------------------------------
6238 -- REQUEUE_STATEMENT ::= requeue entry_NAME [with abort];
6240 -- Note: requeue statements are not permitted in Ada 83 mode
6242 -- Gigi restriction: This node never appears
6244 -- N_Requeue_Statement
6245 -- Sloc points to REQUEUE
6246 -- Name
6247 -- Abort_Present
6248 -- Is_Elaboration_Checks_OK_Node
6249 -- Is_SPARK_Mode_On_Node
6250 -- Is_Elaboration_Warnings_OK_Node
6252 --------------------------
6253 -- 9.6 Delay Statement --
6254 --------------------------
6256 -- DELAY_STATEMENT ::=
6257 -- DELAY_UNTIL_STATEMENT
6258 -- | DELAY_RELATIVE_STATEMENT
6260 --------------------------------
6261 -- 9.6 Delay Until Statement --
6262 --------------------------------
6264 -- DELAY_UNTIL_STATEMENT ::= delay until delay_EXPRESSION;
6266 -- Note: delay until statements are not permitted in Ada 83 mode
6268 -- Gigi restriction: This node never appears
6270 -- N_Delay_Until_Statement
6271 -- Sloc points to DELAY
6272 -- Expression
6274 -----------------------------------
6275 -- 9.6 Delay Relative Statement --
6276 -----------------------------------
6278 -- DELAY_RELATIVE_STATEMENT ::= delay delay_EXPRESSION;
6280 -- Gigi restriction: This node never appears
6282 -- N_Delay_Relative_Statement
6283 -- Sloc points to DELAY
6284 -- Expression
6286 ---------------------------
6287 -- 9.7 Select Statement --
6288 ---------------------------
6290 -- SELECT_STATEMENT ::=
6291 -- SELECTIVE_ACCEPT
6292 -- | TIMED_ENTRY_CALL
6293 -- | CONDITIONAL_ENTRY_CALL
6294 -- | ASYNCHRONOUS_SELECT
6296 -----------------------------
6297 -- 9.7.1 Selective Accept --
6298 -----------------------------
6300 -- SELECTIVE_ACCEPT ::=
6301 -- select
6302 -- [GUARD]
6303 -- SELECT_ALTERNATIVE
6304 -- {or
6305 -- [GUARD]
6306 -- SELECT_ALTERNATIVE}
6307 -- [else
6308 -- SEQUENCE_OF_STATEMENTS]
6309 -- end select;
6311 -- Gigi restriction: This node never appears
6313 -- Note: the guard expression, if present, appears in the node for
6314 -- the select alternative.
6316 -- N_Selective_Accept
6317 -- Sloc points to SELECT
6318 -- Select_Alternatives
6319 -- Else_Statements (set to No_List if no else part)
6321 ------------------
6322 -- 9.7.1 Guard --
6323 ------------------
6325 -- GUARD ::= when CONDITION =>
6327 -- As noted above, the CONDITION that is part of a GUARD is included
6328 -- in the node for the select alternative for convenience.
6330 -------------------------------
6331 -- 9.7.1 Select Alternative --
6332 -------------------------------
6334 -- SELECT_ALTERNATIVE ::=
6335 -- ACCEPT_ALTERNATIVE
6336 -- | DELAY_ALTERNATIVE
6337 -- | TERMINATE_ALTERNATIVE
6339 -------------------------------
6340 -- 9.7.1 Accept Alternative --
6341 -------------------------------
6343 -- ACCEPT_ALTERNATIVE ::=
6344 -- ACCEPT_STATEMENT [SEQUENCE_OF_STATEMENTS]
6346 -- Gigi restriction: This node never appears
6348 -- N_Accept_Alternative
6349 -- Sloc points to ACCEPT
6350 -- Accept_Statement
6351 -- Condition from the guard (set to Empty if no guard present)
6352 -- Statements (set to Empty_List if no statements)
6353 -- Pragmas_Before pragmas before alt (set to No_List if none)
6354 -- Accept_Handler_Records
6356 ------------------------------
6357 -- 9.7.1 Delay Alternative --
6358 ------------------------------
6360 -- DELAY_ALTERNATIVE ::=
6361 -- DELAY_STATEMENT [SEQUENCE_OF_STATEMENTS]
6363 -- Gigi restriction: This node never appears
6365 -- N_Delay_Alternative
6366 -- Sloc points to DELAY
6367 -- Delay_Statement
6368 -- Condition from the guard (set to Empty if no guard present)
6369 -- Statements (set to Empty_List if no statements)
6370 -- Pragmas_Before pragmas before alt (set to No_List if none)
6372 ----------------------------------
6373 -- 9.7.1 Terminate Alternative --
6374 ----------------------------------
6376 -- TERMINATE_ALTERNATIVE ::= terminate;
6378 -- Gigi restriction: This node never appears
6380 -- N_Terminate_Alternative
6381 -- Sloc points to TERMINATE
6382 -- Condition from the guard (set to Empty if no guard present)
6383 -- Pragmas_Before pragmas before alt (set to No_List if none)
6384 -- Pragmas_After pragmas after alt (set to No_List if none)
6386 -----------------------------
6387 -- 9.7.2 Timed Entry Call --
6388 -----------------------------
6390 -- TIMED_ENTRY_CALL ::=
6391 -- select
6392 -- ENTRY_CALL_ALTERNATIVE
6393 -- or
6394 -- DELAY_ALTERNATIVE
6395 -- end select;
6397 -- Gigi restriction: This node never appears
6399 -- N_Timed_Entry_Call
6400 -- Sloc points to SELECT
6401 -- Entry_Call_Alternative
6402 -- Delay_Alternative
6404 -----------------------------------
6405 -- 9.7.2 Entry Call Alternative --
6406 -----------------------------------
6408 -- ENTRY_CALL_ALTERNATIVE ::=
6409 -- PROCEDURE_OR_ENTRY_CALL [SEQUENCE_OF_STATEMENTS]
6411 -- PROCEDURE_OR_ENTRY_CALL ::=
6412 -- PROCEDURE_CALL_STATEMENT | ENTRY_CALL_STATEMENT
6414 -- Gigi restriction: This node never appears
6416 -- N_Entry_Call_Alternative
6417 -- Sloc points to first token of entry call statement
6418 -- Entry_Call_Statement
6419 -- Statements (set to Empty_List if no statements)
6420 -- Pragmas_Before pragmas before alt (set to No_List if none)
6422 -----------------------------------
6423 -- 9.7.3 Conditional Entry Call --
6424 -----------------------------------
6426 -- CONDITIONAL_ENTRY_CALL ::=
6427 -- select
6428 -- ENTRY_CALL_ALTERNATIVE
6429 -- else
6430 -- SEQUENCE_OF_STATEMENTS
6431 -- end select;
6433 -- Gigi restriction: This node never appears
6435 -- N_Conditional_Entry_Call
6436 -- Sloc points to SELECT
6437 -- Entry_Call_Alternative
6438 -- Else_Statements
6440 --------------------------------
6441 -- 9.7.4 Asynchronous Select --
6442 --------------------------------
6444 -- ASYNCHRONOUS_SELECT ::=
6445 -- select
6446 -- TRIGGERING_ALTERNATIVE
6447 -- then abort
6448 -- ABORTABLE_PART
6449 -- end select;
6451 -- Note: asynchronous select is not permitted in Ada 83 mode
6453 -- Gigi restriction: This node never appears
6455 -- N_Asynchronous_Select
6456 -- Sloc points to SELECT
6457 -- Triggering_Alternative
6458 -- Abortable_Part
6460 -----------------------------------
6461 -- 9.7.4 Triggering Alternative --
6462 -----------------------------------
6464 -- TRIGGERING_ALTERNATIVE ::=
6465 -- TRIGGERING_STATEMENT [SEQUENCE_OF_STATEMENTS]
6467 -- Gigi restriction: This node never appears
6469 -- N_Triggering_Alternative
6470 -- Sloc points to first token of triggering statement
6471 -- Triggering_Statement
6472 -- Statements (set to Empty_List if no statements)
6473 -- Pragmas_Before pragmas before alt (set to No_List if none)
6475 ---------------------------------
6476 -- 9.7.4 Triggering Statement --
6477 ---------------------------------
6479 -- TRIGGERING_STATEMENT ::= PROCEDURE_OR_ENTRY_CALL | DELAY_STATEMENT
6481 ---------------------------
6482 -- 9.7.4 Abortable Part --
6483 ---------------------------
6485 -- ABORTABLE_PART ::= SEQUENCE_OF_STATEMENTS
6487 -- Gigi restriction: This node never appears
6489 -- N_Abortable_Part
6490 -- Sloc points to ABORT
6491 -- Statements
6493 --------------------------
6494 -- 9.8 Abort Statement --
6495 --------------------------
6497 -- ABORT_STATEMENT ::= abort task_NAME {, task_NAME};
6499 -- Gigi restriction: This node never appears
6501 -- N_Abort_Statement
6502 -- Sloc points to ABORT
6503 -- Names
6505 -------------------------
6506 -- 10.1.1 Compilation --
6507 -------------------------
6509 -- COMPILATION ::= {COMPILATION_UNIT}
6511 -- There is no explicit node in the tree for a compilation, since in
6512 -- general the compiler is processing only a single compilation unit
6513 -- at a time. It is possible to parse multiple units in syntax check
6514 -- only mode, but the trees are discarded in that case.
6516 ------------------------------
6517 -- 10.1.1 Compilation Unit --
6518 ------------------------------
6520 -- COMPILATION_UNIT ::=
6521 -- CONTEXT_CLAUSE LIBRARY_ITEM
6522 -- | CONTEXT_CLAUSE SUBUNIT
6524 -- The N_Compilation_Unit node itself represents the above syntax.
6525 -- However, there are two additional items not reflected in the above
6526 -- syntax. First we have the global declarations that are added by the
6527 -- code generator. These are outer level declarations (so they cannot
6528 -- be represented as being inside the units). An example is the wrapper
6529 -- subprograms that are created to do ABE checking. As always a list of
6530 -- declarations can contain actions as well (i.e. statements), and such
6531 -- statements are executed as part of the elaboration of the unit. Note
6532 -- that all such declarations are elaborated before the library unit.
6534 -- Similarly, certain actions need to be elaborated at the completion
6535 -- of elaboration of the library unit (notably the statement that sets
6536 -- the Boolean flag indicating that elaboration is complete).
6538 -- The third item not reflected in the syntax is pragmas that appear
6539 -- after the compilation unit. As always pragmas are a problem since
6540 -- they are not part of the formal syntax, but can be stuck into the
6541 -- source following a set of ad hoc rules, and we have to find an ad
6542 -- hoc way of sticking them into the tree. For pragmas that appear
6543 -- before the library unit, we just consider them to be part of the
6544 -- context clause, and pragmas can appear in the Context_Items list
6545 -- of the compilation unit. However, pragmas can also appear after
6546 -- the library item.
6548 -- To deal with all these problems, we create an auxiliary node for
6549 -- a compilation unit, referenced from the N_Compilation_Unit node,
6550 -- that contains these items.
6552 -- N_Compilation_Unit
6553 -- Sloc points to first token of defining unit name
6554 -- Context_Items context items and pragmas preceding unit
6555 -- Private_Present set if library unit has private keyword
6556 -- Unit library item or subunit
6557 -- Aux_Decls_Node points to the N_Compilation_Unit_Aux node
6558 -- First_Inlined_Subprogram
6559 -- Library_Unit corresponding/parent spec/body
6560 -- Save_Invocation_Graph_Of_Body
6561 -- Acts_As_Spec flag for subprogram body with no spec
6562 -- Body_Required set for spec if body is required
6563 -- Has_Pragma_Suppress_All
6564 -- Context_Pending
6565 -- Has_No_Elaboration_Code
6567 -- N_Compilation_Unit_Aux
6568 -- Sloc is a copy of the Sloc from the N_Compilation_Unit node
6569 -- Declarations (set to No_List if no global declarations)
6570 -- Actions (set to No_List if no actions)
6571 -- Pragmas_After pragmas after unit (set to No_List if none)
6572 -- Config_Pragmas config pragmas (set to Empty_List if none)
6573 -- Default_Storage_Pool
6575 --------------------------
6576 -- 10.1.1 Library Item --
6577 --------------------------
6579 -- LIBRARY_ITEM ::=
6580 -- [private] LIBRARY_UNIT_DECLARATION
6581 -- | LIBRARY_UNIT_BODY
6582 -- | [private] LIBRARY_UNIT_RENAMING_DECLARATION
6584 -- Note: PRIVATE is not allowed in Ada 83 mode
6586 -- There is no explicit node in the tree for library item, instead
6587 -- the declaration or body, and the flag for private if present,
6588 -- appear in the N_Compilation_Unit node.
6590 --------------------------------------
6591 -- 10.1.1 Library Unit Declaration --
6592 --------------------------------------
6594 -- LIBRARY_UNIT_DECLARATION ::=
6595 -- SUBPROGRAM_DECLARATION | PACKAGE_DECLARATION
6596 -- | GENERIC_DECLARATION | GENERIC_INSTANTIATION
6598 -----------------------------------------------
6599 -- 10.1.1 Library Unit Renaming Declaration --
6600 -----------------------------------------------
6602 -- LIBRARY_UNIT_RENAMING_DECLARATION ::=
6603 -- PACKAGE_RENAMING_DECLARATION
6604 -- | GENERIC_RENAMING_DECLARATION
6605 -- | SUBPROGRAM_RENAMING_DECLARATION
6607 -------------------------------
6608 -- 10.1.1 Library unit body --
6609 -------------------------------
6611 -- LIBRARY_UNIT_BODY ::= SUBPROGRAM_BODY | PACKAGE_BODY
6613 ------------------------------
6614 -- 10.1.1 Parent Unit Name --
6615 ------------------------------
6617 -- PARENT_UNIT_NAME ::= NAME
6619 ----------------------------
6620 -- 10.1.2 Context clause --
6621 ----------------------------
6623 -- CONTEXT_CLAUSE ::= {CONTEXT_ITEM}
6625 -- The context clause can include pragmas, and any pragmas that appear
6626 -- before the context clause proper (i.e. all configuration pragmas,
6627 -- also appear at the front of this list).
6629 --------------------------
6630 -- 10.1.2 Context_Item --
6631 --------------------------
6633 -- CONTEXT_ITEM ::= WITH_CLAUSE | USE_CLAUSE | WITH_TYPE_CLAUSE
6635 -------------------------
6636 -- 10.1.2 With clause --
6637 -------------------------
6639 -- WITH_CLAUSE ::=
6640 -- with library_unit_NAME {,library_unit_NAME};
6642 -- A separate With clause is built for each name, so that we have
6643 -- a Corresponding_Spec field for each with'ed spec. The flags
6644 -- First_Name and Last_Name are used to reconstruct the exact
6645 -- source form. When a list of names appears in one with clause,
6646 -- the first name in the list has First_Name set, and the last
6647 -- has Last_Name set. If the with clause has only one name, then
6648 -- both of the flags First_Name and Last_Name are set in this name.
6650 -- Note: in the case of implicit with's that are installed by the
6651 -- Rtsfind routine, Implicit_With is set, and the Sloc is typically
6652 -- set to Standard_Location, but it is incorrect to test the Sloc
6653 -- to find out if a with clause is implicit, test the flag instead.
6655 -- N_With_Clause
6656 -- Sloc points to first token of library unit name
6657 -- Name
6658 -- Private_Present set if with_clause has private keyword
6659 -- Limited_Present set if LIMITED is present
6660 -- Next_Implicit_With
6661 -- Library_Unit
6662 -- Corresponding_Spec
6663 -- First_Name (set to True if first name or only one name)
6664 -- Last_Name (set to True if last name or only one name)
6665 -- Context_Installed
6666 -- Elaborate_Present
6667 -- Elaborate_All_Present
6668 -- Elaborate_All_Desirable
6669 -- Elaborate_Desirable
6670 -- Implicit_With
6671 -- Limited_View_Installed
6672 -- Parent_With
6673 -- Unreferenced_In_Spec
6674 -- No_Entities_Ref_In_Spec
6676 -- Note: Limited_Present and Limited_View_Installed are used to support
6677 -- the implementation of Ada 2005 (AI-50217).
6679 -- Similarly, Private_Present is used to support the implementation of
6680 -- Ada 2005 (AI-50262).
6682 -- Note: if the WITH clause refers to a standard library unit, then a
6683 -- limited with clause is changed into a normal with clause, because we
6684 -- are not prepared to deal with limited with in the context of Rtsfind.
6685 -- So in this case, the Limited_Present flag will be False in the final
6686 -- tree.
6688 ----------------------
6689 -- With_Type clause --
6690 ----------------------
6692 -- This is a GNAT extension, used to implement mutually recursive
6693 -- types declared in different packages.
6695 -- Note: this is now obsolete. The functionality of this construct
6696 -- is now implemented by the Ada 2005 limited_with_clause.
6698 ---------------------
6699 -- 10.2 Body stub --
6700 ---------------------
6702 -- BODY_STUB ::=
6703 -- SUBPROGRAM_BODY_STUB
6704 -- | PACKAGE_BODY_STUB
6705 -- | TASK_BODY_STUB
6706 -- | PROTECTED_BODY_STUB
6708 ----------------------------------
6709 -- 10.1.3 Subprogram Body Stub --
6710 ----------------------------------
6712 -- SUBPROGRAM_BODY_STUB ::=
6713 -- SUBPROGRAM_SPECIFICATION is separate
6714 -- [ASPECT_SPECIFICATION];
6716 -- N_Subprogram_Body_Stub
6717 -- Sloc points to FUNCTION or PROCEDURE
6718 -- Specification
6719 -- Corresponding_Spec_Of_Stub
6720 -- Library_Unit points to the subunit
6721 -- Corresponding_Body
6722 -- At_End_Proc (set to Empty if no clean up procedure)
6724 -------------------------------
6725 -- 10.1.3 Package Body Stub --
6726 -------------------------------
6728 -- PACKAGE_BODY_STUB ::=
6729 -- package body DEFINING_IDENTIFIER is separate
6730 -- [ASPECT_SPECIFICATION];
6732 -- N_Package_Body_Stub
6733 -- Sloc points to PACKAGE
6734 -- Defining_Identifier
6735 -- Corresponding_Spec_Of_Stub
6736 -- Library_Unit points to the subunit
6737 -- Corresponding_Body
6739 ----------------------------
6740 -- 10.1.3 Task Body Stub --
6741 ----------------------------
6743 -- TASK_BODY_STUB ::=
6744 -- task body DEFINING_IDENTIFIER is separate
6745 -- [ASPECT_SPECIFICATION];
6747 -- N_Task_Body_Stub
6748 -- Sloc points to TASK
6749 -- Defining_Identifier
6750 -- Corresponding_Spec_Of_Stub
6751 -- Library_Unit points to the subunit
6752 -- Corresponding_Body
6753 -- At_End_Proc (set to Empty if no clean up procedure)
6755 ---------------------------------
6756 -- 10.1.3 Protected Body Stub --
6757 ---------------------------------
6759 -- PROTECTED_BODY_STUB ::=
6760 -- protected body DEFINING_IDENTIFIER is separate
6761 -- [ASPECT_SPECIFICATION];
6763 -- Note: protected body stubs are not allowed in Ada 83 mode
6765 -- N_Protected_Body_Stub
6766 -- Sloc points to PROTECTED
6767 -- Defining_Identifier
6768 -- Corresponding_Spec_Of_Stub
6769 -- Library_Unit points to the subunit
6770 -- Corresponding_Body
6772 ---------------------
6773 -- 10.1.3 Subunit --
6774 ---------------------
6776 -- SUBUNIT ::= separate (PARENT_UNIT_NAME) PROPER_BODY
6778 -- N_Subunit
6779 -- Sloc points to SEPARATE
6780 -- Name is the name of the parent unit
6781 -- Proper_Body is the subunit body
6782 -- Corresponding_Stub is the stub declaration for the unit.
6784 ---------------------------------
6785 -- 11.1 Exception Declaration --
6786 ---------------------------------
6788 -- EXCEPTION_DECLARATION ::= DEFINING_IDENTIFIER_LIST : exception
6789 -- [ASPECT_SPECIFICATIONS];
6791 -- For consistency with object declarations etc., the parser converts
6792 -- the case of multiple identifiers being declared to a series of
6793 -- declarations in which the expression is copied, using the More_Ids
6794 -- and Prev_Ids flags to remember the source form as described in the
6795 -- section on "Handling of Defining Identifier Lists".
6797 -- N_Exception_Declaration
6798 -- Sloc points to EXCEPTION
6799 -- Defining_Identifier
6800 -- Expression
6801 -- Renaming_Exception
6802 -- More_Ids (set to False if no more identifiers in list)
6803 -- Prev_Ids (set to False if no previous identifiers in list)
6805 ------------------------------------------
6806 -- 11.2 Handled Sequence Of Statements --
6807 ------------------------------------------
6809 -- HANDLED_SEQUENCE_OF_STATEMENTS ::=
6810 -- SEQUENCE_OF_STATEMENTS
6811 -- [exception
6812 -- EXCEPTION_HANDLER
6813 -- {EXCEPTION_HANDLER}]
6814 -- [at end
6815 -- cleanup_procedure_call (param, param, param, ...);]
6817 -- The AT END phrase is a GNAT extension to provide for cleanups. It is
6818 -- used only internally currently, but is considered to be syntactic.
6819 -- At the moment, the only cleanup action allowed is a single call to a
6820 -- parameterless procedure; this restriction could be lifted if we make
6821 -- some changes in gigi. The At_End_Proc field is an N_Identifier node
6822 -- that denotes the procedure to be called. The cleanup action occurs
6823 -- whenever the sequence of statements is left for any reason. The
6824 -- possible reasons are:
6826 -- 1. reaching the end of the sequence
6827 -- 2. exit, return, or goto
6828 -- 3. exception or abort
6830 -- The cleanup action also occurs whenever the exception handlers are
6831 -- left.
6833 -- The AT END cleanup handler protects only the sequence of statements
6834 -- and the exception handlers (not the associated declarations of
6835 -- the parent), just like exception handlers do not protect the
6836 -- declarations. The big difference is that the cleanup actions occur
6837 -- on either a normal or an abnormal exit from the statement sequence.
6839 -- At_End_Proc is also a field of various nodes that can contain
6840 -- both Declarations and Handled_Statement_Sequence, such as subprogram
6841 -- bodies and block statements. In that case, the At_End_Proc
6842 -- protects the Declarations as well as the Handled_Statement_Sequence.
6844 -- Note: the list of Exception_Handlers can contain pragmas as well
6845 -- as actual handlers. In practice these pragmas can only occur at
6846 -- the start of the list, since any pragmas occurring later on will
6847 -- be included in the statement list of the corresponding handler.
6849 -- Note: although in the Ada syntax, the sequence of statements in
6850 -- a handled sequence of statements can only contain statements, we
6851 -- allow free mixing of declarations and statements in the resulting
6852 -- expanded tree. This is for example used to deal with the case of
6853 -- a cleanup procedure that must handle declarations as well as the
6854 -- statements of a block.
6856 -- Note: the cleanup_procedure_call does not go through the common
6857 -- processing for calls, which in particular means that it will not be
6858 -- automatically inlined in all cases, even though the procedure to be
6859 -- called is marked inline. More specifically, if the procedure comes
6860 -- from another unit than the main source unit, for example a run-time
6861 -- unit, then it needs to be manually added to the list of bodies to be
6862 -- inlined by invoking Add_Inlined_Body on it.
6864 -- N_Handled_Sequence_Of_Statements
6865 -- Sloc points to first token of first statement
6866 -- Statements
6867 -- End_Label (set to Empty if expander generated)
6868 -- Exception_Handlers (set to No_List if none present)
6869 -- At_End_Proc (set to Empty if no clean up procedure)
6871 -- Note: A Handled_Sequence_Of_Statements can contain both
6872 -- Exception_Handlers and an At_End_Proc.
6874 -- Note: the parent always contains a Declarations field which contains
6875 -- declarations associated with the handled sequence of statements. This
6876 -- is true even in the case of an accept statement (see description of
6877 -- the N_Accept_Statement node).
6879 -- End_Label refers to the containing construct
6881 -----------------------------
6882 -- 11.2 Exception Handler --
6883 -----------------------------
6885 -- EXCEPTION_HANDLER ::=
6886 -- when [CHOICE_PARAMETER_SPECIFICATION :]
6887 -- EXCEPTION_CHOICE {| EXCEPTION_CHOICE} =>
6888 -- SEQUENCE_OF_STATEMENTS
6890 -- Note: choice parameter specification is not allowed in Ada 83 mode
6892 -- N_Exception_Handler
6893 -- Sloc points to WHEN
6894 -- Choice_Parameter (set to Empty if not present)
6895 -- Exception_Choices
6896 -- Statements
6897 -- Exception_Label (set to Empty if not present)
6898 -- Local_Raise_Statements (set to No_Elist if not present)
6899 -- Local_Raise_Not_OK
6900 -- Has_Local_Raise
6902 ------------------------------------------
6903 -- 11.2 Choice parameter specification --
6904 ------------------------------------------
6906 -- CHOICE_PARAMETER_SPECIFICATION ::= DEFINING_IDENTIFIER
6908 ----------------------------
6909 -- 11.2 Exception Choice --
6910 ----------------------------
6912 -- EXCEPTION_CHOICE ::= exception_NAME | others
6914 -- Except in the case of OTHERS, no explicit node appears in the tree
6915 -- for exception choice. Instead the exception name appears directly.
6916 -- An OTHERS choice is represented by a N_Others_Choice node (see
6917 -- section 3.8.1.
6919 -- Note: for the exception choice created for an at end handler, the
6920 -- exception choice is an N_Others_Choice node with All_Others set.
6922 ---------------------------
6923 -- 11.3 Raise Statement --
6924 ---------------------------
6926 -- RAISE_STATEMENT ::= raise [exception_NAME];
6928 -- In Ada 2005, we have
6930 -- RAISE_STATEMENT ::=
6931 -- raise; | raise exception_NAME [with string_EXPRESSION];
6933 -- N_Raise_Statement
6934 -- Sloc points to RAISE
6935 -- Name (set to Empty if no exception name present)
6936 -- Expression (set to Empty if no expression present)
6938 ----------------------------
6939 -- 11.3 Raise Expression --
6940 ----------------------------
6942 -- RAISE_EXPRESSION ::= raise exception_NAME [with string_EXPRESSION]
6944 -- N_Raise_Expression
6945 -- Sloc points to RAISE
6946 -- Name (always present)
6947 -- Expression (set to Empty if no expression present)
6948 -- plus fields for expression
6950 -------------------------------
6951 -- 12.1 Generic Declaration --
6952 -------------------------------
6954 -- GENERIC_DECLARATION ::=
6955 -- GENERIC_SUBPROGRAM_DECLARATION | GENERIC_PACKAGE_DECLARATION
6957 ------------------------------------------
6958 -- 12.1 Generic Subprogram Declaration --
6959 ------------------------------------------
6961 -- GENERIC_SUBPROGRAM_DECLARATION ::=
6962 -- GENERIC_FORMAL_PART SUBPROGRAM_SPECIFICATION
6963 -- [ASPECT_SPECIFICATIONS];
6965 -- Note: Generic_Formal_Declarations can include pragmas
6967 -- N_Generic_Subprogram_Declaration
6968 -- Sloc points to GENERIC
6969 -- Specification subprogram specification
6970 -- Corresponding_Body
6971 -- Generic_Formal_Declarations from generic formal part
6972 -- Parent_Spec
6974 ---------------------------------------
6975 -- 12.1 Generic Package Declaration --
6976 ---------------------------------------
6978 -- GENERIC_PACKAGE_DECLARATION ::=
6979 -- GENERIC_FORMAL_PART PACKAGE_SPECIFICATION
6980 -- [ASPECT_SPECIFICATIONS];
6982 -- Note: when we do generics right, the Activation_Chain_Entity entry
6983 -- for this node can be removed (since the expander won't see generic
6984 -- units any more)???.
6986 -- Note: Generic_Formal_Declarations can include pragmas
6988 -- N_Generic_Package_Declaration
6989 -- Sloc points to GENERIC
6990 -- Specification package specification
6991 -- Corresponding_Body
6992 -- Generic_Formal_Declarations from generic formal part
6993 -- Parent_Spec
6994 -- Activation_Chain_Entity
6996 -------------------------------
6997 -- 12.1 Generic Formal Part --
6998 -------------------------------
7000 -- GENERIC_FORMAL_PART ::=
7001 -- generic {GENERIC_FORMAL_PARAMETER_DECLARATION | USE_CLAUSE}
7003 ------------------------------------------------
7004 -- 12.1 Generic Formal Parameter Declaration --
7005 ------------------------------------------------
7007 -- GENERIC_FORMAL_PARAMETER_DECLARATION ::=
7008 -- FORMAL_OBJECT_DECLARATION
7009 -- | FORMAL_TYPE_DECLARATION
7010 -- | FORMAL_SUBPROGRAM_DECLARATION
7011 -- | FORMAL_PACKAGE_DECLARATION
7013 ---------------------------------
7014 -- 12.3 Generic Instantiation --
7015 ---------------------------------
7017 -- GENERIC_INSTANTIATION ::=
7018 -- package DEFINING_PROGRAM_UNIT_NAME is
7019 -- new generic_package_NAME [GENERIC_ACTUAL_PART]
7020 -- [ASPECT_SPECIFICATIONS];
7021 -- | [[not] overriding]
7022 -- procedure DEFINING_PROGRAM_UNIT_NAME is
7023 -- new generic_procedure_NAME [GENERIC_ACTUAL_PART]
7024 -- [ASPECT_SPECIFICATIONS];
7025 -- | [[not] overriding]
7026 -- function DEFINING_DESIGNATOR is
7027 -- new generic_function_NAME [GENERIC_ACTUAL_PART]
7028 -- [ASPECT_SPECIFICATIONS];
7030 -- N_Package_Instantiation
7031 -- Sloc points to PACKAGE
7032 -- Defining_Unit_Name
7033 -- Name
7034 -- Generic_Associations (set to No_List if no
7035 -- generic actual part)
7036 -- Parent_Spec
7037 -- Instance_Spec
7038 -- Is_Elaboration_Checks_OK_Node
7039 -- Is_SPARK_Mode_On_Node
7040 -- Is_Elaboration_Warnings_OK_Node
7041 -- Is_Declaration_Level_Node
7042 -- Is_Known_Guaranteed_ABE
7044 -- N_Procedure_Instantiation
7045 -- Sloc points to PROCEDURE
7046 -- Defining_Unit_Name
7047 -- Name
7048 -- Parent_Spec
7049 -- Generic_Associations (set to No_List if no
7050 -- generic actual part)
7051 -- Instance_Spec
7052 -- Is_Elaboration_Checks_OK_Node
7053 -- Is_SPARK_Mode_On_Node
7054 -- Is_Elaboration_Warnings_OK_Node
7055 -- Is_Declaration_Level_Node
7056 -- Must_Override set if overriding indicator present
7057 -- Must_Not_Override set if not_overriding indicator present
7058 -- Is_Known_Guaranteed_ABE
7060 -- N_Function_Instantiation
7061 -- Sloc points to FUNCTION
7062 -- Defining_Unit_Name
7063 -- Name
7064 -- Generic_Associations (set to No_List if no
7065 -- generic actual part)
7066 -- Parent_Spec
7067 -- Instance_Spec
7068 -- Is_Elaboration_Checks_OK_Node
7069 -- Is_SPARK_Mode_On_Node
7070 -- Is_Elaboration_Warnings_OK_Node
7071 -- Is_Declaration_Level_Node
7072 -- Must_Override set if overriding indicator present
7073 -- Must_Not_Override set if not_overriding indicator present
7074 -- Is_Known_Guaranteed_ABE
7076 -- Note: overriding indicator is an Ada 2005 feature
7078 -------------------------------
7079 -- 12.3 Generic Actual Part --
7080 -------------------------------
7082 -- GENERIC_ACTUAL_PART ::=
7083 -- (GENERIC_ASSOCIATION {, GENERIC_ASSOCIATION})
7085 -------------------------------
7086 -- 12.3 Generic Association --
7087 -------------------------------
7089 -- GENERIC_ASSOCIATION ::=
7090 -- [generic_formal_parameter_SELECTOR_NAME =>]
7092 -- Note: unlike the procedure call case, a generic association node
7093 -- is generated for every association, even if no formal parameter
7094 -- selector name is present. In this case the parser will leave the
7095 -- Selector_Name field set to Empty, to be filled in later by the
7096 -- semantic pass.
7098 -- In Ada 2005, a formal may be associated with a box, if the
7099 -- association is part of the list of actuals for a formal package.
7100 -- If the association is given by OTHERS => <>, the association is
7101 -- an N_Others_Choice.
7103 -- N_Generic_Association
7104 -- Sloc points to first token of generic association
7105 -- Selector_Name (set to Empty if no formal
7106 -- parameter selector name)
7107 -- Explicit_Generic_Actual_Parameter (Empty if box present)
7108 -- Box_Present (for formal_package associations with a box)
7110 ---------------------------------------------
7111 -- 12.3 Explicit Generic Actual Parameter --
7112 ---------------------------------------------
7114 -- EXPLICIT_GENERIC_ACTUAL_PARAMETER ::=
7115 -- EXPRESSION | variable_NAME | subprogram_NAME
7116 -- | entry_NAME | SUBTYPE_MARK | package_instance_NAME
7118 -------------------------------------
7119 -- 12.4 Formal Object Declaration --
7120 -------------------------------------
7122 -- FORMAL_OBJECT_DECLARATION ::=
7123 -- DEFINING_IDENTIFIER_LIST :
7124 -- MODE [NULL_EXCLUSION] SUBTYPE_MARK [:= DEFAULT_EXPRESSION]
7125 -- [ASPECT_SPECIFICATIONS];
7126 -- | DEFINING_IDENTIFIER_LIST :
7127 -- MODE ACCESS_DEFINITION [:= DEFAULT_EXPRESSION]
7128 -- [ASPECT_SPECIFICATIONS];
7130 -- Although the syntax allows multiple identifiers in the list, the
7131 -- semantics is as though successive declarations were given with
7132 -- identical type definition and expression components. To simplify
7133 -- semantic processing, the parser represents a multiple declaration
7134 -- case as a sequence of single declarations, using the More_Ids and
7135 -- Prev_Ids flags to preserve the original source form as described
7136 -- in the section on "Handling of Defining Identifier Lists".
7138 -- N_Formal_Object_Declaration
7139 -- Sloc points to first identifier
7140 -- Defining_Identifier
7141 -- In_Present
7142 -- Out_Present
7143 -- Null_Exclusion_Present (set to False if not present)
7144 -- Subtype_Mark (set to Empty if not present)
7145 -- Access_Definition (set to Empty if not present)
7146 -- Default_Expression (set to Empty if no default expression)
7147 -- More_Ids (set to False if no more identifiers in list)
7148 -- Prev_Ids (set to False if no previous identifiers in list)
7150 -----------------------------------
7151 -- 12.5 Formal Type Declaration --
7152 -----------------------------------
7154 -- FORMAL_TYPE_DECLARATION ::=
7155 -- type DEFINING_IDENTIFIER [DISCRIMINANT_PART]
7156 -- is FORMAL_TYPE_DEFINITION
7157 -- [ASPECT_SPECIFICATIONS];
7158 -- | type DEFINING_IDENTIFIER [DISCRIMINANT_PART] [is tagged]
7160 -- N_Formal_Type_Declaration
7161 -- Sloc points to TYPE
7162 -- Defining_Identifier
7163 -- Formal_Type_Definition
7164 -- Discriminant_Specifications (set to No_List if no
7165 -- discriminant part)
7166 -- Unknown_Discriminants_Present set if (<>) discriminant
7167 -- Default_Subtype_Mark
7169 ----------------------------------
7170 -- 12.5 Formal type definition --
7171 ----------------------------------
7173 -- FORMAL_TYPE_DEFINITION ::=
7174 -- FORMAL_PRIVATE_TYPE_DEFINITION
7175 -- | FORMAL_DERIVED_TYPE_DEFINITION
7176 -- | FORMAL_DISCRETE_TYPE_DEFINITION
7177 -- | FORMAL_SIGNED_INTEGER_TYPE_DEFINITION
7178 -- | FORMAL_MODULAR_TYPE_DEFINITION
7179 -- | FORMAL_FLOATING_POINT_DEFINITION
7180 -- | FORMAL_ORDINARY_FIXED_POINT_DEFINITION
7181 -- | FORMAL_DECIMAL_FIXED_POINT_DEFINITION
7182 -- | FORMAL_ARRAY_TYPE_DEFINITION
7183 -- | FORMAL_ACCESS_TYPE_DEFINITION
7184 -- | FORMAL_INTERFACE_TYPE_DEFINITION
7185 -- | FORMAL_INCOMPLETE_TYPE_DEFINITION
7187 -- The Ada 2012 syntax introduces two new non-terminals:
7188 -- Formal_{Complete,Incomplete}_Type_Declaration just to introduce
7189 -- the latter category. Here we introduce an incomplete type definition
7190 -- in order to preserve as much as possible the existing structure.
7192 ---------------------------------------------
7193 -- 12.5.1 Formal Private Type Definition --
7194 ---------------------------------------------
7196 -- FORMAL_PRIVATE_TYPE_DEFINITION ::=
7197 -- [[abstract] tagged] [limited] private
7199 -- Note: TAGGED is not allowed in Ada 83 mode
7201 -- N_Formal_Private_Type_Definition
7202 -- Sloc points to PRIVATE
7203 -- Uninitialized_Variable
7204 -- Abstract_Present
7205 -- Tagged_Present
7206 -- Limited_Present
7208 --------------------------------------------
7209 -- 12.5.1 Formal Derived Type Definition --
7210 --------------------------------------------
7212 -- FORMAL_DERIVED_TYPE_DEFINITION ::=
7213 -- [abstract] [limited | synchronized]
7214 -- new SUBTYPE_MARK [[and INTERFACE_LIST] with private]
7215 -- Note: this construct is not allowed in Ada 83 mode
7217 -- N_Formal_Derived_Type_Definition
7218 -- Sloc points to NEW
7219 -- Subtype_Mark
7220 -- Private_Present
7221 -- Abstract_Present
7222 -- Limited_Present
7223 -- Synchronized_Present
7224 -- Interface_List (set to No_List if none)
7226 -----------------------------------------------
7227 -- 12.5.1 Formal Incomplete Type Definition --
7228 -----------------------------------------------
7230 -- FORMAL_INCOMPLETE_TYPE_DEFINITION ::= [tagged]
7232 -- N_Formal_Incomplete_Type_Definition
7233 -- Sloc points to identifier of parent
7234 -- Tagged_Present
7236 ---------------------------------------------
7237 -- 12.5.2 Formal Discrete Type Definition --
7238 ---------------------------------------------
7240 -- FORMAL_DISCRETE_TYPE_DEFINITION ::= (<>)
7242 -- N_Formal_Discrete_Type_Definition
7243 -- Sloc points to (
7245 ---------------------------------------------------
7246 -- 12.5.2 Formal Signed Integer Type Definition --
7247 ---------------------------------------------------
7249 -- FORMAL_SIGNED_INTEGER_TYPE_DEFINITION ::= range <>
7251 -- N_Formal_Signed_Integer_Type_Definition
7252 -- Sloc points to RANGE
7254 --------------------------------------------
7255 -- 12.5.2 Formal Modular Type Definition --
7256 --------------------------------------------
7258 -- FORMAL_MODULAR_TYPE_DEFINITION ::= mod <>
7260 -- N_Formal_Modular_Type_Definition
7261 -- Sloc points to MOD
7263 ----------------------------------------------
7264 -- 12.5.2 Formal Floating Point Definition --
7265 ----------------------------------------------
7267 -- FORMAL_FLOATING_POINT_DEFINITION ::= digits <>
7269 -- N_Formal_Floating_Point_Definition
7270 -- Sloc points to DIGITS
7272 ----------------------------------------------------
7273 -- 12.5.2 Formal Ordinary Fixed Point Definition --
7274 ----------------------------------------------------
7276 -- FORMAL_ORDINARY_FIXED_POINT_DEFINITION ::= delta <>
7278 -- N_Formal_Ordinary_Fixed_Point_Definition
7279 -- Sloc points to DELTA
7281 ---------------------------------------------------
7282 -- 12.5.2 Formal Decimal Fixed Point Definition --
7283 ---------------------------------------------------
7285 -- FORMAL_DECIMAL_FIXED_POINT_DEFINITION ::= delta <> digits <>
7287 -- Note: formal decimal fixed point definition not allowed in Ada 83
7289 -- N_Formal_Decimal_Fixed_Point_Definition
7290 -- Sloc points to DELTA
7292 ------------------------------------------
7293 -- 12.5.3 Formal Array Type Definition --
7294 ------------------------------------------
7296 -- FORMAL_ARRAY_TYPE_DEFINITION ::= ARRAY_TYPE_DEFINITION
7298 -------------------------------------------
7299 -- 12.5.4 Formal Access Type Definition --
7300 -------------------------------------------
7302 -- FORMAL_ACCESS_TYPE_DEFINITION ::= ACCESS_TYPE_DEFINITION
7304 ----------------------------------------------
7305 -- 12.5.5 Formal Interface Type Definition --
7306 ----------------------------------------------
7308 -- FORMAL_INTERFACE_TYPE_DEFINITION ::= INTERFACE_TYPE_DEFINITION
7310 -----------------------------------------
7311 -- 12.6 Formal Subprogram Declaration --
7312 -----------------------------------------
7314 -- FORMAL_SUBPROGRAM_DECLARATION ::=
7315 -- FORMAL_CONCRETE_SUBPROGRAM_DECLARATION
7316 -- | FORMAL_ABSTRACT_SUBPROGRAM_DECLARATION
7318 --------------------------------------------------
7319 -- 12.6 Formal Concrete Subprogram Declaration --
7320 --------------------------------------------------
7322 -- FORMAL_CONCRETE_SUBPROGRAM_DECLARATION ::=
7323 -- with SUBPROGRAM_SPECIFICATION [is SUBPROGRAM_DEFAULT]
7324 -- [ASPECT_SPECIFICATIONS];
7326 -- N_Formal_Concrete_Subprogram_Declaration
7327 -- Sloc points to WITH
7328 -- Specification
7329 -- Default_Name (set to Empty if no subprogram default)
7330 -- Box_Present
7331 -- Expression (set to Empty if no expression present)
7333 -- Note: If no subprogram default is present, then Name is set
7334 -- to Empty, and Box_Present is False.
7336 -- Note: The Expression field is only used for the GNAT extension
7337 -- that allows a FORMAL_CONCRETE_SUBPROGRAM_DECLARATION to specify
7338 -- an expression default for generic formal functions.
7340 --------------------------------------------------
7341 -- 12.6 Formal Abstract Subprogram Declaration --
7342 --------------------------------------------------
7344 -- FORMAL_ABSTRACT_SUBPROGRAM_DECLARATION ::=
7345 -- with SUBPROGRAM_SPECIFICATION is abstract [SUBPROGRAM_DEFAULT]
7346 -- [ASPECT_SPECIFICATIONS];
7348 -- N_Formal_Abstract_Subprogram_Declaration
7349 -- Sloc points to WITH
7350 -- Specification
7351 -- Default_Name (set to Empty if no subprogram default)
7352 -- Box_Present
7354 -- Note: if no subprogram default is present, then Name is set
7355 -- to Empty, and Box_Present is False.
7357 ------------------------------
7358 -- 12.6 Subprogram Default --
7359 ------------------------------
7361 -- SUBPROGRAM_DEFAULT ::= DEFAULT_NAME | <> | (EXPRESSION)
7363 -- There is no separate node in the tree for a subprogram default.
7364 -- Instead the parent (N_Formal_Concrete_Subprogram_Declaration
7365 -- or N_Formal_Abstract_Subprogram_Declaration) node contains the
7366 -- default name or box indication, as needed.
7368 -- Note: The syntax "(EXPRESSION)" is a GNAT extension, and allows
7369 -- a FORMAL_CONCRETE_SUBPROGRAM_DECLARATION to specify an expression
7370 -- default for formal functions, in analogy with expression_functions.
7372 ------------------------
7373 -- 12.6 Default Name --
7374 ------------------------
7376 -- DEFAULT_NAME ::= NAME
7378 --------------------------------------
7379 -- 12.7 Formal Package Declaration --
7380 --------------------------------------
7382 -- FORMAL_PACKAGE_DECLARATION ::=
7383 -- with package DEFINING_IDENTIFIER
7384 -- is new generic_package_NAME FORMAL_PACKAGE_ACTUAL_PART
7385 -- [ASPECT_SPECIFICATIONS];
7387 -- Note: formal package declarations not allowed in Ada 83 mode
7389 -- N_Formal_Package_Declaration
7390 -- Sloc points to WITH
7391 -- Defining_Identifier
7392 -- Name
7393 -- Generic_Associations (set to No_List if (<>) case or
7394 -- empty generic actual part)
7395 -- Box_Present
7396 -- Instance_Spec
7397 -- Is_Known_Guaranteed_ABE
7399 --------------------------------------
7400 -- 12.7 Formal Package Actual Part --
7401 --------------------------------------
7403 -- FORMAL_PACKAGE_ACTUAL_PART ::=
7404 -- ([OTHERS] => <>)
7405 -- | [GENERIC_ACTUAL_PART]
7406 -- (FORMAL_PACKAGE_ASSOCIATION {. FORMAL_PACKAGE_ASSOCIATION}
7408 -- FORMAL_PACKAGE_ASSOCIATION ::=
7409 -- GENERIC_ASSOCIATION
7410 -- | GENERIC_FORMAL_PARAMETER_SELECTOR_NAME => <>
7412 -- There is no explicit node in the tree for a formal package actual
7413 -- part. Instead the information appears in the parent node (i.e. the
7414 -- formal package declaration node itself).
7416 -- There is no explicit node for a formal package association. All of
7417 -- them are represented either by a generic association, possibly with
7418 -- Box_Present, or by an N_Others_Choice.
7420 ---------------------------------
7421 -- 13.1 Representation clause --
7422 ---------------------------------
7424 -- REPRESENTATION_CLAUSE ::=
7425 -- ATTRIBUTE_DEFINITION_CLAUSE
7426 -- | ENUMERATION_REPRESENTATION_CLAUSE
7427 -- | RECORD_REPRESENTATION_CLAUSE
7428 -- | AT_CLAUSE
7430 ----------------------
7431 -- 13.1 Local Name --
7432 ----------------------
7434 -- LOCAL_NAME :=
7435 -- DIRECT_NAME
7436 -- | DIRECT_NAME'ATTRIBUTE_DESIGNATOR
7437 -- | library_unit_NAME
7439 -- The construct DIRECT_NAME'ATTRIBUTE_DESIGNATOR appears in the tree
7440 -- as an attribute reference, which has essentially the same form.
7442 ---------------------------------------
7443 -- 13.3 Attribute definition clause --
7444 ---------------------------------------
7446 -- ATTRIBUTE_DEFINITION_CLAUSE ::=
7447 -- for LOCAL_NAME'ATTRIBUTE_DESIGNATOR use EXPRESSION;
7448 -- | for LOCAL_NAME'ATTRIBUTE_DESIGNATOR use NAME;
7450 -- In Ada 83, the expression must be a simple expression and the
7451 -- local name must be a direct name.
7453 -- Note: the only attribute definition clause that is processed by
7454 -- gigi is an address clause. For all other cases, the information
7455 -- is extracted by the front end and either results in setting entity
7456 -- information, e.g. Esize for the Size clause, or in appropriate
7457 -- expansion actions (e.g. in the case of Storage_Size).
7459 -- For an address clause, Gigi constructs the appropriate addressing
7460 -- code. It also ensures that no aliasing optimizations are made
7461 -- for the object for which the address clause appears.
7463 -- Note: for an address clause used to achieve an overlay:
7465 -- A : Integer;
7466 -- B : Integer;
7467 -- for B'Address use A'Address;
7469 -- the above rule means that Gigi will ensure that no optimizations
7470 -- will be made for B that would violate the implementation advice
7471 -- of RM 13.3(19). However, this advice applies only to B and not
7472 -- to A, which seems unfortunate. The GNAT front end will mark the
7473 -- object A as volatile to also prevent unwanted optimization
7474 -- assumptions based on no aliasing being made for B.
7476 -- N_Attribute_Definition_Clause
7477 -- Sloc points to FOR
7478 -- Name the local name
7479 -- Chars the identifier name from the attribute designator
7480 -- Expression the expression or name
7481 -- Entity
7482 -- Next_Rep_Item
7483 -- From_At_Mod
7484 -- Check_Address_Alignment
7485 -- From_Aspect_Specification
7486 -- Is_Delayed_Aspect
7487 -- Address_Warning_Posted
7489 -- Note: if From_Aspect_Specification is set, then Sloc points to the
7490 -- aspect name, and Entity is resolved already to reference the entity
7491 -- to which the aspect applies.
7493 -----------------------------------
7494 -- 13.3.1 Aspect Specifications --
7495 -----------------------------------
7497 -- We modify the RM grammar here, the RM grammar is:
7499 -- ASPECT_SPECIFICATION ::=
7500 -- with ASPECT_MARK [=> ASPECT_DEFINITION] {,
7501 -- ASPECT_MARK [=> ASPECT_DEFINITION] }
7503 -- ASPECT_MARK ::= aspect_IDENTIFIER['Class]
7505 -- ASPECT_DEFINITION ::= NAME | EXPRESSION
7507 -- That's inconvenient, since there is no non-terminal name for a single
7508 -- entry in the list of aspects. So we use this grammar instead:
7510 -- ASPECT_SPECIFICATIONS ::=
7511 -- with ASPECT_SPECIFICATION {, ASPECT_SPECIFICATION}
7513 -- ASPECT_SPECIFICATION =>
7514 -- ASPECT_MARK [=> ASPECT_DEFINITION]
7516 -- ASPECT_MARK ::= aspect_IDENTIFIER['Class]
7518 -- ASPECT_DEFINITION ::= NAME | EXPRESSION
7520 -- Note that for Annotate, the ASPECT_DEFINITION is a pure positional
7521 -- aggregate with the elements of the aggregate corresponding to the
7522 -- successive arguments of the corresponding pragma.
7524 -- See separate package Aspects for details on the incorporation of
7525 -- these nodes into the tree, and how aspect specifications for a given
7526 -- declaration node are associated with that node.
7528 -- N_Aspect_Specification
7529 -- Sloc points to aspect identifier
7530 -- Identifier aspect identifier
7531 -- Aspect_Rep_Item
7532 -- Expression (set to Empty if none)
7533 -- Entity entity to which the aspect applies
7534 -- Next_Rep_Item
7535 -- Class_Present Set if 'Class present
7536 -- Is_Ignored
7537 -- Is_Checked
7538 -- Is_Delayed_Aspect
7539 -- Is_Disabled
7540 -- Is_Boolean_Aspect
7541 -- Split_PPC Set if split pre/post attribute
7542 -- Aspect_On_Partial_View
7544 -- Note: Aspect_Specification is an Ada 2012 feature
7546 -- Note: The Identifier serves to identify the aspect involved (it
7547 -- is the aspect whose name corresponds to the Chars field). This
7548 -- means that the other fields of this identifier are unused, and
7549 -- in particular we use the Entity field of this identifier to save
7550 -- a copy of the expression for visibility analysis, see spec of
7551 -- Sem_Ch13 for full details of this usage.
7553 -- In the case of aspects of the form xxx'Class, the aspect identifier
7554 -- is for xxx, and Class_Present is set to True.
7556 -- Note: When a Pre or Post aspect specification is processed, it is
7557 -- broken into AND THEN sections. The left most section has Split_PPC
7558 -- set to False, indicating that it is the original specification (e.g.
7559 -- for posting errors). For the other sections, Split_PPC is set True.
7561 ---------------------------------------------
7562 -- 13.4 Enumeration representation clause --
7563 ---------------------------------------------
7565 -- ENUMERATION_REPRESENTATION_CLAUSE ::=
7566 -- for first_subtype_LOCAL_NAME use ENUMERATION_AGGREGATE;
7568 -- In Ada 83, the name must be a direct name
7570 -- N_Enumeration_Representation_Clause
7571 -- Sloc points to FOR
7572 -- Identifier direct name
7573 -- Array_Aggregate
7574 -- Next_Rep_Item
7576 ---------------------------------
7577 -- 13.4 Enumeration aggregate --
7578 ---------------------------------
7580 -- ENUMERATION_AGGREGATE ::= ARRAY_AGGREGATE
7582 ------------------------------------------
7583 -- 13.5.1 Record representation clause --
7584 ------------------------------------------
7586 -- RECORD_REPRESENTATION_CLAUSE ::=
7587 -- for first_subtype_LOCAL_NAME use
7588 -- record [MOD_CLAUSE]
7589 -- {COMPONENT_CLAUSE}
7590 -- end record;
7592 -- Gigi restriction: Mod_Clause is always Empty (if present it is
7593 -- replaced by a corresponding Alignment attribute definition clause).
7595 -- Note: Component_Clauses can include pragmas
7597 -- N_Record_Representation_Clause
7598 -- Sloc points to FOR
7599 -- Identifier direct name
7600 -- Mod_Clause (set to Empty if no mod clause present)
7601 -- Component_Clauses
7602 -- Next_Rep_Item
7604 ------------------------------
7605 -- 13.5.1 Component clause --
7606 ------------------------------
7608 -- COMPONENT_CLAUSE ::=
7609 -- component_LOCAL_NAME at POSITION
7610 -- range FIRST_BIT .. LAST_BIT;
7612 -- N_Component_Clause
7613 -- Sloc points to AT
7614 -- Component_Name points to Name or Attribute_Reference
7615 -- Position
7616 -- First_Bit
7617 -- Last_Bit
7619 ----------------------
7620 -- 13.5.1 Position --
7621 ----------------------
7623 -- POSITION ::= static_EXPRESSION
7625 -----------------------
7626 -- 13.5.1 First_Bit --
7627 -----------------------
7629 -- FIRST_BIT ::= static_SIMPLE_EXPRESSION
7631 ----------------------
7632 -- 13.5.1 Last_Bit --
7633 ----------------------
7635 -- LAST_BIT ::= static_SIMPLE_EXPRESSION
7637 --------------------------
7638 -- 13.8 Code statement --
7639 --------------------------
7641 -- CODE_STATEMENT ::= QUALIFIED_EXPRESSION;
7643 -- Note: in GNAT, the qualified expression has the form
7645 -- Asm_Insn'(Asm (...));
7647 -- See package System.Machine_Code in file s-maccod.ads for details on
7648 -- the allowed parameters to Asm. There are two ways this node can
7649 -- arise, as a code statement, in which case the expression is the
7650 -- qualified expression, or as a result of the expansion of an intrinsic
7651 -- call to the Asm or Asm_Input procedure.
7653 -- N_Code_Statement
7654 -- Sloc points to first token of the expression
7655 -- Expression
7657 -- Note: package Exp_Code contains an abstract functional interface
7658 -- for use by Gigi in accessing the data from N_Code_Statement nodes.
7660 ------------------------
7661 -- 13.12 Restriction --
7662 ------------------------
7664 -- RESTRICTION ::=
7665 -- restriction_IDENTIFIER
7666 -- | restriction_parameter_IDENTIFIER => EXPRESSION
7668 -- There is no explicit node for restrictions. Instead the restriction
7669 -- appears in normal pragma syntax as a pragma argument association,
7670 -- which has the same syntactic form.
7672 --------------------------
7673 -- B.2 Shift Operators --
7674 --------------------------
7676 -- Calls to the intrinsic shift functions are converted to one of
7677 -- the following shift nodes, which have the form of normal binary
7678 -- operator names. Note that for a given shift operation, one node
7679 -- covers all possible types, as for normal operators.
7681 -- Note: it is perfectly permissible for the expander to generate
7682 -- shift operation nodes directly, in which case they will be analyzed
7683 -- and parsed in the usual manner.
7685 -- Sprint syntax: shift-function-name!(expr, count)
7687 -- Note: the Left_Opnd field holds the first argument (the value to
7688 -- be shifted). The Right_Opnd field holds the second argument (the
7689 -- shift count). The Chars field is the name of the intrinsic function.
7691 -- N_Op_Rotate_Left
7692 -- Sloc points to the function name
7693 -- plus fields for binary operator
7694 -- plus fields for expression
7695 -- Shift_Count_OK
7697 -- N_Op_Rotate_Right
7698 -- Sloc points to the function name
7699 -- plus fields for binary operator
7700 -- plus fields for expression
7701 -- Shift_Count_OK
7703 -- N_Op_Shift_Left
7704 -- Sloc points to the function name
7705 -- plus fields for binary operator
7706 -- plus fields for expression
7707 -- Shift_Count_OK
7709 -- N_Op_Shift_Right_Arithmetic
7710 -- Sloc points to the function name
7711 -- plus fields for binary operator
7712 -- plus fields for expression
7713 -- Shift_Count_OK
7715 -- N_Op_Shift_Right
7716 -- Sloc points to the function name
7717 -- plus fields for binary operator
7718 -- plus fields for expression
7719 -- Shift_Count_OK
7721 -- Note: N_Op_Rotate_Left, N_Op_Rotate_Right, N_Shift_Right_Arithmetic
7722 -- never appear in the expanded tree if Modify_Tree_For_C mode is set.
7724 -- Note: For N_Op_Shift_Left and N_Op_Shift_Right, the right operand is
7725 -- always less than the word size if Modify_Tree_For_C mode is set.
7727 --------------------------
7728 -- Obsolescent Features --
7729 --------------------------
7731 -- The syntax descriptions and tree nodes for obsolescent features are
7732 -- grouped together, corresponding to their location in appendix I in
7733 -- the RM. However, parsing and semantic analysis for these constructs
7734 -- is located in an appropriate chapter (see individual notes).
7736 ---------------------------
7737 -- J.3 Delta Constraint --
7738 ---------------------------
7740 -- Note: the parse routine for this construct is located in section
7741 -- 3.5.9 of Par-Ch3, and semantic analysis is in Sem_Ch3, which is
7742 -- where delta constraint logically belongs.
7744 -- DELTA_CONSTRAINT ::= DELTA static_EXPRESSION [RANGE_CONSTRAINT]
7746 -- N_Delta_Constraint
7747 -- Sloc points to DELTA
7748 -- Delta_Expression
7749 -- Range_Constraint (set to Empty if not present)
7751 --------------------
7752 -- J.7 At Clause --
7753 --------------------
7755 -- AT_CLAUSE ::= for DIRECT_NAME use at EXPRESSION;
7757 -- Note: the parse routine for this construct is located in Par-Ch13,
7758 -- and the semantic analysis is in Sem_Ch13, where at clause logically
7759 -- belongs if it were not obsolescent.
7761 -- Note: in Ada 83 the expression must be a simple expression
7763 -- Gigi restriction: This node never appears, it is rewritten as an
7764 -- address attribute definition clause.
7766 -- N_At_Clause
7767 -- Sloc points to FOR
7768 -- Identifier
7769 -- Expression
7771 ---------------------
7772 -- J.8 Mod clause --
7773 ---------------------
7775 -- MOD_CLAUSE ::= at mod static_EXPRESSION;
7777 -- Note: the parse routine for this construct is located in Par-Ch13,
7778 -- and the semantic analysis is in Sem_Ch13, where mod clause logically
7779 -- belongs if it were not obsolescent.
7781 -- Note: in Ada 83, the expression must be a simple expression
7783 -- Gigi restriction: this node never appears. It is replaced
7784 -- by a corresponding Alignment attribute definition clause.
7786 -- Note: pragmas can appear before and after the MOD_CLAUSE since
7787 -- its name has "clause" in it. This is rather strange, but is quite
7788 -- definitely specified. The pragmas before are collected in the
7789 -- Pragmas_Before field of the mod clause node itself, and pragmas
7790 -- after are simply swallowed up in the list of component clauses.
7792 -- N_Mod_Clause
7793 -- Sloc points to AT
7794 -- Expression
7795 -- Pragmas_Before Pragmas before mod clause (No_List if none)
7797 --------------------
7798 -- Semantic Nodes --
7799 --------------------
7801 -- These semantic nodes are used to hold additional semantic information.
7802 -- They are inserted into the tree as a result of semantic processing.
7803 -- Although there are no legitimate source syntax constructions that
7804 -- correspond directly to these nodes, we need a source syntax for the
7805 -- reconstructed tree printed by Sprint, and the node descriptions here
7806 -- show this syntax.
7808 -----------------
7809 -- Call_Marker --
7810 -----------------
7812 -- This node is created during the analysis/resolution of entry calls,
7813 -- requeues, and subprogram calls. It performs several functions:
7815 -- * Call markers provide a uniform model for handling calls by the
7816 -- ABE mechanism, regardless of whether expansion took place.
7818 -- * The call marker captures the target of the related call along
7819 -- with other attributes which are either unavailable or expensive
7820 -- to recompute once analysis, resolution, and expansion are over.
7822 -- * The call marker aids the ABE Processing phase by signaling the
7823 -- presence of a call in case the original call was transformed by
7824 -- expansion.
7826 -- * The call marker acts as a reference point for the insertion of
7827 -- run-time conditional ABE checks or guaranteed ABE failures.
7829 -- Sprint syntax: #target#
7831 -- The Sprint syntax shown above is not enabled by default
7833 -- N_Call_Marker
7834 -- Sloc points to Sloc of original call
7835 -- Target
7836 -- Is_Elaboration_Checks_OK_Node
7837 -- Is_SPARK_Mode_On_Node
7838 -- Is_Elaboration_Warnings_OK_Node
7839 -- Is_Source_Call
7840 -- Is_Declaration_Level_Node
7841 -- Is_Dispatching_Call
7842 -- Is_Preelaborable_Call
7843 -- Is_Known_Guaranteed_ABE
7845 ------------------------
7846 -- Compound Statement --
7847 ------------------------
7849 -- This node is created by the analyzer/expander to handle some
7850 -- expansion cases where a sequence of actions needs to be captured
7851 -- within a single node (which acts as a container and allows the
7852 -- entire list of actions to be moved around as a whole) appearing
7853 -- in a sequence of statements.
7855 -- This is the statement counterpart to the expression node
7856 -- N_Expression_With_Actions.
7858 -- The required semantics is that the set of actions is executed in
7859 -- the order in which it appears, as though they appeared by themselves
7860 -- in the enclosing list of declarations or statements. Unlike what
7861 -- happens when using an N_Block_Statement, no new scope is introduced.
7863 -- Note: for the time being, this is used only as a transient
7864 -- representation during expansion, and all compound statement nodes
7865 -- must be exploded back to their constituent statements before handing
7866 -- the tree to the back end.
7868 -- Sprint syntax: do
7869 -- action;
7870 -- action;
7871 -- ...
7872 -- action;
7873 -- end;
7875 -- N_Compound_Statement
7876 -- Actions
7878 --------------
7879 -- Contract --
7880 --------------
7882 -- This node is used to hold the various parts of an entry, subprogram
7883 -- [body] or package [body] contract, in particular:
7884 -- Abstract states declared by a package declaration
7885 -- Contract cases that apply to a subprogram
7886 -- Dependency relations of inputs and output of a subprogram
7887 -- Global annotations classifying data as input or output
7888 -- Initialization sequences for a package declaration
7889 -- Pre- and postconditions that apply to a subprogram
7891 -- The node appears in an entry and [generic] subprogram [body] entity.
7893 -- Sprint syntax: <none> as the node should not appear in the tree, but
7894 -- only attached to an entry or [generic] subprogram
7895 -- entity.
7897 -- N_Contract
7898 -- Sloc points to the subprogram's name
7899 -- Pre_Post_Conditions (set to Empty if none)
7900 -- Contract_Test_Cases (set to Empty if none)
7901 -- Classifications (set to Empty if none)
7902 -- Is_Expanded_Contract
7904 -- Pre_Post_Conditions contains a collection of pragmas that correspond
7905 -- to pre- and postconditions associated with an entry or a subprogram
7906 -- [body or stub]. The pragmas can either come from source or be the
7907 -- byproduct of aspect expansion. Currently the following pragmas appear
7908 -- in this list:
7909 -- Post
7910 -- Postcondition
7911 -- Pre
7912 -- Precondition
7913 -- Refined_Post
7914 -- The ordering in the list is in LIFO fashion.
7916 -- Note that there might be multiple preconditions or postconditions
7917 -- in this list, either because they come from separate pragmas in the
7918 -- source, or because a Pre (resp. Post) aspect specification has been
7919 -- broken into AND THEN sections. See Split_PPC for details.
7921 -- In GNATprove mode, the inherited classwide pre- and postconditions
7922 -- (suitably specialized for the specific type of the overriding
7923 -- operation) are also in this list.
7925 -- Contract_Test_Cases contains a collection of pragmas that correspond
7926 -- to aspects/pragmas Contract_Cases, Test_Case and Subprogram_Variant.
7927 -- The ordering in the list is in LIFO fashion.
7929 -- Classifications contains pragmas that either declare, categorize, or
7930 -- establish dependencies between subprogram or package inputs and
7931 -- outputs. Currently the following pragmas appear in this list:
7932 -- Abstract_States
7933 -- Async_Readers
7934 -- Async_Writers
7935 -- Constant_After_Elaboration
7936 -- Depends
7937 -- Effective_Reads
7938 -- Effective_Writes
7939 -- Extensions_Visible
7940 -- Global
7941 -- Initial_Condition
7942 -- Initializes
7943 -- Part_Of
7944 -- Refined_Depends
7945 -- Refined_Global
7946 -- Refined_States
7947 -- Volatile_Function
7948 -- The ordering is in LIFO fashion.
7950 -------------------
7951 -- Expanded Name --
7952 -------------------
7954 -- The N_Expanded_Name node is used to represent a selected component
7955 -- name that has been resolved to an expanded name. The semantic phase
7956 -- replaces N_Selected_Component nodes that represent names by the use
7957 -- of this node, leaving the N_Selected_Component node used only when
7958 -- the prefix is a record or protected type.
7960 -- The fields of the N_Expanded_Name node are laid out identically
7961 -- to those of the N_Selected_Component node, allowing conversion of
7962 -- an expanded name node to a selected component node to be done
7963 -- easily, see Sinfo.CN.Change_Selected_Component_To_Expanded_Name.
7965 -- There is no special sprint syntax for an expanded name
7967 -- N_Expanded_Name
7968 -- Sloc points to the period
7969 -- Chars copy of Chars field of selector name
7970 -- Prefix
7971 -- Selector_Name
7972 -- Entity
7973 -- Associated_Node
7974 -- Is_Elaboration_Checks_OK_Node
7975 -- Is_SPARK_Mode_On_Node
7976 -- Is_Elaboration_Warnings_OK_Node
7977 -- Has_Private_View (set in generic units)
7978 -- Redundant_Use
7979 -- Atomic_Sync_Required
7980 -- plus fields for expression
7982 -----------------------------
7983 -- Expression With Actions --
7984 -----------------------------
7986 -- This node is created by the analyzer/expander to handle some
7987 -- expansion cases, notably short-circuit forms where there are
7988 -- actions associated with the right-hand side operand.
7990 -- The N_Expression_With_Actions node represents an expression with
7991 -- an associated set of actions (which are executable statements and
7992 -- declarations, as might occur in a handled statement sequence).
7994 -- The required semantics is that the set of actions is executed in
7995 -- the order in which it appears just before the expression is
7996 -- evaluated (and these actions must only be executed if the value
7997 -- of the expression is evaluated). The node is considered to be
7998 -- a subexpression, whose value is the value of the Expression after
7999 -- executing all the actions.
8001 -- If the actions contain declarations, then these declarations may
8002 -- be referenced within the expression.
8004 -- (AI12-0236-1): In Ada 2022, for a declare_expression, the parser
8005 -- generates an N_Expression_With_Actions. Declare_expressions have
8006 -- various restrictions, which we do not enforce on
8007 -- N_Expression_With_Actions nodes that are generated by the
8008 -- expander. The two cases can be distinguished by looking at
8009 -- Comes_From_Source.
8011 -- ???Perhaps we should change the name of this node to
8012 -- N_Declare_Expression, and perhaps we should change the Sprint syntax
8013 -- to match the RM syntax for declare_expression.
8015 -- Sprint syntax: do
8016 -- action;
8017 -- action;
8018 -- ...
8019 -- action;
8020 -- in expression end
8022 -- N_Expression_With_Actions
8023 -- Actions
8024 -- Expression
8025 -- plus fields for expression
8027 -- Note: In the final generated tree presented to the code generator,
8028 -- the actions list is always non-null, since there is no point in this
8029 -- node if the actions are Empty. During semantic analysis there are
8030 -- cases where it is convenient to temporarily generate an empty actions
8031 -- list. This arises in cases where we create such an empty actions
8032 -- list, and it may or may not end up being a place where additional
8033 -- actions are inserted. The expander removes such empty cases after
8034 -- the expression of the node is fully analyzed and expanded, at which
8035 -- point it is safe to remove it, since no more actions can be inserted.
8037 -- Note: In Modify_Tree_For_C, we never generate any declarations in
8038 -- the action list, which can contain only non-declarative statements.
8040 --------------------
8041 -- Free Statement --
8042 --------------------
8044 -- The N_Free_Statement node is generated as a result of a call to an
8045 -- instantiation of Unchecked_Deallocation. The instantiation of this
8046 -- generic is handled specially and generates this node directly.
8048 -- Sprint syntax: free expression
8050 -- N_Free_Statement
8051 -- Sloc is copied from the unchecked deallocation call
8052 -- Expression argument to unchecked deallocation call
8053 -- Storage_Pool
8054 -- Procedure_To_Call
8055 -- Actual_Designated_Subtype
8057 -- Note: in the case where a debug source file is generated, the Sloc
8058 -- for this node points to the FREE keyword in the Sprint file output.
8060 -------------------
8061 -- Freeze Entity --
8062 -------------------
8064 -- This node marks the point in a declarative part at which an entity
8065 -- declared therein becomes frozen. The expander places initialization
8066 -- procedures for types at those points. Gigi uses the freezing point
8067 -- to elaborate entities that may depend on previous private types.
8069 -- See the section in Einfo "Delayed Freezing and Elaboration" for
8070 -- a full description of the use of this node.
8072 -- The Entity field points back to the entity for the type (whose
8073 -- Freeze_Node field points back to this freeze node).
8075 -- The Actions field contains a list of declarations and statements
8076 -- generated by the expander which are associated with the freeze
8077 -- node, and are elaborated as though the freeze node were replaced
8078 -- by this sequence of actions.
8080 -- Note: the Sloc field in the freeze node references a construct
8081 -- associated with the freezing point. This is used for posting
8082 -- messages in some error/warning situations, e.g. the case where
8083 -- a primitive operation of a tagged type is declared too late.
8085 -- Sprint syntax: freeze entity-name [
8086 -- freeze actions
8087 -- ]
8089 -- N_Freeze_Entity
8090 -- Sloc points near freeze point (see above special note)
8091 -- Entity
8092 -- Access_Types_To_Process (set to No_Elist if none)
8093 -- TSS_Elist (set to No_Elist if no associated TSS's)
8094 -- Actions (set to No_List if no freeze actions)
8095 -- First_Subtype_Link (set to Empty if no link)
8097 -- The Actions field holds actions associated with the freeze. These
8098 -- actions are elaborated at the point where the type is frozen.
8100 -- Note: in the case where a debug source file is generated, the Sloc
8101 -- for this node points to the FREEZE keyword in the Sprint file output.
8103 ---------------------------
8104 -- Freeze Generic Entity --
8105 ---------------------------
8107 -- The freeze point of an entity indicates the point at which the
8108 -- information needed to generate code for the entity is complete.
8109 -- The freeze node for an entity triggers expander activities, such as
8110 -- build initialization procedures, and backend activities, such as
8111 -- completing the elaboration of packages.
8113 -- For entities declared within a generic unit, for which no code is
8114 -- generated, the freeze point is not equally meaningful. However, in
8115 -- Ada 2012 several semantic checks on declarations must be delayed to
8116 -- the freeze point, and we need to include such a mark in the tree to
8117 -- trigger these checks. The Freeze_Generic_Entity node plays no other
8118 -- role, and is ignored by the expander and the back-end.
8120 -- Sprint syntax: freeze_generic entity-name
8122 -- N_Freeze_Generic_Entity
8123 -- Sloc points near freeze point
8124 -- Entity
8126 --------------------------------
8127 -- Implicit Label Declaration --
8128 --------------------------------
8130 -- An implicit label declaration is created for every occurrence of a
8131 -- label on a statement or a label on a block or loop. It is chained
8132 -- in the declarations of the innermost enclosing block as specified
8133 -- in RM section 5.1 (3).
8135 -- The Defining_Identifier is the actual identifier for the statement
8136 -- identifier. Note that the occurrence of the label is a reference, NOT
8137 -- the defining occurrence. The defining occurrence occurs at the head
8138 -- of the innermost enclosing block, and is represented by this node.
8140 -- Note: from the grammar, this might better be called an implicit
8141 -- statement identifier declaration, but the term we choose seems
8142 -- friendlier, since at least informally statement identifiers are
8143 -- called labels in both cases (i.e. when used in labels, and when
8144 -- used as the identifiers of blocks and loops).
8146 -- Note: although this is logically a semantic node, since it does not
8147 -- correspond directly to a source syntax construction, these nodes are
8148 -- actually created by the parser in a post pass done just after parsing
8149 -- is complete, before semantic analysis is started (see Par.Labl).
8151 -- Sprint syntax: labelname : label;
8153 -- N_Implicit_Label_Declaration
8154 -- Sloc points to the << token for a statement identifier, or to the
8155 -- LOOP, DECLARE, or BEGIN token for a loop or block identifier
8156 -- Defining_Identifier
8157 -- Label_Construct
8159 -- Note: in the case where a debug source file is generated, the Sloc
8160 -- for this node points to the label name in the generated declaration.
8162 ---------------------
8163 -- Itype Reference --
8164 ---------------------
8166 -- This node is used to create a reference to an Itype. The only purpose
8167 -- is to make sure the Itype is defined if this is the first reference.
8169 -- A typical use of this node is when an Itype is to be referenced in
8170 -- two branches of an IF statement. In this case it is important that
8171 -- the first use of the Itype not be inside the conditional, since then
8172 -- it might not be defined if the other branch of the IF is taken, in
8173 -- the case where the definition generates elaboration code.
8175 -- The Itype field points to the referenced Itype
8177 -- Sprint syntax: reference itype-name
8179 -- N_Itype_Reference
8180 -- Sloc points to the node generating the reference
8181 -- Itype
8183 -- Note: in the case where a debug source file is generated, the Sloc
8184 -- for this node points to the REFERENCE keyword in the file output.
8186 ---------------------
8187 -- Raise xxx Error --
8188 ---------------------
8190 -- One of these nodes is created during semantic analysis to replace
8191 -- a node for an expression that is determined to definitely raise
8192 -- the corresponding exception.
8194 -- The N_Raise_xxx_Error node may also stand alone in place
8195 -- of a declaration or statement, in which case it simply causes
8196 -- the exception to be raised (i.e. it is equivalent to a raise
8197 -- statement that raises the corresponding exception). This use
8198 -- is distinguished by the fact that the Etype in this case is
8199 -- Standard_Void_Type; in the subexpression case, the Etype is the
8200 -- same as the type of the subexpression which it replaces.
8202 -- If Condition is empty, then the raise is unconditional. If the
8203 -- Condition field is non-empty, it is a boolean expression which is
8204 -- first evaluated, and the exception is raised only if the value of the
8205 -- expression is True. In the unconditional case, the creation of this
8206 -- node is usually accompanied by a warning message (unless it appears
8207 -- within the right operand of a short-circuit form whose left argument
8208 -- is static and decisively eliminates elaboration of the raise
8209 -- operation). The condition field can ONLY be present when the node is
8210 -- used as a statement form; it must NOT be present in the case where
8211 -- the node appears within an expression.
8213 -- The exception is generated with a message that contains the
8214 -- file name and line number, and then appended text. The Reason
8215 -- code shows the text to be added. The Reason code is an element
8216 -- of the type Types.RT_Exception_Code, and indicates both the
8217 -- message to be added, and the exception to be raised (which must
8218 -- match the node type). The value is stored by storing a Uint which
8219 -- is the Pos value of the enumeration element in this type.
8221 -- Gigi restriction: This expander ensures that the type of the
8222 -- Condition field is always Standard.Boolean, even if the type
8223 -- in the source is some non-standard boolean type.
8225 -- Sprint syntax: [xxx_error "msg"]
8226 -- or: [xxx_error when condition "msg"]
8228 -- N_Raise_Constraint_Error
8229 -- Sloc references related construct
8230 -- Condition (set to Empty if no condition)
8231 -- Reason
8232 -- plus fields for expression
8234 -- N_Raise_Program_Error
8235 -- Sloc references related construct
8236 -- Condition (set to Empty if no condition)
8237 -- Reason
8238 -- plus fields for expression
8240 -- N_Raise_Storage_Error
8241 -- Sloc references related construct
8242 -- Condition (set to Empty if no condition)
8243 -- Reason
8244 -- plus fields for expression
8246 -- Note: Sloc is copied from the expression generating the exception.
8247 -- In the case where a debug source file is generated, the Sloc for
8248 -- this node points to the left bracket in the Sprint file output.
8250 -- Note: the back end may be required to translate these nodes into
8251 -- appropriate goto statements. See description of N_Push/Pop_xxx_Label.
8253 ---------------------------------------------
8254 -- Optimization of Exception Raise to Goto --
8255 ---------------------------------------------
8257 -- In some cases, the front end will determine that any exception raised
8258 -- by the back end for a certain exception should be transformed into a
8259 -- goto statement.
8261 -- There are three kinds of exceptions raised by the back end (note that
8262 -- for this purpose we consider gigi to be part of the back end in the
8263 -- gcc case):
8265 -- 1. Exceptions resulting from N_Raise_xxx_Error nodes
8266 -- 2. Exceptions from checks triggered by Do_xxx_Check flags
8267 -- 3. Other cases not specifically marked by the front end
8269 -- Normally all such exceptions are translated into calls to the proper
8270 -- Rcheck_xx procedure, where xx encodes both the exception to be raised
8271 -- and the exception message.
8273 -- The front end may determine that for a particular sequence of code,
8274 -- exceptions in any of these three categories for a particular builtin
8275 -- exception should result in a goto, rather than a call to Rcheck_xx.
8276 -- The exact sequence to be generated is:
8278 -- Local_Raise (exception'Identity);
8279 -- goto Label
8281 -- The front end marks such a sequence of code by bracketing it with
8282 -- push and pop nodes:
8284 -- N_Push_xxx_Label (referencing the label)
8285 -- ...
8286 -- (code where transformation is expected for exception xxx)
8287 -- ...
8288 -- N_Pop_xxx_Label
8290 -- The use of push/pop reflects the fact that such regions can properly
8291 -- nest, and one special case is a subregion in which no transformation
8292 -- is allowed. Such a region is marked by a N_Push_xxx_Label node whose
8293 -- Exception_Label field is Empty.
8295 -- N_Push_Constraint_Error_Label
8296 -- Sloc references first statement in region covered
8297 -- Exception_Label
8299 -- N_Push_Program_Error_Label
8300 -- Sloc references first statement in region covered
8301 -- Exception_Label
8303 -- N_Push_Storage_Error_Label
8304 -- Sloc references first statement in region covered
8305 -- Exception_Label
8307 -- N_Pop_Constraint_Error_Label
8308 -- Sloc references last statement in region covered
8310 -- N_Pop_Program_Error_Label
8311 -- Sloc references last statement in region covered
8313 -- N_Pop_Storage_Error_Label
8314 -- Sloc references last statement in region covered
8316 ---------------
8317 -- Reference --
8318 ---------------
8320 -- For a number of purposes, we need to construct references to objects.
8321 -- These references are subsequently treated as normal access values.
8322 -- An example is the construction of the parameter block passed to a
8323 -- task entry. The N_Reference node is provided for this purpose. It is
8324 -- similar in effect to the use of the Unrestricted_Access attribute,
8325 -- and like Unrestricted_Access can be applied to objects which would
8326 -- not be valid prefixes for the Unchecked_Access attribute (e.g.
8327 -- objects which are not aliased, and slices). In addition it can be
8328 -- applied to composite type values as well as objects, including string
8329 -- values and aggregates.
8331 -- Note: we use the Prefix field for this expression so that the
8332 -- resulting node can be treated using common code with the attribute
8333 -- nodes for the 'Access and related attributes. Logically it would make
8334 -- more sense to call it an Expression field, but then we would have to
8335 -- special case the treatment of the N_Reference node.
8337 -- Note: evaluating a N_Reference node is guaranteed to yield a non-null
8338 -- value at run time. Therefore, it is valid to set Is_Known_Non_Null on
8339 -- a temporary initialized to a N_Reference node in order to eliminate
8340 -- superfluous access checks.
8342 -- Sprint syntax: prefix'reference
8344 -- N_Reference
8345 -- Sloc is copied from the expression
8346 -- Prefix
8347 -- plus fields for expression
8349 -- Note: in the case where a debug source file is generated, the Sloc
8350 -- for this node points to the quote in the Sprint file output.
8352 ----------------
8353 -- SCIL Nodes --
8354 ----------------
8356 -- SCIL nodes are special nodes added to the tree when the CodePeer mode
8357 -- is active. They are only generated if SCIL generation is enabled.
8358 -- A standard tree-walk will not encounter these nodes even if they
8359 -- are present; these nodes are only accessible via the function
8360 -- SCIL_LL.Get_SCIL_Node. These nodes have no associated dynamic
8361 -- semantics.
8363 -- Sprint syntax: [ <node kind> ]
8364 -- No semantic field values are displayed.
8366 -- N_SCIL_Dispatch_Table_Tag_Init
8367 -- Sloc references a node for a tag initialization
8368 -- SCIL_Entity
8370 -- An N_SCIL_Dispatch_Table_Tag_Init node may be associated (via
8371 -- Get_SCIL_Node) with the N_Object_Declaration node corresponding to
8372 -- the declaration of the dispatch table for a tagged type.
8374 -- N_SCIL_Dispatching_Call
8375 -- Sloc references the node of a dispatching call
8376 -- SCIL_Target_Prim
8377 -- SCIL_Entity
8378 -- SCIL_Controlling_Tag
8380 -- An N_Scil_Dispatching call node may be associated (via Get_SCIL_Node)
8381 -- with the N_Procedure_Call_Statement or N_Function_Call node (or a
8382 -- rewriting thereof) corresponding to a dispatching call.
8384 -- N_SCIL_Membership_Test
8385 -- Sloc references the node of a membership test
8386 -- SCIL_Tag_Value
8387 -- SCIL_Entity
8389 -- An N_Scil_Membership_Test node may be associated (via Get_SCIL_Node)
8390 -- with the N_In node (or a rewriting thereof) corresponding to a
8391 -- classwide membership test.
8393 --------------------------
8394 -- Unchecked Expression --
8395 --------------------------
8397 -- An unchecked expression is one that must be analyzed and resolved
8398 -- with all checks off, regardless of the current setting of scope
8399 -- suppress flags.
8401 -- Sprint syntax: `(expression)
8403 -- Note: this node is always removed from the tree (and replaced by
8404 -- its constituent expression) on completion of analysis, so it only
8405 -- appears in intermediate trees, and will never be seen by Gigi.
8407 -- N_Unchecked_Expression
8408 -- Sloc is a copy of the Sloc of the expression
8409 -- Expression
8410 -- plus fields for expression
8412 -- Note: in the case where a debug source file is generated, the Sloc
8413 -- for this node points to the back quote in the Sprint file output.
8415 -------------------------------
8416 -- Unchecked Type Conversion --
8417 -------------------------------
8419 -- An unchecked type conversion node represents the semantic action
8420 -- corresponding to a call to an instantiation of Unchecked_Conversion.
8421 -- It is generated as a result of actual use of Unchecked_Conversion
8422 -- and also by the expander.
8424 -- Unchecked type conversion nodes should be created by calling
8425 -- Tbuild.Unchecked_Convert_To, rather than by directly calling
8426 -- Nmake.Make_Unchecked_Type_Conversion.
8428 -- Note: an unchecked type conversion is a variable as far as the
8429 -- semantics are concerned, which is convenient for the expander.
8430 -- This does not change what Ada source programs are legal, since
8431 -- clearly a function call to an instantiation of Unchecked_Conversion
8432 -- is not a variable in any case.
8434 -- Sprint syntax: subtype-mark!(expression)
8436 -- N_Unchecked_Type_Conversion
8437 -- Sloc points to related node in source
8438 -- Subtype_Mark
8439 -- Expression
8440 -- Kill_Range_Check
8441 -- No_Truncation
8442 -- plus fields for expression
8444 -- Note: in the case where a debug source file is generated, the Sloc
8445 -- for this node points to the exclamation in the Sprint file output.
8447 -----------------------------------
8448 -- Validate_Unchecked_Conversion --
8449 -----------------------------------
8451 -- The front end does most of the validation of unchecked conversion,
8452 -- including checking sizes (this is done after the back end is called
8453 -- to take advantage of back-annotation of calculated sizes).
8455 -- The front end also deals with specific cases that are not allowed
8456 -- e.g. involving unconstrained array types.
8458 -- For the case of the standard gigi backend, this means that all
8459 -- checks are done in the front end.
8461 -- However, in the case of specialized back-ends, in particular the JVM
8462 -- backend in the past, additional requirements and restrictions may
8463 -- apply to unchecked conversion, and these are most conveniently
8464 -- performed in the specialized back-end.
8466 -- To accommodate this requirement, for such back ends, the following
8467 -- special node is generated recording an unchecked conversion that
8468 -- needs to be validated. The back end should post an appropriate
8469 -- error message if the unchecked conversion is invalid or warrants
8470 -- a special warning message.
8472 -- Source_Type and Target_Type point to the entities for the two
8473 -- types involved in the unchecked conversion instantiation that
8474 -- is to be validated.
8476 -- Sprint syntax: validate Unchecked_Conversion (source, target);
8478 -- N_Validate_Unchecked_Conversion
8479 -- Sloc points to instantiation (location for warning message)
8480 -- Source_Type
8481 -- Target_Type
8483 -- Note: in the case where a debug source file is generated, the Sloc
8484 -- for this node points to the VALIDATE keyword in the file output.
8486 -------------------------------
8487 -- Variable_Reference_Marker --
8488 -------------------------------
8490 -- This node is created during the analysis of direct or expanded names,
8491 -- and the resolution of entry and subprogram calls. It performs several
8492 -- functions:
8494 -- * Variable reference markers provide a uniform model for handling
8495 -- variable references by the ABE mechanism, regardless of whether
8496 -- expansion took place.
8498 -- * The variable reference marker captures the entity of the variable
8499 -- being read or written.
8501 -- * The variable reference markers aid the ABE Processing phase by
8502 -- signaling the presence of a call in case the original variable
8503 -- reference was transformed by expansion.
8505 -- Sprint syntax: r#target# -- for a read
8506 -- rw#target# -- for a read/write
8507 -- w#target# -- for a write
8509 -- The Sprint syntax shown above is not enabled by default
8511 -- N_Variable_Reference_Marker
8512 -- Sloc points to Sloc of original variable reference
8513 -- Target
8514 -- Is_Elaboration_Checks_OK_Node
8515 -- Is_SPARK_Mode_On_Node
8516 -- Is_Elaboration_Warnings_OK_Node
8517 -- Is_Read
8518 -- Is_Write
8520 -----------
8521 -- Empty --
8522 -----------
8524 -- Used as the contents of the Nkind field of the dummy Empty node and in
8525 -- some other situations to indicate an uninitialized value.
8527 -- N_Empty
8528 -- Chars is set to No_Name
8530 -----------
8531 -- Error --
8532 -----------
8534 -- Used as the contents of the Nkind field of the dummy Error node.
8535 -- Has an Etype field, which gets set to Any_Type later on, to help
8536 -- error recovery (Error_Posted is also set in the Error node).
8538 -- N_Error
8539 -- Chars is set to Error_Name
8540 -- Etype
8542 end Sinfo;